User Configurations

• optional

A Template Package can include user configurations to be deployed to Twinit by configuring user config definitions in the manifest.configs array and matching files containing the content of the user configs in the packages 'configs' folder.

A user config definition should include the _name, _description, _shortName, and _userType for the config like so:

// manifest.json"configs": [   {      "_name": "Sample User Config",      "_shortName": "sampleuc",      "_description": "A sample user config",      "_userType": "sample"   }]

You may include as many user config definitions in the configs array as needed.

Each user config definition must map to a .json file in the package's configs folder, where the _name of the user config definition matches the name of the .json file. The content of the .json should be the .json content of the user config.

Complete Example:

// manifest.json{   "Template Name": "Water Treatment Operations Digital Twin",   "Template Version": "1.0.5",   "configs": [      {         "_name": "Sample User Config",         "_shortName": "sampleuc",         "_description": "A sample user config",         "_userType": "sample"      }   ]}

// Package Zip FileWater Treatment Template.zip /||-- configs /|   |-- Sample User Config.json||-- manifest.json

// Sample User Config.json{  "handlers": {},  "homepage": {},  "groupedPages": {},  "settings": {}}

Deploying User Configs

When the Template Package is deployed, if the defined user config does not exist it will be created. If a user config with the same _name already exists, a new version of the user config will be created.

Deploying multiple versions of the same user config is also possible. See Support for Deploying Versioned Items