Deployments

A deployment is a configuration in Heretto CCMS that defines which main sitemap is published to which Heretto Portal environment or other delivery endpoint such as a website, application, device, or machine. Deployments carry information like deployment type, audience, locales (or target languages), or metadata. They enable you to publish content from the CCMS to your delivery endpoints.

There are two types of deployments: active sync and manual.

Active Sync Deployments

A deployment type that automatically publishes content updates to a Heretto Portal environment or other delivery endpoints. With active sync, content updates made in a topic or map are visible in an associated delivery endpoint automatically and instantaneously. This deployment type is particularly useful to preview work-in-progress content in a non-production delivery endpoint. Active sync deployments can be configured only for non-production delivery endpoints.

Manual Deployments

A deployment type that requires publishing to be triggered manually in Heretto CCMS. With manual deploy, content updates made in topics and maps are not visible in an associated Heretto Portal or other delivery endpoints until that deployment is manually published. This deployment type enables you to control when content updates are visible in your delivery endpoint. This deployment type is particularly useful to publish your final content to a production delivery endpoint in a controlled manner. Manual deployments can be configured for any delivery endpoint.

Apart from deployment type, each deployment contains a number of settings including the ones that define which content and in which languages gets published through it, which audiences are included, or which metadata is included.

General Configuration

General deployment settings that enable you to set the essential aspects for a deployment: its name, map, and locales.

Known Limitations

  • You cannot publish content through a deployment from a release. You can, however, branch a release and publish through a deployment from that branch.

  • Deployments do not warn about validation issues in your content. Use the preflight check to validate your content before publishing it to portal. For more information, see Preflight Check.

Configure Deployments

Deployments are configured in Heretto CCMS. They connect content in the CCMS with Heretto Portal environments or other delivery endpoints via Heretto Deploy API and enable you to publish content to the associated delivery endpoint. A portion of the configuration must be completed by the Heretto team.

To complete this procedure, you must be assigned the Administrator role in Heretto CCMS.

If you want to create a deployment for a map on a specific branch, switch to that branch.

  1. In the top-left corner, click the Main Menu and go to Deployments.
  2. In the Administration interface, go to Deployments.
  3. In the top-right corner of the Deployments interface, click + New Deployment.
  4. In the Create Deployment window, provide these details:
    Create Deployment Window
    1. Select deployment type: manual deployment or active sync deployment.

      Manual deployment can be configured for any delivery endpoint. Active sync deployments can be configured only for non-production delivery endpoints.

    2. Provide the name of the deployment.
      Note:

      We recommend including the name of the branch and portal environment or a different delivery endpoint in the deployment name. For example, when your deployment is to publish content from the production branch to the staging portal environment, your deployment name could be Production branch & Staging portal. This ensures that anyone can understand how each deployment is configured.

    3. Add a map by clicking Add file and navigating to the map you want to publish through this deployment.
      Remember:

      To deploy a map from a specific branch, switch to that branch before starting this step. Also, after you save the deployment, you cannot change the map used in this deployment.

      For more information about DITAVAL files, see Conditional Processing Overview and DITAVALs.

    4. Add a DITAVAL file(s) with audiences by clicking Add audiences and navigating to the DITAVAL file you want to use in this deployment.
    5. Configure which metadata should be included in this deployment.

      For more information about metadata, see Metadata Governance in Heretto CCMS and Metadata Governance in Heretto Portal.

    6. Optional: Heretto Portal only: Decide if you want to disable automatic redirects in this deployment.
      Automatic redirects are available only for manual deployments configured to publish to a Heretto Portal environment. By default, automatic redirects are enabled and we recommend keeping them enabled. For more information, see Automatic Redirects.
  5. Click Save.
  6. Copy the ID Heretto generated for your deployment and pass it to your Customer Success Manager, along with the these details:

    • Share URL to the map you added to this deployment

    • The name of the branch that contains the map

    • The Heretto Portal environment or another delivery endpoint the deployment should be connected to

Once the Heretto team completes the configuration on their side, the configuration of the deployment is complete. Users assigned the Administrator role in the CCMS can modify most aspects of the deployment with the exception of the map it uses. To use a different map in a deployment, a new deployment must be configured.

Last updated: April 29, 2026