Process command syntax


This topic describes syntax considerations for process commands.

Because Application commands always run on the server, use the following syntax when executing an Application command from an active link:

  • To run the command on the current server:

    @@:<processCommand>
    [<parameters>]
  • To run the command on a different AR System server:

    @<serverName:processCommmand> [<parameters>]

    To run the process from a Set Fields action with the $PROCESS$ keyword, enter $PROCESS$ before the command. This indicates that whatever follows is the process command. For example:

    $PROCESS$ @@:<processCommand>
    [<parameters>]

For PERFORM-ACTION commands and other workflow commands, simply enter the command and its arguments. (Do not use server parameters — @@: or @serverName: or $PROCESS$ @@:) The workflow engine determines whether the command runs on the client or on the current server.  You cannot use @@ or @serverName: to run PERFORM-ACTION on the server. An error might occur when you use PERFORM-ACTION commands with server parameters.

Case sensitivity and using quotation marks

Run Process and $PROCESS$ commands are case-sensitive. If incorrect capitalization is used, an error can occur.

When you define a run process command, you must use quotation marks in some cases to indicate that the content inside the quotation marks makes up a single parameter:

  • If a parameter includes a space or a special character, put quotation marks around the parameter.
  • Surround any keywords with quotation marks in case the substituted value contains spaces or special characters.
  • If a value contains one or more quotation marks, double the quotation marks and put quotation marks around the entire parameter.

The following table lists examples of these guidelines.

Value

Syntax

AR System

"AR System"

AR "System" User

"AR ""System"" User"

$SCHEMA$

"$SCHEMA$"

The Run Process action deletes the entries that match qualification, '101' = "AR ""System"" User" where the actual value in the field 101 is AR "System" User.

The Set Fields action sets the value of Full Name field to the actual value AR "System" User.

case_sensitivity_example.png

Syntax exception-Application commands with qualifications

Any arguments before the final argument follow the rules described in the previous section. 

These rules do not apply for the final argument of Application commands where the final argument is a qualification or a substitution string. Commands that take this format include the following commands:

  • Application-Parse-xxx
  • Application-Format-xxx
  • Application-Query-Delete-Entry

Example of Application-Query-Delete-Entry

If you creates a workflow to delete entries on the same form based on qualification; where the Street Name field is a character field and the Zip Code field is an integer field:

Application-Query-Delete-Entry "$SCHEMA$" 'Street Name'="$Street Name$" AND 'Zip Code' = $Zip Code$

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*