Process commands - Documentation for Remedy Action Request System 20.02

Active LinksFilters or EscalationsReturns a valueCommandDescription and exampleY

GET-CHANGE-FLAG

Gets the change flag status of the current window. 1 means that changes were made, and 0 means that no changes were made.

For example:

$PROCESS$ GET-CHANGE-FLAG

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:

1: Enable
0: Disable

For example, to enable the cursor:
ENABLE-WAIT-CURSOR-ON-LONG-RUNNING-PROCESS 1

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, PERFORM-ACTION-ACTIVE-LINK 8 specifies to run all On Modify active links as if a modify operation was performed. The active links fire, but no modify is actually performed. The options for this command are as follows:

Button: PERFORM-ACTION-ACTIVE-LINK 1 fieldID
Row Double Click or Return: PERFORM-ACTION-ACTIVE-LINK 2 fieldID
Submit: PERFORM-ACTION-ACTIVE-LINK 4
Modify: PERFORM-ACTION-ACTIVE-LINK 8
Display: PERFORM-ACTION-ACTIVE-LINK 16
Menu Choice: PERFORM-ACTION-ACTIVE-LINK 128 fieldID
Lose Focus: PERFORM-ACTION-ACTIVE-LINK 256 fieldID
Set Default: PERFORM-ACTION-ACTIVE-LINK 512
Search: PERFORM-ACTION-ACTIVE-LINK 1024
After Modify: PERFORM-ACTION-ACTIVE-LINK 2048
After Submit: PERFORM-ACTION-ACTIVE-LINK 4096
Gain Focus: PERFORM-ACTION-ACTIVE-LINK 8192 fieldID
Window Open: PERFORM-ACTION-ACTIVE-LINK 16384
Un-Display: PERFORM-ACTION-ACTIVE-LINK 65536
Window Close: PERFORM-ACTION-ACTIVE-LINK 32768
Copy To New: PERFORM-ACTION-ACTIVE-LINK 131072
Window Loaded: PERFORM-ACTION-ACTIVE-LINK 262144
Interval:PERFORM-ACTION-ACTIVE-LINK 524288
Event: PERFORM-ACTION-ACTIVE-LINK 1048576
Table content change: PERFORM-ACTION-ACTIVE-LINK 2097152 fieldID
Hover on Label: PERFORM-ACTION-ACTIVE-LINK 4194304 fieldID
Hover on Data: PERFORM-ACTION-ACTIVE-LINK 8388608 fieldID
Hover on Field: PERFORM-ACTION-ACTIVE-LINK 16777216 fieldID
Expand: PERFORM-ACTION-ACTIVE-LINK 33554432 fieldID
Collapse: PERFORM-ACTION-ACTIVE-LINK 67108864 fieldID

YYYPERFORM-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:

1: Canceled
2: Failed

For filters and escalations, the field ID must be an attachment field, and the file name is required. For active links:

The file name is optional. If omitted, a Browse dialog box is displayed to allow you to select a file name. (If viewed in a web browser, a Browse dialog box is always displayed.)
The field ID can be an attachment field or an attachment pool.
- If the field ID is an attachment field, the attachment is added to the specified field. If the field has a value, the existing value is overwritten.
- If the field ID is an attachment pool, the attachment is added to the first available field within the pool that has no attachment. If no attachment meets this criteria within the pool, no action is taken.
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:

PERFORM-ACTION-ADD-ATTACHMENT 536870915 "C:\Trace.txt"

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 PERFORM-ACTION-APPLY process command and the Commit Changes action is that the Commit Changes action works differently in conjunction with a dialog box. The PERFORM-ACTION-APPLY process command has no effect on a dialog box, it only works with regular forms.

For example:

PERFORM-ACTION-APPLY

PERFORM-ACTION-CHANGE-MODE mode

Changes the mode of the form. This command takes mode as a parameter and then changes the mode. The allowable values for mode are QUERY (new search), CREATE (new request) and SET ALL (modify all). This is exactly what the $OPERATION$ keyword returns currently.

For example:

PERFORM-ACTION-CHANGE-MODE CREATE

Y

PERFORM-ACTION-CLEAR-PROMPTBARClears 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:

PERFORM-ACTION-CLEAR-PROMPTBAR

PERFORM-ACTION-DELETE-ATTACHMENT fieldID

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:

1: Canceled
2: Failed

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:

PERFORM-ACTION-DELETE-ATTACHMENT 536880912

Y

PERFORM-ACTION-EXIT-APP

Exits the Windows client or logs out of the web client.

For example:

PERFORM-ACTION-EXIT-APP

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:

PERFORM-ACTION-GET-ENTRY $Request ID$

Y
YPERFORM-ACTION-GET-FIELD-LABEL fieldID

Returns a field label. Use this command in a Set Fields action with $PROCESS$ to obtain the return value. For the query builder widget, returns the query builder widget qualification in user readable format ( $PROCESS$ ), which is a string containing what is seen in the query builder widget. The fieldID is the field ID of the view field, which has been initialized as a query widget, and will return null if fieldID is not a query widget or invalid field ID.

For example, it is used in Set Fields action:

$PROCESS$ PERFORM-ACTION-GET-FIELD-LABEL 536880912 where 536880912 is the field ID whose label is to be retrieved.
or
$PROCESS$ PERFORM-ACTION-GET-FIELD-LABEL $Character Field$

where $Character Field$ is used to enter fields IDs dynamically.

Y
YPERFORM-ACTION-GET-PREFERENCE fieldID

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:

PERFORM-ACTION-GET-PREFERENCE 20121 where 20121 is the field ID of the User Locale field. To find the field ID:

Open the AR System User Preference form in BMC Remedy Developer Studio.
Select the field in question, and find the ID property in the Properties tab.

Y

PERFORM-ACTION-GO-HOME

Opens the form configured as your home page.

For example:

PERFORM-ACTION-GO-HOME

Y

PERFORM-ACTION-SHOW-TOOLBAR [Value]

Shows or hides the toolbar on a form. If the value to set to 1, the form displays the toolbar. Otherwise, the form hides the toolbar. This command is available for all modes, except Dialog and Popup. For information about the related features, see Ability to modify toolbar option.

For example:

PERFORM-ACTION-SHOW-TOOLBAR 0

PERFORM-ACTION-SHOW-TOOLBAR 1

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:

PERFORM-ACTION-HOME-FIELD-REFRESH

PERFORM-ACTION-LIST-APPEND fieldID "value"

Adds the value to the end of the list maintained by a character field.

For example, if character field 1234 contains the value abc;def;ghi;jkl;, the following command modifies the value to abc;def;ghi;jkl;mno.

PERFORM-ACTION-LIST-APPEND 1234 "mno"

YYY

PERFORM-ACTION-MAP-GROUPIDS-TO-NAMES fieldID

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:

$PROCESS$ PERFORM-ACTION-MAP-GROUPIDS-TO-NAMES $536871123$

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 $grouplist$ LIKE "%"'groupname'"%", first add a process command to translate a list of group IDs to a space separated list of group names.

PERFORM-ACTION-MAP-PUT fieldID key "value"

Adds or updates the value in a list or map maintained by a character field.

For example, if character field 1234 contains the value type=4;Name=John, the following command modifies the value to type=4;Name=George.

PERFORM-ACTION-MAP-PUT 1234 Name "George"

PERFORM-ACTION-NAV-FIELD-SET-SELECTED-ITEM navbarItemID

Set focus to the specified navigation bar item.

For example:

PERFORM-ACTION-NAV-FIELD-SET-SELECTED-ITEM 304247449

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.

PERFORM-ACTION-NAV-FIELD-SET-SELECTED-ITEM 536870978 1

Y

PERFORM-ACTION-NEXT

Moves to the next request in the Results pane and displays the details in the Details pane.

For example:

PERFORM-ACTION-NEXT

Y
Y

PERFORM-ACTION-OPEN-ATTACHMENT fieldID

Opens an attachment from an attachment field, and returns a value of 0 (Successful). If the attachment is not opened, the command returns one of the following codes:

1: Canceled
2: Failed

For example, to use in Run Process or Set Fields action, enter:

$PROCESS$ PERFORM-ACTION- OPEN-ATTACHMENT 536870915

536870915 is the attachment field ID.

PERFORM-ACTION-OPEN-URL [ current | :new ] " urlString"

Opens the specified URL in a browser. For the Windows client, a browser is opened. The URL is opened in a browser as follows:

To open the page in a new browser window, enter
PERFORM-ACTION-OPEN-URL "urlString" or PERFORM-ACTION-OPEN-URL new "urlString"
To open the page in a new browser window with the toolbar, menu bar, and location bar hidden, enter
PERFORM-ACTION-OPEN-URL newwithouttoolbar "urlString"
To open the page in the current browser window, enter
PERFORM-ACTION-OPEN-URL current "urlString"
To enter two fields as arguments where the first field represents value for the target window and the second field represents value for the URL string
PERFORM-ACTION-OPEN-URL $z1D Char01$ $z2D Char02$

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:// (). The mid tier always requires a complete and well-formed URL.

For example:

PERFORM-ACTION-OPEN-URL $z1D Char01$

PERFORM-ACTION-OPEN-URL new $HOMEURL$SMPM/Change/Change_Process_Frames.htm

Y

PERFORM-ACTION-PREV

Moves to the previous request in the Results pane and displays the details in the Details pane.

For example:

PERFORM-ACTION-PREV

YNNAPERFORM-ACTION-REFRESH-PREFERENCE

Refreshes the user preferences. The flag options are as follows:

1 — Saves all modified preferences from user to the preference server, and reloads preferences from the preference server.
0 — Discards all modified preferences from user and reloads from the preference server.

YPERFORM-ACTION-SAVE-ATTACHMENT fieldID [" fileName" ]

PERFORM-ACTION-SAVE-ATTACHMENT fieldID [" fileName" ]

Saves an attachment from an attachment field to a file, and returns a value of 0 (Successful). If the attachment is not saved, the command returns one of the following codes:

1 — Canceled
2 — Failed

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:

The file is saved on the client computer.
The field ID can be an attachment field or an attachment pool. If the field ID is an attachment pool, the first available attachment is saved.
The file name is optional. If omitted, the web client always displays a dialog box. If the file name is given, the simple file name is displayed in the file name field.

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. See Using a special override naming convention.

For example:

$PROCESS$ PERFORM-ACTION-SAVE-ATTACHMENT 536870915 "C:\Trace.txt"

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:

@ — The "at" sign signifies the parent of the current window.
Note: In the web client, an Open Window active link action can open a form in the current window. This window does not have a parent window, so a target value of @ is not valid in this case.

# — The pound sign character signifies all child windows of the current window.
* — The asterisk character signifies all windows managed by the client environment, even the current window.
eventType — The name of the event. This is an arbitrary string defined by the application author (for example, ChildClosed). The receiving workflow can access the value of eventType through the EVENTTYPE keyword.
eventData — The data for the event.
FdataVisualizationModuleFieldID — The target for sending events is the module field in the current form.

For more information, see Ability to highlight required fields through workflow and Ability to highlight required fields through workflow.

For example:

PERFORM-ACTION-SEND-EVENT F536870914 "DisplayItem" $ItemName$, where:

536870914 is the data visualization field ID.

DisplayItem is an event type that is recognized by the module.

$ItemName$ is a field on the form that contains the name of the item to be displayed in the module field.

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:

PERFORM-ACTION-SET-PREFERENCE 20121 "ja_JP"

20121 is the field ID of the User Locale field and ja_JP is the value that represents a Japanese locale.

To find the field ID:

Open the AR System User Preference form in BMC Remedy Developer Studio.
Select the field in question, and find the ID property in the Properties tab.

To find the value or format of a user preference field:

Log on to a preference server and specify a value for a user preference. For example, select a Display Locale in the Locale tab.
Open the AR System User Preference form to see what format is used or what value is stored in the corresponding field (for example the User Locale field in the Locale tab).

This is the format or value you specify for the value argument.

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:

fieldid — The field ID of the view field. This value is required.
guid — Looks up form/field information. This value is required.
AREncodedQual — AR encoded qualification string. Pass NULL if not needed. This value is required.

Returns one of the following integers:

0: Successful
1: Error

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 NULL for the encoded qualification. No backchannel call will be made to retrieve field information because the query builder widget already knows it has the field information. Alternatively, sending a qualification will reinitialize the current query builder widget with the new qualification. In this case, a backchannel call is still required in this case to interpret the encoded qualification.

Y

PERFORM-ACTION-TABLE-ADD-ROW tableFieldID rowIndexInserts 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:

tableFieldID — The ID of the table field to which to add the row. This value is required.
rowIndex(Optional) — The position (row index) at which to insert the row. (Row indexes are based on the version of the table in the client memory data structure.) The specified index determines the actions that occur as follows:
- 0 — Invalid row index. The current selection and highlight are not changed.
- Greater than 0 and less than 100,000,000 — A row is inserted at the specified index, selected, and highlighted. Workflow is then fired on the new row.
- Greater than 100,000,000 — A row is inserted at rowIndex - 100,000,000. For example, if the specified index is 100,000,005, the row is inserted at index 5. The new row is selected but not highlighted. Workflow is then fired on the new row.
- Less than 0 and greater than -100,000,000 — A row is inserted at the specified index multiplied by -1. For example, if the specified index is -500, a row is inserted at index 500. The new row is selected and highlighted. Workflow is then fired on the new row.
- Less than -100,000,000 — A row is inserted at rowIndex + 100,000,000. For example, if the specified index is -100,000,500, a row is inserted at index -500. The new row is selected, but it is not highlighted. Workflow is not fired. This value can come at runtime from a field on the form (for example, use PERFORM-ACTION-TABLE-ADD-ROW $Field1$ $Field2$). If a row already occupies the specified position, this command pushes the existing row and all the rows that follow it down one position. If the specified index is greater than the number of existing rows, the row is inserted at the end of the table. If a row index is not specified, a row is inserted at the end of the table, selected, and highlighted. Workflow is then fired on the new row. See Updating tables on-screen only.
  For example, the following command cab be used in Run process in active link:
  PERFORM-ACTION-TABLE-ADD-ROW 536870915 $Character Field2$
  536870915 is the field ID of the tree or table field , and row index can be provided at run time via character field.

Y

PERFORM-ACTION-TABLE-CHANGE-ROW-COL-VISIBILITY tableFieldID [0 | 1] columnFieldID

Hides (1) or shows (0) the contents of a column field for the current row.

For example:

PERFORM-ACTION-TABLE-CHANGE-ROW-COL-VISIBILITY 91530 0 91535

PERFORM-ACTION-TABLE-CLEAR tableFieldID

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:

PERFORM-ACTION-TABLE-CLEAR 536870915

536870915 is the field ID of the tree or table field.

PERFORM-ACTION-TABLE-CLEAR-ROWCHANGED tableFieldID

Clears the ROWCHANGED flag for the current row.

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.

PERFORM-ACTION-TABLE-DELETE-ROW tableFieldID rowIndex rowToSelect

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:

rowToSelect (Optional) — The position of the row to select after the row at rowIndexis deleted. If this value is specified, a row is selected as follows:
- 0 — Invalid row index. The current selection is not changed, but the highlight is removed.
- NULL — The current selection and highlight are not changed unless the highlighted row is deleted. In that case, the highlight is removed.
- Greater than 0 and less than 100,000,000 — The row at the specified index is selected and highlighted, and workflow is fired.
- Greater than 100,000,000 — The row at rowToSelect - 100,000,000 is selected but not highlighted, and workflow is fired. For example, if the specified index is 100,000,005, row 5 is selected but not highlighted, and workflow is fired.
- Less than 0 and greater than -100,000,000 — The row at the specified index multiplied by -1 is selected and highlighted, and workflow is not fired. For example, if the specified index is -5, the row at index 5 is selected and highlighted.
- Less than -100,000,000 — The row at rowIndex + 100,000,000 is selected but not highlighted, and workflow is not fired. For example, if the specified index is -100,000,500, row -500 is selected but not highlighted, and workflow is not fired. If the selected row is deleted, it remains selected in memory, but it no longer appears on-screen. This command is valid for list view, tree view, and cell-based tables. See Updating tables on-screen only.

For example, the command can be used in run process action as follows:

PERFORM-ACTION-TABLE-DELETE-ROW 536870915 $Character Field2$

Here, 536870915 is the field ID of the tree or table field and CharacterField2 is the value of the row to be deleted.

PERFORM-ACTION-TABLE-DESELECTALL tableFieldID

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:

PERFORM-ACTION-TABLE-DESELECTALL 536870915

PERFORM-ACTION-TABLE-GET-CHUNKSIZE tableFieldID

Returns one of the following values:

0— Indicates one of the following conditions:
- The table is not chunked.
- The table ID is invalid.
- The table is unrefreshed.
Chunk size of the table. If the table is not content clipped, the value is the same as the chunk size defined in BMC Remedy Developer Studio.

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:

PERFORM-ACTION-TABLE-GET-CHUNKSIZE 536870915

Y
Y

PERFORM-ACTION-TABLE-GET-CURRENT-CHUNK tableFieldID

Returns one of the following values:

Index of the currently displayed table chunk — Chunk index numbers start at 1. For example, if the fifth chunk is currently displayed, this command returns 5.
NULL— Indicates one of the following conditions:
- The form does not contain the specified field.
- The command syntax is incorrect.
- The table is unrefreshed.
1— Indicates one of the following conditions:
- The index of the currently displayed chunk is 1.
- The table has no chunks. For example, it might be a results list table whose chunk size is not defined, a tree view table, or an alert list table.
- The table is empty.
- The specified field is not a table. For content clipped tables, the chunk calculation is dynamic as the number of visible cells changes.

For example:

PERFORM-ACTION-TABLE-GET-CURRENT-CHUNK 536870915

Y
Y

PERFORM-ACTION-TABLE-GET-SELECTED-COLUMN fieldID [returnType]

Returns the field ID or level of the selected node, which starts at 1. If root is selected, the command returns 0. If nothing is selected, the command returns NULL. This command works only with tree view table fields. The arguments for this command are:

Field ID — The field ID of the tree field.
Return type — 1 returns the selected column's field ID. Anything other than 1 returns the number of the level.

For example:

To return the field ID of a tree with an ID of 536870913, enter: PERFORM-ACTION-TABLE-GET-SELECTED-COLUMN 536870913 1

To return the level of a tree with an ID of 536870913, enter: PERFORM-ACTION-TABLE-GET-SELECTED-COLUMN 536870913

Y
Y

PERFORM-ACTION-TABLE-IS-LEAF-SELECTED tableFieldID

Returns 1 if selected node is a leaf, and returns 0 if the selected node is not a leaf or if nothing is selected.

For example:

$PROCESS$ PERFORM-ACTION-TABLE-IS-LEAF-SELECTED 303836000

PERFORM-ACTION-TABLE-NEXT-CHUNK tableFieldID

Displays the next chunk of data in a table. If the action is for a results list, use reserved field ID 1020. If content clipping is enabled, this will display the next visible chunk. If the full chunk is not visible, this is not be the same as the next physical chunk.

For example:

PERFORM-ACTION-TABLE-NEXT-CHUNK 536870915

PERFORM-ACTION-TABLE-PREV-CHUNK tableFieldID

Displays the next chunk of data in a table. If the action is for a results list, use reserved field ID 1020. This command is ignored for tree view table fields. If content clipping is enabled, this will display the previous visible chunk. If the full chunk is not visible, this is not the same the previous physical chunk.

For example:

PERFORM-ACTION-TABLE-PREV-CHUNK 536870915

PERFORM-ACTION-TABLE-REFRESH tableFieldID[startRow] [numberToRetrieve]

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:

PERFORM-ACTION-TABLE-REFRESH 301132300 0 50

PERFORM-ACTION-TABLE-REPORT tableFieldID

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:

PERFORM-ACTION-TABLE-REPORT 431390002

PERFORM-ACTION-TABLE-SELECT-NODE fieldID rowNumber [columnNumber] [flag]

Selects the specified node in a tree view table. The arguments for this command are:

Field ID — The field ID of the tree field.
Row number — The 1-based row position of the node.
Column number (optional) — The column (level) of the node. If you enter an invalid column number, a leaf is selected.
Flag — 1 expands the selected node. Anything other than 1 is ignored.

For example, the following command selects a node whose tree field ID is 536870913, and the node is in row 3 and column 4.
The command also requests that the node be expanded.PERFORM-ACTION-TABLE-SELECT-NODE 536870913 3 4 1

PERFORM-ACTION-TABLE-SELECTALL tableFieldID

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:

PERFORM-ACTION-TABLE-SELECTALL 536870915

PERFORM-ACTION-TABLE-SET-ROWSTATE tableFieldID rowIndex rowState

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:

tableFieldID — The ID of the table field from which to delete the row. This value is required.
rowIndex(Optional) — The position of the row to apply the state to. (Row indexes are based on the version of the table in the client memory data structure.) If this value is not specified, one of these actions occurs:
- If this command is run under a table loop guide, the state is applied to the current row in the guide.
- Otherwise, the state is applied to all the rows in the table. This value can come at runtime from a field on the form (for example, use PERFORM-ACTION-TABLE-ADD-ROW $Field1$ $Field2$).
rowState(Optional) — An integer indicating the state to apply to the specified row:
- 0 (Loaded or Unchanged) — (Default) The row was just refreshed.
- 1 (Modified) — A Set Fields action was just performed on the row.
- 2 (New) — The row was just added. See PERFORM-ACTION-TABLE-ADD-ROW.
- 3 (Deleted) — The row was just marked as Deleted and removed from view. It is now hidden from users but visible to workflow. See PERFORM-ACTION-TABLE-DELETE-ROW. If this value is not specified, it defaults to 0 (Loaded or Unchanged). If this value is out of the range, such as 4, this command does not change the row's state. This command sets the $ROWCHANGED$ keyword to the rowState value. This command is valid for list view, tree view, and cell-based tables. See Updating tables on-screen only.

For example:

PERFORM-ACTION-TABLE-SET-ROWSTATE 91340 $tableSort_SOURCE$ 2

PERFORM-ACTION-VALIDATE-NULL-REQUIRED-FIELDS [display] [fieldIDsSeparatedByBackslashes]

Validates missing values or the $NULL$ value in the data fields. If the Run Process action returns true, it stops the workflow, highlights the field with a colored border (for example, a red border), and displays an error message.

The displayparameter has two options to determine where to place the message:
- PROMPT (in the prompt bar)
- POPUP (in a pop-up box).
The fieldID parameter takes a list of field IDs separated by backslashes to validate specific fields. If this parameter is not specified, the parameter verifies all data fields on the form (but automatically excludes non-data fields, such as table fields, column fields, and panel holders). If a field in a specified parameter list is not a data field or not a required field, the Run Process action ignores those fields.

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.

PERFORM-ACTION-VALIDATE-NULL-REQUIRED-FIELDS PROMPT 8\536870913. For more information, see Ability to highlight required fields through workflow.

Y
YSECURITY-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:

$PROCESS$ SECURITY-FILTER $field containing malicious data$

Y

SET-CHANGE-FLAG [ 0 | 1 ]Sets the change flag status of the current window to on (1) or off (0).

For example:

SET-CHANGE-FLAG 0

SET-CHANGE-FLAG 1

Note: When you do not set a parameter, the change flag status of the current window is set to off.

SET-RO-COLOR redCode, greenCode, blueCode

Sets the background color of read-only fields according to red, green, blue (RGB) color coding.

For example, to set the blue background color:

SET-RO-COLOR 0,0,255

NYY

$PROCESS$ URL-Safe-Encode $CILookup$

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:

{"BMC.CORE:BMC_ComputerSystem" : "abc"}, the output is encoded as follows:

%7B%22BMC.CORE%3ABMC_ComputerSystem%22

Related Journals

Most Famous R&B Singers

Angel Shave Club Closes $200K Investment Deal With Quake Capital and Hatcher+

No Matter How Long It Takes by Cross Point Music

Meet Barbra Streisand’s Husband James Brolin