Parms

The
PARMS
 execute obtains the parameters of a procedure.
The format and return for this execute includes:
Execute Format
A
FactoryTalk Batch
 Server supports an execute string with the PARMS keyword. The format of the execute string:
[PARMS(
Item,UserID,ProcedureID
)]
where:
Item
Item name as specified by the client.
UserID
User identification associated with this event.
ProcedureID
Unique path name to the procedure, starting with the CreateID and followed by the step name(s), all of which are tab delimited.
Action
A successful PARMS execute returns the parameter string into the item specified by the client.
Return Format
The PARMS execute s returns in this format:
<Parameter>
\t
<ResponseType>
\t
<EngUnits>
\t
<MaxValue>
\t
<MinValue>
\t
<Value>
\crlf
where:
Field Name
Format
Description
<Parameter>
ASCII - String
Parameter name required to create the batch.
<ResponseType>
ASCII - Integer
Data type for the response:
  • 1 = real
  • 2 = long
  • 3 = string
  • 5 = enumeration
<EngUnits>
ASCII - String
Engineering units for the parameter.
<MaxValue>
ASCII - String
High range for the parameter.
<MinValue>
ASCII - String
Low range for the parameter.
<Value>
ASCII - String
Current value of the parameter.
The following table shows an example of the return on this execute.
Example:
An execute string consisting of:
[PARMS(Item,UserID,41 \t CLS_SWEETCREAM_UP:1 \t CLS_SWEETCREAM_OP:1 \t TEMP_CTL:1)
Could place this data in Item for the client:
HOLD_TIME \t 1 \t MINUTES \t 60 \t 0 \t 5 \crlf
TEMP_SP \t 1 \t DEG \t C \t 100 \t 0 \t 71.1 \crlf
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal