Integrations

Customize the bot configuration in Alloy Navigator Express

Introduced in 8.7.3

Updated in 2022.1

The Alloy Self-Service Assistant bot configuration is an XML document that controls some aspects of the bot's interaction with Alloy Navigator Express. This article describes how to import the bot configuration to Alloy Navigator Express, if needed, and how to customize it there. Namely, you should replace an example URL with your Self Service Portal's actual address; other customizations are optional.

NOTE: If needed, you can download the XML configuration using the download link in the instruction below.

Import the configuration to Alloy Navigator Express

The bot configuration must be stored in the database. Starting with version 2022, the default configuration comes with Alloy Navigator Express. However, the configuration may be missing after the upgrade, because changes to the default workflow do not apply automatically. If you do not have the TeamsBot configuration, you need to import it to Alloy Navigator Express first.

To import the default configuration for the Alloy Self-Service Assistant bot:

  1. Click here to download a zip archive containing an XML configuration file for the Alloy Self-Service Assistant bot.

  2. Unzip the archive.

  3. Launch your Alloy Navigator Express Settings App. For example, open the Alloy Control Panel and click Settings.

  4. In Settings, click Import Settings on the toolbar and import the XML bot configuration file. For detailed instructions, see Help: Importing configuration settings.

Once the import is complete, the imported configuration will be available under Services > Mobile Applications. Its name is TeamsBot.

Customize the configuration in Alloy Navigator Express

NOTE: This article describes most recent version of the bot configuration. If you already had the XML configuration imported, and your version differs from the one we describe here, see Update the bot configuration in Alloy Navigator Express to decide whether you need to update to the newest version and see how to update.

  1. In Settings, go to Services > Mobile Applications and double-click TeamsBot. The Mobile Application [TeamsBot] dialog box opens.

  2. The configuration is available in the Configuration field. It is an XML document, where all configuration entries are wrapped inside the <Data> and </Data> tag pair.

    INFO: For detailed information on every configuration entry, see What does the configuration include?

    Element Description
    <Portal URL="SSP URL" 
    Enabled="True/False"/>

    Connects the bot to your Self Service Portal and controls the availability of Self Service Portal links. For details, see Self Service Portal links.

    • URL - defines the SSP URL.

      IMPORTANT: Replace the example value https://www.example.com/hd with the actual URL of your Self Service Portal.

    • Enabled - controls the availability of direct links to the Self Service Portal from Teams:
      • True or not present - SSP links are available.
      • False - SSP links are not available.

    TIP: You can view the Self Service Portal URL in the Settings App. Go to Workflow and Business Logic > Advanced > System Macros and copy the contents of the Self Service Portal Link field. For details, see Settings App Help: Customizing links to Alloy web applications.

    <Tickets Enabled="True/False" AltMessage="Message">
    	<CreateAction ID="CreateActionID" 
    	Enabled="True/False" AltMessage="Message"/>
    	<UpdateAction ID="UpdateActionID" 
    	Enabled="True/False" AltMessage="Message"/>
    </Tickets>

    Specifies which workflow actions the bot uses in commands for creating and updating tickets and controls the availability of those commands.

    • Enabled - controls the availability of commands for tickets:
      • True or not present - commands are available.
      • False - commands are not available. Attempts to run a command shows the message.
    • AltMessage - the message to show when the command is not available. For example:

      AltMessage="To create or update tickets, visit [Self Service Portal](https://www.example.com/hd)"

      If a command is disabled, but the command's AltMessagetext is missing, the bot uses the message text for the Tickets element. If the Tickets' AltMessage text is missing, the bot shows this built-in message: This action is disabled in the bot configuration.

    For details, see Workflow form for creating tickets and Workflow item for updating tickets.

    <ApprovalRequests Enabled="True/False" AltMessage="Message">
    	<ApproveAction ID="ApproveActionID" 
    	Enabled="True/False" AltMessage="Message"/>
    	<RejectAction ID="RejectActionID" 
    	Enabled="True/False" AltMessage="Message"/>
    </ApprovalRequests>

    Specifies which workflow actions the bot uses in commands for approving and rejecting approval requests and controls the availability of those commands.

    • Enabled - controls the availability of commands for approval requests:
      • True or not present - commands are available.
      • False - commands are not available. Attempts to run a command shows the message.
    • AltMessage - the message to show when the command is not available. For example:

      AltMessage="To approve or reject requests, visit [Self Service Portal](https://www.example.com/hd)"

      If a command is disabled, but the command's AltMessagetext is missing, the bot uses the message text for the ApprovalRequests element. If the ApprovalRequests' AltMessage text is missing, the bot shows this built-in message: This action is disabled in the bot configuration.

    For details, see Workflow items for approving and rejecting requests.

What does the configuration include?

The XML bot configuration in Alloy Navigator Express specifies the address of your Self Service Portal for , defines which workflow items the bot uses in commands for creating and updating tickets and working with approval requests, and controls the availability of those commands.

What's next?

NEXT STEP: Stay in the Settings App to complete the next step. Your next step is to obtain credentials from Alloy Navigator Express to allow the bot to access Alloy Navigator Express.