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.)

To define the execution options for active links

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

   The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
   This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it. The following table describes active link execution options relevant to field actions. Active links: Field-based execution options
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.