--- alias: experiment-actions hide: - toc description: "This documentation details available actions within an experiment workflow for material management" --- # 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 [[user-guide-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 [[tutorials-experimentmanagement]] 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. * If the Assembly Type is Mixed, provide the Track-In Check Mode. !!! note If the provided BOM has Use Mixed Assembly set to `true`, the Assembly Type must be Mixed. * **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 Process** - skips the processing of a Queued **Material** at a skippable **Step**, marking it as Processed within the same **Step**. * **Skip Step** - skips the current **Step**, which must be skippable. !!! info The difference between the Skip Process and Skip Step experiment actions is that, in Skip Process, the Material automatically changes from Queued to Processed within the same Step, whereas the Skip Step bypasses the Step entirely. * **Split** - defines how the **Material** will be split across the **Experiment Definition**. Splits that may involve multiple **Materials** will be handled as a single Split. For more information, see the [[tutorials-experimentmanagement]] 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-gt]] 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. For a detailed a list of possible combinations between **Experiment Actions** and **Events**, see [[experiment-actions-restrictions]]. Depending on the action, additional information may need to be provided. For more information, see [[experiment-actions-restrictions#experiment-actions-required-information|Required Information for Experiment Actions]].