1. Knowledge Base
  2. Developer
  3. HMT Custom Software Configuration

Tagset Deployment Configuration

Introduction

Pre-defined tagsets can be configured using configuration files. This gives administrators and users the flexibility to create tagsets that are more appropriate for their data.

Glossary

  • <storage> refers to the internal storage on the HMT, sometimes referred to as ‘internal_storage’, ‘sdcard’ & ’emulated/0/’.
  • JSON is a standard text-based format for representing structured data based on JavaScript object syntax.
  • <custom_file_name> is a user-defined name for the file. Example ‘tagset.json’, ‘mytagsets.json’, ‘pump1_tagsets.json’

Tagset Configuration

File

In order to create and modify the tagset data, it is recommended to use:

  • VisualStudioCode

This tool will help with JSON validation and tagset formatting.

Files

The tagset service requires two files in order to correctly configure the tagging service. Using VisualStudioCode, or your preferred text editing tools create a new file with the filename listed below.

Note: If you are using Foresight to configure your tagsets then you will only need to create .json

  • config.json – This is the configuration file that will enable the tagging service and direct to the location of the tagset file described below.
  • <custom_file_name>.json – This is a custom tag set file which will contain the actual “tags”. Example: ‘mytagset.json’, ‘engine_tagset.json’.

Format and Options

In order for the tagging service to read in the configuration and tagset, the information must be provided in a JSON format and all of the required fields must be supplied.

  • tagSetFile: the name of the tagset file. (Required Field)
  • enabled: indicates whether the tagging service should be enabled or not. (Required Field)

Example config.json file:

Copy the JSON text below into your text editor and change to the name of the custom tagset file name you created above.

{
"tagSetFile": "<custom_file_name>.json",
"enabled": "true"
}

Example Tagset file:

  • tags: the actual tags permitted in to be used in the tagging system. (Required Field)

Copy the JSON provided below into your <custom_file_name>.jsonfile and change the values “Tag A“, “Tag B“, “Another Tag” If you wish to app more tags remember to add “quotations“ around the text and make sure the previous tag and new tag are split using a comma “,“.

{
"tags": ["Tag A", "Tag B", "Another Tag"]
}

Folder Location

The tagset service reads the files from the folder /<storage>/realwear/com.realwear.tags/ on the device. In the deployment section, you will learn how to get the files in to the correct folder location.

/<storage>/realwear/com.realwear.tags/

    • /<storage>/realwear/com.realwear.tags/config.json
    • /<storage>/realwear/com.realwear.tags/.json

The next section includes instructions to create this folder and correctly transfer the file.

 Tagset Deployment

After you’ve created your tagset, there are three ways to deploy the tagset to your RealWear device(s).

      • Foresight
      • EMM Partner
      • Android File Transfer

RealWear Foresight

  • In order to upload tagsets via foresight click the tab ‘Device Management” and select tagsets.

tagset-deployment-configuration-01

  • All tagsets will be shown on this page. To create a new tagset, click ‘add tagset’.

tagset-deployment-configuration-02

  • Create a tagset name, fill in a description, set tagset status to enabled, select your tagset.json, and then save the tagset.

tagset-deployment-configuration-03

  • Next, create a policy within the policy controller. Create a policy name, fill in a description, and select a tagset.

tagset-deployment-configuration-04-1536x571

  • Add the policy to your desired device group. Once your device group has the policy, the tagset data will be applied.
  • To register for Foresight, or for more details on using the product, visit the product page on RealWear’s website.

Via your Enterprise Mobility Management Solution (EMM)

  • Please see your EMM provider on how to push files to your device. When files are pushed to the HMT, remember to push the files to the location: ‘/realwear/com.realwear.tags/
  • For more information on managing RealWear devices via EMM, visit the dedicated RealWear Knowledge Center page

Android File Transfer

  • Download Android File Transfer (MAC users only)
  • Using Android File Transfer (MAC) or Windows Explorer (PC), browse your HMT files.

tagset-deployment-configuration-05

  • Open the folder ‘realwear’ and create the folder ‘com.realwear.tags’.
  • Copy the config.json and <custom_file_name>.json files into the new folder.

tagset-deployment-configuration-06

 References:

Known Issues

The maximum number of tags that the HMT can have is limited by the number of lines available to display the list of tags. There can be six lines-worth of tags that the user can select from. One line is long enough to display one approximately-50-character tag, about seven 3-character tags, or about five 5-character tags. That would allow a user to have a total of six 50-character-long tags, forty-two 3-character tags, or thirty 5-character tags.

When creating JSON files using Foresight, the file can unknowingly contain invalid characters and encoded values. If you see this error you can use https://jsonlint.com/ in order to validate and check the errors in the file.

Dependencies

Firmware Version Number 11.1=>

TagService 1.0.2-7 =>