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

Inbox, Outbox & Device Log

Each device record in GAP has an Inbox, Outbox (if it supports MT messaging) and Device Log.

Inbox

The Inbox displays messages that the device has sent to GAP (MO Messages).

user-lock

Access to the inbox requires the View All Inbox Messages permission. Otherwise, only the most recent message is shown.

Viewing the Inbox

  1. In the GAP Portal, click "Devices" from the banner menu.

  2. Click on the device whose inbox you want to view.

  3. Under the "Context" section, click "Inbox".

Searching & Filtering the Inbox

  1. In the GAP Portal, click "Devices" from the banner menu.

  2. Click on the device whose inbox you want to view.

  3. Under the "Context" section, click "Inbox".

  4. Click "Inbox Options".

  5. To search for specific text in a message, enter the text in the "Search in Messages" text box and click the (magnifying glass) icon.

  6. To show a specific number of messages in the Inbox (up to 5,000), select a value from the "Select number of messages or choose Start Date and End Date" drop-down list. Alternatively, select a start and end date using the "Start Date" and "End Date" date and time pickers.

  7. To filter the Inbox based on accuracy of position data in messages, use the "Show messages based on position accuracy" drop-down list.

  8. To filter the Inbox based on message type, use the "Show messages based on message type" drop-down list.

  9. Click the "Reload" button.

Configuring Inbox View Settings

Changing these settings applies to your user account only.

  1. In the GAP Portal, click "Devices" from the banner menu.

  2. Click on the device whose Inbox you want to configure.

  3. Under the "Context" section, click "Inbox".

  4. Click "Inbox Options".

  5. Click the "Setup" button.

  6. Check the "Setup Custom Fields" check box under "Template Options".

  7. Remove unwanted fields using the (trash) icon.

  8. Re-order fields by clicking and dragging the (grip) icon as required.

  9. Configure custom number formats using the (code) icon. You can also use this option to not show zero values.

  10. Click the "+ Add Field" button to add new fields.

  11. Enter a label for the field in the "Label (optional)" text box.

  12. Select a value to display in that field using the drop-down list on the right-hand side of the "Label (optional)" text box.

  13. Repeat steps 11 and 12 as required.

  14. Click "OK".

Exporting Inbox Messages

To perform a one-off export of MO messages:

  1. In the GAP Portal, click "Devices" from the banner menu.

  2. Click on the device whose inbox you want to view.

  3. Under the "Context" section, click "Inbox".

  4. Click "Inbox Options".

  5. Filter the inbox as required (see Searching & Filtering the Inbox).

  6. Click the "Export" button and select a format in which to export the data.

  7. Save the file when prompted by your web browser.

Deleting Inbox Messages

user-lock

This action requires the Delete Messages permission.

Deleting Specific Messages

  1. In the GAP Portal, click "Devices" from the banner menu.

  2. Click on the device whose messages you want to delete.

  3. Under the "Context" section, click "Inbox".

  4. Click "Inbox Options".

  5. Click the "Delete" button.

  6. Select "Delete selected messages" from the "Delete Option" drop-down list.

  7. Select each message you want to delete using the check box on the right-hand side of each message tile.

  8. Click the "Yes, Delete" button.

Deleting Messages for a Time Period

  1. In the GAP Portal, click "Devices" from the banner menu.

  2. Click on the device whose messages you want to delete.

  3. Under the "Context" section, click "Inbox".

  4. Click "Inbox Options".

  5. Click the "Delete" button.

  6. Select "Delete messages for interval" from the "Delete Option" drop-down list.

  7. Select the start and end date and times for the period using the "Start Date" and "End Date" pickers respectively.

  8. Type 'delete' (without the single quotes) into the confirmation text box.

  9. Click the "Yes, Delete" button.

Outbox

The Outbox displays messages that GAP has sent to the device (MT Messages).

user-lock

Access to the inbox requires the Show Device Outbox permission.

Only devices of types that support MT messaging will have an outbox.

Viewing the Outbox

  1. In the GAP Portal, click "Devices" from the banner menu.

  2. Click on the device whose outbox you want to view.

  3. Under the "Context" section, click "Outbox".

Filtering the Outbox

  1. In the GAP Portal, click "Devices" from the banner menu.

  2. Click on the device whose outbox you want to view.

  3. Under the "Context" section, click "Outbox".

  4. Click "Outbox Options".

  5. To show outbox messages sent between a specific period, select a start and end date using the "Start Date" and "End Date" date and time pickers.

  6. Click the "Reload Messages" button.

Exporting Outbox Messages

To perform a one-off export of MT messages:

  1. In the GAP Portal, click "Devices" from the banner menu.

  2. Click on the device whose outbox you want to view.

  3. Under the "Context" section, click "Outbox".

  4. Click "Outbox Options".

  5. Filter the inbox as required (see Filtering the Outbox).

  6. Click the "Export" button.

  7. Save the file when prompted by your web browser.

Device Log

The Device Log is an audit trail of activity relating to a device. It typically stores the following kinds of information:

  • Event notifications that have been triggered by the device

  • Actions performed on the device (such as acknowledging an emergency, assigning the device to another user, etc.)

  • Ad-hoc text notes

Viewing the Device Log

  1. In the GAP Portal, click "Devices" from the banner menu.

  2. Click on the device whose log you want to view.

  3. Under the "Context" section, click "Device Log".

Filtering the Device Log

  1. In the GAP Portal, click "Devices" from the banner menu.

  2. Click on the device whose log you want to view.

  3. Under the "Context" section, click "Device Log".

  4. Click "Device Log Options".

  5. To show log messages sent between a specific period, select a start and end date using the "Start Date" and "End Date" date and time pickers.

  6. Click the "Reload" button.

Exporting the Device Log

To perform a one-off export of MT messages:

  1. In the GAP Portal, click "Devices" from the banner menu.

  2. Click on the device whose log you want to view.

  3. Under the "Context" section, click "Device Log".

  4. Click "Device Log Options".

  5. Filter the inbox as required (see Filtering the Device Log).

  6. Click the "Export" button.

  7. Save the file when prompted by your web browser.

Adding Text Notes

user-lock

This action requires the Add Device Log Notes permission.

  1. In the GAP Portal, click "Devices" from the banner menu.

  2. Click on the device whose log you want to annotate.

  3. Under the "Context" section, click "Device Log".

  4. Click "Add Note to Device Log".

  5. Enter a note in the "Note Text" text box.

  6. Click the "Add Note" button.

Last updated