Execute reference

An
Execute
commands the
FactoryTalk Batch
Server to perform some action.
TIP:
Use the List Separator and number format for language. Examples used are for English:
List Separator: ,
Number Format: 1,234.56
For Spanish, use a semicolon ( ; ) instead of a comma for the List Separator.
The formatting methods used for each Execute:
Title
Description
Execute Format
Describes the input format of the Execute statement.
IMPORTANT: Do NOT use spaces, unless specifically directed to do so.
Use this format:
svrobject
.
Execute strExecute
.
For Example:
svrobject
.
ACK(Item,STATION5/Operator,1,5)
Action
Describes what action is a result of the Execute.
Return Format
Describes that data and its format returned by the Execute. All data returns in CFTEXT format, representing either strings or integers.
A list of the key characters and what they symbolize follows:
<TEXT>
is
Denotes a variable.
<
TEXT
>
is
Denotes a variable which will be expanded.
TEXT
is
Any text that is not enclosed in the < > characters is a keyword and appears as the literal string.
<NullString>
is
Denotes an empty string, CString.Empty( ), unless otherwise specified.
\t
is
Denotes a Tab character (ASCII - 9), used as a field delimiter. A space before and after the \t is included for readability.
Do NOT include the spaces when formatting the command line.
|
is
Used to denote an OR situation. Either the text on left of the bar, or the text to the right of the bar used as the output.
\crlf
is
Denotes a carriage return/line feed character which are used as a record delimiter.
<sp>
is
Denotes a space character (ASCII – 32).
Item
is
The name of the item, as specified by the client. The
FactoryTalk Batch
Server creates the item. The value stored in the item on the server. The client must Advise on this item and wait for an update. Follow the naming rules listed here:
  • Clients should use response item names that are generated to be unique to the client (prepending of node names is common).
  • Clients should ensure that they never have 2 or more outstanding EXECUTE instructions with the same response item name.
  • Clients should use a fixed set of response item names instead of generating a unique name for each EXECUTE. Because the
    FactoryTalk Batch
    Server allocates resources to manage each response item, using a limited set will limit the number of resources required by the server. Conversely, generating a unique name for each response item will eventually use all available resources on the server.
UserID
is
User identification that will be entered into the event journal associated with this event. For example:
Machine Name/UserID
.
Example:
Defines an example for the EXECUTE statement in this format:
Return Format
Execute String
TIP:
Even though
Item
is used in examples, follow the naming rules.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal