Add Item

Users will see a varying degree of list items according to their account type and permission level, with up to a total of 20 creation options available to highest tier users. Because there is a varying degree of permissions, popular options will appear at the top of the create item panel in order to ease the use patterns for power users.

Add Address Book Entry

Address Book Entries are similar to Contacts, and are used only by supported devices. Users will be asked to provide the following information when creating an address book entry:

  • Address Book: Select from a drop down menu with the list of address books users have added to the portal
  • NAL Shout Short Code: Numerical value 30-99 that indicates the canned message order; specific to NAL devices
  • NAL Shout Contact Group: Textual value that indicated which contact group to assign this contact; specific to NAL devices
  • Name: Contact name
  • Email: Contact email
  • Phone: Contact phone number
  • Location: Contact location

Add Address Book

Users will be asked to provide the following information when creating an address book:

  • Name: Name the address book

Address books have no properties in the portal except for their names, as they are only used as container elements for Address book entries, so that users can reference their contents and associate different collections with different assets. Users can also have different permissions to access different address books, giving administrators and managers more control of their asset ecosystem.

Add Alert

Users will be asked to provide the following information when creating an alert:

  • Type: Related to the triggering criteria for the alert, as each triggering criteria can have multiple alerts
  • Name: How the user wants the alert to be identified in the portal. Users often choose names that would be found on the subject line of an email
  • Description: For standard alerts, this helps identify the nature of the problem, or gives insight as to the severity of the alert itself
  • Resolution Procedure: For alerts that will potentially be acknowledged by any portal operator, notes about how to respond to it can prove valuable in time-sensitive scenarios. Any text in the Resolution Procedure box will display on the Alert in the portal.
  • Photo: While not often used, some alerts might benefit from including a photo with instructions to supplement the resolution procedure
  • Alert applies to: Use this to specify which assets or asset groups can trigger it (limit by inclusion)
  • Exclude from Alert: Use this in conjunction with the above option if you wish to (limit by exclusion)
  • Filters: Applies any of the selected filters to the alert triggering criteria, allowing managers to control when automated triggering occurs
    • Time: Restrict alert trigger according to time of day
    • Date Range: Restrict alert trigger to only a specific period of time
    • Day: Restrict alert trigger to specific days of the week
    • Date: Restrict alert trigger to specific dates in the year
    • Week: Restrict alert trigger to specific weeks of the year
    • Speed: Restrict alert trigger to being above a certain speed
    • I/O: Restrict alert trigger according to a change in value of a specific input/output
    • Fence: Restrict alert based on whether it triggers inside or outside a geofence
  • Cooldown Period: Time between sending an alert notification and resending the same alert notification
  • Acknowledgement: Select yes if the alert is urgent and requires attention from an individual with portal access
    • If yes, Priority: when there are multiple Alerts visible in the portal, they will display in order of priority, where lower numbers appear first on the list.
    • If yes, Color: set a color for the Alert to distinguish it from others
    • If yes, Pop up alert in portal: determines whether or not the Alert notification will pop over the interface in the portal without being opened manually
    • If yes, Rename acknowledge buttons: the text in each box will replace the corresponding text on the two buttons that display in the Alert window. Users typically set these to some version of “under control” and “needs attention”
  • Notifications: Use this to determine the types of messaging to be sent for each alert, and who receives each type of message notification. This is typically only used for time-sensitive and safety-related alert triggers. If there are no contacts in the list, use the Add Contact form to create external Alert recipients.
  • Hide Alert notices on map: if yes, users will only see Alert notifications in the List Panel and Details Panel when they expand Assets.

Add Asset

Users will be asked to provide the following information when adding an Asset to the portal.

Main tab
  • Name: The name of the Asset that will display in the List Panel and anywhere else the application references the Asset
  • Device: Two drop-down menus to identify the Manufacturer and then the specific device
  • IMEI/Unit #/Device ID: Device specific identifier number (usually found on a sticker provided by the manufacturer; either on the box or device)
  • Sensitivity: Position grouping factor, with a default value of 50. The platform will group positions that are near one another to present a clean map interface. Any positions that are within (sensitivity value) meters of one another will be grouped together. Set this value to 0 to disable position grouping.
  • Icon: What the asset’s icon will look like on the main map interface. The Icon Set drop-down menu can be changed to display a number of other market-specific options for icons.
  • Color: The color the asset’s icon will appear on the main map interface
Groups tab

Select Asset Groups in which the device will be visible by clicking the box next to their names. Any Group with a green check mark next to its name will contain the new Asset.

Users tab

Select the Users for whom this Asset will be visible by clicking the box next to their names. The search box allows users to quickly find the specific names they wish to include, and the Select All/Select None buttons allow for quick filtering. Any User with a green check mark next to its name will be able to view and interact with the Asset.

Attributes Tab
  • General information
    • IMEI: International Mobile Equipment Identifier - unique device ID number used by networks
    • Serial number: Unique device identifier provided by the manufacturer
    • Software version: Operating system version
    • Notes: Open field
    • Photo: Allows photo of asset to be added
  • SIM information
    • ICCID: SIM card’s unique serial number
    • Phone Number: Number associated with the SIM
    • Pin Code: Open field for customer utilization
    • Pin Unlock Key: Open field for customer utilization
    • Provider: Carrier that provides service
  • Driver information
    • Mission: Name of the reason to log trips
    • Driver: Driver’s name
    • Phone Number: Contact info for the Driver
    • License Number: Driver’s license number
    • National Identity Card Number: Passport or other identifying document
  • Vehicle information
    • Fuel efficiency: Data entry by the user
    • Make/model: Make refers to the manufacturer, model refers to the product line
    • Purchase date: Date the organization acquired the asset
    • VIN: Seventeen alphanumeric characters that identify the specific vehicle
    • Plate number: License plate number(s) associated with the vehicle
  • Vessel information
    • Name: Vessel name
    • Call Sign: Radio broadcast identity
    • Flag of registry: Used to identify the ship’s origin country
    • IMO number: Format is usually IMO followed by seven digits
    • MMSI: Maritime Mobile Service Identity
    • Tonnage: Weight
    • Class: Type of vessel
    • Skipper: Captain’s information
Settings Tab
  • Out of service: Toggle yes/no
  • Draw lines between positions: Visualization in map views; toggle yes/no
  • Snap lines to roads: Visualization in map views; toggle yes/no
  • Use GPS corrected magnetic course: Toggle yes/no
  • Suppress emergency alerts: Toggle yes/no
  • Popup incoming text messages: Toggle yes/no
  • Message destination ID: Method for routing text messages between devices that do not support address books. Template is “{Destination ID}:{Message}”. A quick example is device A has an ID of “1” and device B has an ID of “2”, device A can send a message to device B by typing “2:hello device B”
  • Device password: Password to generate to mobile messages for authentication. Only specific devices require passwords for mobile terminated messages
  • Transmit encryption key: Encryption key for to-mobile messages, if device supports encryption and enabled
  • Hide information: Options to the user whether or not to hide the following information on position reports and logs
    • Accuracy
    • Address
    • Altitude
    • Heading
    • Speed
    • History flag icons
  • Spatial reference system: Select from a drop-down list of the sources of geolocation data
  • Clear asset history: Users can clear data reported by the asset
  • Current status information: Displays yes, no, or unknown as a status indication for each of the following pieces of information (requires the Asset to report this information) - also displays in the Asset’s Status update logs
    • Moving
    • Engine on
    • Speeding
    • Idling
    • Towing
    • Dwelling
    • In low power mode
    • On backup power
    • Antenna cut
    • GPS jammed
    • Cell jammed
    • Immobilized

There are two buttons at the bottom of the Settings tab, to Reset the Status of the Asset and to Refresh the values of the Asset’s Status.

I/O Tab
  • Analog tolerance Voltage variance on remote terminal I/O pin to trigger a level change
  • I/O mapping template: Select from a drop down of templates in the portal, or manage templates to create one
  • Input - analog pin: Users have the option to manually insert the I/O map for the device
Driver Tab

The Driver tab gives users control over which Drivers can be assigned to the Asset, and which ones can log in as Drivers. The Driver information section pulls the most recently reported Driver information, and also gives users the ability to set a current Driver status. To set Driver Status, click the Current Driver Information button at the bottom of the tab.

Alerts Tab

The Alerts tab displays all of the Alerts that have been configured using Asset-specific triggers from the selected Asset. These are typically Alert events that require manual actions, like pressing an emergency button on a device, or activating some kind of device-specific emergency protocol. Users can view, edit, and delete all of these Alerts directly using inline buttons on each Alert entry.

Garmin Tab

The Garmin tab will populate for any Garmin Asset, and includes drop-down options for Quick Message templates, and multiselect boxes for Garmin Forms. The tab gives users control over which forms the device has access to, and helps users manage the Quick Message templates that the device employs.

Contacts Tab

For phones and other devices that support text messaging routed through the portal, the contacts tab will display multiselect boxes to give users control over which other Assets in the portal the selected device will be able to message. The selected Asset will be able to send messages through the portal to any Asset with a green check box next to its name.

Add Asset Group

Users will be asked to provide the following information when creating a group:

  • Main
    • Name: Set the asset group name
    • Color: Set the display color for the asset group
    • Parent: If the group is a subgroup, select the parent group
    • Message destination ID: Method for routing text messages between devices that do not support address books. Template is “{Destination ID}:{Message}”. A quick example is device A has an ID of “1” and device B has an ID of “2”, device A can send a message to device B by typing “2:hello device B”
  • Users: Select the users that will have access and visibility for this group from a drop-down list
  • Assets: Select the assets that will be put in this group from a list

Add Canned Message

Users will be asked to provide the following information when creating a canned message:

  • Canned Message Group: If the canned message will be sorted into a category or group, select from list
  • Index: Numerical value 0-999 that indicates the canned message order
  • Label: Short text label to select the canned message on the remote device
  • Message: Text you wish to have in the canned message
  • NAL Shout Short Code: Numerical value 30-99 that indicates the canned message order; specific to NAL devices

Add Canned Message Group

Users will be asked to provide the following information when creating a canned message group:

  • Name: Name of the canned message group

Canned message groups have no properties in the portal except for their names, as they are only used as container elements for canned message entries, so that users can reference their contents and associate different collections with different assets. Users can also have different permissions to access different canned message groups, giving administrators and managers more control of their asset ecosystem.

Add Contact

Users will be asked to provide the following information when creating a contact:

  • Name: Contact name
  • Type: Email, free SMS, or paid SMS
  • Email address: If email selected, the email address you wish to associate with this contact
  • Phone information: If SMS selected, country code, number, and provider information
  • Emergency contact: If the contact is to be used as an emergency contact in the system, click yes
  • Emergency notification rate limit: Restricts message notifications to this contact to once every
  • Rate limit: Restricts non-emergency message notifications to this contact to once every
  • Notification language: Language to display for notification data details
  • Notification speed display: Choice of units of measure
  • Lat/Lng format: Choice of display method
  • Fuel units: Choice of units of measure
  • Timezone: Timestamps for events to appear in this timezone
  • OpenPGP Key: Used to encrypt the messages sent from the portal for additional security, for details on how to configure these keys and set up encryption: https://www.gsattrack.com/wiki/OpenPGP.ashx?HL=openpgp

Add Driver

Users will be asked to provide the following information when creating a Driver:

  • First name: Driver first name
  • Last name: Driver last name
  • Username: Driver username for login
  • Password: Driver password for login
  • Duress Password: To be entered to alert managers of dangerous situation, such as hijacking
  • iButton ID: Identification number printed on the iButton ID, if using iButton logins. Some devices require a 12 byte ID (not including the checksum) and others require the entire 16 byte ID. Check with the specific manufacturer to confirm which is required.
  • Phone Number: Driver phone number
  • Blood Type: Driver blood type (in case of emergency/unconscious)
  • License Number: Driver’s license number
  • License Expiration: Driver’s license expiration date
  • License Restriction: Driver’s license restriction code(s), ie: Glasses, night
  • Manager: Driver’s manager
  • Emergency Contact: Driver’s emergency contact name
  • Emergency Contact Number: Driver’s emergency contact phone number
  • Photo: Of the Driver or documentation such as licenses

Add Driver Status Template

Use this to create simple options for Drivers to choose from the interface on their reporting devices. The most common status template options are active, off duty, resting, delayed, delivering, waylaid, and in distress. Users will be asked to provide the following information when creating a Driver status template:

  • Status: Define the status indicator
  • Is Log Off?: Indicates that this status means the Driver is inactive. If there are multiple off duty statuses, this field must be checked for each Repeat above as many times as the user wants options for the template

Add Garmin Form - IDP Devices

Use Garmin Forms support to create pre-defined fields and input restrictions to ensure a common message format and templates delivered from the field for your application. The supported form fields include: Numeric, Text, Date, Time, Single Select List, Multi Select List, and Stops. Each of the form fields can have additional limitations or requirements assigned to them, and also mark them as required or optional input form fields. The Garmin Forms designer is built directly into the portal interface, and updates to the Garmin Forms are transmitted over the air to the remote devices. You can assign multiple Garmin Forms per remote device, under the Edit Asset configuration panel. Completed forms are displayed in the portal under Events if you are monitoring the live interface, or they can trigger Alerts behaviors as well.

Add Gateway Account

Gateway accounts are special, and correspond to specific hardware types that have been integrated with the portal. Users will be asked to provide the following information when creating a gateway account:

  • Account Type: Users will choose the device type for which they are making a gateway account. Device types:
    • Garmin telematics
    • Iridium directIP
    • Inmarsat OnNet SMS
    • IsatData Pro - Skywave
    • IsatData Pro - Inmarsat
    • IsatM2M - Skywave
    • LongTimeTracker
    • SPOT
    • TRAXxs
    • ViaSat Mobile Satellite Services (MSS)
    • Yellowbrick
  • Access ID/Username: Used for logging in
  • Password: Used for logging in
  • Description: Displays in the portal when the Gateway is chosen
  • Solution Provider ID: User must get this information directly from the Gateway provider

Add Geofence

Users will be asked to provide the following information when creating a geofence:

  • Main category
    • Name: Name the geofence
    • Description: Description of the geofence
    • Color: Set the display color of the overlay for the geofence
    • Do not synchronize with assets: Disables the automatic synchronization of this geofence with remote assets. By default, when you create a geofence plus an alert, and the remote devices supports geofence calculations, the geofence will be sent to the remote device.
    • Add segment/shape: Click the map to create the geofence
    • Segments: List of existing geofence area(s) and the ability to delete those shapes
  • Users: Opens a drop-down menu with a list of portal users and their access to the geofence.
  • Extra: Allows users to add a photo to the geofence.

How it Works: Drawing Geofences

Custom Shape

Adding Segments to Geofences as part of the creation process requires users to click the Map to create custom shapes or circles. To create a custom shape, select the polygon tool and click points on the Map until you’ve made a complete shape.

Circle

Adding circular Segments to Geofences requires the user to click two points on the Map. The first point is the center of the circle to be added as part of the Geofence, and the second point is the radial edge of the circle. The circle will complete itself around the center point based on the radius drawn.

Multiple Segments

Users can add as many Segments as they wish to form one complete Geofence, and these segments can be any combination of polygon or circular areas. Any overlapping space in the Segments will not display as separate areas in the final Geofence. Only the outer lines will display.

Add I/O Mapping Template

I/O mapping templates will vary drastically depending on the device type for which they are being configured. Users will select their device type from a drop-down list, and then will see data input fields relevant to that device. The I/O mapping template for the GSatMicro has been included below as an example. When configuring a GSatMicro I/O mapping template, users will be asked to provide the following information:

  • Pin Label: Text field to describe the field. This will be displayed in reports
  • Unit: Unit of measure, such as L, kg, lb, etc. This will be displayed in reports
  • Factor: Mathematical factor to multiply the received value by
  • Behavior:
    • Fuel level
    • Fuel consumed
    • Odometer
    • Weight
    • Engine RPM
    • Power take-off (PTO)
    • Battery voltage
    • Battery percentage
    • Altitude
  • Full value: For analog input monitoring, enter the “amount when full”
  • Fuel capacity: For tank level monitoring, enter the capacity of the tank(s)
  • Max weight: For weight/scale monitoring on an analog input, enter the maximum value. This is not necessary for digital inputs.

Add a Journey

Users will be prompted to provide the following information when creating a Journey:

  • Name: the name to be assigned to the Journey, will be displayed in the Journeys interface
  • Asset: choose the asset that will be providing the data for the Journey
  • Description: optional, will not be displayed in the interface
  • Color: select a color for the Journey to be displayed in the list panel
  • Status: enabled/disabled toggles the Journey’s viewability in the list panel; Disabled Journeys will not appear in the Journeys UI or anywhere in the portal

As part of creating a Journey, users will be prompted to add Trips to them, and each Trip is a collection of position history for the Asset selected above. Each Trip may include any number of position reports greater than 0, and there is no limit on the number of Trips a user can include in a Journey. Users may opt to add multiple Trips that do not have sequential start or end points, and they will be displayed without a connecting line between them.

The Add Trip section of the form will prompt users for the following information:

  • Name: the name to be assigned to the Trip, will be displayed in the Journeys interface
  • Date Range of Data: Begin references the earlier of the two endpoints in the date range and End references the more recent of the two endpoints in the date range for the trip. Date Range can be as little as minutes, and as long as the user chooses.
  • Display Options: users will choose whether to show the Trip as a single segment with only start and end points, or if they wish to display all of the individual points between the start and end points
  • Status: enabled/disabled toggles the Trip’s viewability in the list panel; Disabled Trips will not appear in the Journeys UI or anywhere in the portal

After Trips have been added to a Journey, they will be listed in the bottom section of the Add Journey form. From here, users can manage these Trips, correct any errors, and can edit them by selecting the pencil icon on the left, or delete them by selecting the trash can icon on the right.

Add Map Layer

Users will be asked to provide the following information when creating a map layer:

  • Name: Name the map tile
  • Type: Select the type of map file from a drop-down options list
    • Keyhole Markup Language (KML)
    • Tile layer
    • GeoJSON
    • GPS exchange format (GPX)
    • Image overlay
    • Web Map Service (WMS)
  • File: Upload the map file
  • Enabled by Default: Should this map layer be available to all users

Preview: Unique to this add functionality is the ability to test the new map layer before adding it to the portal. Clicking Preview will show the user what the interface will look like with the new layer enabled. Add Map Layer: When finished, clicking this button will push the map layer to the portal

Add Place

To create a place, users must first find the place and identify it to the portal (either by clicking a location on the map, looking up the address, or inputting the location coordinates), and then users will be asked to provide the following information when creating a place:

  • Name: Default name is the address
  • Description: Add a description of the place
  • Color: Set the display color for the icon on the map and the text in the second panel
  • Users: Assign the place to users so it is visible to those users
  • Extra: Contact (attach a contact to the place)
  • Extra: Photo (upload a photo)
  • Extra: Unique key for customer reference

Add QM From Template

Device-specific feature. Users will be asked to provide the following information when creating a quick message from template:

  • Name: Message template set name
  • Device: Choose from the following options
    • Skywave IDP 6xx
    • Skywave IDP 780/790
    • Skywave IDP 782
    • Skywave IDP 782 cell
    • Skywave IDP 8xx
    • Skywave M2M
    • Skywave SG 7100
    • Skywave ST 6100
  • Quick Messages:
    • Message: Message content
    • Type - Basic: Text Message (most common)
    • IDP Devices with a Garmin screen also support:
      • Advanced - Lua Chunk: The remote device will run the provided Lua command
      • Help: Trigger a help request
      • Refuel: Request refuel information and transmit
      • Status: Get the IDP system status
      • Pause: Disconnect the Garmin FMI interface. This is used only when you need to connect a local RS232 port to the IDP device to load firmware/agents
      • Factory: Trigger a factory reset of the Garmin screen
      • Response: Query user for additional text

Add QM To Template

Device-specific feature. Users will be asked to provide the following information when creating a quick message from template:

  • Name: Message template set name
  • Device: Choose from the following options
    • Skywave IDP 6xx
    • Skywave IDP 780/790
    • Skywave IDP 782
    • Skywave IDP 782 cell
    • Skywave IDP 8xx
    • Skywave M2M
    • Skywave SG 7100
    • Skywave ST 6100
  • Quick Messages: Actual message content

Add New User

Users will be asked to provide the following information when creating a user:

  • First name: User’s first name
  • Last name: User’s last name
  • Username: This will be used for login purposes, most usernames are the user’s email address
  • Email address: User’s email address
  • Password: Give the user a password that they can change after their first login
  • Confirm Password: Re-enter the password to ensure proper spelling and characters
  • Two-factor authentication: Set up by default or allow users to set it up themselves
  • Type: Refer to user profiles above for user types
  • Preferences: These will populate platform defaults, configurable in the admin panel, but can be changed at the user level to accommodate the needs of diverse organizations
  • Permissions: Defaults to a subset of permissions for each user type, but can be customized to create flexibility in user types, allowing for more complex hierarchies
  • Assets and Groups: Assign assets or asset groups to the user so that they can see and interact with them
  • Geofences: Assign geofences to the user so that they can see and interact with them
  • Places: Assign places to the user so that they can see and interact with them
  • Contacts: Assign contacts to the user so that they can see and interact with them
  • Drivers: Assign Drivers to the user so that they can see and interact with them

Add User Email Template

Users will be asked to provide the following information when creating an email template:

  • Name: Name of the email template
  • Subject: Subject line for the email
  • Body: Content of the email

Variables can be used for templates through the portal, those available variables are: Variable | Example — | — ProductTitle | GSatTrack FirstName | John LastName | Smith Username | jsmith Email | jsmith@example.com Password | jSm1tH AssetList | <ul><li>Asset One</li><li>Asset Two</li><li>Asset Three</li></ol> AssetGroupList | <ul><li>Group One</li><li>Group Two</li><li>Group Three</li></ol> FenceList | <ul><li>Fence One</li><li>Fence Two</li><li>Fence Three</li></ol> PlaceList | <ul><li>Place One</li><li>Place Two</li><li>Place Three</li></ol> PermissionsList | <ul><li>Can add/edit/delete authorized assets</li><li>Can add/edit/delete alerts</li><li>Can add/edit/delete geofences</li></ol> SiteUrl | www.google.com