# TMX Insight™ Service Platform 2.5 User Guide

# 1 Preface

This guide is primarily intended to give the user administrator a comprehensive understanding of the ThingsMatrix Service Platform. The Platform represents the ThingsMatrix Service Platform.

# 2 Overview

The Platform enables IoT solutions with its modular approach in design and deployment. The Platform consists of four main components: IoT Gateway (IOTGW), Device Management Platform (DMP), Connectivity Management Platform (TMX Connect™) and Control Management Center (CMC). Each component can also be deployed independently based on the service requirements.

IOTGW handles device communication and interprets protocol and data.

DMP handles device and session management, data collection, storage, and reporting.

TMX Connect™ integrates with mobile operator networks and provides overall SIM management features such as SIM status management, session management and usage reporting.

CMC is a core component which provides user management and centralized control features via a web UI interface. It also provides API services which contain all necessary business logic.

Based on a user's requirements, each deployment can have various components and features. Throughout those components, the whole system provides the following features:

  • Organization Management Service
  • Connectivity Management Service
  • Asset Management Service
  • Data Management Service
  • API Services

# 3 Browser Compatibility

# 3.1 Supported Browsers

The Platform currently only supports Chrome and Firefox.

# 4 Supported Devices

# 4.1 Device Models

IoT Gateway is responsible for device communication via TCP or TLS. Different protocols are supported and used for the communication with each unique device model. The IoT Gateway currently supports the following ThingsMatrix approved devices:

Version Model Description
1.x TMA01 Logistics Tracker (2G, LTE)
TMA11 Detachable Sensor Hub for TMA01
TMX06 Tracker (2G)
TMX07 Tracker (LTE Cat-M)
TMM01 Certified 3rd party devices
2.x TMX08 Collector Tracker (Cat-M)
TMF01 Fibocom IoT Modules (NL668, MT910, etc)
TMY01 Tracker (2G, Cat-M)
TMY02 Tracker (2G, Cat-M, NB)
TMX09 Tracker (2G, Cat-M, NB)
TMY07 Tracker (2G, Cat-M, NB)
TMY09 Tracker (2G, Cat-M, NB)
TMY03 Tracker (2G, Cat-M, NB)
TMY05 Tracker (2G, Cat-M, NB)
TMX01 Tracker (2G LTE Cat-M)
TMX02 Tracker (2G LTE Cat-M)
TMX03 Tracker (2G)
TMX04 Tracker (2G LTE Cat-M)

# 5 Get Started

Every new user who wants to utilize the Platform, needs to provide following information in order to initiate company registration and deployment:

  • Company name
  • Unique name or Code (Used in domain URL)
  • Main contact email address (Unique)
  • Email domain (Multiple, by default it uses the email domain from main contact)
  • Selected Services

Once the request has been received by ThingsMatrix and a service contract is signed, ThingsMatrix is responsible for creating a new company in the Platform. Meanwhile, an email with the login URL, username and password will be sent to the email address of the main contact person. The user then can log in to the Platform with the given information.

# 6 Sign In

Click the login URL to go to the login portal, then enter username and password.

Once the user has logged in successfully, it enters the Home page. There is a navigation bar on the left side and a map to show devices' locations as shown below:

Currently it is in Filter Mode. Users can filter the devices by selecting a model name, a group name or status.

By configuring a data variable, the corresponding data will display in the list and also above the location points of devices. If the corresponding data has not been generated yet, it will display as "--".

As mentioned above, a device list is on the right side to show more detailed device information for each device in the visible area, including alias, serial number, model name, group name, locating type, detailed address and corresponding device data if configured.

Click the serial number of the device to go to its detail page to view more information.

Authorized users can easily reset or restart a specific device if available by clicking the Reset button or Restart button.

Click the Search button, it enters Search Mode. Enter at least three digits of serial number, and select the desired serial number, then click the Search button to locate the specific device.

For convenience, authorized users can also set a targeting point on the map. So that it will display the map with the targeting point as the center every time after logging in. Simply right click the place where you would like to set as the targeting point on the map, and click the Targeting point setting button, the specific place will be set as the targeting point.

Right click the existed targeting point to delete it, or right click another place to set another new targeting point.

The statistics and locations of devices will refresh if new location data is reported to the Platform.

# 7 Organization Management Service

# 7.1 Feature Description

The Platform provides an Organization Management feature for each company separately, which allows a user administrator to create its own organizational structure and manage users through the organization menu. Based on all user information, the Platform uses role-based access control for all static configuration and applies user access control in order to share device telemetry data for each individual.

The Organization Management service consists of four parts:

  • All Users
  • Department
  • Team
  • Role management

# 7.2 All Users

For user management, user access control is applied. By default, a normal user can only view the Device List, but is not allowed to view device data. The privilege of viewing device telemetry data is controlled within each device group. Only the user who has been authorized can access data via the GUI or API. A company administrator automatically has the access to all data.

By clicking the All Users tab, the User List and Pending User List are shown as below. If can’t access to the All Users part, please make sure the organization management service is purchased and valid for the user administrator account. In the section of User List, the user administrator has the privilege to add and delete users, as well as view and modify the information of all level of user roles. In the Pending User List section, the user administrator can invite new users, view the user information of those who are applying for access to the Platform, and perform operations on them.

The Platform provides three methods to add a user:

  1. The user administrator can enter all user information and add the user directly. Temporary password is shared via email. Please refer to 7.2.1 Adding new users section below.
  2. The user administrator can invite the user via an email address, and the user can then accept the invitation and complete the registration with an invitation code. Please refer to 7.2.3 Inviting new users section below.
  3. The user can enter a valid email address to complete the sign up process via a web page. The process will generate an invitation code and send it to the user's email address. Please refer to 7.2.5 New user registration section below.

After a user completes the registration process, the user can log into the Platform with his username and password. The user administrator can change the user role later. Every user can modify the password via account center and the user administrator can reset a user's password from the User List. A user can also generate an API token in account center if he needs to get access to the API of the Platform.

# 7.2.1 Adding new users

By clicking the + button in the User List section, an Add User window will pop up, and the user administrator can then add a new user account.

To assign specific device group access to the new user, select the device groups in the "Device group permissions (Own)" field. It means that the new user can view all device data of the selected device groups: "tmx08_periodic_30m" and "tmx09_motion_10m", for example as below. After filling in the form, click the Submit button to add a new user.

# 7.2.2 Managing users

By choosing one of the users and clicking the Actions button, a list of available actions will be displayed. The user administrator can then click the Modify button to modify the information of an added user. The Enable/Disable button can help the user administrator manage the user accounts by activating or deactivating them. By clicking the Reset Password button, the user administrator can reset the password of users. The Delete button can help the user administrator delete users.

  • Modifying users

    Click the Modify button, an Edit User window will pop up as below, and the user administrator can modify the user information.

    If the "Device group permissions (Inherited)" field is not empty, it means that the user is permitted by his own department or team to access the device data of the specific device groups: "tmy05_motion_30m" and "tmy07_periodic_1h", for example as below. To modify this field, please refer to 7.3.1 Adding new sub-departments, 7.3.2 Modifying sub-departments, 7.4.1 Adding new teams and 7.4.2 Modifying teams sections. After the modification of the user, click the Submit button to apply the changes.

  • Disabling users

    Disabled users cannot log into the Platform or use API services. By selecting a user and clicking the Disable button, the user account will be disabled. An example is outlined below:

  • Enabling users

    Enabled users can log into the Platform and have access to API services. By selecting the user and clicking the Enable button, the user account will be enabled as outlined below:

  • Reset Password

    By clicking the Reset Password button, the password of the selected user will be reset. An email will be sent to the selected user's email address, together with the new password for him to use during login.

  • Deleting users

    Please note: The user needs to be removed from both his own department and team if he has before he can be deleted. Also, the user needs to be disabled following instructions provided previously. After the user has been disabled, please click the Delete button, and the selected user account will be deleted from the Platform.

# 7.2.3 Inviting new users

By clicking the + button in the Pending User List, an Invite User window will pop up. The user administrator can enter the email address of the user that he wants to invite. After clicking the Invite button, a verification email will be sent to the email address. The user can then register on the Platform following instructions found within the verification email. Please note: The invitation code can be found in the verification email.

# 7.2.4 Pending user operations

The user administrator can view invited users' registration status, reinvite and delete pending users.

# 7.2.5 New user registration

The user can enter a valid email address to complete the sign up process via the portal registration page. The valid email address should match one of the names in the company email domain list. Click the Sign Up > button to go to the registration page.

Enter the user‘s valid email address, and then click the Sign Up button.

Fill in the registration form, and click the Sign Up button. Please note: The invitation code can be found in the verification email.

The user has registered successfully on the Platform. Enter username and password, and click the Login button to log in.

# 7.3 Department Organization

To organize department structure, click the Department tab. The user administrator can create separate sub-departments to assign different data access to users. Once the first level sub-department is created, the user administrator can add, modify and delete sub-departments if needed.

# 7.3.1 Adding new sub-departments

To create a sub-department, the user administrator needs to select the parent department, then click the Action button, and click the Add Sub-department button.

An Add Sub-department window will pop up, please enter a name for the department. To assign specific device group access to the new department, select the device groups in the "Device group permissions (Own)" field. It means that all the users of this department can view all device data of the selected device groups: "tmy02_periodic_15m" and "tmy05_always_1h", for example as below. After filling in the form, click the Submit button to add a new sub-department.

# 7.3.2 Modifying sub-departments

By selecting one of the departments and clicking the Action button and the Modify button, a Modify Sub-department window will pop up for the user administrator to modify the sub-department.

If the "Device group permissions (Inherited)" field is not empty, it means that all of the users who belong to this department are permitted to access the device data of the specific device group: "tmy05_always_1h" and "tmy02_periodic_15m", for example as below. Please note: The device group permissions are inherited from its sub-departments. To modify this field, you need to modify the sub-departments of this department. After the modification, click the Submit button to apply the changes.

# 7.3.3 Deleting sub-departments

The user administrator can simply select one of the departments and then click the Delete button to delete it. The sub-department will be deleted and the department information of the account will also be removed. Please note: If you do so, it will also delete all the sub-departments below it. However, it will not remove the members' accounts linked to it.

# 7.4 Team Definition

For flexibility, the user administrator can define teams for users from different departments and assign different data access to them. Teams has no organizational architecture.

# 7.4.1 Adding new teams

Click the + button, an Add Team window will pop up for the user administrator to add a new team by entering a team name and define a team member list.

To assign specific device group access to the new team, select the device groups in the "Device group permissions (Own)" field. It means that all the members of this team can view all device data of the selected device groups: "tmx06_periodic_30m", "tmx07_periodic_2h" and "tmx07_schedule_15m", for example as below. After finishing the form, click the Save button to create a new team.

# 7.4.2 Modifying teams

If the user administrator wants to modify the team, he can select the team and then click the Modify button to edit the team's name, assign different device group permissions and rearrange the team members.

After the modification, Click the Save button to save the changes.

# 7.4.3 Deleting teams

The user administrator can delete a team as well as remove the members from the team by clicking the Delete button. Please note: This operation will not remove the members' accounts within the team from the company.

# 7.5 Role Management

The Platform applies role-based access control to manage user roles. There are two default user roles setup internally, which cannot be modified or deleted:

  • Company Admin
  • Normal User

By default, Company Admin has the privilege to manage all objects and configuration within his own company, such as add or delete devices. Normal user can only view the Device List, but is not allowed to view device data. The privilege of viewing device telemetry data is controlled within each device group. Only an authorized user can access that data via the GUI or API. Company Admin automatically has the access to all data.

The user administrator can authorize different roles for different levels of access.

# 7.5.1 Adding new roles

Click the + New button, the user administrator can create a new role by filling in the Add Role form.

# 7.5.2 Managing roles

Select one of the user roles and click the Actions button, it will show the list of different actions the user administrator can do.

  • Modifying roles

    The user administrator can modify roles by clicking the Modify button. A Modify Role window will pop up, and the user administrator can rename the role and modify owned permissions of it.

    After the modification, Click the Submit button to save the changes.

  • Deleting roles

    Select a user role first, and then click the Delete button to delete a user role. Please note: The user administrator needs to make sure that there is no associated user of the role, or he will not be able to delete it.

# 8 Connectivity Management Service

# 8.1 Feature Description

Connectivity Management Service is used to manage SIM cards distributed from mobile network operators. The Platform supports two types of SIM cards:

  1. User-supplied SIM cards
  2. ThingsMatrix-supplied SIM cards

For user-supplied SIM cards, Connectivity Management Service is responsible for SIM card inventory management. For ThingsMatrix-supplied SIM cards, the Platform is integrated with the MNO's service API in order to retrieve SIM card information and real time session status. Based on the MNO's SIM usage report, Connectivity Management Service is capable of providing a summary report on SIM card usage in the View of SIM card data. Please note: In current release, the connectivity data statistics only supports AT&T and ARM SIM card types.

# 8.2 ThingsMatrix-supplied SIM Cards

The user administrator can view SIM card historical and statistics data as well as export the SIM card list in Excel and CSV formats.

# 8.2.1 Viewing SIM card usage summary

By clicking the View button in the Data column, the corresponding SIM card usage data will be displayed. You can check historical data and statistics data by selecting the start date and end date.

# 8.2.2 Exporting SIM card list

By clicking the Export button, an Export window will pop up. Choose a format and click the Export button to export SIM card list.

# 8.3 User-supplied SIM Cards

The user administrator can view SIM card historical and statistics data, as well as import new SIM cards and export the SIM card list in Excel and CSV formats.

# 8.3.1 Adding new SIM cards

Click the + New button and a New SIM Connectivity window will pop up.

Fill in the form and click the Submit button to add a new SIM card.

# 8.3.2 Importing new SIM cards

By clicking the Import button, an Import window will pop up. By choosing CSV or Excel format, a corresponding template will ask to be downloaded.

After downloading the template, the user administrator can then fill in the form. Click the Browser button to select the file.

Click the Import button to upload the file and import the SIM cards into SIM card list.

# 8.3.3 Exporting SIM card list

By clicking the Export button, an Export window will pop up. The user administrator can then choose to get the SIM card list exported in Excel or CSV format.

# 9 Asset Management Service

# 9.1 Feature Description

This service is responsible for the overall management of devices and sensors. A device is a piece of equipment which has an MCU, Network Module, GPS and built-in sensors. A sensor hub is a standalone piece of equipment which connects to multiple sensors. It can be attached to a device, but it cannot communicate to the Platform independently. A sensor hub has its own serial number. Asset Management Tab provides a list of features for the authorized users to manage all devices and corresponding configurations. The Asset management service has seven parts:

  • Device Management
  • Device List
  • Report
  • Event
  • Alarm
  • Command
  • Certificate

# 9.2 Device Management

In the Device Management section, the default device models are pre-configured by ThingsMatrix, thus users can not add, modify or delete these default device models here. User administrator can purchase more desired default device models from ThingsMatrix official website or by contacting ThingsMatrix. To support MQTT devices, the Platform provides custom models for users to add.

For a proprietary protocol model, Let's take model TMX08 as an example. Select model TMX08.

The basic information of the model is shown in the middle.

  • Data Schema

    Each proprietary protocol model has its own data schemas. Initially it only contains system schemas, which cannot be deleted. User administrator can extend schemas if desired. Please note: The data of extended schemas will be generated only if they have been configured and calculated in Flow feature. For more information, please refer to 10.3.3 Configuring flow components section.

  • Group

    Device Group is a logical component which includes a group of devices of the same model. Authorized users can manage some common properties of devices. In Group tab, it contains the basic information of the group and shows all the charts configured in Dashboard and set to be enabled in Settings for the selected device group. For more information, please refer to 10.2 Dashboard section and 12 Settings section. If dashboard display is enabled, you can view device group data.

  • Config Template

    Each device model has its unique configuration file, which is used to define the basic settings, firmware version, and ruleset of the device. During device registration and authentication, the device configuration file will be passed to the IoT Gateway and downloaded onto the devices. By default, a device group could have an empty configuration template. It means the device will use its default configuration settings. After applying a configuration template, the device will use the new configuration settings. If the template is changed, the new configuration is proactively issued to the online devices and applied. For offline devices, the new configuration will be issued and applied the next time the offline devices are connected to the Platform. The change would be applied to all devices in this group. For parameter configuration, please refer to the Parameter Table section in the corresponding device's ThingsMatrix Device Manual for further information.

  • Topic (Only for custom models applying MQTT protocol)

    To connect the Platform, an MQTT device needs to provide its client ID as its serial number and configure the corresponding broker URL, for example, "<company_name>.gw.thingsmatrix.io". Each custom model has several topics for communication between MQTT devices and the Platform. Thus a topic must be selected for the device to report data or receive configurations and commands. There are some pre-configured topics as shown below:

    Devices can publish "Device Information", "Data Report" and "Event" to the Platform. Meanwhile, devices can subscribe "Configuration" and "Command" from the Platform.

    • info

      A device will report basic information after it turned on or received related commands.

    • report

      A device will report real-time data based on different conditions. Assume that the device reports temperature as the real-time data, to receive and store its temperature data, an extended schema needs to be created on the Platform first. For more information about creating an extended schema, please refer to 9.2.4 Adding new extended schemas. After the temperature schema is created, here is an example reported by an MQTT device:

      {
          "temperature": 27.5
      }
      

      Please note: In current release, the Platform accepts data reported by MQTT devices in JSON format.

# 9.2.1 Adding new custom models

Authorized users can add new custom models to apply MQTT devices. Click the + button on the top right side, a New Model window will pop up.

Fill in the form and click the Save button to add a new custom model. Please note: The fields with * are required, while the others are optional. The user can also upload a device image of which size is smaller than 500 KB.

# 9.2.2 Modifying custom models

Select a custom model and then click the Modify button, a Modify Model window will pop up.

After modifying the model, click the Save button to save all the changes to the custom model.

# 9.2.3 Deleting custom models

Click the Delete button to delete the custom model. Please note: you need to delete all devices of the model first before you can delete it.

# 9.2.4 Adding new extended schemas

Click the Add button on the left side, a new empty form to create an extended schema will be displayed on the right side.

A field description will display when hovering the mouse over the Information icon. Fill in the form and then click the Add button on the right side to create a new extended schema. Please note: The unit can be customized if desired.

If the user would like to add a "boolean" type schema, its value description can be setup for better understanding.

After saving the schema, it will be displayed in the Latest Received Report section of the Last Report tab in the Device List for device model TMX08 as shown below:

Please note: The data of extended schemas will be generated only if they have been configured and computed in Flow feature. An example is shown as follows:

If more than a device schema is desired, follow the instructions above to add more device schemas.

# 9.2.5 Viewing schemas

There are some operations to help users view device schemas.

  • Search

    You can enter field identifier or title to search for a specific device schema.

  • Sort

    You can sort the schemas by dragging the Drag button, which takes effect to the schema order in Asset - Device List - Last Report and the field order in Asset - Device List - Report.

# 9.2.6 Modifying schemas

Click the specific schema card which you are desired to modify. After the modification, click the Save button to save the changes. Please note: "Identifier" and "Type" fields cannot be modified. If there are any unsaved changes, a red dot will be attached to the Save button as a reminder.

# 9.2.7 Enabling schemas

The data of enabled schemas will show on the Platform side and can be accessed via APIs. By checking the Enable checkbox and then click the Save button, the disabled schema will be enabled. The Eye icon will turn on after the operation.

# 9.2.8 Disabling schemas

The data of disabled schemas will not show on the Platform and cannot be accessed via APIs. The export report files exclude the related data. By unchecking the Enable checkbox and then click the Save button, the enabled schema will be disabled. The Eye icon will turn off after the operation.

# 9.2.9 Storing schemas

The data of storable schemas will be allowed to be stored by authorized users on the Platform. By checking the Store in database checkbox and then click the Save button, the non-storable schema will be storable. The Storage icon will turn on after the operation.

# 9.2.10 Unstoring schemas

The data of non-storable schemas will not be stored on the Platform. By unchecking the Store in database checkbox and then click the Save button, the storable schema will be non-storable. The Storage icon will turn off after the operation.

# 9.2.11 Deleting extended schemas

Click the Delete button to delete an extended schema. Please Note: System schemas cannot be removed. Users can delete extended schemas in use and all of the removed schemas will be marked as "invalid schemas" in Data.

# 9.2.12 Adding new groups

Select device model TMM01, enter Group tab, and click the + button, a New Group window will pop up.

Fill in the form and click the Save button to create a new group.

  • For "Config Template" field, the user administrator can assign a specific configuration for the new group. Please refer to Parameter Table section in the corresponding device's ThingsMatrix Device Manual for further information.

  • For "Push Notification" field, the user administrator can specify the URL to push notifications.

  • For "Notification" field, the user administrator can select desired category of reported data to push to the URL configured above.

  • For "Certificate" field, the user administrator can select desired certificate of authentication for safety purpose. (Only for specific models applying MQTT protocol) Please refer to 9.8 Asset - Certificate for further information.

# 9.2.13 Modifying groups

Select a specific group and then click the Modify button, a Modify Group window will pop up.

After modifying the group, click the Save button to save all the changes to the group.

# 9.2.14 Deleting groups

Select a specific group and then click the Delete button to delete the group. Please note: you need to empty the group first before you can delete it, that is, remove all the devices within the group.

# 9.2.15 Adding new templates

Select a device model, and click the + button in the Configuration Template list. A New Configuration window will pop up.

  • Default Model

    Each device model has its own configuration parameter settings. Please refer to the Parameter Table section in the corresponding device's ThingsMatrix Device Manual for further information.

    Let's take device model TMY07 as an example. Its own configuration consists of the following categories: "Working Mode Option", "Periodic Mode Settings", "Storage Mode Settings", "Motion Static Mode Settings", "Schedule Mode Settings", "Master Server Settings", "Firmware". Within each parameter category, hovering your mouse over one of the parameters, an explanation will be displayed. Each parameter has a default value, users can modify the value based on requirements. A description can also be added if needed. After the configuration, click the Save button to create a new configuration template.

  • Custom Model

    The user administrator can add a new template by uploading a configuration file in JSON format. Enter the name and necessary description and then click the Save button to create a new configuration template.

# 9.2.16 Modifying templates

Select a specific template and then click the Modify button, a Modify Configuration window will pop up.

  • Default Model

    After changing the parameter values, click the Save button to apply the new changes. If the template has already been applied to some groups, once the template is changed, the new configuration is proactively issued to the online devices in those groups and applied. For the offline devices within those groups, the new configuration will be issued and applied the next time the offline devices are connected to the Platform. The changes would be applied to all devices in those groups.

  • Custom Model

    The user administrator can modify the template by uploading a new configuration file in JSON format. Then click the Save button to save the changes.

# 9.2.17 Copying templates

By selecting a specific template and then clicking the Copy button, a New Configuration window will pop up.

  • Default Model

    The configuration template is exactly the same as the one the user chose. Enter a new name and description for the new configuration, then click the Save button to create a template. The user administrator can also modify the settings during the creation to apply some changes on the new configuration.

  • Custom Model

    The configuration template is exactly the same as the one the user chose. Enter a new name and description for the new configuration, then click the Save button to create a template. The user administrator can also create a new template by uploading a new configuration file in JSON format.

# 9.2.18 Deleting templates

Select a specific template and then click the Delete button to delete the template. Please note: A template can only be deleted when it isn’t applied by any groups.

  • Default Model

  • Custom Model

# 9.3 Device List

In the Device List section, authorized users can get detailed device information and also the data collected by the device. We have statistics for the data reported to the Platform, so the users can have a better understanding of the data trends.

A page with all added device information will show up as below:

From the list, we can find following device basic information:

  • Serial number: Each device will have one unique serial number for identification purposes.
  • Model: Device model name.
  • Alias: Device alias.
  • Group: Device group name in which the device belongs.
  • Status: Different working statuses of the device are as follows:
    • When a device is just imported from ThingsMatrix and hasn't connected to the Platform yet, it will show as "Inactive".
    • When a device has connected to the Platform, it will show as "Online".
    • When a device enters sleep mode, it will show as "Standby".
    • When a device is not working for a period of time (according to the user administrator’s timer settings), it will show as "Offline".
    • When a device is disabled by the users, it will show as "Disabled".
    • When a device's owner company is changed, it will show as "Suspended".
    • When a device is in tracking mode, it will show as "Tracking".
  • State: We have 4 states to indicate the device properties:
    • The first icon looks like a battery. If it is on, it displays the battery status of the device; while if it is off, it means the Platform does not received any battery data.
    • The second icon looks like a plug. If it is on, it means the device is connecting to external power; while if it is off, it means the Platform does not received any data of external power.
    • The third icon looks like a cell tower or a satellite, which represents the positioning features. If the cell tower icon is on, it means the device is sending LBS location data; while if the satellite icon is on, it means the device is sending GPS location data. However, If the icon is in grey with an X mark, it means the device is sending invalid location data. Actually the latest location displayed on the Platform is its last location data, this is, the real latest location is unknown.
    • The fourth icon looks like a warning. If the warning icon is on, the device is sending alarms to the Platform.

Besides basic information, there are reported data in the list. All the data columns here are configured by device schemas. Please Note: Disabled schemas and their values will not be displayed. When a device reports new data to the Platform, the latest data in the list will refresh automatically, including status, state and enabled schema values.

# 9.3.1 Adding new custom model devices

Before you can add a new custom model device, you need to create a group first. Please refer to 9.2.10 Adding new groups section above to get further information. Please note: Only custom model devices can be added manually through this way. All purchased default model devices will be imported into their default model groups by ThingsMatrix automatically. for example, all purchased TMX08 devices will be imported into "TMX08_DG" group.

After a custom model group is created, go to Asset - Device List section and click the + button on the top right. A New Device window will pop up.

Fill in the form and click the Submit button to add a new device. Please note: The fields with * are required, while the others are optional. For "SIM ICCID" field, users can choose to provide or not provide relevant information because the Platform will automatically collect this information. If the Auto Update checkbox is checked, the Platform is allowed to do additional updates after the information is initially populated, such as replacing the SIM card. If not, the Platform will reject the connection to the device if you replace the SIM card after the information is initially populated. You can also assign a specific alias, add tags and create customized attributes to the device.

You can see the newly added device.

# 9.3.2 Importing new custom model devices

The Platform provides device import feature. Click the Import button and an Import window will pop up. Please note: Only new custom model devices can be imported. Import up to 5000 devices at a time.

By choosing CSV or Excel format, a corresponding device information import template will ask to be downloaded.

After downloading the device information import template, the user administrator can fill in the form.

These are fields in the template:

  • SerialNumber, Group, Model are required fields:

    • SerialNumber: Unique identifier of the Device.
    • Group: The device group name to which the device belongs. Group must exist in the system first, and has a corresponding relationship with the model. If it is not, please add it to the system first.
    • Model: Model name of the device.
  • The remaining fields are optional:

    • Alias: Must be 1-30 characters, including the numbers 0-9, the letters a-z and A-Z, Chinese characters, the characters "_" and "-".
    • SimICCID: Must be 20 digits.
    • SensorSN: Sensor Serial Number. Must be 8-16 bit characters, including the numbers 0-9 and the letters A-Z.
    • SimAutoUpdate: 0 means non-automatic update, 1 means automatic with new. Default is automatic with new, empty means default.
    • SensorAutoUpdate: 0 means non-automatic update, 1 means automatic with new. Default is automatic with new, empty means default.
    • Description: Must be 1-200 characters.
    • Tags: Must be 1-50 characters, including the numbers 0-9, the letters a-z and A-Z, the characters "-", ".", "_", "@", "$" and blank space. The number of tags for a device does not exceed 20 tags and tags are separated by ",".
    • Attribute: The attribute is filled in by the header, such as "attribute:xx", which means adding an attribute whose name is xx. Must be 1-50 characters, including the numbers 0-9, the letters a-z and A-Z, the characters "-", ".", "_", "@", "$" and blank space.
  • Example:

    SerialNumber Alias Group Model Description Sim ICCID Tags Attribute.Address
    861901268000009 tmx07_0009 tmx07_20m TMX07 Device 1 San Antonio, Atlanta 9442 North Capital of Texas Hwy
    801046031113285 tmx08_3285 tmx08_2h TMX08 Device 2 San Antonio, Atlanta 9445 North Capital of Texas Hwy
    801046031097369 tmx08_7369 tmx08_1h TMX08 Device 3 San Antonio, Atlanta 9442 North Capital of Texas Hwy

Then click the Browser button to select the file, and click the Import button to upload the file to import the devices. if some errors occurred during the import, the error details will be displayed in the Import Log section.

# 9.3.3 Exporting devices

The user administrator can export devices by clicking the Export button on the top right. An Export window will pop up, then the user administrator can choose to get the Device List exported in Excel or CSV format.

# 9.3.4 Modifying devices

Select a device and then click the Modify button, a Modify Device window will pop up. Please note: Suspended devices cannot be modified.

After modifying the device, click the Submit button to save all the changes to the device.

Authorized users can also select multiple devices and then click the Modify button, a Batch Actions Device window will pop up.

After the modification, click the Submit button to save all the changes to the selected devices. Please note: The "Modify" checkbox need to be checked to apply the corresponding changes.

# 9.3.5 Batch update devices information

To batch update devices information, simply click the Import button and an Import window will pop up. Please note: Only added devices can be updated. Batch update up to 5000 devices at a time.

By choosing CSV or Excel format, a corresponding device information import template will ask to be downloaded.

After downloading the device information import template, the user administrator can fill in the form. Please refer to 9.3.2 Import new custom devices for details.

Then click the Browser button to select the file, and click the Import button to upload the file to batch update device information. if some errors occurred during the update, the error details will be displayed in the Import Log section.

# 9.3.6 Deleting devices

Select a device and then click the Delete button to delete a device. Please note: Only disabled, inactive and suspended devices can be deleted. If you happened to delete a default model device but would like it back, please contact ThingsMatrix. For custom model device, it can be added back manually by authorized users following the instructions of 9.3.1 Adding new custom model devices.

# 9.3.7 Commands on devices

Select the device(s), by clicking the Command button, the authorized users can perform commands on them, such as enabling, disabling, restarting and resetting. Some device models support additional commands such as snapshotting, tracking, etc. However, if an action item is in gray color, the corresponding command is not supported at the moment temporarily.

Below are the following commands that can be performed:

  • The Enable/Disable button can help the authorized users activate or deactivate devices as needed.
  • The Restart button allows the authorized users to restart the online device remotely.
  • The Reset button can help the authorized users reset devices.
  • The Snapshot button can be used to snapshot a device's location information.
  • The Track button allows the authorized users to track devices for a period of time.

Please note: You can select more than one device and click the Command button to issue commands to devices in batch.

Commands can also be performed In device detail page. Click the Command button and select a desired command to execute.

  • Disabling devices

    Disabled devices cannot connect to the Platform. Click the Disable button, and the selected device will be disabled, for example as below:

  • Enabling devices

    Only enabled devices can connect to the Platform. Click the Enable button, and the selected device will be enabled, for example as below:

  • Restarting devices

    The user administrator can restart the online devices by clicking the Restart button.

  • Resetting devices

    Devices can be reset by the user administrator. Please click the Reset button to reset the device.

  • Snapshotting devices

    Click the Snapshot button to snapshot a device. Please note: Snapshotting will not affect any working timers of a device.

  • Tracking devices

    Click the Track button and a Tracking Setting window will pop up.

    Fill in the Interval and Expiration fields and then click the OK button to track a device. For example, an authorized user would like to track a device in one hour and require the device to report location information every ten seconds. The configuration is shown as below:

    If the device is still online, the device will turn the status from "Online" into "Tracking". The tracking configuration is displayed when hovering the mouse over the clock icon.

    When tracking the device, user can still perform commands shown as below, such as restarting, resetting, snapshotting, stopping tracking, disabling the device:

    Please note: Tracking will not affect any working timers of a device, however, it will make an effect on the device working time, that is, make the device work longer. For example, the device is set to wake up every hour to report data. Let's say it is at 15:00:00 that the device will wake up, and it will turn into sleep state after 30 seconds. An authorized user performs a Tracking command at 15:00:10, setting the interval to be 10 seconds and the expiration to be 150 seconds. Then the Tracking command takes effect and the device will report data every 10 seconds in next 150 seconds. After that, the device will shutdown the Tracking command and remain working for 20 seconds due to its working timer - normally, it is supposed to be online for 30 seconds totally every hour. And the report interval will keep the same as it was before the Tracking command had been performed.

# 9.3.8 Viewing device details

The device details is only available for authorized users. When the authorized users select one of the added devices, the second half of the page will display more details:

  • Last Report
  • Statistics
  • Report
  • Dashboard
  • Event
  • Alarm

Click the Detail button, it will enter the device detail page.

  1. Last Report

    A device's serial number, alias, description, SIM card ICCID, tags and attributes are shown to all users in Information section. Authorized users can view the device's latest reported data in Latest Received Report section together with the location of the device in Location section. Please note: The order of the schemas in Latest Received Report section can be managed in Asset - Device Management - Schema. The latest data will refresh if new data is reported by the devices.

  2. Statistics

    Authorized users can view the chart of device's detailed historical data and the chart of statistics data by configured time range, data variable and granularity. A path map is also provided to show device's route records. By selecting a desired data variable, for example "Signal Strength", its historical data will display on the map. you can switch between "All", "LBS" and "GPS" to filter data reported in different locating mode. The Historical Data chart will refresh if new data is reported by the device.

  3. Report

    Authorized users can view the device's report records. Click the Export button to export filtered report records. Please note: The order of the fields can be managed in Asset - Device Management - Schema.

  4. Dashboard

    Authorized users can view all the charts configured in Dashboard feature and set to be enabled in Settings for the selected device group. For more information, please refer to 10.2 Dashboard section and 12 Settings section.

  5. Event

    Authorized users can view the device's event records. By clicking the Chart View button on the right side, the chart view of the device's event records will be displayed.

    The scroll bar on the top can help you specify the time range. Click the Table View button on the right side to go back to the table view.

  6. Alarm

    Authorized users can view the device's alarm records.

# 9.3.9 Customizing Device List columns

Click the Modify Column button and a Column Edit window will pop up.

You can select preferred columns to be shown or hidden. Move the fields into Show Column section or Hide Column section by clicking the Left/Right button.

You can also customize the orders of the columns by selecting a column and clicking the Up/Down button.

After you finished the customization, click the Save button to apply.

# 9.4 Report

In the Report section, authorized users can get detailed report records.

# 9.4.1 Viewing report records

Let's take device model TMY10 as an example. Select model TMY10.

All the report records of the devices whose model is TMY10 will be displayed. Please note: The order of the fields can be managed in Asset - Device Management - Schema. Authorized users can filter the records by specifying device serial number, selecting time range and device group.

# 9.4.2 Exporting report records

Authorized users can export report records by clicking the Export button on the top right. An Export window will pop up, and you can choose to get the report records exported in Excel or CSV format.

# 9.5 Event

In the Event section, authorized users can get detailed event records.

# 9.5.1 Viewing event records

All the event records will be displayed. Authorized users can filter the records by specifying device serial number, and by selecting time range, device model, device group and event codes.

By clicking the Chart View button on the right side, the chart view of the event records will be displayed.

The scroll bar on the top can help you specify the time range. Click the Table View button on the right side to go back to the table view.

# 9.5.2 Exporting event records

Authorized users can export event records by clicking the Export button on the top right. An Export window will pop up, and you can choose to get the event records exported in Excel or CSV format.

# 9.6 Alarm

In the Alarm section, authorized users can get detailed alarm records.

# 9.6.1 Viewing alarm records

All the alarm records will be displayed. Authorized users can filter the records by specifying device serial number and alarm category, and by selecting time range, device model, device group, severity, alarm codes and status.

# 9.6.2 Exporting alarm records

Authorized users can export alarm records by clicking the Export button on the top right. An Export window will pop up, and you can choose to get the alarm records exported in Excel or CSV format.

# 9.7 Command

The platform provides a Command Center for device command management. Authorized users can view command records as shown below:

# 9.7.1 Adding new commands

Click the + button on the top right side, a Create a Command window will pop up.

There are three steps need to be done totally to create a new command.

  • First Step: Command and Device

    Enter a command alias, write a description and select devices which are required to execute the command. Authorized users can search a device by entering its serial number, alias, SIM ICCID, attributes or description. A filter of model, group and status is also provided for authorized users to select specific devices.

    If a selected device needs to be excluded, click the Delete button on the right side of the device to remove it from the selected device list.

    By clicking the Clear All button, all of the selected devices will be removed from the selected device list.

    After filling in the form in the first step, click the Next button to go to the second step.

  • Second Step: Configuration

    There is a selected device list for authorized users to assure device selection. After the confirmation, authorized users must select one of the common supported command types to illustrate which type of command is desired to execute. Only one type of command can be chosen. Hover the mouse on the Information icon on the top right of the command type button to read its description. Let's select the "restart" type of command for example as shown below:

    After finishing the selection, click the Next button to go to the third step.

  • Third Step: Parameter and Execution

    Fill in the form and click the Submit button to add a new command. Please note: The fields with * are required, while the others are optional. For Execute Strategy, authorized users can choose multiple statuses, signal strength range and battery condition to determine which devices are required to execute the command. The command can be set to be executed immediately or on schedule by selecting a fixed time. For Retry Strategy, timeout, retry times and retry interval can be configured. Please note: The value of Timeout means the total execution timeout, that is, if the command exceeds timeout, the command will be marked as "failed". All retries are processed within the duration of timeout.

# 9.7.2 Favoriting commands

By clicking the Favorite button, the specific command will be favorited, that is, it will be displayed on the top of the command list. Authorized users can find a specific command by favoriting it.

# 9.7.3 Canceling favorite commands

By clicking the Cancel Favorite button, the specific command will be removed from the favorites.

# 9.7.4 Viewing commands

Authorized users can search commands by entering device serial number, device alias or command alias. You can also filter the commands by selecting a specific time, the result will show a command list where the specific time is between the start time and the end time of the commands. The platform also provides a command status filter. Check the Favorite icon, the result will show the favorite command list.

Select a specific command, its detail is shown in the bottom section as shown below:

Enter the Device tab to view detailed device command execution results.

# 9.7.5 Copying commands

Click the Copy button, a Copy a Command window will pop up. Following the instructions in 9.7.1 Adding new commands to copy the command, Before submitting, you can perform modification based on requirements to create a desired command.

# 9.7.6 Retrying commands

Select a command and then click the Retry button to retry the execution of the specific command.

To retry a specific device command, authorized users can also select a command, enter the Device tab, select the desired device and then click the Retry button.

# 9.7.7 Canceling commands

Select a command and then click the Cancel button to cancel the execution of the specific command.

To cancel a specific device command, authorized users can also select a command, enter the Device tab, select the desired device and then click the Cancel button.

# 9.7.8 Exporting commands

Select a command, enter the Device tab, and then click the Export button to export specific device command records.

An Export window will pop up, and you can choose to get the command records exported in Excel or CSV format.

# 9.8 Certificate

Certificate Management is used to uniformly manage the TLS certificates required by each network component. The Platform supports certificates in PEM format. Authorized users can configure the certificate and the server trust store to establish a secure connection between the devices and the Platform. Please click here to download server certificate.

# 9.8.1 Adding new certificates

Click the + Add button, an Add CA Certificate window will pop up.

Hover the mouse on the Information icon to read its description. Fill in the form and click the Add button to add a new CA certificate.

  • For "Registration Code" field, authorized users can copy the value to generate verification certificate.

  • For "CA Certificate" field, authorized users can upload a private CA certificate.

  • For "Verification Certificate" field, authorized users can upload a verification certificate created using the private key corresponding to this CA certificate to prove that you own it.

    • Verification certificate files support .cer, .crt and .pem formats only.

    • We will introduce the steps in creating a verification certificate by using OpenSSL as an example:

      1. Generate a key pair of the private key's verification certificate. The command to generate a key pair is as follows:

        openssl genrsa -out verificationCert.key 2048
        
      2. Use the value of "registration code" field above to create a CSR.

        The command to create a CSR is as follows:

         openssl req -new -key verificationCert.key -out verificationCert.csr
        

        Copy the value of "registration code" field above and paste it as the value of Common Name field below.

        ……
        Common Name (e.g. server FQDN or YOUR name) []: c7cdfde6775c4b408b69d7e3c865f21bafe67937dc9a483ebbf7e6997b7b****
        ……
        
      3. Use the CSR signed by the private key of the CA certificate to create a verification certificate.

        The command to generate a verification certificate is as follows:

        openssl x509 -req -in verificationCert.csr -CA yourCA.cer -CAkey yourPrivateKey.key -CAcreateserial -out verificationCert.crt -days 300 -sha512
        

# 9.8.2 Viewing CA certificates

Authorized users can filter the certificates by specifying CA certificate name and description, or selecting CA certificate status.

# 9.8.3 Downloading CA certificates

Select a specific CA certificate and then click the Download button to download the CA certificate.

# 9.8.4 Deleting CA certificates

Select a specific CA certificate and then click the Delete button to delete the CA certificate. Please note: The CA certificates associated with device certificates cannot be deleted.

# 9.8.5 Adding new device certificates

Click the + Add button, an Add Device Certificate window will pop up.

Hover the mouse on the Information icon to read its description. Fill in the form and click the Add button to add a new device certificate.

  • For "Device Certificate" field, authorized users can upload a device certificate.
  • For "CA Certificate" field, authorized users can select an existed CA certificate to associate with.

# 9.8.6 Viewing device certificates

Authorized users can filter the certificates by specifying device certificate name, device certificate serial number, associated CA certificate name and device certificate description, or selecting device certificate status.

# 9.8.7 Downloading device certificates

Select a specific device certificate and then click the Download button to download the device certificate.

# 9.8.8 Deleting device certificates

Select a specific device certificate and then click the Delete button to delete the device certificate. Please note: A device certificate can only be deleted when it isn’t applied by any groups.

# 10 Data Management Service

# 10.1 Feature Description

The Platform has the capability of analyzing some telemetry data and presenting some helpful information to authorized users. Once the user administrator enables data storage, both the historical data and statistics data are available to view. Please refer to 9.3.8 Viewing device details for further information. In current release, the Platform provides Dashboard feature for customized data visualization, Flow and Function features for data configuration, Bucket feature for data storage. It also provides Policy feature for further data monitoring and safety purposes.

# 10.2 Dashboard

The Platform provides data visualization and autonomous configuration of visual data through the dashboard to help users monitor and analyze data. In the Dashboard section, users can configure charts based on actual needs to monitor real-time data or historical data change tracks for individual devices. Users can also configure statistical charts to count the total number of devices in the company and their status distribution. When configuring the charts, users can also configure the time period for the chart display and select refresh interval in order to define its frequency.

# 10.2.1 Adding new dashboards

Before you can add a new chart, you need to create a new dashboard. By clicking the + Add button on the top left, a New Dashboard window will pop up. Enter the name and then click the Submit button to create a new dashboard.

# 10.2.2 Viewing dashboards

Simply click the dashboard card to view the dashboard detail.

There are several quick configurations can be set in the dashboard as shown below. Please note: Modification of the configuration here will not be saved. It is only for quick chart configuration.

  • Legend Theme:

    Select theme of charts.

  • Time Range:

    Select time range of data collection.

  • Refresh Interval:

    Set chart refresh frequency.

  • Group Name Bar:

    Quickly generate charts for a specific group. After configured a new group, all charts in the dashboard will be configured by the specific group, no matter which group they were configured by before.

  • Serial Number Bar:

    Quickly generate charts for a specific serial number. After configured a new serial number, all charts in the dashboard will be configured by the specific serial number, no matter which serial numbers they were configured by before.

  • Bucket Name Bar:

    Quickly generate charts for a specific Bucket. After configured a new bucket, all charts in the dashboard will be configured by the specific Bucket, no matter which Bucket they were configured by before.

  • Field Identifier Bar:

    Quickly generate charts for a specific field. After configured a new field, all charts in the dashboard will be configured by the specific field, no matter which fields they were configured by before.

The platform also provides full screen view for the specific dashboard. Simply click the More button and then click the Full Screen button to enter full screen view page.

An example is shown as follows:

# 10.2.3 Modifying dashboards

By clicking the Settings button, user administrator can enter the dashboard settings page. In this page, user administrator can rename the dashboard and also determine which quick configurations to display in dashboard detail page.

For Hide Field in General section, if it is on, the quick configurations section will not display in the dashboard detail page.

For Group, Serial Number, Bucket and Field in Variables section, "Query" type means user can perform fuzzy search and all the options cannot be customized, while "Custom" type means user administrator can customize the options. If "Text box" type is selected, it allows users to enter arbitrary values. A default value for it can be pre-configured here.

After finishing the configuration, click the < button to go back to dashboard detail page.

Then click the Save Dashboard button to save the changes. Please note: If there are any unsaved changes, a red dot will be attached to the Save Dashboard button as a reminder.

# 10.2.4 Adding new panels

In the dashboard detail page, by clicking the Add Panel button, all supported panel types will be displayed, including Graph, Gauge, Table, Pie, Stat and Map panel.

Let's take the Graph as an example. Click the Graph button and an empty graph is created.

# 10.2.5 Modifying panels

Click the ... button on the top right of the panel and then click the Edit button to enter the panel detail page.

There are several tabs shown as below:

  • Data

    Data source configuration.

    To configure a specific data source, please follow these steps:

    1. Select a type of Data Source, for example, "Device Telemetry Data".

    2. Enter the Serial Number of the specific device. For convenience, you can enter at least three characters to perform fuzzy search.

    3. Select a desired Data Field, such as "Signal Strength".

    Click the + Add Data button to add more data sources.

    By clicking the Copy button, a copy of the specific data source is generated for you to edit.

    Also, you can click the Hide button to hide a specific data source. Please note: The hidden data will neither display in panel detail page nor panel view page.

    To delete a data source, click the Delete button. Please note: If there is only a data source, it cannot be deleted.

  • Visualization

    Visual configuration of chart. Data Show, Axes and Legend can be customized in this tab.

  • General

    General Settings, including Panel Name, Data Range and Refresh Interval.

After finishing all the settings, please click the < button to go back to dashboard detail page, and then click the Save Dashboard button to save all the changes. Please note: If there are any unsaved changes, a red dot will be attached to the Save Dashboard button as a reminder.

The panel size can be adjusted by dragging its border to give a more comfortable visual experience.

Also, the panel can be relocated by dragging it. Hover the mouse over its blank space, when the cursor turns into a dragging icon, users can rearrange the position of the panels.

# 10.2.6 Viewing panels

By clicking the ... button on the top right of the panel and then clicking the View button, it enters panel view page.

In dashboard detail page, users can click the ... button on the top right of the specific panel and then clicking the Refresh button to refresh the data immediately.

# 10.2.7 Importing panels

Click the More button and then click the Import button to import panels.

Click the Browser button to upload a JSON file, then click the Import button to import panels.

# 10.2.8 Exporting panels

Click the More button and then click the Export button to export panels.

# 10.2.9 Deleting panels

Click the ... button on the top right of the panel and then click the Delete button to delete the panel.

# 10.2.10 Copying dashboards

In the dashboard card page, click the ... button on the top right of the dashboard card and then click the Copy button to copy the dashboard.

# 10.2.11 Deleting dashboards

Click the ... button on the top right of the dashboard card and then click the Delete button to delete the dashboard. Please note: The dashboard can only be deleted when it is not configured in the Settings section.

# 10.3 Flow

The Platform provides a browser-based editor that makes it easy to create computational flows to obtain desired data based on reported data by devices. Flows are independent if they belongs to different models.

# 10.3.1 Adding new flows

Select a model, TMX07 for example, click the + Add button and a New Flow block will appear. Enter the name of the flow and then click the Save button to create a new flow.

# 10.3.2 Renaming flows

By Clicking the Modify button, authorized users can rename the flow.

# 10.3.3 Configuring flow components

There are several components which can be configured in a flow as shown below:

Click the flow block to enter flow detail page.

  • Filter: Select input data.

    By clicking the Edit button in Filter section, authorized users can select specific groups to make the data as the input of the flow. Please note: All device data will go through the flows by default.

    After the configurations, click the Save button to save all the changes.

  • Transformer: Configure functions used by the flow.

    By clicking the Edit button in Transformer section, authorized users can select specific functions to be applied by current flow. Please note: No function is applied by the flows by default.

    There is a Function Library on the left side and a Function in Transformer List on the right side. By clicking the Right button, you can select functions from the library to be used in the transformer. Please note: If you want to use your own functions, you need to configure them in Data - Function before you can select them from the library. If not, there are some preset functions in the library for you to use. To remove functions from the transformer, select the functions and then click the Left button. You can also search for functions in the searching bar. Click the Up/Down button to modify the order for executing the functions. After modifying the transformer, click the Save button to save the settings. For more information about function, please refer to 10.4 Function section. An example of applying the "Ultrasonic Temperature Compensator" function and then the "temp_minus" function is shown as below:

  • Action: Determine the actions on data computed by flow.

    By clicking the Edit button in Action section, authorized users can select specific actions to be applied by current flow. Please note: No action is applied by the flows by default.

    Click the + Add button, a New Action block will appear. Select an action type and enter a name for it. Click the Add Condition button to configure trigger conditions if desired. Select "Match Any" or "Match All" on the right side to configure condition determination.

    Add necessary conditions, for example as follows:

    • Alarm: Generate alarm records to alarm list. For more information, please refer to 9.6 Alarm.

      Enter a name, select a severity and add a description for the alarm, then click the Save button to save all the changes.

    • Event: Generate event records to event list. For more information, please refer to 9.5 Event.

      Enter a name and add a description for the event, then click the Save button to save all the changes.

    • Bucket: Store processed data in specific bucket. For more information, please refer to 10.5 Bucket.

      Click the + Add button to add a configuration into the bucket field and flow result mapping list. An example of a bucket field of "speed" which has already been added in the bucket is shown as below:

      Then click the Save button to save all the changes.

    • SMS: Send an SMS message to a specific phone number.

      Enter a phone number and add a description for the SMS message, then click the Save button to save all the changes. The targeted user will receive an SMS message with a URL to login on to the Platform to read the content.

    • URL: Push processed data to a specific URL.

      Enter a URL, then click the Save button to save all the changes.

    • Email: Send processed data to specific email address(es).

      Enter an valid email address, then click the Save button to save all the changes. Please note: Press the Enter key to apply an email address. The email will be sent to the applied email address(es) only. If in red, it has been regarded as an invalid email address.

    • Command: Issue control commands to the devices in Filter.

      Select a command type, then click the Save button to save all the changes. Please note: If parameters are required, please fill in the parameters.

  • Debug: Display debug messages.

    For the Debug switch, if it is on, the debug messages for most recent data flow will display.

    Click the Refresh button to refresh the log.

# 10.3.4 Inserting flows

Click the + button on the left side to insert a new flow. After entering the name of the flow and clicking the Save button, a new flow is inserted.

# 10.3.5 Opening flows

When a flow is open, it will compute every time when there is input data. To open a flow, simply switch the Flow switch to "Run". Please note: An open flow cannot be modified. However, the debug switch is still valid.

You can also perform batch opening for all the flows by clicking the Open All button.

# 10.3.6 Closing flows

When a flow is closed, it will stop computation. To open a flow, simply switch the Flow switch to "Stop". Please note: If you want to modify a flow, you need to close it first.

You can also perform batch closing for all the flows by clicking the Close All button.

# 10.3.7 Importing flows

Click the ... button and then click the Import button, an Import Flow window will pop up.

Select "Import Above" to import all the flows in the front of current flow or "Import Below" to import all the flows at the back of current flow.

Click the Browser button to select a JSON file, then click the Import button to import flows.

# 10.3.8 Exporting flows

Click the ... button and then click the Export button to export the selected flow.

You can also perform batch export for all the flows by clicking the Export All button, a JSON file with all flows' information will ask for being downloaded.

# 10.3.9 Replacing all flows

To import new flows and replace all original flows, simply click the Replace All button. An Import Flow window will pop up.

Click the Browser button to select a JSON file, then click the Import button to replace all flows.

# 10.3.10 Deleting flows

Click the ... button and then click the Delete button to delete the flow. Please note: Only closed flows can be deleted.

# 10.4 Function

A function is used for computing data as a component of a flow. There are some preset functions in the library shown as below.

A function is in use only when it is configured by a running flow. And the number is displayed on the top right side. For example as below, only "Ultrasonic Temperature Compensator", "Temperature(C to F convertor)" and "temp_minus" these three functions are in use.

# 10.4.1 Adding new functions

Click the + Add button, a New Function window will pop up.

Authorized users can enter a title for the function, write a description and perform some coding tasks. Instructions are on the right side and a syntax parser is provided to help authorized users write the code. The programming language is JavaScript inside the coding section. Please note: You do not need to write a return statement. The unit of timestamp is millisecond (13 digits), and the valid time string format is "yyyy-MM-dd HH:mm:ss.SSS". After finishing the form, click the Save button to create a new function. An example for temperature compensation is shown as below:

# 10.4.2 Modifying functions

Simply click the function card or the Detail button to edit the function.

After the modification, click the Update button to save all the changes. Please note: Functions in use and preset functions cannot be modified.

# 10.4.3 Copying functions

Click the Copy button, a Copy Function window will pop up. Before clicking the Save button to copy the function, you can perform modification on it based on requirements.

# 10.4.4 Deleting functions

Click the Delete button to delete the function. Please note: Functions in use and preset functions cannot be deleted.

# 10.5 Bucket

Data Bucket applies storage strategy on data store, and it unifies the data format for easier process. It is an object to combine Channel and Policy features. Together with data Transformer, it provides a better way to define data Flow.

# 10.5.1 Adding new buckets

Click the + button and a New Bucket window will pop up.

Fill in the form and then click the Submit button to create a new bucket.

  • For "Retention" field, you can define the time range of data collection. For example, if a retention of "60 days" is selected, the bucket will store the data generated for 60 days.
  • For "Share Data" field, you can select specific users to share data. They will have access to view all data in this bucket. User administrators and users who already have all privileges will automatically have access to view all data.

# 10.5.2 Modifying buckets

Select the bucket you want to modify and then click the Modify button, an Edit Bucket window will pop up.

After modifying the bucket, click the Submit button to save the changes. Please note: The "Retention" field cannot be modified.

# 10.5.3 Adding new bucket fields

Select a bucket, then enter the Bucket Field tab. A preset bucket field "time" is provided to represent the time that data generated. Click the Add button and the OK button to add a new bucket field. You can enter field name, field title, type of field value, unit of field value, max value of field value if required, min value of field value if required and a description of the field. If you want to create more than a field, click the + Add button to add more fields. All the added fields will be listed in the field list below.

# 10.5.4 Deleting bucket fields

Click the Delete button to delete a specific bucket field. Please note: Bucket fields in use and preset bucket fields cannot be modified.

# 10.5.5 Viewing buckets

There are several tabs shown as below:

  • Bucket Field

    It shows bucket data schemas.

  • Dashboard

    It shows all the charts configured in Dashboard feature and set to be enabled in Settings for the selected bucket. For more information, please refer to 10.2 Dashboard section and 12 Settings section.

  • Bucket Data

    It shows all the data configured and stored in the bucket. Authorized users can filter data by specifying device serial number and selecting time range.

    You can export bucket data by clicking the Export button on the right side. An Export window will pop up, and you can choose to get the bucket data exported in Excel or CSV format.

# 10.5.6 Deleting buckets

Select the bucket you want to delete and then click the Delete button to delete the bucket. Please note: A bucket in use cannot be deleted.

# 11 API Services

The Platform provides north bound API services to external users and systems. For detailed technical information, please refer to ThingsMatrix Service Platform API Guide.

# 12 Settings

Users can select the appropriate language, time zone, data statistics unit, and map display type by clicking the Edit button via the settings. You can also enable/disable dashboard display in Dashboard settings. You can select specific dashboard to display in Asset - Device List, Asset - Device Management or Data - Bucket section.

Click the Save button to save all the changes.

By clicking the dashboard name, you can go to the dashboard detail page.

Click the Restore default button to return to the initial state.

The user administrator can pre-set a common company settings template for other users in the company. If needed, other users can have their own personal general settings.

  • User Administrators
  1. Personal Account Settings

  2. Company settings

  • Other Users

    General Settings only

# 13 Operation Log

User administrator can view log of operations performed by company members. Hover the mouse over the Avatar icon on the top right side, Then click the Operation Log button to view the log.

# 14 Notification Board

The Platform provides Notification Board to display notifications and messages, such as system upgrade schedule and over limit/frequency alert of SMS, URL and email usage. Check the Ring button on top right, you may notice that there is a number next to it, which shows the number of unconfirmed messages. There is one unconfirmed notification for example as shown below:

There can also be just a red dot next to the Ring button, meaning that there are several unread notifications needn't to be confirmed.

By clicking the Ring button, a Notification Board will pop up. It will display all notifications and messages. You can filter notifications by selecting a desired notification type.

Click the unread notification for detailed content. Please note: The notice with a red dot means that it hasn't been read yet.

Click the Confirm button to confirm the notice.

Last updated: 4/30/2021, 9:52:12 AM