Customizing the API Link Macro

Alloy Navigator Express uses e-mail notifications to communicate information about workflow-related events to users, and those notifications contain direct links to objects in Alloy Navigator Express. For example, when an automated email invites customers to participate in a customer satisfaction survey, that email includes a direct link to the resolved Ticket.

The default workflow pack includes a special API Link system macro. By default, this macro expands to an auto-suggested value. Before you begin production use of the API module, you must specify the actual link to the API.

The Web Configuration tool will prompt you to customize the API Link macro. You can skip this step during the initial configuration and customize the direct link macro later, but keep in mind that object links in API notifications will not work without that customization.

To customize the API Link system macro:

  1. Run the Web Configuration tool. For example, using Alloy Control Panel.

  2. In the sidebar, select your API instance. In the Web section of the main pane on the right hand side, click Configure.

    TIP: Alternatively, you can choose Configure Portal > Web from the pop-up menu.

  3. Navigate to the Workflow Integration page.

    The Web Configuration tool detects the URL address automatically and suggests to use this value by default. To replace the auto-detected URL with your custom value, click Replace the macro’s value with a custom URL and type in your custom URL address.

    TIP: Applying the suggested URL is the best choice when the web application is to be accessed only over the local network. When the web application will be accessed over the Internet, you may need to type in the real URL manually.

    Click Next.

  4. On the Ready to Apply Settings page, review the new Workflow Macro API Link and click Apply.

  5. Exit the Web Configuration tool.

TIP: You can also customize the API Link system macro from the Settings App. For details, see Administration Guide: Specifying the API URL for Direct Links.