How-to

How to set up Alloy Self-Service (for administrators)

Introduced in 2022.1

For Alloy Navigator Express admins

This article explains administration tasks to integrate the mobile app with Alloy Navigator Express and describes how you can import the default Alloy Self-Service mobile app configuration to the database, if needed.

API integration and API URL

The Alloy Self-Service mobile app integrates with Alloy Navigator Express via the API. That's why you need to make sure you have the Alloy Navigator Express API module installed and configured for the Access Token user authentication. For details, see Installation Guide: Installing and Configuring the API Module.

Communicate the API URL to end-users; they will need to specify that URL to sign in.

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

SSP customer accounts for end-users

Mobile app users must have SSP Customer accounts in Alloy Navigator Express.

INFO: For more information, see Administration Guide: Creating and Maintaining SSP Customer Accounts.

Web-based Self Service Portal

The Self-Service mobile app does NOT require the web-based Self Service Portal; it is an independent application for self-service. You may use the mobile app as the only communication channel for end-users or use it along with the web-based Self Service Portal—it is up to you.

INFO: For more information, see Installation Guide: Installing and Configuring the Self Service Portal.

Self-Service mobile app configuration

The Alloy Self-Service mobile app configuration is an XML document that controls various aspects of the app's interaction with Alloy Navigator Express. That XML configuration must be stored in the database.

Starting with version 2022.1, Alloy Navigator Express comes with the default configuration for the Alloy Self-Service mobile app. It is included in the default workflow and contains everything to get started. If you do not have the Alloy Self-Service mobile configuration in the database, you will have to import it to Alloy Navigator Express first. You will be able to download the XML configuration using the download link in the instruction below.

How do you know if you need to import the configuration?

The Self-Service mobile app configuration may be missing (for example, if you have accidentally deleted it). A simple way to tell if you have the configuration in the database is to have a look at the Services > Mobile Applications section in your Settings App. The configuration name is SelfServiceMobile.

Import the configuration to Alloy Navigator Express

Use the instruction below to import the default Alloy Self-Service mobile configuration if you do not have SelfServiceMobile configuration in the database or when you want to revert to defaults.

To import the default configuration for the Alloy Self-Service mobile app:

  1. Click here to download a zip archive containing an XML configuration file for the Self-Service mobile app.

  2. Unzip the archive.

  3. In the Settings App, click Import Settings on the toolbar and import the XML bot configuration file.

    INFO: 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 SelfServiceMobile.

Customize the Self-Service mobile app configuration

The default mobile configuration is the best choice for most organizations. However, administrators can access the configuration settings and make some customizations. To access the Self-Service mobile app configuration, launch the Settings App, navigate to Services > Mobile Applications and double-click the SelfServiceMobile record.

INFO: For instructions, see Settings App Help: Configuring Alloy Self-Service mobile app.