Process commands
When you create a Run Process action or a Set Fields action with $PROCESS$, BMC Remedy Developer Studio enables you to select any of the commands described in this section. You must understand how each command operates to determine whether it is appropriate to use in your workflow.
The Application commands table and the PERFORM-ACTION and related workflow commands table include the following information along with the syntax and description for each command.
Column | 'Y' indicates |
|---|---|
Active Links | Use the command only with active links. |
Filter or Escalations | Use the command only with filters and escalations. |
Returns a value | The command returns a value. To capture the returned value, you must use the command in a Set Fields action with the |
The following table describes Application commands, which are always executed on the server. If you use one of these commands in an active link, you must use the @@: processCommand or @ serverName: processCommand or syntax.
Application commands
Tip
Press F to view the table in full screen mode. Press Esc to exit full screen mode.
| Active Links | Filter or Escalations | Returns a value | Command | Description and example |
|---|---|---|---|---|
| Returns a new time that is the requested offset into the future, taking availability and business hours and holidays into account. Offset is a value of 0 or greater than 0. The default is 1 hour. Offset unit values are:
For more information, see Defining business schedules using Business Time. For example:
| |||
| Y |
| Returns an integer that represents the number of seconds between the start and stop time, taking business hours into account. For more information, see Defining business schedules using Business Time. For example:
| ||
| Y |
| Returns a new time that is the requested offset into the past, taking business hours into account. Offset is a value of 0 or greater than 0. The default is 1 hour. Offset unit values are:
For more information, see Defining business schedules using Business Time. For example:
| ||
| Y |
| Performs a business time calculation by starting with the start time and resulting in a new time that adds the requested offset. The command returns a timestamp representing the time calculated. Use this command to recalculate time into the future. For more information, see Defining business schedules using Business Time. For example:
| ||
| Y |
| This command contains EntityID parameters, so you do not need to query the Business Segment-Entity Association form. For more information, see Defining business schedules using Business Time. For example:
| ||
| Y |
| This command contains EntityID parameters, so you do not need to query the Business Segment-Entity Association form. For more information, see Defining business schedules using Business Time. For example:
| ||
| Y |
| This command contains EntityID parameters, so you do not need to query the Business Segment-Entity Association form. For more information, see Defining business schedules using Business Time. For example:
| ||
| Y |
| This command contains EntityID parameters, so you do not need to query the Business Segment-Entity Association form. For more information, see Defining business schedules using Business Time. For example:
| ||
| Y |
| This command contains EntityID parameters, so you do not need to query the Business Segment-Entity Association form. For more information, see Defining business schedules using Business Time. For example:
| ||
| Y |
| Performs a business time calculation by computing the difference between the start time and the end time. The return is an integer representing the difference in seconds. Use this command to compare two different times (start time and end time) to get the actual business time. For more information, see Defining business schedules using Business Time. For example:
| ||
| Y |
| Returns the start of the next available or unavailable free time segment at the same level or a higher level that is duration seconds long. For more information, see Defining business schedules using Business Time. For example:
| ||
| Y |
| Returns the start of the next available or unavailable time segment that is duration seconds long. If duration is 0 (the default), the command returns either the start of available time segment or the start of the unavailable time segment. For more information, see Defining business schedules using Business Time. For example:
| ||
| Y |
| Performs a business time calculation by starting with the start time and resulting in a new time that subtracts the requested offset. The command returns a timestamp representing the time calculated. Use this command to recalculate time in the past. For more information, see Defining business schedules using Business Time. For example:
| ||
| Y | Y |
| Verifies that the current user is a member of the specified group. Returns one of the following integers:
This command is not context sensitive for a given entry. Validation of group IDs For example, to find whether the user is a member of Administrator group, enter:
| |
| Y | Y | Application-Confirm-Password password | Validates if the password is the password for the current user. For password, you can use a reference to the field that contains the password, such as field 102 or field 103. This command returns one of the following integers:
If you used BMC Remedy AR System version prior to 6.0 to create workflow involving a Password field (ID 102), the workflow might not function in BMC Remedy AR System versions 6.0 and later. Version 6.0 included enhanced encryption and tighter security controls. To workaround this issue, use the For example:
| |
| Y | Y |
| Copies a field on the current form to another field on the current form. Returns one of the following integers:
To get the return value, use this command in a Set Fields action with For example:
| |
| Y | Y | Y |
| Deletes the specified entry. For example:
Where Note: To delete an entry from a different form, provide the name of the form within quotes:
|
| Y | Application-Event eventNumber eventDetail | Initiates a server event. These valid values for eventNumber cause the BMC Remedy AR System server to perform the following actions:
For more information about server events, see Capturing server events for workflow or API calls. For example:
| ||
| Y | Y | Application-Format-Qual "form" internalQualifier | Converts an internal representation of a qualifier into a qualification string. See Syntax exception-Application commands with qualifications. For example:
| |
| Y | Y | Application-Format-Qual-Filter " form" internalQualifier | Converts an internal representation of a qualifier from a filter Run If into a qualification string. See Syntax exception-Application commands with qualifications. For example:
| |
| Y | Y | Application-Format-Qual-ID "form" internalQualifier | Converts an internal representation of a qualifier into a qualification string using ID format. See Syntax exception-Application commands with qualifications. For example:
| |
| Y | Y | Application-Format-Qual-L "form" "VUILabel" internalQualifier | For the indicated VUI, converts an internal representation of a qualifier into a qualification string using labels. See Syntax exception-Application commands with qualifications. For example:
| |
| Y | Y | Application-Format-Qual-SField "form1" "form2" internalQualifier | Converts an internal representation of a qualifier from a Set Fields or Push Fields filter action into a qualification string. See Syntax exception-Application commands with qualifications. For example:
| |
| Y | Y | Application-Format-Val-SField "form1" fieldID" form2" internalAssignment | Converts an internal representation of a Set Fields or Push Fields assignment into an assignment statement. See Syntax exception-Application commands with qualifications. For example:
| |
| Y | | Initiates a full text reindex on the specified form.
Note: The standard format is a character string date, but the server also accepts a numeric timestamp (EPOC time) value.
Examples: Reindexing a single form:
Reindexing all FTS enabled forms:
| |
| Y | Application-Generate-GUID [" GUIDPrefix" ] | Generates a globally unique identifier (GUID). The prefix can be a maximum of two characters, which can contain non-alpha characters (although alpha characters are recommended). If you do not include the GUID prefix, it defaults to For example:
| ||
| Y | Y | Application-Get-Approval-Join "form" | Retrieves the name of the join form between the application and the AP:Detail form. This command is used for the Approval Server. For example:
In the result, the form names are separated by spaces as follows:
| |
| Y | Y |
| Retrieves the name of the join form between the three-way join form (join between the application form and AP:Detail-Signature) and the names of the AP:Detail-Signature form, AP:Detail form, and AP:Signature form. This command is used for the Approval Server. For example:
In the result, the form names are separated by spaces as follows:
| |
| Y | Y |
| Retrieves the name of the join form between the three-way join form (join between the application form and AP:Detail-Signature) and the names of the AP:Detail-Signature form, AP:Detail form, and AP:Signature form. This command is used for the Approval Server. For example:
In the result, the form names are separated by new lines as follows:
| |
| Y | Y |
| Retrieves the appropriate form alias for the specified form and VUI. If you do not include a VUI, the default VUI is used. For example:
| |
| Y | Y |
| Retrieves the form name for the specified form alias and VUI. If you do not include a VUI, the default VUI is used. For example:
| |
| Y | Y |
| Retrieves the number of licenses of the specified type. Use the license name that is used in the License Tool. For example:
| |
| Y | Y |
| Retrieves the VUI ID for the locale that you specify. The VUI types are Windows ( Apart from setting the locale, you must also set the When this property is set to true then only the AR System server returns this VUI ID, provided the locale and VUI type matches. For example:
| |
| Y |
| Returns a timestamp representing the recurrence time. For more information, see Operators. For example:
| ||
| Writes an invalid string for the password value to disable the current user's account. The For example:
| |||
| Y | Y |
| Maps the IDs of the fields or keywords in the string to a name representation. For example:
| |
| Y | Y |
| For the indicated VUI, maps the IDs of the fields or keywords in the string to a name representation using labels. If the field label is blank, the database name is used. For example:
| |
| Y | Y |
| Maps the names of the fields or keywords in the string to an internal ID representation. For example:
| |
| Y | Y |
| For the indicated VUI, maps the labels of the fields or keywords in the string to an internal ID representation. An empty string for the VUI denotes the default VUI for the form. For example:
| |
| Y | Y |
| Converts a qualification string into an internal representation. For example, to parse the qualification string into its internal representation, enter:
The qualification string does not need double quotation marks around it because all data after the form name is treated as the qualification string. | |
| Y | Y |
| Converts a Run If filter qualification string into an internal representation. See Syntax exception-Application commands with qualifications. For example:
| |
| Y | Y | Application-Parse-Qual-L " form"" VUILabel" qualificationString | For the indicated VUI, converts a qualification string with labels into an internal representation. The result of this command is used in the For example:
| |
| Y | Y | Application-Parse-Qual-SField " form1"" form2" qualificationString | Converts a Set Fields or Push Fields filter qualification string into an internal representation. See Syntax exception-Application commands with qualifications. For example:
| |
| Y | Y |
| For the indicated VUI, converts a Set Fields or Push Fields filter qualification string into an internal representation. See Syntax exception-Application commands with qualifications. For example:
| |
| Y | Y |
| Converts a Set Fields or Push Fields filter assignment statement into an internal representation. The result of this command is used in the For example:
Note: When you define service targets, do not use parenthesis ( ) in the title. | |
| Y | Y |
| Deletes all entries matching the specified qualification. See Syntax exception-Application commands with qualifications. For example:
| |
| Y | Application-Release-Pending | Causes database operations generated by the current workflow to be sent to the database immediately. In a filter, this command changes the usual filter phasing and causes the Run Process action to run in phase 1. Note: Use this advanced feature with caution. The command allows workflow to see the results of previous workflow by causing the previous workflow's actions to be entered into the database. See Releasing pending operations for a detailed explanation. For example: | ||
| Y | Application-Set-Filter-Phasing "value" | Determines whether form entries are created when the workflow operation to create them occurs or whether they are created in bulk during a later filter phase. When issued, this command affects all subsequent entry create operations for the current API call. Entries already created as a result of the call are not undone. The effect of the command lasts for the duration of the API call or until the command is reissued with a different value. value can be
Note: If the create phase is delayed, the entries are not immediately added to the database, so their data is unavailable to subsequent workflow actions. This can change the effect of filters that use the data in qualifications or as a source for Set Fields actions. This command does not affect filters whose names end with For example:
| ||
|
The following table describes PERFORM-ACTION and other workflow commands, which are executed by the workflow engine and can run on the client or the server as appropriate.
PERFORM-ACTION and other workflow commands
Tip
Press F to view the table in full screen mode. Press Esc to exit full screen mode.
| Active Links | Filters or Escalations | Returns a value | Command | Description and example |
|---|---|---|---|---|
| Y | GET-CHANGE-FLAG | Gets the change flag status of the current window. For example:
| ||
| Y | ENABLE-WAIT-CURSOR-ON-LONG-RUNNING-PROCESS | Enables BMC Remedy AR System applications to explicitly enable and disable the wait cursor for a particular execution stack. This run process action only affects the workflow actions that support wait cursor. The wait cursor is automatically disabled at the end of the current execution stack. This run process action needs to be called for each execution stack. For example, clicking a button causes Table A to refresh and the first row to be selected and selecting a row of Table A causes Table B to refresh. If the wait cursor is required for both these refreshes, then it needs to be called twice, once for each execution stack. This is a global setting for every execution stack and not for every form. Possible values are:
For example, to enable the cursor: | ||
| Y | PERFORM-ACTION-ACTIVE-LINK | Executes all active links associated with the specified Execute On condition (and field ID, as needed). The active links fire as if the Execute On condition indicated occurred. For example,
| ||
| Y | Y | Y | PERFORM-ACTION-ADD-ATTACHMENT fieldID [" fileName"] | Adds an attachment to an attachment field, and returns a value of 0 (Successful). If the attachment is not added, the command returns one of the following codes:
For filters and escalations, the field ID must be an attachment field, and the file name is required. For active links:
For example:
|
| Y | PERFORM-ACTION-APPLY | If the form is open in Search mode, performs the Search operation (clicks the Search button). In Modify or New mode, performs the Apply or Save operation. Note: The only difference between the For example:
| ||
| Y |
| Changes the mode of the form. This command takes mode as a parameter and then changes the mode. The allowable values for mode are For example:
| ||
| Y | PERFORM-ACTION-CLEAR-PROMPTBAR | Clears the prompt bar of all messages. This command is useful to run before custom validation occurs (through PERFORM-ACTION-VALIDATE_NULL-REQUIRED-FIELDS) if the prompt bar will not be cleared automatically.For example:
| ||
| Y |
| Deletes an attachment from an attachment field, and returns a value of 0 (Successful). If the attachment is not deleted, the command returns one of the following codes:
Note: If you use this command in a filter with a Run Process action instead of in a Set Fields action, you must use the filter phase override naming convention filterName`!. This causes the action to run in filter phase 1 so that the changes are committed to the database. See Using a special override naming convention. For example, it is used in the Run Process as follows:
| ||
| Y | PERFORM-ACTION-EXIT-APP | Exits the Windows client or logs out of the web client. For example:
| ||
| Y | PERFORM-ACTION-GET-ENTRY "entryID" | Retrieves the entry based on the entry ID. This command is applicable only for the Display and Modify modes. For information about the related features, see Ability to modify data on display forms. For example:
| ||
| Y | Y | PERFORM-ACTION-GET-FIELD-LABEL fieldID | Returns a field label. Use this command in a Set Fields action with For example, it is used in Set Fields action:
where | |
| Y | Y | PERFORM-ACTION-GET-PREFERENCE fieldID |
Gets the value of the field you specify from the User Preference form. For example, to get the value of the User Locale field, enter the following command:
| |
| Y | PERFORM-ACTION-GO-HOME | Opens the form configured as your home page. For example:
| ||
| Y | PERFORM-ACTION-SHOW-TOOLBAR [Value] | Shows or hides the toolbar on a form. If the value to set to For example:
or
| ||
| Y | PERFORM-ACTION-HOME-FIELD-REFRESH | Refreshes the Application List field on the home page form. Typically, you use this command to display a subset of entry points based on the values that are dynamically entered into the reserved character field ID 1576. For example:
| ||
| Y | Y |
| Adds the value to the end of the list maintained by a character field. For example, if character field
| |
| Y | Y | Y |
| Returns a list of group names instead of group IDs. A group list field now always returns a list of group IDs and not group names. For example:
Note: This command is only available on BMC Remedy AR System server 7.6.04 or later servers. To use a group list with a LIKE statement, which requires a text string, first use this command to convert the group IDs to group names. For example, to use a statement such as |
| Y |
| Adds or updates the value in a list or map maintained by a character field. For example, if character field
| ||
| Y |
| Set focus to the specified navigation bar item. For example:
| ||
| Y | PERFORM-ACTION-NAV-FIELD-SET-SELECTED-ITEM FieldID state | To expand or collapse items of the navigation bar field. For more information, see Expanding and collapsing items in the navigation bar. For example, to expand all the items in the navigation bar field, execute the following command by providing the vertical navigation bar field ID.
| ||
| Y | PERFORM-ACTION-NEXT | Moves to the next request in the Results pane and displays the details in the Details pane. For example:
| ||
| Y | Y |
| Opens an attachment from an attachment field, and returns a value of
For example, to use in Run Process or Set Fields action, enter:
| |
| Y |
| Opens the specified URL in a browser. For the Windows client, a browser is opened. The URL is opened in a browser as follows:
Note: Verify that the URL is complete and well-formed so that the browser handles it correctly. For example, to open a web page, be sure the URL begins with http:// (http://*). The mid tier always requires a complete and well-formed URL. For example:
or
| ||
| Y | PERFORM-ACTION-PREV | Moves to the previous request in the Results pane and displays the details in the Details pane. For example:
| ||
| Y | N | NA | PERFORM-ACTION-REFRESH-PREFERENCE | Refreshes the user preferences. The flag options are as follows:
|
| Y | PERFORM-ACTION-SAVE-ATTACHMENT fieldID [" fileName" ] |
Saves an attachment from an attachment field to a file, and returns a value of
For filters and escalations, the file is saved on the server where filters and escalations are running. The field ID must be an attachment field, and the file name is required. For active links:
Note: If you use this command in a filter with a Run Process action instead of in a Set Fields action, you must use the filter phase override naming convention For example:
| ||
| Y | PERFORM-ACTION-SEND-EVENT "target" "eventType" "eventData" "FdataVisualizationModuleFieldID" | Sends an event to another window. target is the window to which to send the event. Possible values are:
For more information, see Ability to highlight required fields through workflow and Ability to highlight required fields through workflow. For example:
| ||
| Y | PERFORM-ACTION-SET-PREFERENCE fieldID "value" | Sets the value of the field you specify for the current session only. The preference is not set in the database. For example, to set the value of the User Locale field to Japanese, enter the following command:
This is the format or value you specify for the | ||
| Y | PERFORM-ACTION-SET-QUERY-WIDGET fieldid guid AREncodedQual | Initializes a view field as a query builder widget. Can be used with $PROCESS$ in the Set Field action.This command takes the following arguments:
Returns one of the following integers:
Workflow logging will be added to the run process to help the application developer debug while developing query widget usage in the application. Note: While this command can be used to initialize a query builder widget, it can also be used to reinitialize the query builder widget to another state. If you want to clear out the constructed query, send the same guid and send | ||
| Y | PERFORM-ACTION-TABLE-ADD-ROW tableFieldID rowIndex | Inserts an empty table row at the specified position on-screen. ("Row" refers to a row in list view tables, a node in tree view tables, and a cell in cell-based tables). This command does not commit the new row to the database. To add data to the empty row, you must use the appropriate active link. This command takes the following arguments:
| ||
| Y | PERFORM-ACTION-TABLE-CHANGE-ROW-COL-VISIBILITY tableFieldID [0 | 1] columnFieldID | Hides ( For example:
| ||
| Y |
| Clears the contents of the table field. For list view table fields, tree view table fields, and alert list fields, returns the table to its initial state. For results list fields, fires workflow and then resets the mode to Query. This is equivalent to pressing the New Search form action button. For example:
| ||
| Y |
| Clears the Note: This command was removed from BMC Remedy AR System server 7.6.03 and later releases. In those releases, use the PERFORM-ACTION-TABLE-SET-ROWSTATE|process commands#row_state command instead. | ||
| Y |
| On-screen, removes a row from view. In the database, sets the row's state to Deleted. This command does not remove the row from the database. Therefore, table loop guides can still step through the row. ("Row" refers to a row in list view tables, a node in tree view tables, and a cell in cell-based tables.) This command takes the following arguments:
For example, the command can be used in run process action as follows:
Here, | ||
| Y |
| Deselects all entries in a table field. This command is valid for all types of table fields. For example, the command can be used in run process action as follows:
| ||
| Y |
| Returns one of the following values:
For a content clipped table, the Min (administrator-defined chunk size; the number of cells which can be displayed in the available space). To determine the actual number of visible cells, use the VisibleRows function. See Cell-based tables. For example:
| ||
| Y | Y |
| Returns one of the following values:
For example:
| |
| Y | Y |
| Returns the field ID or level of the selected node, which starts at
For example:
| |
| Y | Y |
| Returns For example:
| |
| Y |
| Displays the next chunk of data in a table. If the action is for a results list, use reserved field ID For example:
| ||
| Y |
| Displays the next chunk of data in a table. If the action is for a results list, use reserved field ID For example:
| ||
| Y |
| Refreshes a table. You can optionally specify a start row and a maximum number of rows to retrieve. If the action is for a results list, use reserved field ID 1020. This command is valid for all types of table fields. For example:
| ||
| Y |
| Runs a report on the selected rows in a table. If no rows are selected, the report is on the entire table. This command is ignored for tree view table fields. For example:
| ||
| Y |
| Selects the specified node in a tree view table. The arguments for this command are:
For example, the following command selects a node whose tree field ID is | ||
| Y |
| Selects all the entries in a table field. This command is valid for all types of table fields. For a tree view table field, the command selects the root label, which represents all data. If there is no root label, the command selects nothing. For example:
| ||
| Y |
| Sets the state of the row at the specified position. ("Row" refers to a row in list view tables, a node in tree view tables, and a cell in cell-based tables.) This command takes the following arguments:
For example:
| ||
| Y |
| Validates missing values or the
Note: If a field listed in the command is a default field and the value was not changed, the field's value is not validated. If that default field is changed and empty, then the field's value is validated. The validation is performed on the browser (client) before passing the value to the server. In the following example, the server validates two fields (8 and 536870913), and the message appears in the prompt bar.
| ||
| Y | Y | SECURITY-FILTER <fieldName> | This command is used to encode HTML data to prevent erroneous content from executing. This command handles security-related issues before a string input from a user is used in any HTML element and displayed back to the user. You can use a Set Fields action to call the process and use any string field value as the input parameter, and then get the result back. For example, to set a view field value as the result:
| |
| Y | SET-CHANGE-FLAG [ 0 | 1 ] | Sets the change flag status of the current window to on (1) or off (0).For example:
or
Note: When you do not set a parameter, the change flag status of the current window is set to off. | ||
Y |
| Sets the background color of read-only fields according to red, green, blue (RGB) color coding. For example, to set the blue background color:
| ||
| N | Y | Y |
| This command encodes the URL input based on the UTF 8 standards. When this command is invoked, the AR System server takes care of the special characters in the URL. For example, when you give the following input:
|
In this section:
Comments
Log in or register to comment.