Template Package Manifest

The Template Package manifest is a json file that specifies what data should be created or updated when a template is deployed, and how that data should be deployed.

There is a direct connection between between the information in the manifest and the structure of the package file. For instance, the config, omapiConfig, and scripts fields in the sample manifest below relate directly to the config, omapiConfig, and scripts folders in the package.

// manifest.json{   "Template Name": "",   "Template Version": "",   "configs": [],   "omapiConfig": [],   "scripts": [],   "userGroups": [],   "userGroupToUserConfig": []}

Manifest Specification

The Manifest Specification defines the fields that may be used in a manifest.json. Any fields found in a manifest.json that are not included in the manifest specification will result in the template package not being deployed.

The manifest currently requires:

• Template Name and Version

The manifest currently supports optional deployment of:

• File Upload With Tags
• Item Import
• NamedUserCollections
• Object Model API (OMAPI) Configurations
• Orchestrators
• Scripts
• User Configurations
• User Group to User Config Associations
• User Groups

Template Packages also support extensibility and supports deploying more than what the manifest specification supports. See Extending the Template Package for more information.

Manifest Deployment Order

To ensure successful deployment of Template Package materials, items configured in the manifest are deployed in this order:

1. Initialize Script
2. Scripts
3. User Configs
4. API Configs
5. User Groups
6. User Group to User Config Associations
7. Orchestrators
8. NamedUserCollections
9. Item Import
10. File Upload With Tags
11. Setup Script

This order ensures that if a later deploy steps requires other items, like a User Group to User Config Association requires a user group and a user config, that the preceding items will have already been created.