Deployment Definitions

A Deployment Definition is a set of instructions for a deployment job. It defines the package version to use, which content from the package to include, and whether any of the content has to be modified during deployment. You can configure the deployment definition to create a new application or to update an existing application.

Before You Begin

Verify that the desired package and version have been created.

Create a Deployment Definition That Creates a New Application

1. In Qrvey Admin Center, select the Content Deployment icon in the left navigation panel to display the Deployment Definitions tab.

2. Select Create Definition. The Deployment Definition Description page displays.

3. At the top of the page, enter a name and description in the fields provided.

4. From the Package to Deploy drop-down, select the package to use in this deployment.

5. Select the Package Version drop-down and select the package version to deploy.

6. Select the content to deploy:

   • Select Select Content. The Select Content dialog displays.

   • Select individual items to include in the deployment. To include all the content in the application, select Baseline (all content).

   • Select OK. The page updates with the dependencies of each of your selections.

   Note: If you select content that has dependencies, the system automatically includes them in the deployment. For example, if you select a dashboard, but you do not select the datasets that power the charts on that dashboard, the system automatically includes that dataset.

7. (Optional) To use APIs for Content Deployment, select Show Content ID. You need this information to call the API.

8. Leave Create New Application (default) selected.

9. Enter a name in the New Application Name field.

10. (Optional) Enter a description in the Application Description field.

11. Expand the selections to display their properties. Modify the selections as needed.

    For datasets, the default setting is to load the data when creating the dataset.

Create a Deployment Definition That Updates an Existing Application

1. In the Qrvey Admin Center, select the Content Deployment icon in the left navigation panel to display the **Deployment Definitions tab.

2. Select Create Definition to display a form for adding definition information.

3. In the fields provided, enter a name and description to replace the placeholder text.

4. From the Package to Deploy drop-down, select the package to use in this deployment.

5. Select the Version of the Package to Deploy drop-down, select a package version.

6. Select the content to deploy:

   a. Select Select Content. The Select Content dialog displays.

   b. Select individual items to include in the deployment. To include all the content in the application, select Baseline (all content).

   c. Select OK. The page updates to reflect the dependencies of each of your selections.

7. (Optional) To use APIs for Content Deployment, select Show Content ID. You need this information to call the API.

8. Select Update an Existing Application.

9. From the Select Fields to Update drop-down, select one of the following options and enter additional information as new fields are displayed:

   • Select All
   • Application Name
   • Application Description

10. Expand the selections to display their properties. Modify the selections as needed.

    For datasets, the default setting is to load the data when creating the dataset.

Note: An unknown label might indicate a new connection type that has not yet been updated in the Content Deployment section. The new connection type can still be deployed, set up, and used.

Delete a Deployment Definition

To delete an existing deployment definition, select its corresponding options menu from the definition table, then select Delete.

Note: You cannot delete a deployment definition if it is associated with a deployment job.

Update Custom Attributes

By default, the Update Custom Attributes option is enabled in dashboards when selecting content.

When a customAttributes object contains IDs such as datasetId, chartId, dashboardId, and workflowId, they are replaced in the deployed application with new IDs.

To keep the IDs from updating in the target application’s customAttributes object, disable this option. After the application is deployed, the IDs in the customAttributes object remain the same as in the source application.

Note: Only IDs recognized by the Content Deployment process are affected by this functionality. Any other values added to the customAttributes object remain unchanged.