Modules

Module is enabled condition

Implement workflow handling outcome based on whether another module is enabled or disabled.

Description

Implement workflow handling outcome based on whether another module is enabled or disabled. 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 skipped.

Note: This only applies to modules explictly enabled/disabled by the user. It does not apply to modules that are inactive due to invalid parameters (modules highlighted in red in the module list).

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 mode Controls whether the specified workflow handling outcome is applied if another module is enabled or disabled:
  • "Module is enabled" Execute specified outcome if another module is enabled.
  • "Module is not enabled" Execute specified outcome if another module is not enabled.
Test module Module to test the enabled/disabled state of. This doesn't necessarily need to be a module that would execute before the current module.