For the complete documentation index, see llms.txt. This page is also available as Markdown.

Managing Devices

A device represents an object that sends messages to and / or receives messages from GAP.

A device can be anything that has a mechanism for sending and / or receiving data (including satellite phones, GSM (cellular) trackers, smartphone apps, etc.).

Adding Devices

Depending on the device type you select, you may need to enter additional information when creating a device (e.g. phone number).

If you do not see the type of device you want to add listed, please see the Supported Devices List.

user-lock

This action requires the Add Device permission.

  1. From the GAP Admin home page, click "Devices" under the "Devices" section.

  2. Click the "+ Add Device" button.

  3. Select the tenant in which the device will reside using the "Tenant" drop-down list.

  4. Enter a device ID in the "Device ID" text box. The device ID must be unique (e.g. IMEI, GUID, etc.).

  5. Enter a friendly name for the device in the "Device friendly name" field.

  6. Select the type of device from the "Device type" drop-down list.

  7. Select a user to whom the device is assigned from the "Assigned User" drop-down list.

  8. Select a device manager from the "Device manager" drop-down list.

  9. Select the device's provisioning status from the "Provisioning status" drop-down list.

  10. Enter a description in the "Description" text box.

  11. To add tags to the device, click "+ Add Tags". Enter a tag name and tag value. Repeat as required.

  12. To add a note to the device, click "+ Add Note".

  13. Click the "Submit" button.

Editing Device Details

Depending on the device type you select, you may have additional fields shown when editing a device (e.g. phone number).

user-lock

These actions require the Edit Device and Change Device User permissions.

  1. From the GAP Admin home page, click "Devices" under the "Devices" section.

  2. Click the name of the device you want to edit.

  3. To change the friendly name, click " EDIT" next to the device friendly name, amend the name in the text box and click the "Save" button.

  4. To change the device status, toggle the "Status" option.

  5. To assign the device to a different user, select the user from the "Assigned user" drop-down list.

  6. To assign the device to a different device manager, select the device manager from the "Device manager" drop-down list.

  7. To edit the device's tags, click " EDIT TAGS" and amend the tag names or values as required. Tags can be deleted by clicking " DELETE". New tags can be added by clicking "+ ADD TAG". Click the "Done" button when complete.

  8. To edit the device notes, amend the value in the "Notes" text box.

  9. To change device-type specific settings (e.g. phone number, SIM card number, etc.), click the "Type-Specific Settings" tab and amend the settings as required.

  10. Click the "Save Changes" button.

Changing Device IDs

user-lock

This action requires the Edit Device and Change Device ID permissions.

  1. From the GAP Portal home page, click "Devices".

  2. Click the name of the device you want to edit.

  3. Under the "Device Actions" section, click "Configure Device".

  4. Click "Advanced".

  5. Click "Change Device Id".

  6. Enter the new device ID in the "New Device Id" text box. The device ID must be unique (e.g. IMEI, GUID, etc.).

  7. Click "OK".

Deactivating Devices

user-lock

This action requires the Change Device Provisioning Status permission.

Deactivating a device retains its data in GAP and stops messages being sent from it being processed (except for emergency messages). The device will appear greyed out in the GAP Portal.

  1. From the GAP Admin home page, click "Devices" under the "Devices" section.

  2. Click the name of the device you want to deactivate.

  3. To change the device status, toggle the "Status" option to off.

  4. Click the "Save Changes" button.

Deleting Devices

user-lock

This action requires the Delete Device permission.

  1. From the GAP Admin home page, click "Devices" under the "Devices" section.

  2. Click (trash) icon next to the name of the device you want to delete.

  3. Click the "Delete Device" button at the prompt.

Last updated