Command syntax guidelines

Use the following general syntax guidelines when using the
FactoryTalk View
 commands:
  • Commands and parameters are not case sensitive.
  • Parameters do not have to be entered in the order they are listed in the command definition.
  • Start each new command on a new line or separate commands on the same line with a semicolon (;).
  • Separate multiple parameters with a space.
  • Separate multiple tag references with a comma and no spaces.
  • If an exclamation mark (!) occurs at the beginning of a command sequence, (either at the beginning of a line or after a semicolon), the command sequence is treated as a comment. The next carriage return or semicolon (;) ends the comment.
  • If an exclamation mark occurs anywhere but at the beginning of a command sequence, it is processed as a valid part of the command.
  • Enclose long file names that have spaces with double quotes when the file names are used as parameters. For example,
    Display PID_LOOP /P"Aerator Oxygen"
  • Enclose area and component names that contain spaces, or are ambiguous, in double quotes. An ambiguous area name is one that is the same as another parameter for a command.
You also need to following some other syntax, including:
  • To specify an area, precede the area name with a forward slash.
  • Use a tag placeholder to replace a tag reference with its current value when the command is evaluated. To create a tag placeholder, enclose the tag reference in dollar signs ($), for example,
    $tag1$
    .
    • Enclosing tag reference containing dollar sign ($) in two dollar signs, for example $Tag$Name$, is not supported.
    • If the tag placeholder is enclosed within double quotes, or nested in the string value of another tag placeholder,
      FactoryTalk View SE
       does not substitute the tag value.
  • If a component such as a graphic display, contains an even number of $ characters in its name, but these are not being used to enclose a tag placeholder, the entire component name must be enclosed with double quotes.
  • The maximum number of characters for floating point tag values is 17. If the value is longer than 17 digits, it is represented in scientific format.
  • The maximum command length is 5000 characters. The command will be truncated if substituted tag values cause the command to exceed this length.
  • If a command accepts wildcard characters, this is indicated as part of the definition of the command. The wildcard characters are:
    • *
       - matches any number of characters, including the backslash (\) and period (.) characters
    • ?
       - matches any single character
  • Wildcard characters cannot be used within area/server names. For example, Acknowledge /Area* is not valid, but Acknowledge /Area1::* is valid, where the wildcard character is used to specify all, or part of a tag reference.
  • Do not use command names to name components:
    • to name a component Display 5, for example, omit the space and use Display5, to avoid problems when issuing commands.
    • if a component is named Display 5, to close it using the Abort command, for example, you have to enclose the name with double quotation marks: Abort "Display 5".
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal