Modules

GUI condition

DEPRECATED: Please use "Global variables" module (in "Choice" mode) in conjunction with "Fixed text condition", which offer equivalent functionality.

Description

DEPRECATED: Please use "Global variables" module (in "Choice" mode) in conjunction with "Fixed text condition", which offer equivalent functionality.

Implement variable workflow handling outcomes based on a user-selectable drop-down list of choices. Each choice has a unique workflow outcome, which can include termination of the analysis and redirection of the active module to another part of the workflow. Redirection allows parts of the analysis workflow to be skipped.

An example usage case for GUI conditions is providing a drop-down box on the basic control view. With this simple control, the user can execute different blocks of the workflow without having to fundamentally understand how they are assembled.

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.
Choice Currently-selected choice from the available set (all choices added via "Add choice" option). The relevant workflow operation (e.g. termination/redirection) will be implemented for the selected condition. This control can be made visible in the processing view, so users can select between a set of pre-determined outcomes.
Store as metadata item When selected, the selected choice will be stored as a metadata item. This allows it to be exported to the final spreadsheet.
Metadata name Name for selected choice to be stored as metadata using. The choice will be accessible via this metadata name in subsequent modules and can be exported to the final spreadsheet.
Add choice Add another condition that "Choice" can select from. Each choice can have its own handling outcome (e.g. termination/redirection).
Choice name Name that this choice will appear as in the "Choice" drop-down menu.
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.
Choice Currently-selected choice from the available set (all choices added via "Add choice" option). The relevant workflow operation (e.g. termination/redirection) will be implemented for the selected condition. This control can be made visible in the processing view, so users can select between a set of pre-determined outcomes.
Store as metadata item When selected, the selected choice will be stored as a metadata item. This allows it to be exported to the final spreadsheet.
Metadata name Name for selected choice to be stored as metadata using. The choice will be accessible via this metadata name in subsequent modules and can be exported to the final spreadsheet.