BlueFletch Chat

Getting Started

The following guide walks through the fastest flow for getting a device online with the BlueFletch Chat application. Further details on implementing more features of the Chat application are linked throughout the guide.

Configuration

To format an existing launcher.json configuration file to support BlueFletch Chat, open the file in an integrated development environment (IDE) or the BlueFletch Portal's Configurations editor (View Raw Config option). If no launcher.json file has yet been configured for the organization's devices, follow the steps in Getting Started with a Launcher.JSON first.

In the configuration file, confirm that within the "emsSupportTool" object, the property "orgId" is defined as the company's BlueFletch organization ID, which can be found on the Portal Admin - Organization page (click here to navigate away from the documentation and to your BlueFletch Portal instance to view organization information).

...
"emsSupportTool": {
    "orgId": "ORG ID HERE",
    ...
}
...

Create a new object "bfChat" in the configuration and include the following properties:

• "apiKey": the organization's API key, which can be retrieved from the BlueFletch Portal on the Admin - API Keys page if actively managed, or in Manage Organization settings on the Organization page if displayed statically.
• "autoPlayAudio": can be true or false.
• "allowAttachments": can be true or false.
• "callTimeout": can be any integer.

...
"bfChat": {
    "apiKey": "ORG API KEY HERE",
    "autoPlayAudio": true,
    "allowAttachments": true,
    "callTimeout": 20
}
...

Within the "settings" object, set the value for the "useSiteInfoService" property to true and a set a placeholder string for "defaultLocation".

...
"settings": {
    "useSiteInfoService": true,
    "defaultLocation": "Location"
    ...
}
...

Within the "intents" object, add or edit the "login" and "logout" arrays to include the BlueFletch Chat Login and Logout intent objects.

...
"intents": {
    "login": [
        {
            "action": "com.bluefletch.chat.ACTION_LOGIN",
            "package": "com.bluefletch.chat",
            "flags": 1,
            "typeIntent": "a"
        }
    ],
    "logout": [
        {
            "action": "com.bluefletch.chat.ACTION_LOGOUT",
            "package": "com.bluefletch.chat",
            "flags": 1,
            "typeIntent": "a"
        }
    ]
}
...

The BlueFletch Chat package (com.bluefletch.chat) must be added to a layout for an identity provider (IdP) security group. For more information on adding packages to group arrays in the "layouts" object, see the Layouts feature guide.

For further descriptions of these configuration properties and for additional settings, see the BlueFletch Chat Technical Guide.

Site Assignment

The device must be assigned a location in order to find other users in the Chat application. One way to assign location is by downloading a site list CSV file on the device. For more information on setting up a site list file, see the Site Information Service documentation.

Accessing Chat

Download the launcher.json and sitelist.csv files and install BlueFletch Chat and the other required applications, then start the Enterprise Launcher application. With Launcher open, long-press on the default location placeholder above the login button and manually override location to select a site.

Press the Login button and proceed through the login steps for the particular authentication application.

Once logged-in, the Chat application should be displayed as configured in the layout. Press the BlueFletch Chat icon, and the application should open to its device user list.

Communication

On the device user list any other devices assigned to the same site and logged in should show as Active. These users can be messaged. Click on a user to open a conversation, then type and send a message to another device user.

On a Zebra device, an audio recording attachment can also be sent by holding down the Push-To-Talk (PTT) button to record and releasing the PTT button to send.

The device can also be messaged from the BlueFletch Portal. Locate the device from a list of devices on the Home dashboard or from the Playbook MDM - Devices list and open its Device Details page. Press the Chat button to open a messaging window and begin messaging the device. The device user only sees a Portal user in the Active users folder after the Portal user opens the Chat messaging window.

When finished messaging on the device, press Logout on the home screen to logout as that user and return to the OpenZone. Other device users will see this device user listed under Inactive.