Metadata Governance in Deploy API
Metadata governance gives your team intentional control over what information accompanies your content at each stage of the delivery pipeline. Rather than accepting default behavior, you can make deliberate choices about exactly which metadata reaches each endpoint.
Metadata governance is the practice of controlling which metadata accompanies your content as it moves from Heretto CCMS through to its delivery endpoints, whether that's Heretto Portal, a third-party system, or a connected device. It gives your team a structured way to decide what information about your content, such as modification dates, taxonomy values, or metadata for audience and product applicability, is included in or excluded from published output.
Metadata governance support was introduced in Heretto CCMS 25.10.30 and Heretto Portal v5, and requires a two-step activation process. First, the Heretto team must enable the feature in Heretto CCMS. Once that's done, a user assigned the Administrator role in the CCMS must enable and configure metadata in each deployment. Contact your Customer Success Manager to get started.
Metadata governance is most valuable in these areas:
- Content exposure control
- You decide which metadata belongs in your published output and which should remain internal to the CCMS. This lets you tailor what external audiences see while preserving metadata that supports your internal workflows and content organization.
- Search and discoverability
- In Heretto Portal, metadata drives search behavior, keyword indexing, and search facets. With governance in place, you can shape the search experience for your end users, ensuring that the appropriate facets are available and that search results surface the most relevant content.
- Consistency across delivery endpoints
- When your content is served to multiple endpoints such as Heretto Portal or a third-party endpoint like a device or machine, you can tailor metadata for each destination. Governance gives you the flexibility to include different metadata depending on what each endpoint requires.
Heretto provides metadata governance through two levels of control that correspond to stages in the content delivery pipeline:
Deployment-level control, configured in the Deployments interface in Heretto CCMS, determines which custom metadata is included in content published through a deployment. This level of control is available for all delivery endpoints, including Heretto Portal and third-party endpoints, like a machine or device.
Portal-level control, configured in the config.json file associated with your main portal sitemap, provides an additional layer of filtering for content delivered to Heretto Portal specifically. It lets you fine-tune which metadata from a deployment appears in Heretto Portal HTML.
These two levels work together to give you granular control over metadata at each stage of the content delivery process.
Metadata Types in Heretto
Metadata is information about your content, such as author details, modification dates, taxonomy values, or metadata for audience and product filtering. Metadata helps with content management, organization, retrieval, and processing, but typically doesn't appear in the body of your content, such as in paragraphs or notes. Instead, it is stored in the DITA XML structure of your files (in-document metadata) or in visible fields on the document, such as tags or modification dates (on-document metadata). While in-document metadata is specific to DITA files, on-document metadata applies to any file type.
There are two high-level metadata types in your files: DITA metadata and CCMS metadata.
- DITA Metadata
-
DITA metadata, also referred to as in-document metadata, is DITA elements and attributes stored within the XML structure of DITA files.
- CCMS Metadata
-
CCMS metadata, also referred to as on-document metadata, is system and custom metadata added to all files in the CCMS, including DITA and binary files. CCMS metadata is stored in the CCMS (as opposed to within the XML structure which is true for DITA metadata). While system metadata is added to files automatically by Heretto CCMS, custom metadata can be configured and added to files by users.
You can view DITA metadata in the DITA XML structure of a file. See View DITA Content and Metadata for a Resource. You can view system metadata in the Overview tab for a file in Heretto CCMS. See View CCMS Metadata for a Resource. Custom metadata corresponds to the custom metadata that is configured in the CCMS.
Metadata Flow in Heretto
-
Files stored in Heretto CCMS contain different types of metadata: DITA metadata (elements and attributes), and CCMS metadata (system and custom). When content is published through a deployment, deployment-level metadata control determines which custom metadata is included in the processed content. DITA and system metadata are always included.
-
Heretto Deploy API processes content and any custom metadata disabled in the deployment. For example, when custom metadata B is not enabled in the deployment, it is removed at this stage and unavailable to any delivery endpoint.
-
Deploy API serves the processed content and its remaining metadata to Heretto Portal or a third-party endpoint. For third-party endpoints, this is the only available level of metadata governance.
-
For content served to Heretto Portal, portal-level metadata control provides an additional layer of filtering. For example, in the portal configuration, you can exclude custom metadata A from the portal HTML. It remains available to the portal search engine because that relies on Deploy API.
- Deployment-level metadata governance
-
Users with the Administrator role in Heretto CCMS can configure which custom metadata is included in each deployment through the Deployments interface. Any metadata disabled at this level is removed from the published content entirely, making it unavailable to all delivery endpoints. If a deployment publishes content to a third-party delivery endpoint, this is the only available level of metadata governance.
- Portal-level metadata governance
-
Portal-level metadata provides a method for overriding the deployment-level metadata. It is configured in the config.json file associated with the main portal sitemap. By default, all metadata included in a deployment is present in portal HTML. Metadata excluded at this level is removed from portal HTML but remains available to the portal search engine. This level of governance is available only when publishing to Heretto Portal.
Metadata Operation and Guidelines
Before you configure metadata in a deployment, familiarize yourself with a number of facts and guidelines related to metadata in the Heretto platform.
- General
There are two high-level metadata types in your files: DITA metadata and CCMS metadata. DITA metadata, also referred to as in-document metadata, is DITA elements and attributes stored within the XML structure of DITA files. CCMS metadata, also referred to as on-document metadata, is system and custom metadata added to all files in the CCMS, including DITA and binary files, that is stored in the CCMS (as opposed to within the XML structure which is true for DITA metadata).
There are two levels of metadata control: deployment and portal. The deployment-level control is available when publishing to both Heretto Portal and a third-party endpoint; it enables you to control custom metadata. The portal-level control is available only when publishing to Heretto Portal, it enables you to control all custom metadata as well as some system metadata.
Custom metadata is included in a deployment and portal HTML based on its configuration in Heretto CCMS and deployment settings. It must be configured and enabled in the CCMS Metadata interface and added to files. If disabled in the CCMS or in a deployment, it is excluded from the deployment and portal HTML. If enabled in both, it is included.
When configured, custom metadata added to both topics and maps is carried over to deployments and Heretto Portal HTML. Map-level metadata cascades down to all topics in the map. For details on map-level metadata, see Metadata in maps below.
Metadata published through active sync and manual deployments behaves the same way.
- Metadata and deployments
Deployments let you control custom metadata. System and DITA metadata cannot be configured through the Deployments interface. Only users with the Administrator role in the CCMS can modify and publish deployments.
By default, metadata processing in a deployment is disabled. To enable metadata processing, you must select this check box in the Deployments interface: Select to start processing, without selecting the configuration below is only preparatory. This action is one-way: once saved, it cannot be undone. Once enabled, metadata processing in a deployment can't be disabled.
By default, metadata added to maps is excluded from a deployment. To enable map-level metadata processing, you must select this check box in the Deployments interface: Include map-level metadata. Map-level metadata processing can be disabled in a deployment at any point in time.
By default, no custom metadata is enabled in a deployment. To enable metadata, you must select desired metadata in the Deployments interface.
There are two metadata availability types in a deployment: Optional and Disabled. Optional metadata can be enabled in a deployment. Disabled metadata can't.
If a deployment lists custom metadata as disabled, it means the metadata is disabled in the CCMS Metadata interface (Administrators only).
All metadata included in a deployment is used by the portal search engine, regardless of whether it is filtered from portal through a config.json configuration. This behavior is expected. To exclude metadata from portal search, exclude it on the deployment level.
Changes made in the CCMS Metadata interface are not automatically reflected in deployments. For active sync deployments, you must re-save the deployment. For manual deployments, you must republish. For example, if you disable metadata in the CCMS Metadata interface that is already enabled in a deployment, the deployment continues to reference the old configuration until you re-save or republish it.
When custom metadata enabled in a deployment is disabled in the CCMS Metadata interface, its status in the Deployments interface changes to Disabled (changed). Once the deployment is re-saved, the status becomes Disabled.
When new custom metadata is added to the CCMS Metadata interface, it's listed as optional in the Deployments interface but it's not enabled. Enable it to include it in the deployment.
When custom metadata is removed from the CCMS Metadata interface, it is also removed from the Deployments interface.
If search facets are configured in Heretto Portal but metadata they use is disabled on the deployment level, search facets become unavailable in portal (just as if they weren't configured). For details on portal search facets configuration, see Heretto Portal Search Facets.
- Known limitations
DITA metadata that is not passed to deployments:
prodinfolinktexttopicmeta- passed to deployments but not to Heretto Portalothermetacopyright
Changes made in the CCMS Metadata interface are not automatically reflected in deployments. For active sync deployments, you must re-save the deployment. For manual deployments, you must republish. For example, if you disable metadata in the CCMS Metadata interface that is already enabled in a deployment, the deployment continues to reference the old configuration until you re-save or republish it.