Step
The
STEP
execute changes the active control step(s) within a control recipe.The format and return for this execute includes:
Execute Format | A FactoryTalk Batch Server supports an execute with this format:[STEP( Item,UserID,ProcedureID,DeactivateList,STEP,ActivateList )] | ||
where: | Item | Response item name as specified by the client. | |
UserID | User Identification entered into the event journal associated with this event. | ||
ProcedureID | Unique hierarchical path name to the procedure, unit procedure, or operation: <FullPath>
| ||
<Deactivate
List> | Step name list to be deactivated in the procedure: <DeactivateList> $INITSTEP and $TERMSTEP are recognized as the initial and terminal step names in a procedure and can deactivate the initial or terminal steps. | ||
STEP | Literal STEP is passed separating the step list to be deactivated from the list to be activated. | ||
<Activate
List> | List of step names to be activated in the procedure: <ActivateList> $INITSTEP and $TERMSTEP are recognized as the initial and terminal step names in a procedure and can activate the initial or terminal steps. | ||
where: | |||
<FullPath> | is | <CreateID> | <CreateID> /t <Path> | |
<Path> | is | <StepIdentifier> | <StepIdentifier> /t <Path> | |
<Deactivate List> | is | <NullList | <StepList> | |
<ActivateList> | is | <NullList> | <StepList> | |
< StepList> | is | <StepIdentifier> | <StepIdentifier> , <StepList> | |
Field | Format | Description | |
<CreateID> | ASCII - Integer | Unique batch ID assigned by the FactoryTalk Batch Server. | |
<StepIdentifier> | ASCII – String | Step identifier (for example, Mix:1) | |
Action | A successful STEP execute changes the active steps within a control recipe. | ||
Return Format | The item populates with this data: SUCCESS: | SUCCESS: <ActionID> | FAIL: <message> | ||
where: | |||
Field | Format | Description | |
<ActionID> | ASCII – Integer | Action identifier associated with signature(s) generated as a result of the potential parameter value change. The parameter value will not actually change unless all signatures are successfully signed. | |
<message> | ASCII - String | Error message appropriately formatted for operator display. | |
The following table shows an example of the return on this execute.
Example: | An execute string consisting of: [STEP(Item,STATION5/Operator,9 \t FRENCH_VANILLAPREMIUM1_MEGA_PARLOR_OPT_1_O1:1,TEMP_CTL:2,RECIRC:1,STEP,MBR_DUMP:1)] or STEP(Item,Station2/View, 17\tMakePreMix:1\tChargeDryMats:1, DoseDust:1, STEP, DoseSand:1) Could return: SUCCESS:997 |
Provide Feedback