This documentation applies to the 8.1 version of Remedy Action Request System, which is in "End of Version Support."

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

Using fields in the advanced search bar

Enclose field labels in single quotation marks. For example:

'Short Description'

If a field name contains a single quotation mark (such as an apostrophe), add another single quotation mark next to it. For example, if the field is named Submitter's Phone Number, enter it as 'Submitter''s Phone Number'.

To search on a field that does not have a label, see your administrator for the field ID. Use this ID instead of the name enclosed in single quotation marks.

Note

Instead of entering the field label and the quotation marks into the advanced search bar, click the field's label in the form, or select the field from the Field List dialog box. The field name is automatically added, with the correct syntax, to the search statement.

See the following sections for more information about using fields in the advanced search bar:

Using status history fields

Status history fields must have all of the following information enclosed within single quotation marks:

  • The name or ID of the status history field followed by a period.
  • The name or index of the status value that you want to match followed by a period.
  • The keyword USER (for the user who changed the request to that status) or TIME (for the time last changed to that status).

The following example uses names:

'Status History.Fixed.TIME' < "07/01/08"

Using currency fields

For currency fields, you must enclose one of the following items in single quotation marks:

  • The name or ID of the currency field. For example:
    'Currency Field' = $NULL$
  • The name of the currency field, followed by a period, followed by a specific portion of the currency field's value, such as the date or a functional currency value. For example:
    'Currency Field.VALUE' < 5000

Using keywords in the advanced search bar

You can use keywords anywhere that you can enter character values.

You can use the $NULL$ keyword to search for requests that have no value in a field. For example, to search for requests that have not been assigned (requests with no value in the Assigned to field), enter 'Assigned to' = $NULL$.

The most commonly used keywords are: $DATE$, $NULL$, $TIME$, $TIMESTAMP$, $USER$, and $WEEKDAY$.

Note

Keywords are case-sensitive. Use only UPPERCASE, as shown in the following table.



Keywords

Keyword Substituted value
$APPLICATION$ The application name if the application is running; $NULL$ when no application is running.
$BROWSER$ The browser (Internet Explorer or Netscape) being used in the current session. If the browser is anything other than Internet Explorer or Netscape, Netscape is returned.
$CLIENT-TYPE$ The client type of the API program. AR System administrators use this keyword.
$CURRENTWINID$ The window ID that uniquely identifies the current window in the client environment. AR System administrators use this keyword.
$DATABASE$ The name of the database on which the current form's data is stored.
$DATE$ In a character field, the current date is displayed. In a date/time field, the time defaults to midnight (00:00:00).
$DEFAULT$ The default value for the associated field (used only when assigning a value to a field).
$ERRNO$ When an error is encountered, the number of the error that just occurred.
$ERRMSG$ The message for the error that just occurred.
$ERRAPPENDMSG$ The appended message, if any, for the error that just occurred.
$EVENTSRCWINID$ The window ID that uniquely identifies the event source window in the client environment. AR System administrators use this keyword.
$EVENTDATA$ The value that identifies the data of the event. AR System administrators use this keyword.
$EVENTTYPE$ The value that identifies the type of the event. AR System administrators use this keyword.
$FIELDHELP$ The field help text for the currently selected field.
$FIELDID$ The ID of the field that is currently selected. If the field is not selected, it returns NULL.
$FIELDLABEL$ The label of the field that is currently selected, If the field is not selected, it returns NULL.
$FIELDNAME$ The name of the field that is currently selected. If the field is not selected, it returns NULL.
$GROUPIDS$ The group IDs of which the current user is a member. If there are no groups, the keyword returns a value of NULL.
$GROUPS$ The groups to which the current user belongs.
$GUIDE$ The guide name if the guide is running; NULL if the guide is not running.
$GUIDETEXT$ Help text that provides instructions when a guide is running.
$HARDWARE$ The hardware platform on which the current process is running.
$HOMEURL$ The URL of the current page. This option is only valid on web pages. AR System administrators use this keyword.
$INBULKTRANSACTION$ Indicates whether you are in a bulk transaction. This keyword is not supported and is reserved for future use.
$LASTCOUNT$ The number of matches found in the most recent search.
$LASTID$ The ID of the last successfully created request.
$LASTOPENEDWINID$ The Send Event keyword that resolves to the ID of the window that was last opened. AR System administrators use this keyword.
$LOCALE$ The language and country code for the specified locale, in the format language_COUNTRYCODE, for example, en_US.
$NULL$ A null value.
$OPERATION$

The current mode or operation being performed. One of the following values is returned:

  • CREATE--For a Create request operation.
  • DELETE--For a Delete operation.
  • DIALOG--When a form is opened as a dialog box.
  • GET--For a Get Entry operation.
  • MERGE--For a Merge operation.
  • QUERY--For a database search.
  • SET--For a Modify operation.
  • SET ALL--For a Modify All operation.
$OS$ The operating system under which the current process is running.
$ROLES$ For a deployable application, returns the list of roles that map to groups to which the current user belongs.
$ROWCHANGED$

Evaluates whether a row in a table field has changed in a table loop guide.

  • 0 = Not changed
  • 1 = Changed
$ROWSELECTED$

Evaluates whether a row in a table field is selected in a table loop guide.

  • 0 = Not selected.
  • 1 = Highlighted as the secondary selection.
  • 2 = Highlighted as the primary selection.
$ROWVISIBLE$

Evaluates if a row in a table field is visible.

  • 0 = Deleted, irrespective of table type, whether chunking is enabled, or whether content clipped is enabled.
  • 1 = Not deleted, for non-content clipped tables.
$SCHEMA$ The form on which you are currently operating.
$SCHEMA-ALIAS$ The singular alias used for a form.
$SERVER$ The name of the current AR System server.
$SERVERTIMESTAMP$

The current date, time, or both on the AR System server. The keyword is used with the following fields:

  • Date/Time
  • Time
  • Date
$TCPPORT$ The TCP/IP port of the local AR System server. AR System administrators use this keyword.
$TIME$ In a character field, the current time is displayed. In a date/time field, the date defaults to the current date.
$TIMESTAMP$ The current date/time stamp.
$USER$ The name of the user who is currently logged in.
$VERSION$ The version of AR System server. If the version includes a patch, it is also included.
$VUI$ The name of the view of the current active window.
$VUI-TYPE$ The views platform (such as Web or Windows).
$WEEKDAY$ The current day of the week.

Using values in the advanced search bar

Enclose nonnumeric values (including time, selection, and currency values) in double quotation marks (for example, "07/01/08" for July 1, 2008).

Using selection field values

Selection field values can be specified as text values (in quotation marks) or numeric values or IDs (not in quotation marks). For example, if you have a Status field with the option buttons labeled Open, Fixed, and Verified, you can enter either "Open" or 0 to specify the value of Open, because Open is the first selection value in the selection field. For example:

'Status'="Open"

or

'Status'= 0

Using currency field values

For currency fields, use the Currency Codes submenu to select an available currency code. When you select a currency code, the double quotation marks are automatically entered (such as "USD" ). Add the currency value within the double quotation marks (for example, "100 USD" ).

If you do not specify a currency code, the primary allowable currency type is assumed.

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments

  1. Bruce Steinberg

    this was not helpful because there are no documents we can print for our users. General users cannot access this site and online there is not a lot of good docs anymore.

    Since queries have not changed, maybe it would be good to make this available to outside users.

    Aug 15, 2019 07:40