In this article
What is a Program Template?
A program template is a package containing all the necessary assets for setting up a program in your system. It is organized into a specific folder structure with key files that drive the program's functionality. A program template is typically a zip file that can be uploaded or modified as needed.
Program Asset Folders
Program templates follow a predefined folder structure, ensuring that the assets are correctly associated with the program workflow.
The main folders in a program template are:
Dashboards: This folder contains dashboards defined in CDL (Configuration Description Language) files. Each dashboard has its own subfolder where the dashboard definition is stored.
Surveys: Contains survey XML files that define the surveys associated with the program. Each survey also has its own subfolder.
TextAnalytics: This folder holds configuration files related to text analytics models, typically for sentiment analysis or categorization. Unlike other folders, there are no asset files, only the manifest.json file.
Note: These folder names are fixed. Renaming them will break the functionality of the program template. Make sure to keep the structure intact.
Each of these folders can contain sub-folders for each individual asset e.g. The survey folder contains two sub folders, which represent two surveys to be added in via the program template.
Important: The names of the subfolders are used in the workflow task generation process, so correct naming is crucial for proper task creation.
Manifest File and Assets
Inside each subfolder is a manifest.json file. This file provides an overview of the asset it represents:
For Surveys, the asset will be an XML file.
For Dashboards, the asset will be a CDL document.
For TextAnalytics, there is no asset file; the folder will contain only the manifest.json file.
Root-Level Files
At the root level of the program template, there are three files:
Workflow.cdl: This document defines the task generation that powers the program.
manifest.json: This file describes the overall program and is used in the program overview screen.
Image file (.png): This file is displayed in the program overview screen as part of the visual representation of the program.