Skip to main content

Using Configuration Templates

Zuora

Using Configuration Templates

Describes the general steps to use the configuration templates.

In the following sections, you'll learn about configuration templates, limitations, how to create a source tenant, launch a new deployment run, view history, and logs, and revert a deployment.

Overview

Configuration Templates automate the deployment of non-transactional objects (components). Using templates, you can deploy the same subset of configurations across multiple tenants and environments.

The following graph describes a high-level flow for using the Configuration Templates.

 

Configuration Templates.png

Access Configuration Templates

After logging into the target tenant, you can access the Configuration Templates from the left-side navigation under Administration.

clipboard_e28ed6edc16f8c163e51742a46291bbbf.png

Limitations

The Configuration Templates currently has the following limitations:  

  1. You can download the files only in JSON format at the moment. 
  2. The template size currently is 10 MB. It can be enhanced if required. 
  3. The JSON file format is not editable.
  4. Deployment Manager removes a created template from the backend in 60 days if the template has not been used for any deployments.

See Deployment Manager Known Facts and Limitations for more information.

Create Source Template

You can create a source template from the Template List View screen (landing page of the Configuration Templates).

Take the following steps to create a template:

  1. Click  + New button.

clipboard_e78ecf2fb5983f4d22251d324c2476d79.png

  1. In the resulting New Template pop-up, provide the Template Name and Description.

 

  1. (Optional) Click Advanced Options button to select the subset of objects child.

    1. In the resulting pop-up, select the components.

    2. Click Add.

  2. Click Create.

Note that when you select components and click create, all the child parameters of the selected component will be automatically saved in the template.

  1. Now, you can view the newly created template on the Template List View Screen.

clipboard_ed121ff9fe3cf7a25e4731f97198d28be.png

  1. Click the template Name to view the newly created template details.

Download Template

Take the following steps to download template:

  1. Navigate to Template List View Screen.
  2. Click Download corresponding to the template.
  3. The JSON file of the template will be created and downloaded, you will see it at the bottom of your browser window. Click the file name to open it.

Note that you can save the template to your local computer, a shared drive, or a repository.

Compare, Validate, and Deploy

Take the following steps to Compare, Validate, and Deploy:

  1. Navigate to Deployment Manager from the left-side navigation under Administration.
  2. Click  + New button.
  3. In the resulting New Deployment pop-up, provide the Deployment Name and Deployment Description.
  4. Click Upload Template radio button under the source tenant.
  5. Click + UPLOAD FILE to upload the template.
  6. Select the Target tenant.
  7. Click Next.
  8. You will then be taken to the compare screen for Deployment Manager. See Using Deployment Manager.

Deployment Manager References

To understand the known behavior of configuration templates and APIs, see the following sections:

Product Catalog deployment known facts and system behavior. 

Product Catalog deployment FAQs.

Deployment Manager Known Facts and Limitations.