Parms2

The
PARMS2
execute obtains the procedure’s parameters.
The format and return for this execute includes:
Execute Format
A
FactoryTalk Batch
Server supports an execute string with the PARMS keyword. The execute string’s format:
[PARMS2(
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 PARMS2 execute returns the parameter string into the item specified by the client.
Return Format
The PARMS2 execute returns in this format:
<Parameter>
\t
<ResponseType>
\t
<EngUnits>
\t
<MaxValue>
\t
<MinValue>
\t
<Value>
\t
<HighHighHighLimit>
\t
<HighHighLimit>
\t
<HighLimit>
\t
<LowLimit>
\t
\<LowLowLimit>
\t
<LowLowLowLimit>
\crlf
where:
Field Name
Format
Description
<Parameter>
ASCII - String
Name of the parameter.
<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.
<HighHighHighLimit>
ASCII - Integer
High-High-High limit.
<HighHighLimit>
ASCII - Integer
High-High limit.
<HighLimit>
ASCII - Integer
High limit.
<LowLimit>
ASCII - Integer
Low limit.
<LowLowLimit>
ASCII - Integer
Low-Low limit.
<LowLowLowLimit>
ASCII - Integer
Low-Low-Low limit.
The following table shows an example of the return on this execute.
Example:
An execute string consisting of:
[PARMS2(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 \t90 \t83 \t78 \t65 \t45 \t35 \crlf.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal