This documentation supports the 9.0 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

Keywords

The following table lists the keywords that you can use when building a qualification.

Keywords

KeywordValue
$ALT_KEY$To verify if the Alt key is pressed. The value is set to 1 when the Alt key is pressed while starting the workflow from a control field, a double-click or return on a table field. Any other value represents that the Alt key is not pressed.
$APPLICATION$The name (not label) of the currently running application. On the web client, this keyword is set to NULL when the form is opened from a URL that does not include the application's name. This keyword is NULL on the server.
$BROWSER$The browser (Internet Explorer or other) being used in the current session. If the browser is anything other than Internet Explorer, Netscape is returned. This keyword is NULL on the server.
$CLIENT_TYPE$The client type of the API program. When used in workflow, this keyword resolves to a number that corresponds to BMC Remedy Developer Studio, DSO, and so on. The number representations of the different client types are in the ar.h file, which is located in ARServerInstallDir\ARServer\api\include. For example, if you use $CLIENT_TYPE$ in a Run If qualification for an active link, you can cause the active link to execute only for a mid tier client (for example, $CLIENT_TYPE$ = 9 ). For more information on client type of the API program, see List of Client Type ID.
$CTRL_KEY$To verify if the Ctrl key is pressed. The value is set to 1 when the Ctrl key is pressed while starting the workflow from a control field, a double-click or return on a table field. Any other value represents that the Ctrl key is not pressed.
$CURRENTWINID$Window ID that uniquely identifies the current window in the client environment. This is the same ID used to send events to this window. The format and length of window IDs are not constrained. The value returned from $CURRENTWINID$ should be saved into a display-only character field with a database length of zero (unlimited length).$CURRENTWINID$ is not the window with focus, but the window ID of the window in which the active link is running. This keyword is NULL on the server.
$DATABASE$The type of database used on the current server. This keyword is especially useful for workflow that is dependent on the database environment.
$DATE$

For date/time fields, this keyword evaluates to the current date, and the time defaults to midnight. Anything stored in a date/time field is stored as the number of seconds since UNIX epoch time, which includes the date and time.

Note: When using $DATE$ in a search on a Date/Time field, you can add or subtract date/time by using a value that is based on seconds. For example: dateTimeField> $DATE$ - 86400 (86400 is the number of seconds in 24 hours.) For Date fields, this keyword evaluates to the current date. For Time fields, this keyword evaluates to 12:00:00 AM.

Note: The $DATE$ keyword is not expanded when default values are set. This allows the value to be set to the date the form is submitted rather than the date the form is opened. Consequently, the literal keyword is displayed in the field before the request is submitted.

$DRAGSRCFIELDID$An integer representing the ID of the field from which a drag operation started. Use this keyword in workflow to reference the source field immediately after a drag operation has started. This keyword is useful with the Application-Copy-Field-Value command. For more information, see Process commands.
$DROPTGTFIELDID$An integer representing the ID of the field on which a drop operation occurred.
$ERRNO$The number of the first error on the stack. Defined only during filter error handler execution.
$ERRMSG$The error message for the first error on the stack. Defined only during filter error handler execution.
$ERRAPPENDMSG$The appended message for the first error on the error stack, if any. Defined only during filter error handler execution.
$EVENTDATA$The value that identifies the data of the event. This keyword is NULL on the server.
$EVENTSRCWINID$Window ID that uniquely identifies the event source window in the client environment. The value returned from*$EVENTSRCWINID$* should be saved into a display-only character field with a database length of zero (unlimited length). This keyword is NULL on the server.
$EVENTTYPE$The value that identifies the type of the event. The value returned from $EVENTTYPE$ should be saved into a display-only character field with a database length of zero (unlimited length). This keyword is NULL on the server.
$FIELDHELP$The help text in the Help Text tab of the Field Properties window. Web applications do not support the $FIELDHELP$ keyword; it returns NULL. This keyword is NULL on the server.
$FIELDID$The ID of the field that currently has focus in the client. Returns NULL if the FIELDHELP keyword is not implemented.
$FIELDLABEL$The label of the field that currently has focus in the client.
$FIELDNAME$The name of the field that currently has focus in the client.
$FILTER_ERRNO$An error-handling keyword that was replaced by $ERRNO$, but remains for backward compatibility purposes.
$FILTER_ERRMSG$An error-handling keyword that was replaced by $ERRMSG$, but remains for backward compatibility purposes.
$FILTER_ ERRAPPENDMSG$An error-handling keyword that was replaced by $ERRAPPENDMSG$, but remains for backward compatibility purposes.
$GROUPIDS$Returns the list of the group IDs of which the current user is a member. If there are no groups, the value is NULL. If there are groups, the value is a string displayed in the following format: ; groupID; groupID; groupID;
$GROUPS$Returns the list of the groups of which the current user is a member.
$GUIDE$The name of the currently running guide. (The name is $NULL$ if no guide is running.) This keyword is useful for determining if an active link or filter is executing as a part of normal workflow or in a guide.
$GUIDETEXT$The text that is entered under the Help tab of a guide definition. Web applications do not support the $GUIDETEXT$ keyword; it returns NULL. This keyword is NULL on the server.
$HARDWARE$

The hardware on which the process is running. This is the name each hardware vendor has given their hardware:

  • On UNIX platforms, the name returned by the uname -m command (for example, sun4c).
  • On PC platforms, the processor type (for example, PC i486).

You can use this keyword to build filters, escalations, and active links that execute only if the process is running on an appropriate platform. Web applications do not support the $HARDWARE$ keyword; it returns NULL.

$HOMEURL$The mid tier translates $HOMEURL$ to the base URL of the current page. The $HOMEURL$ keyword enables you to use the relative path to the application resources when creating workflow. For example, in the Set Fields action, you can enter the following text for the Set Value for the View Field:$HOMEURL$/Resources/test.html The URL is resolved at the runtime and loads a different file without changing the Set Fields action.
$INBULKTRANSACTION$

Indicates if the current execution is within a bulk transaction. The values returned are:

  • 0 = False
  • 1 = True

The keyword always expands to a value of 0 on BMC Remedy AR System clients.

$LASTCOUNT$

The number of requests returned from the most recent search. You can use this keyword with any search, including one run from the search window, a Set Fields operation, a macro, a table refresh, and so on.

Note: The $LASTCOUNT$ keyword is not expanded when default values are set. This allows the value to be set when the form is submitted rather than when the form is opened. Consequently, the literal keyword is displayed in the field before the request is submitted.

$LASTID$

Upon a successful submit, the keyword contains the Request ID of the most recently created request during the user's login environment.

Note: The $LASTID$ keyword is not expanded when default values are set. This allows the value to be set when the form is submitted rather than when the form is opened. Consequently, the literal keyword is displayed in the field before the request is submitted.

$LASTOPENEDWINID$Sent Event keyword that resolves to the ID of the window that was last opened. Every window that is opened, including children, is saved as the last opened window. The value of this keyword is in effect until another window is opened. The format and length of window IDs are not constrained. The value returned from $LASTOPENEDWINID$ should be saved into a character field with a database length of zero (unlimited length). This keyword is NULL on the server.
$LOCALE$The language and country code for the specified locale, in the format language _countryCode. To view a list of the language and county codes, open a form in BMC Remedy Developer Studio. In the Properties tab, click in the Locale property. Locales appear in the Value list for the property.
$NULL$A null value (no value).
$OPERATION$

The current operation.

Click here for more information.

$OS$The operating system of the computer on which a process is running. You can use this keyword to build workflow that executes conditionally, based on the current operating system. Web applications do not support the $OS$ keyword; it returns NULL.
$ROLES$For a deployable application, returns the list of roles that map to groups to which the current user belongs.
$ROWCHANGED$

Evaluates the state of a row in a table field:

  • 0 = Loaded/unchanged.
  • 1 = Modified.
  • 2 = New.
  • 3 = Deleted. The row is hidden from users but visible to workflow.

Values 2 and 3 are returned only by BMC Remedy AR System server 7.6.03 or later. This keyword is valid only in the context of a table loop guide.

$ROWSELECTED$

Evaluates if a row in a table field is selected:

  • 0 = Not selected
  • 1 = Secondary selection
  • 2 = Primary selection

This keyword is valid only in the context of a table loop guide.

Note: The $ROWSELECTED$ keyword is not expanded when default values are set. This allows the value to be set when the form is submitted rather than when the form is opened. Consequently, the literal keyword is displayed in the field before the request is submitted.

$ROWVISIBLE$

Evaluates if a row in a table field is visible:

  • 0 = Not visible
  • 1 = Visible

This keyword is valid only in the context of a table loop guide. If a row is deleted, irrespective of table type, whether chunking is enabled, or whether content clipped is enabled, the value 0 is returned. If a row is not deleted for non-content clipped tables, the value 1 is returned.

$SCHEMA$The name of the current form.
$SCHEMA_ALIAS$The singular alias used for a form. This is the form's active alias, which comes from one of the request aliases of the active view (VUI).
$SERVER$

The name of the current BMC Remedy AR System server. The configuration settings in the ar.cfg (or ar.conf ) file determine the return value as follows:

  • If the Server-Name and Domain-Name parameter values are defined, the value is: <_serverName _> + <domainName >
  • If Server-Name is defined but Domain-Name is not, the value is: <serverName + domainNameReturnedBySystemCall>
  • If Domain-Name is defined but Server-Name is not, the value is: <serverNameReturnedBySystemCall + domainName>
  • If Server-Name and Domain-Name are not defined, the value is: <fullyQualifiedDomainName>
$SERVERTIMESTAMP$

For Date/Time fields, the current date and time on the server. For Time fields, the current time on the server. For Date fields, the current date on the server.

Note: The $SERVERTIMESTAMP$ keyword is not expanded when default values are set. This allows the value to be set to the date and time (on the server) the form is submitted rather than the date and time the form is opened. Consequently, the literal keyword is displayed in the field before the request is submitted.

$SHIFT_KEY$To verify if the Shift key is pressed. The value is set to 1 when the Shift key is pressed while starting the workflow from a control field, a double-click or return on a table field. Any other value represents that the Shift key is not pressed.
$TCPPORT$The TCP/IP port of the local BMC Remedy AR System server. This keyword is an integer data type. Web applications do not support the $TCPPORT$ keyword; it returns NULL.
$TIME$

For Date/Time fields, the current time (date defaults to current day). Anything stored in a date/time field is stored as the number of seconds since UNIX epoch time, which includes the date and time. For Time fields, the current time. For Date fields, the number of seconds since 12:00:00 a.m., which is converted to a date value.

Note: The $TIME$ keyword is not expanded when default values are set. This allows the value to be set to the time the form is submitted rather than the time the form is opened. Consequently, the literal keyword is displayed in the field before the request is submitted.

$TIMESTAMP$

For Date/Time fields, the current date and time. For Time fields, the current time. For Date fields, the current date.

Note: The $TIMESTAMP$ keyword is not expanded when default values are set. This allows the value to be set when the form is submitted rather than when the form is opened. Consequently, the literal keyword is displayed in the field before the request is submitted. 

$USER$The current user login. A "user" can be a human user or an internal (system) user. Internal users include AR_ESCALATOR, Distributed Server, and an application binary.
$VERSION$  The software version running on the client (active links) or server (filters and escalations). This keyword includes any applicable patch number.
$VUI$The label of the form view displayed in the active window. This keyword is NULL on the server.
$VUI_TYPE$The view's platform (such as web or Windows). When used in workflow, this keyword is the platform value of the active form view. For filters and escalations, this keyword resolves to an empty string. This keyword is similar to $VUI$ except that its value is the VUI type of the active view. The values for this keyword are NONE, WINDOWS, WEB(RELATIVE), WEB(FIXED), WIRELESS. The number representations of the different view platforms are in the ar.h file.
$WEEKDAY$

The current day of the week as a character string.

Note: The $WEEKDAY$ keyword is not expanded when default values are set. This allows the value to be set to the day of the week the form is submitted rather than the day of the week the form is opened.

  You can use the $OPERATION$ keyword in qualifications to determine whether the filter or active link should execute on the current operation. For example, the qualification $OPERATION$="SET" causes the filter or active link to execute when a request is modified but not when a request appears in display mode. You can also use this keyword to capture audit information. For example, setting a field to the value:

"Filter X executed on operation "+$OPERATION$

tells you whether a filter executed during a submit operation (CREATE returned) or a modify operation (SET returned).
$OPERATION$ values 

$OPERATION$ valueDescriptionFilter execution conditionsForm mode
CREATESet when creating a request.SubmitNew
DELETESet when deleting a request.DeleteDelete 
DIALOGSet when opening a form as a dialog box. Dialog
GETSet when retrieving a request for display.GetDisplay
MERGESet when merging requests.Merge 
QUERYSet when searching for requests. Search
SETSet when modifying a request.ModifyModify
SET ALLSet when a Push Fields action that is configured to modify all matching requests modifies a request. Modify Modify All 
Was this page helpful? Yes No Submitting... Thank you

Comments