Configuring Alloy Navigator Mobile App

Introduced in 8.7

Updated in 8.7.2

Alloy Navigator Mobile App 2.2

Alloy Navigator is our native app that gives technicians mobile access to Alloy Navigator. The Mobile App is available for Android and iOS mobile devices on Google Play and App Store.

API backend

The Mobile App uses native API integration with Alloy Navigator, which means that the API module must be installed and configured for the Access Token user authentication. For instructions, see Installation Guide: Installing the API Module.

When technicians are signing in to Alloy Navigator mobile app, they specify the API web address (URL) along with their Alloy Navigator credentials.

TIP: To view the API URL, start the Web Configuration tool on the web server and navigate to the API module using the sidebar. The URL is shown in the main pane on the right hand side, among other configuration information.

Mobile App configuration

The default configuration for Alloy Navigator Mobile App contains ready-to-use settings for all object classes that the Mobile App supports (Incidents, Work Orders, Service Requests, etc). The configuration is stored in the Alloy Navigator database, and you can access and manage it from the Settings App.

Configuration settings include:

To manage the Mobile App configuration:

  1. Go to Services > Mobile Applications and double-click NavigatorMobile. The Mobile Application [NavigatorMobile] 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. For details, see the table below.

    IMPORTANT: Any changes made to the mobile app configuration become immediately active. We recommend that you export the default configuration to an external XML file before making any changes. Without backup, it can be difficult to reverse your changes and revert to the default configuration.

    Section Elements and attributes Description

    DisabledObjects

    <Object Name="Object"/>

    Available attributes:

    • Announcement,
    • Incident,
    • Service Request,
    • Change Request,
    • Work Order,
    • Approval Request.

    The section contains disabled object classes, i.e., the objects that are hidden from Mobile App users. When an object class is disabled, its link disappears from the home screen.

    By default, the DisabledObjects section contains some object classes, and the whole section is disabled (commented out). To hide unwanted objects from Mobile App users, leave only those objects inside the <DisabledObjects> and </DisabledObjects> tag pair and uncomment the section.

    TIP: You may want to adjust the workflow not to send push notifications on changes to disabled objects. Otherwise, Mobile App users would receive push notifications with links to objects they cannot access.

    Views

    <Object Name="Object">
    	<View Name="View Name">
    		<Fields>
    			<Field Name="Field_Name"/>
    			...
    		</Fields>
    		<Sorting>
    			<SortBy FieldName="Field_Name"/>
    			...
    		</Sorting>
    		<Filter>
    			<SQL WHERE clause>
    		</Filter>
    	</View>
    	...
    </Object>
    
    
    
    

    The section defines views for displaying lists of objects. Views are grouped by the objects they apply to.

    • Object Name - the object class name (Incident, Change Request, etc.)

    • View Name - the name of the view, as it appears in the Mobile App.

    • Fields - the list of object fields the view shows (as columns). You can add new fields, change their display order, and remove unwanted fields from the view.

      TIP: For correct field names, go to General > Fields > [Object Class] in the Settings App and double-click the desired field. The physical field name is in the Field Name field on the General tab.

    • Sorting - the list of object fields by whose values to sort the view. By default, field values are sorted in the descending order, from largest (latest) to smallest (earliest). To sort in the accenting order, add Reverse="1" after the field name; for example:
      <SortBy FieldName="Due_Date" Reverse="1"/>.

    • Filter - the filtering expression, specified as a valid SQL WHERE clause (without the word WHERE) that the Mobile App uses to select records to display.

    Forms
    <Objects>
    	<Object Name="Object">
    		<Fields>
    			<Field Name="Field_Name"/>
    			...
    		</Fields>
    	</Object>
    	...
    </Objects>

    The section defines forms for displaying object details (field values). Every object has a single view form.

    • Object Name - the object class name (Incident, Change Request, etc.)

    • Fields - the list of object fields the form shows (as values). You can add new fields, change their display order, and remove unwanted fields from the form.

  3. In most cases, leave the URL Mask field blank. This field stores the API URL associated with the Alloy Navigator Mobile App. When you have a single API backend associated with this mobile app, there is no need to specify the URL here.

    However, if you need to have different configurations for different API endpoints, you can explicitly specify the API endpoint URL or its significant part in the URL Mask field. This requires you to have more than one API modules configured.

  4. Click OK to close the window and save your changes, if any. Alloy Navigator will check the syntax of the XML configuration file before saving.

The difference between disabled objects and unsupported objects

Every new version of Alloy Navigator Mobile App adds new features, including support for new Alloy Navigator object classes. The latest version (2.2) provides mobile access to these objects:

  • Announcements
  • Incidents
  • Service Requests
  • Change Requests
  • Work Orders
  • Approval Requests

Mobile App users access Alloy Navigator objects by tapping their links on the home screen. If you want to block mobile access to some functionality, you can disable unwanted object classes by adding them to the DisabledObjects section in the mobile configuration. Links to disabled objects will disappear from the Mobile App home screen.

The home screen displays links to all mobile-accessible non-disabled objects, even when your current version of Alloy Navigator API or the mobile configuration does not provide support for some of them. Such unsupported objects would display a red "Do not enter" icon next to their links.

If there are any unsupported objects, the Mobile App will inform about them. See the table below for different situations that may occur on the home screen and how to resolve them.

Situation Description Solution

A red icon appears next to the link. Attempts to open the link throw this error message:

The Alloy Navigator server needs to be upgraded to version 8.7.2 or later to support these objects.

Your version of Alloy Navigator API is earlier than expected. The expected version is 8.7.2 or later. Upgrade your Alloy Navigator to the latest version.

A red icon appears next to the link. Attempts to open the link throw this error message:

The Alloy Navigator server is not configured to support these objects. Contact your administrator to request a configuration update.

The API has the expected version (i.e., 8.7.2 or later), but the mobile configuration lacks settings for the objects. Contact our Support Team to get the latest mobile configuration and import it to Alloy Navigator.There is n
There is no link to objects on the home screen. The object class is disabled. If you do not want those objects disabled, remove them from the DisabledObjects section in the mobile configuration.