To access custom actions

  1. Click user menu > Settings.
  2. In the Settings view, click the Configurations tab.
  3. To see the custom actions for all item types:
  4. In the Item Types panel, click All Item Types.
  5. In the Show list, select Custom Actions.​​

In the list of Custom Actions, Display Order refers to their order in drop-down menus and ribbons with buttons.

To create a custom action:

  1. In the Item Types panel, select the entity that you want to create the custom action for, for example, Work Item.
  2. In the Create New list, select Custom Action.
  3. Enter the properties for the custom action:
    1. Name (mandatory)
    2. Description
    3. Error notifications
  4. Expand the Advanced section and then enable settings as required.
  5. By default, all users have access to new custom actions, but you can specify the users who can access the custom action. In the Permissions section, enable either all users or the specific users who can access the custom action.
  6. By default, new custom actions are always displayed. To display the custom action under specific conditions (for example, only when a task state is complete):
    1. In the Evaluation Criteria section, click Show under conditions.
    2. In the If True= text box, enter the conditions.
    3. To check the syntax, click Check Syntax.
  7. To make the custom action mandatory or require confirmation from users:
    1. In the User Input section, select the Request values or confirmation from user check box.
    2. Enter the Dialog box title, and optionally, instructions for the user.
    3. Define the Variables. These include the items in the form such as dates, text, etc.
    4. Click Formula Options to select from the available options.
  8. Define the Set Actions fields. Actions can include creation of new work items, sending an email, adding a post, etc.
  9. (Optional) Define the Success message:
    The Success message is displayed after the custom action is completed successfully. (When a custom action fails, an error message appears/.)
    To open a new window with the specified URL instead, click the Open URL option.
    You can enter a standard URL or generate a URL for the current user by inputting a formula that uses variables or parameters and run them directly through URLs and even create wizards.
    Click Formula Options to select from the available options.
  10. Click Save.

Best Practices

  • For Custom Actions, you can set up to 5 actions - one action can trigger another action that can trigger another one…
  • For complex Custom Actions, enable Run in background to avoid impacting the end-user experience. Note that:
    • The order is not guaranteed
    • Validations are not checked (including evaluation criteria that are not checked again)


See also

Custom Action examples

Filtered Lookups for Custom Action Forms.