Skip to main content

NamedUserCollections

  • optional

A Template Package can include one or more NamedUserCollection configurations to be deployed to Twinit by configuring the manifests namedUserCollection array.

Each entry in the namedUserCollection array must be a valid NamedUserCollection definition.

// manifest.json
"namedUserCollections": [
   {
      "_name": "Default Collection",
      "_shortName": "Default",
      "_description": "Named User Collection",
      "_userType": "Default_Collection"
   }
]

Options​

  • ifExists - each collection configuration can have an optional ifExists option set. Valid values for IfExists are default, recreate, and version.
    • default: the same as not including ifExists. The default behavior is to skip creating the collection if a collection with the same name already exists.
    • recreate: will first delete any collections with the same name before creating a new collection. All items in the existing version will be deleted.
    • version*: will create a new empty version of the collection if one with the same name is found. All items in the existing version will be persisted in the old version.

Complete Example:​

// manifest.json
{
   "Template Name": "Water Treatment Operations Digital Twin",
   "Template Version": "1.0.5",
   "namedUserCollections": [
      {
         "_name": "Default Collection",
         "_shortName": "Default",
         "_description": "Named User Collection",
         "_userType": "Default_Collection"
      },
      {
         "ifExists": "default",
         "_name": "Encrypted Collection",
         "_shortName": "Encrypted",
         "_description": "Named User Collection",
         "_userType": "Encrypted_Collection",
         "_encryptionEnabled": true
      },
      {
         "ifExists": "recreate",
         "_name": "Recreate Collection",
         "_shortName": "Recreate",
         "_description": "Named User Collection",
         "_userType": "Recreate_Collection"
      },
      {
         "ifExists": "version",
         "_name": "Version Collection",
         "_shortName": "Version",
         "_description": "Named User Collection",
         "_userType": "Version_Collection"
      }
   ]
}
// Package Zip File
Water Treatment Template.zip /
|
|-- manifest.json