SetParm

The
SETPARM
 execute sets the parameter value(s) of a control recipe step. The
SETPARM
 execute does not change the MATERIAL formula parameter or the MATERIAL_CLASS formula parameter on all material phases. The MATERIAL formula parameter determines how a phase is bound and material availability for binding; because of this the value must not change during recipe execution. If storing the parameter results in deviation limits being violated that require signature confirmations, then an action ID returns identifying the signatures generated as a result of the
SETPARM
 execute.
The format and return for this execute includes:
Execute Format
A
FactoryTalk Batch
 Server supports an execute with this format:
[SETPARM(
Item,UserID,ProcedureID,ParamName,Value
)]
where:
Item
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, operation or phase:
  • Procedure: CreateID
  • Unit Procedure: CreateID \t UnitProcIDName
  • Operation: CreateID \t UnitProcIDName \t OperIDName
  • Phase: CreateID \t UnitProcIDName \t OperIDName \t PhaseIDName
ParamName
Parameter name requiring a value assignment.
Value
Value to be loaded in the step’s parameter.
where:
<FullPath>
is
<CreateID>
|
<CreateID>
/t
<Path>
<Path>
is
<StepIdentifier>
|
<StepIdentifier>
/t
<Path>
where:
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 SETPARM execute either changes the parameter value in the specified step or queue the value change and return an action ID. As a result of deviations triggered by the potential SETPARM, the signature requests generated can be detected.
Return Format
The item populates with this data:
SUCCESS: | SUCCESS:
<ActionID>
| FAIL:
<message>
| FAILED
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 does 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:
SETPARM(Item, Station2/View, 37/tMakeStuff1:1/tFill1:1/tDose1:1, Amount, 3.14159)
Could return:
SUCCESS:997
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal