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.

Creating active links

Active link execution options cause the active link to execute based on actions taken by the user. Some actions are specific to the open request or open window, while other actions are associated with fields in the referenced form. The following figure shows the execution options panel for an active link.

If an active link is part of a guide, you do not need to select an execution option.

Active link execution options (Click the image to expand it.)

  1. Open an existing active link or create a new one.
  2. Make sure there is an associated form selected. Select one in the Associated Forms panel if necessary. See Associating workflow objects with forms.
  3. Expand the Execution Options panel.
  4. Set the State field to Enabled or Disabled. When the state is Enabled, the active link becomes active as soon as it is saved. You might want to set the state to Disabled during development or when troubleshooting.
  5. If necessary, enter a number in the Execution Order field. The value that you enter in the Execution Order field determines the order in which this active link is executed relative to other active links with the same triggering conditions. Numbers between 0 and 1000 are valid execution order values; lower numbers are processed first. The default value is 0.
  6. Select the execution options for request and window actions, if any. The execution options for request and window actions that trigger active links are described in the following table. You can select any combination of these execution conditions, or none of them, as appropriate. If you select multiple options, the active link or filter executes when any one of the selected operations occurs.
  7. Define the execution options for field actions, if any. To do so:
    1. Click the Field ellipsis button. The fields that appear in the field list are taken from the Primary Form defined in the Associated Forms panel. To locate a field quickly in a long list, use the Filtering Options or the Locate field in the Field Selector dialog box. See To filter the contents in an object list.

      Tip

      Instead of clicking the ellipsis button, you can also press Ctrl+Space with the cursor in the Field field. This brings up a list of the available fields from the form. Begin to type the field name to narrow the list, and then select the field you want.

    2. Select the appropriate field from the Field Selector dialog box and then click OK. When you select a field, the field execution options appropriate to the field type become active. The field-based, button, and menu execution options for active links are described in the following table.
    3. Select one or more field execution options for the field.
  8. To cause the active link to execute when the user clicks a button:
    1. Click the Button/Menu Field ellipsis button.
    2. Select the appropriate button field and then click OK.

      Tip

      You can also associate an active link with a button by selecting the active link in the button's field properties.

  9. In the Interval field, select an execution interval, if any. The minimum interval is three seconds, and the maximum interval is 7200 seconds. When this is selected, the active link executes when the form is open at the specified time interval. (If two or more active links on a form have the same interval, they execute at the same time unless the execution order is set.)

    Warning

    In workflow triggered by the Interval condition, avoid the use of Message actions and Open Window (of type Dialog) actions. This is to prevent an uncontrolled loop of messages or opened windows, which could consume resources on the client computer and make it difficult for the user to close the form.



    The following table describes active link execution options relevant to request and window actions.

    Active links: Execution options for request and window actions

    Execution optionDescription
    After ModifyExecutes when a user modifies an existing request and after the request is written to the database. If the modification fails, the active link is not executed. (The active link does not execute during a Modify All operation.)
    After SubmitExecutes after a user submits a new request and after the request is written to the database. If the submission fails, the active link is not executed. If you use this condition for a set fields action on the current entry, the set value is not stored in the database.
    DisplayExecutes after an existing request is loaded into a form, but before the request appears in the Details Pane.
    Event

    Executes when a window has changed its application state, for example, when one window wants to send an event to one or more windows; when one window has caused data to change and another window references that data; or when one window is closed and other windows must be notified. This capability allows one part of an application in a client environment to notify other parts that an "event" has occurred. Other parts of the application can then react by performing actions such as refreshing table fields. The Event condition provides a mechanism in the context of a single client environment (for example, in a web client) for a parent window to be notified when a child window has been closed, so that workflow can refresh related data on the parent window. Events are constrained to the client environment. Windows in two separate client environments cannot send messages to each other. See Ability to highlight required fields through workflow.

    Warning: In some cases, event driven workflow can fail when executed on the mid tier. To avoid this issue, explicitly define the parent-child relationship.

    ModifyExecutes when a user modifies an existing request. The active link is executed before the request is sent to the server. (The active link does not execute during a Modify All operation.)
    Search

    Executes when a user performs a search operation. The active link executes before the search operation so that, if the active link criteria is not met, the If actions are not performed. (If Else actions exist, they are performed.) To prevent a specific search from occurring (such as an unqualified search), you can have the active link return a message (such as an error); otherwise, the search is performed. You can also use active links to set fields to modify the search.

    Note: The active link can access and assign values in the Search window, including the Search Bar if the reserved Search Bar field is present on the form.

    Set DefaultExecutes when the user selects Edit > Set to Defaults from the menu bar. It can also happen after Window Open if default field values have been set in the form through user preferences.
    SubmitExecutes when a user submits a new request. The active link is executed before the request is sent to the server.
    Un-DisplayExecutes when a request is removed from the Details pane because a new request was selected in the Results pane or because the window is closing. The workflow actions execute before the request is removed from the form.
    Window ClosedExecutes when a user closes a window.
    Window LoadedExecutes after all the data values have been loaded into a Submit or Search window (from defaults, from a Copy to New action, or from an Window Open action).
    Window Open

    Executes when any of the following actions occur:

    • A form window opens in New, Search, Modify, or Modify All operation mode.
    • The mode of the Detail pane switches to New, Search, Modify, or Modify All mode.
    • The form is opened by using the Open Window action. This is useful for establishing the initial environment when a user opens a new window or changes modes. The active link is executed before any data is loaded into the window, except when the form is opened in Dialog mode by the Open Window action.    

    Note: If you use a Set Fields action with the Window Open condition, the set fields values might be deleted if the user preference is set to Clear All Fields On Search or On New. To avoid this when using a Set Fields action, use the Window Loaded execution option, which executes after preferences are loaded, instead. 

     The following table describes active link execution options relevant to field actions. Active links: Field-based execution options

    Execution optionDescription
    Button/Menu FieldExecutes when a user selects a button or a menu button.
    Collapse

    Appears when the selected field is a Panel field type.

    • For Accordion and Stacked panel fields, executes when the user collapses a panel field.
    • For a panel field of the Splitter type and Tabbed type, this option causes no action.
    DragExecutes when the mouse moves over a field, and the user presses the left mouse button and drags the mouse. See Allowing data to be dragged and dropped.
    DropExecutes when the left mouse button is released over a "droppable" field after being dragged from a "draggable" field. See Allowing data to be dragged and dropped.
    Expand

    Appears when the selected field is a panel field type.

    • For Accordion and Stacked panel fields, executes when the user expands a panel field.
    • For a panel field of the Splitter type and Tabbed type, this option causes no action.
    Gain Focus

    Executes when the specified field receives the focus. If you select this option, the Field list is enabled so that you can specify the field that causes the active link to execute.

    Note: If you use the Gain Focus condition to execute an active link on a view field, the active link might not execute as expected. This is because the HTML page in the view field is taking the focus.

    If the Gain Focus option is defined on a column field and if the table does not currently have focus, the Gain Focus is also fired for the table. For example, if a table has columns A and B and if the current focus is on column A and the user shifts focus to column B, the Gain Focus is not fired on the table because the table already has the focus. However, if the current focus is on another field outside the table and the user shifts focus to a column inside the table, the Gain Focus will be fired for the table.

    Note: This Gain Focus option for column fields is applicable only for cell based and list view tables. For list view tables, only the columns with display type not set to "read only" fire focus events.

    Hover On Field Hover On Data Hover On LabelExecutes when the user hovers the mouse pointer over a field, field data, or a field label in the web client. Along with the Message active link action, enables the use of tooltips to display a brief informational message. If the selected field is a data field, all three options are enabled. If the selected field does not have distinguishable label and data areas, only the "Hover on field" option is enabled. For information about creating tooltips, see Message action.
    Level ChoiceAppears when the selected field is a tree-view table field type. Executes when a user selects a level in the tree.
    Level Double Click or ReturnAppears when the selected field is a tree-view table field type. Executes when a user double-clicks a leaf in a tree view table or selects a leaf and then presses Enter to drill down to the source form. (If a user double-clicks on a parent node with child nodes under it, the node collapses or expands or no workflow is executed.) For more information, see Tree view tables.
    Lose Focus

    Executes as the focus is changed, for example, by clicking in another field. If you select this option, the Field list is enabled so that you can specify the field that causes the active link to execute. An existing panel field loses focus when a new panel of the set appears at the front. Panels can gain focus whenever a user clicks a tab, an active link sets focus to a panel or a field on a panel, or another panel is hidden. Panel focus is independent of data field focus.

    Note: If you use the Lose Focus condition to execute an active link on a view field, the active link might not execute as expected. This is because the HTML page in the view field is taking the focus.

    If the Lose Focus option is defined on a column field and the focus is moving to a field outside the table, the Lose Focus is also fired for the table. For example, if a table has columns A and B and if the current focus is on column A and the user shifts focus to column B, the Lose Focus is not fired on the table because the table still has the focus. However, if the current focus is on a column inside the table and the user shifts focus to a field outside the table, the Lose Focus will be fired for the table. 

    Note: This Lose Focus option for column fields is applicable only for cell based and list view tables. For list view tables, only the columns with display type not set to "read only" fire focus events. 

    Menu ChoiceAppears as an execution option when the selected field has an associated menu. Executes when a user makes a selection from a character menu attached to the field or selects a node in a tree view table field.
    Return

    Executes when any of the following actions occur:

    • A user presses Enter on the keyboard.
    • A user presses Shift-Enter in a multirow character field.
    • A user selects a check box, drop-down menu item, or radio button.
    Row ChoiceAppears as an execution option when the selected field is a table field. Executes when a user selects a row in the table.
    Row Double Click or ReturnAppears when the selected field is a table field type. Executes when a user double-clicks a row in a table field or selects a row and then presses Enter to drill down to the source form. This execution condition works independently of whether the table drill-down option has been selected for the table field. This execution option works only if the user has been granted permission to fields on the supporting form, the column fields, and the table field.
    Table RefreshAppears as an execution option when the selected field is a table field. Executes when the user updates the table contents by loading the field, sorting, refreshing, or displaying the previous or next chunk.
  10. Expand a Run If Qualification panel, and enter a qualification, if needed. For more information, see Using buttons and menu bar items to execute active links.
  11. Enter If and Else actions, as needed. For more information, see Using buttons and menu bar items to execute active links.
  12. Save the active link.

Was this page helpful? Yes No Submitting... Thank you

Comments