Experiment Actions#
You can find a list of the available actions that can be added to a Material group in the context of an Experiment:
- Change Flow and Step - specifies the change to the Flow Path from which the Flow and Step are derived. All actions of type Change Flow And Step do not move any Experiment Definition Step Material Group to a previous point in the flow, thereby avoiding circular executions.
- Create Send-Ahead Run - defines parameters to enable the creation of a Send-Ahead Run, including the Sub-Materials to add as Send-Ahead Materials, the Send-Ahead Split Type to be applied to the Material remaining in the Waiting state, the Selection Mode, and the Flows and Steps used for the Send-Ahead Run, along with the Results Capture Mode. For more information, see Create Send-Ahead Run.
- Execute Rule - assigns a Rule of scope Material Future Action.
- Hold - provides a valid Hold Reason for the Step where the action is defined. Optionally, a Hold Code and a Release Role can also be specified.
- Merge - specifies how the Material will be merged across the Experiment Definition. For more information, see the Experiment Management tutorial.
- Send Mail - sends an email notification making the Distribution List field mandatory. If the Notification license is enabled, you must specify whether to create a notification and fill in all required fields accordingly.
-
Set BOM - assigns a valid BOM and specifies the Assembly Type:
- If the Assembly Type is Automatic At Track-Out, you must provide the Track-In Check Mode and the Track-Out Losses Mode.
- If the Assembly Type is Weigh And Dispense, you must provide the Weigh And Dispense Mode.
-
Set Checklist - assigns a previously defined Checklist to the Material Group.
-
Set Data Collection - assigns a valid Data Collection and Data Collection Type (Immediate, Long Running, and Long Running After Track-In) and optionally, a Data Collection Limit Set of the same Data Collection.
Note
The Long Running Data Collection Type is only valid during the Track-In event.
-
Set Durables - assigns a valid BOM with the scope set to Durables.
- Set Measure All - specifies an event during which the action will be executed.
- Set Note - displays a user-defined note to be shown during processing.
- Set Recipe - assigns a valid Recipe (the Enabled and Executable properties must be set to
true). The parameters of the Recipe can be set directly in the Experiment Definition. - Set Resource - specifies which Resource will be used by the Material.
- Set Service - specifies which Service of processing type Process will be added to the Step.
- Skip Step - skips the current Step.
- Split - defines how the Material will be split across the Experiment Definition. For more information, see the Experiment Management tutorial.
- Temporary Off-Flow - provides a valid Off-Flow Reason for the Step (applicable to Off-Flow), and specifies the Go To Flow Path from which the Flow and Step are derived.
- Terminate - provides a valid Loss Reason for the Step where the action is defined and applicable to Terminate in that Step. Optionally, Terminate Loss Classifications can also be provided (either from a Lookup Table or as free text).
Note
Each type of action can only be defined once for the same event. Moreover, for any single event, only one of the following actions may be specified: Terminate, Change Flow And Step and Temporary Off Flow. For the Change Flow And Step action, in scenarios where the same Step is repeated within the Flow and the Material is in a Processed state, you may opt to enable Force Queued State. Otherwise, the Material will stay in the Processed state. Furthermore, it is possible to define the default value for the Force Queued State by editing the entry Context = Material.ChangeFlowAndStep for the Element = ForceQueuedState in the GUIElementDefaultValue Generic Table.
If more than one Step was added, the Manage wizard will be activated, thus allowing you to modify the sorting order of the Steps.
The table below presents a list of possible combinations between Actions and Events:
| Action | Requires Split | Queued | Track-In | Track-Out | Processed | Exit Step |  | Applicable on Temporary Off-Flow Return | Additional Information |
|---|---|---|---|---|---|---|---|---|---|
| Terminate | Physical Split or Full Lot | - | - | ExperimentDefinition. ActionTerminate | Must be the last action for the event. If set at Queued, no actions can be set at other events. It is not possible to have at the same Step and State - Create Send Ahead Run and Terminate. | ||||
| Hold | Physical Split or Full Lot | - | - | ExperimentDefinition. ActionHold | For the same event - must be the first action for the event or the second action if preceded by a Set Note, Send Mail, Set Resource, Set Service, Split or Merge. | ||||
| Change Flow And Step | Physical Split or Full Lot | - | - | ExperimentDefinition. ActionChangeFlowAndStep | Must be the last action for the event. If set at Queued, no actions can be set at other events. | ||||
| Skip Step | Physical Split or Full Lot | - | - | - | ExperimentDefinition. ActionSkipStep | Must be the only action for the Experiment Definition Step Material Group. | |||
| Temporary Off Flow | Physical Split or Full Lot | - | - | ExperimentDefinition. ActionTemporaryOffFlow | If set at Queued, the only other possible actions at this event are Hold, Set Note, Send Mail, Set Resource, Set Service, Split To, Split From, Merge To, and Merge From. | ||||
| Create Send-Ahead Run | Physical Split or Full Lot | - | - | - | ExperimentDefinition. ActionCreateSendAheadRun | No | It is not possible to have at the same Step and State - Create Send Ahead Run and Terminate. For the same event - must be the first action or must be preceded by a Send Mail, Send Note, Split, Merge or Hold. | ||
| Set Measure All | - | - | - | ExperimentDefinition. ActionSetMeasureAll | |||||
| Set BOM | Physical or Logical, if not Full Lot | - | - | - | ExperimentDefinition. ActionSetBOM | ||||
| Set Durables | Physical or Logical, if not Full Lot | - | - | - | ExperimentDefinition. ActionSetDurables | ||||
| Set Checklist | Physical or Logical, if not Full Lot | - | ExperimentDefinition. ActionSetChecklist | Long Running Checklists are only possible for the Track-In event. | |||||
| Set Data Collection | Physical or Logical, if not Full Lot | - | ExperimentDefinition. ActionSetDataCollection | Long Running and Long Running after Track-In is only possible for the Track-In event. | |||||
| Set Data Documents | Physical or Logical, if not Full Lot | - | ExperimentDefinition. ActionSetDocuments | ||||||
| Set Recipe | Physical or Logical, if not Full Lot | - | - | - | ExperimentDefinition. ActionSetRecipe | ||||
| Set Note | Physical or Logical, if not Full Lot | - | - | ExperimentDefinition. ActionSetNote | For the same event - must be the first action for the event or the second action if preceded by a Send Mail, Split or Merge. | ||||
| Set Resource | Physical or Logical, if not Full Lot | - | - | - | ExperimentDefinition. ActionSetResource | If defined, there must be no actions for the state Queued of the following type: - Terminate - Change Flow And Step - Skip Step | |||
| Set Service | Physical or Logical, if not Full Lot | - | - | - | ExperimentDefinition. ActionSetService | If defined, there must be no actions for the state Queued of the following type: - Terminate - Change Flow And Step - Skip Step | |||
| Send Mail | Physical or Logical, if not Full Lot | - | - | - | ExperimentDefinition. ActionSendMail | For the same event - must be the first action for the event or the second action if preceded by a Set Note, Split or Merge. | |||
| Execute Rule | Physical or Logical, if not Full Lot | - | - | ExperimentDefinition. ActionExecuteRule | If defined, it must be the last action for the event. | ||||
| Split | Physical or Logical, if not Full Lot | - | - | ExperimentDefinition. ActionSplit | If set at Queued, the event must: - be the first action for the Split To Material Group. - be the only action for the Split From Material Group at the Step. If any other action is required, you can specify the split as part of the action. If set at Processed: - the Split To Material Groups must not have other actions defined for the Queued, In Process or Processed states. The same Material Group can only be part of one action of type Split or Merge for the same state. If the Split Scope is set to For Current Step, there must not be any actions for Processed events. | ||||
| Merge | Physical or Logical, if not Full Lot | - | - | ExperimentDefinition. ActionMerge | If set, the event must be the first action for both the Merge To and Merge From Material Groups. No other actions for the Merged From Material Groups are possible at the same state (as the Material will be Terminated). The same Material Group can only be part of one action of type Split or Merge for the same state. |
Table: Experiment Management Actions restrictions
Depending on the action, additional information may need to be provided, as shown in the table below.
| Action | Action Details | Required Information |
|---|---|---|
| Terminate | It terminates the Material or Material Group. | - The Loss Reason for the Action Step |
| Hold | It puts the Material or Material Group on hold. | - The Hold Reason for the Action's Step - The Release Code (optional) - The Release Role (optional) |
| Change Flow And Step | It changes the Material or Material Group to a different Flow and/or Step. | - The Flow Path to where the material will be sent. In order to avoid circular executions, it is not possible to send the material to a previous point in the flow. |
| Create Send-Ahead Run | Creates a Send-Ahead Run at the defined Step. | - Specific definitions to allow the creation of a Send-Ahead Run, including the Sub-Materials to add as send-ahead Materials, the Send-Ahead Split Type that will be performed to the Material that will be kept in the Waiting state, the Selection Mode and the Steps and Flows to configure the Send-Ahead Run, as well as the Results Capture Mode. |
| Skip Step | Skips the current Step. | - No required information |
| Temporary Off Flow | It sends the Material or Material Group to a different Flow and/or Step temporarily. | - The Off-Flow Reason for the Action's Step - The Go To Flow Path |
| Set Measure All | Marks all the Materials in the Material Group to be measured (when In-Step Sampling is used for the Step). | - No required information |
| Set BOM | Overrides the BOM to be used for the Material or Material Group. | - The BOM of scope Materials - The Assembly Type - The Track-In Check Mode (for Assembly Type Automatic At Track-Out) - The Track-Out Losses Mode (for Assembly Type Automatic At Track-Out) - The Weigh And Dispense Mode (for Assembly Type Weigh And Dispense) |
| Set Durables | Overrides the Durables BOM to be used for the Material or Material Group. | - The BOM of scope Durables |
| Set Checklist | Overrides the Checklist to be used for the Material or Material Group. | - The Checklist of scope Material Tracking that can only be Long Running if the event is Track-In |
| Set Data Collection | Overrides the Data Collection to be used for the Material or Material Group. | - The Data Collection - The Data Collection Type that can only be Long Running or Long Running After Track-In if the event is Track-In - The Data Collection Limit Set (optional) |
| Set Recipe | Overrides the Recipe to be used for the Material or Material Group. | - The Recipe |
| Set Note | Sets the Note to be displayed to the User for the Material or Material Group. | - The note (rich text) to be displayed |
| Set Resource | Sets the Resource to be used to process the Material. | - The Resource (of processing type Line or Process) that is Top-Most and is Active, Non-Template and which provides any of the Step required Services. If the selected Resource is of DispatchScheduling type Dispatch, user can select to AutomaticDispatch to that Resource (defaults to false) |
| Set Service | Sets the Service to be used to process the Material in that Step. | - The Service must be of processing type Process (that is Active and Non-Template) |
| Send Mail | Sends an email notification. | - Distribution List field is mandatory. If Alarm Management is licensed, you must enable or not the Create Notification and complete the mandatory fields accordingly. |
| Merge | Specifies the way the Material will be merged across the Experiment Definition. | - See Experiment Management Actions restrictions table |
| Split | Specifies the way the Material will be split across the Experiment Definition. | - See Experiment Management Actions restrictions table |
| Execute Rule | Executes a Rule of scope Material Future Action. | - The Rule of scope Material Future Action |
Table: Action details
Warning
If Feature Level Security is enabled, then the Actions defined above are protected by a security feature. That protection means that if you don't have explicit access to the feature, you will not be able to use that Action in an Experiment. Additionally, there is the special security feature ExperimentDefinition.AllActions that provides access to all the available Actions. For more information, see Security.