Modules

Fixed text condition

Implement variable workflow handling outcomes based on comparison of a fixed text value against a series of fixed conditions.

Description

Implement variable workflow handling outcomes based on comparison of a fixed text value against a series of fixed conditions. If the text test value matches any of the conditions the workflow handling outcome associated with that condition will be implemented. Outcomes can include termination of the analysis and redirection of the active module to another part of the workflow. Redirection allows parts of the analysis to be looped, or sections of the workflow to be skipped.

An example usage case for fixed text conditions is implementing the same behaviour at multiple parts of the workflow without having to control them individually. This can be achieved using a global variable (see "Global variables" module). The global variable could be specified once, early on in the analysis, then used as "Test value" in this module. As such, it's possible to only specify the value once, but refer to it in multiple "Fixed text condition" modules. Note: The global variables module allows variables to be user-selected from a drop-down list, negating risk of mis-typing parameter names that will be compared in this module.

Parameters

Parameter Description
Continuation mode Controls what happens if the termination/redirection condition is met:
  • "Redirect to module" The analysis workflow will skip to the module specified by the "Redirect module" parameter. Any modules between the present module and the target module will not be evaluated.
  • "Terminate"The analysis will stop evaluating any further modules.
Redirect module If the condition is met, the workflow will redirect to this module. In doing so, it will skip evaluation of any modules between the present module and this module.
Show redirect message Controls if a message should be displayed in the log if redirection occurs.
Redirect message Message to display if redirection occurs.
Show termination warning When selected, a warning will be displayed in the terminal if terminating a workflow early.
Export terminated workspaces Controls if the workspace should still be exported to the output Excel spreadsheet if termination occurs.
Remove images from workspace Controls if images should be completely removed from the workspace along with any associated measurements if termination occurs.
Remove objects from workspace Controls if objects should be completely removed from the workspace along with any associated measurements if termination occurs.
Test value Text value that will tested. If this matches any of the reference values listed within this module the relevant workflow operation (e.g. termination/redirection) will be implemented. This text value could be a global variable.
Add condition Add another condition that "Test value" can be compared against. Each condition can have its own handling outcome (e.g. termination/redirection).
Reference value Value "Test value" will be compared against. If the two values match, the associated handling outcome of this condition will be implemented.
Continuation mode Controls what happens if the termination/redirection condition is met:
  • "Redirect to module" The analysis workflow will skip to the module specified by the "Redirect module" parameter. Any modules between the present module and the target module will not be evaluated.
  • "Terminate"The analysis will stop evaluating any further modules.
Redirect module If the condition is met, the workflow will redirect to this module. In doing so, it will skip evaluation of any modules between the present module and this module.
Show redirect message Controls if a message should be displayed in the log if redirection occurs.
Redirect message Message to display if redirection occurs.
Show termination warning When selected, a warning will be displayed in the terminal if terminating a workflow early.
Export terminated workspaces Controls if the workspace should still be exported to the output Excel spreadsheet if termination occurs.
Remove images from workspace Controls if images should be completely removed from the workspace along with any associated measurements if termination occurs.
Remove objects from workspace Controls if objects should be completely removed from the workspace along with any associated measurements if termination occurs.