Each block element starts with a new line.

Block Elements

Inline elements do not start with separate lines.

Inline Elements

<body id="concept-1670"><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1" id="ariaid-title1">DITA Elements</h1><p class="shortdesc">We use a limited number of the available DITA elements.</p></article></main></body>

The Heretto Information Model
            contains guidelines for structuring content at Heretto.

Heretto Information Model

Use glossary entry topics to define a term and its terminology information.

Glossary Entry Topic

We use a limited number of the available DITA elements.

DITA Elements

heretto-ccms/get-started/introduction-to-content-development/heretto-information-model/dita-elements

get-started/introduction-to-content-development/heretto-information-model/dita-elements

<body id="topic-8515"><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1 hide-footer-title" id="ariaid-title1">Footer Section</h1><div class="body footer-container"><p class="shortdesc"></p><section class="section footer-item footer-links footer-full"><h2 class="title sectiontitle" id="our-support-team-is-here-to-help-0">Our Support Team is here to help</h2>
            
            <p class="p">Submit a support request or check the status of your existing requests. You can also email us.</p>
            <p class="p"><a class="xref footer-connect-button j-external-link" href="https://support.heretto.com/hc/en-us" target="_blank">Contact Support Team</a></p>
        </section><section class="section footer-bottom-container">

        <div class="div footer-item footer-links footer-bigger">
            <p class="p footer-img-left"><a class="xref j-external-link" href="https://heretto.com/" target="_blank"><img class="image footer-logo" src="https://heretto.deploy.heretto.com/v4/deployments/I9vA3KlK8201IYmECh5U/object/a69de2b0-741e-11ee-a3d9-0242d8e432a4?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJodHRwczovL2pvcnNlay5jb20vZXpkX29yZ2FuaXphdGlvbiI6ImpvcnNlay1kb2NzIiwiaHR0cHM6Ly9qb3JzZWsuY29tL2V6ZC9vYmplY3RfdXVpZCI6ImE2OWRlMmIwLTc0MWUtMTFlZS1hM2Q5LTAyNDJkOGU0MzJhNCIsImV4cCI6MTc1NTE5MTY0NywianRpIjoiOGY1YjQ5Y2Q3NWYzNDZiOWJlYjM2NDBhY2YxMTQ3OWIiLCJodHRwczovL2pvcnNlay5jb20vZXpkX2ZpbGVzZXQiOiJ0eWp6dnJGOWI3Q3U3bmxYS2pXaSJ9.n6Rqyu2x84ZaMOWheuCawFWHrqxX2L1nBtRy34R49TM"></a></p>
            <p class="p footer-section-title">Love this help site?</p>
            <p class="p">You can have one, too! Sitting on top of the Heretto CCMS, our team can build a tailored portal that will delight your customers. Meet with our team to learn more.</p>
            <p class="p"><a class="xref footer-connect-button j-external-link" href="https://www.heretto.com/request-demo?utm_medium=direct-traffic&amp;utm_source=direct-traffic&amp;utm_campaign=demo-request&amp;utm_content=helpsite&amp;utm_term=" target="_blank">Connect with us</a></p>
        </div>
        <div class="div footer-item footer-links">
            <p class="p footer-heading">Explore</p>
            <p class="p"></p>
            <p class="p"></p>
            <p class="p"><a class="xref" href="/heretto-ccms/integrations/heretto-ccms-integrations-overview">Integrations</a></p>
            <p class="p"><a class="xref j-external-link" href="https://heretto.com/video-tutorials/" target="_blank">Video Tutorials</a></p>
            <p class="p"><a class="xref j-external-link" href="https://learningdita.com/" target="_blank">Learning DITA </a></p>
        </div>
        <div class="div footer-item footer-links">
            <p class="p footer-heading">Company</p>
            <p class="p"><a class="xref j-external-link" href="https://heretto.com/about-heretto/" target="_blank">About Us</a></p>
            <p class="p"><a class="xref j-external-link" href="https://www.heretto.com/contact" target="_blank">Contact Us</a></p>
            <p class="p"><a class="xref j-external-link" href="https://heretto.com/" target="_blank">heretto.com</a></p>
        </div>
        <div class="div footer-item footer-links">
            <p class="p footer-heading">Legalities</p>
            <p class="p"><a class="xref j-external-link" href="https://heretto.com/legal/" target="_blank">Legal</a></p>
            <p class="p"><a class="xref j-external-link" href="https://heretto.com/privacy-policy/" target="_blank">Privacy Policy</a></p>
            <p class="p"><a class="xref j-external-link" href="https://heretto.com/terms-of-use/" target="_blank">Terms of Use</a></p>
        </div>
        <div class="div footer-copyright-container">
            <div class="div copyright-left">
                <p class="p copyright-item">© 2025 Heretto Intellectual Property. All rights reserved.</p>
                <p class="p copyright-item"><a class="xref copyright-link j-external-link" href="https://heretto.com/legal/" target="_blank">Legal</a></p>
                <p class="p copyright-item"><a class="xref copyright-link j-external-link" href="https://heretto.com/privacy-policy/" target="_blank">Privacy Policy</a></p>
                <p class="p copyright-item"><a class="xref copyright-link j-external-link" href="https://heretto.com/terms-of-use/" target="_blank">Terms of Use</a></p>
                <p class="p copyright-item"><a class="xref copyright-link j-external-link" href="https://heretto.com/about-heretto/" target="_blank">About Us</a></p>
            </div>
            <div class="div copyright-right">
                <p class="p copyright-item"><a class="xref j-external-link" href="https://twitter.com/helloHeretto" target="_blank"><img class="image social-logo" src="https://heretto.deploy.heretto.com/v4/deployments/I9vA3KlK8201IYmECh5U/object/a6b402c0-741e-11ee-a3d9-0242d8e432a4?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJodHRwczovL2pvcnNlay5jb20vZXpkX29yZ2FuaXphdGlvbiI6ImpvcnNlay1kb2NzIiwiaHR0cHM6Ly9qb3JzZWsuY29tL2V6ZC9vYmplY3RfdXVpZCI6ImE2YjQwMmMwLTc0MWUtMTFlZS1hM2Q5LTAyNDJkOGU0MzJhNCIsImV4cCI6MTc1NTE5MTY0NywianRpIjoiY2FkNDJmYzgyZGJiNGYwM2EyYWI1NzA5NzU1OTZiOGYiLCJodHRwczovL2pvcnNlay5jb20vZXpkX2ZpbGVzZXQiOiJ0eWp6dnJGOWI3Q3U3bmxYS2pXaSJ9.p98Tf5i9HYhXp5glhdmnY_Rxki7TbU1r2_c8h_cKRrY"></a></p>
                <p class="p copyright-item"><a class="xref j-external-link" href="https://www.linkedin.com/company/heretto/" target="_blank"><img class="image social-logo" src="https://heretto.deploy.heretto.com/v4/deployments/I9vA3KlK8201IYmECh5U/object/a6c7b1d0-741e-11ee-a3d9-0242d8e432a4?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJodHRwczovL2pvcnNlay5jb20vZXpkX29yZ2FuaXphdGlvbiI6ImpvcnNlay1kb2NzIiwiaHR0cHM6Ly9qb3JzZWsuY29tL2V6ZC9vYmplY3RfdXVpZCI6ImE2YzdiMWQwLTc0MWUtMTFlZS1hM2Q5LTAyNDJkOGU0MzJhNCIsImV4cCI6MTc1NTE5MTY0NywianRpIjoiYzhhNTE1YWIwMGNjNGY0ZGI3ZDg2NTM3ZGQ4MmFiYTciLCJodHRwczovL2pvcnNlay5jb20vZXpkX2ZpbGVzZXQiOiJ0eWp6dnJGOWI3Q3U3bmxYS2pXaSJ9.mr4FyPPrFeHihVd9mV28jw1r2dh2_3mB3Hv4g2ZANy8"></a></p>
            </div>
        </div>

</section></div></article></main></body>

Footer Section

<i18n-message>[MISSING CONTENT]</i18n-message>

Etto, the Heretto Copilot, is a generative Artificial Intelligence (AI) tool built for Heretto CCMS. The goal of Etto is to help you create quality structured content in the DITA XML standard, boost productivity by assisting with time-consuming tasks, and improve overall content consistency.

Etto, the Heretto Copilot Overview

Deploy API Functions

Deploy API Content Flow

Deploy API Definitions

<body class="page-break-after" id="concept-925"><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1" id="ariaid-title1"><span class="ph">Deploy API</span> Overview</h1><div class="body conbody"><div class="abstract">
        <div class="note note note_note"><span class="note__title">Note:</span> If you are looking for information about how to publish API specifications to <span class="ph">Heretto Portal</span>, see <a class="xref" href="/heretto-portal/heretto-portal-api-docs#concept-603">Heretto Portal API Docs</a>.</div>
        <div class="note important note_important"><span class="note__title">Important:</span> 
            <p class="p"><span class="ph">Heretto Deploy API</span> is undergoing a major architectural redesign and upgrade that enhances its performance, usability, and scalability. The first building blocks for this next generation (v4) of <span class="ph">Heretto Deploy API</span> are being rolled out, with the current focus on manual deployments. This content will be updated as the building blocks of the next generation <span class="ph">Deploy API</span> are rolled out.<span class="ph"> For an overview of changes  in manual deployments  v4, see <a class="xref" href="/release-notes/may-2025#concept-3235">Release Notes</a>.</span></p>
        </div>
        <p class="shortdesc"><span class="ph">Heretto Deploy API</span> is the crucial content delivery service that processes content from <span class="ph">Heretto CCMS</span> and transforms it into formats that can be delivered to end-users. The processed content is then delivered through the <span class="ph">Heretto Portal</span> or other delivery endpoints such as websites, applications, devices, or machines.</p>
    </div><p class="p">As an example, the documentation you are currently reading was delivered to this help site with <span class="ph">Deploy API</span>. Our help site is powered by both <span class="ph">Deploy API</span> and <span class="ph">Heretto Portal</span>.</p><div class="p"><span class="ph">Deploy API</span> supports: <ul class="ul"><li class="li">
                    <p class="p">Delivering localized content</p>
                </li><li class="li">
                    <p class="p">Managing access through authentication</p>
                </li><li class="li">
                    <p class="p">Tailoring content to different audiences (personalization)</p>
                </li></ul></div><p class="p">Key <span class="ph">Deploy API</span> use cases:</p><dl class="dl"><dt class="dt dlterm">Building Websites</dt><dd class="dd">
            <p class="p">Transform your <span class="ph">Heretto CCMS</span> content into complete websites such as knowledge bases, support portals, or documentation hubs. Customize branding and design elements to maintain visual consistency with your existing web properties.</p>
        </dd><dt class="dt dlterm">Embedding Content</dt><dd class="dd">
            <p class="p">Integrate content from <span class="ph">Heretto CCMS</span> directly into existing websites or applications. This enables context-sensitive help, in-app documentation, or targeted information delivery within your digital products.</p>
            
        </dd><dt class="dt dlterm">Distributing to Multiple Endpoints</dt><dd class="dd">
            <p class="p">Deploy your DITA source content to diverse delivery channels including IoT devices, embedded systems, and custom applications using <span class="ph">Deploy API</span>. This ensures consistent information across all customer touchpoints.</p>
        </dd></dl><p class="p">This single-source publishing approach ensures content consistency while reducing maintenance overhead. When you update content in <span class="ph">Heretto CCMS</span>, you can easily deliver them to all channels, typically significantly reducing publishing time compared to traditional multi-channel publishing workflows.</p></div><article class="topic concept nested1" aria-labelledby="ariaid-title2" lang="en-us" id="concept-5440"><h2 class="title topictitle2" id="ariaid-title2"><span class="ph">Deploy API</span> Functions</h2><div class="body conbody"><p class="shortdesc"><span class="ph">Heretto Deploy API</span> serves two main functions: it  processes content managed in <span class="ph">Heretto CCMS</span>, and serves it to the <span class="ph">Heretto Portal</span> or other delivery endpoints such as websites, applications, devices, or machines.</p><dl class="dl"><dt class="dt dlterm">Content Processing</dt><dd class="dd">
                    <p class="p">The <span class="ph">Deploy API</span> processes content managed in <span class="ph">Heretto CCMS</span> and published through a deployment. It captures and snapshots all content involved in a publishing job, performs content rendering, and creates an immutable database of the final content.</p>
                    
                </dd><dt class="dt dlterm">Content Delivery</dt><dd class="dd">
                    <p class="p">The <span class="ph">Deploy API</span> serves the processed content to delivery endpoints such as the <span class="ph">Heretto Portal</span>, websites, applications, machines, and devices. </p>
                    
                </dd></dl><div class="note note note_note"><span class="note__title">Note:</span> <p class="p">In <span class="ph">Deploy API</span> v4, the functions of processing and serving content have been separated to make <span class="ph">Deploy API</span>  significantly  more resilient and scalable. This change is currently only applicable to manual deployments in <span class="ph">Deploy API</span> v4. <span class="ph">Deploy API</span> v4 conceptually runs in the same infrastructure as Cloud Publishing, with each deployment being treated as a publishing job and processed in an ephemeral container in the cloud.</p></div></div></article><article class="topic concept nested1" aria-labelledby="ariaid-title3" lang="en-us" id="concept-875"><h2 class="title topictitle2" id="ariaid-title3">Deploy API Content Flow</h2><div class="body conbody"><p class="shortdesc"><span class="ph">Heretto Deploy API</span> serves as the processing and delivery engine for <span class="ph">Heretto CCMS</span> content. It transforms content into delivery-ready formats and distributes it to various endpoints including websites, applications, and devices.</p><section class="section"><h3 class="title sectiontitle" id="how-content-is-passed-to-deploy-api-0">How Content is Passed to <span class="ph">Deploy API</span></h3>
            
            <p class="p">Once content is finalized in <span class="ph">Heretto CCMS</span>, it moves to the <span class="ph">Deploy API</span> through  deployments. </p>
            <p class="p">Deployments are essential configuration elements that determine which content is published, where it's published, and under what conditions. Deployments connect specific content in the CCMS with appropriate delivery endpoints such as <span class="ph">Heretto Portal</span> or other delivery endpoints.</p>
            <p class="p"><span class="ph">Deploy API</span> supports two deployment types:</p>
            <dl class="dl"><dt class="dt dlterm"><span class="ph b">Active Sync</span></dt><dd class="dd">
                        <p class="p">Automatically and continually publishes content updates from the CCMS to delivery endpoints. As content creators make changes in the CCMS, their updates are rapidly integrated into the associated deployment and published to a delivery endpoint. </p>
                        <p class="p">Active sync is valuable for preview environments where teams need to see work-in-progress content. Due to its immediate nature and the risk of publishing work-in-progress content, active sync is not available for production portal environments.</p>
                    </dd><dt class="dt dlterm"><span class="ph b">Manual Deploy</span></dt><dd class="dd">
                        <p class="p">Requires deliberate user action to initiate the publishing process. Content updates remain in the CCMS until a user manually publishes a deployment. This deployment type gives teams control over when updates are released, enabling them to work on substantial content updates.</p>
                        <p class="p">Manual deploy is available for all portal environments. It is the standard configuration for publishing official content versions.</p>
                    </dd></dl>
        </section><section class="section"><h3 class="title sectiontitle" id="how-content-becomes-a-deployment-0">How Content Becomes a Deployment</h3>
            
            <p class="p">Once content is passed from <span class="ph">Heretto CCMS</span> through a deployment to <span class="ph">Deploy API</span>, it is processed into a final output and served to the <span class="ph">Heretto Portal</span> or other delivery endpoints.</p>
            <p class="p">Processing a deployment involves evaluating raw DITA content and associated assets and converting them into a final output used to serve the content to its final delivery endpoint for end-user consumption. All deployment processing starts in <span class="ph">Heretto CCMS</span> with the deployment configuration and a DITA map (sitemap). At a high level, the following happens during a deployment processing:</p>
            <ul class="ul"><li class="li">
                    <p class="p">Deployment instructions indicate the audiences and the locales (target languages) that are included.</p>
                </li><li class="li">
                    <p class="p">The map defines the scope of the deployment.</p>
                </li><li class="li">
                    <p class="p">All content files for a tenant are located and made available.</p>
                </li><li class="li">
                    <p class="p">All source content is processed into a normalized structure with all necessary information for output. </p>
                    <p class="p">This process involves steps such as: evaluating document metadata, including or excluding review markup, processing conditional sets, processing keyrefs and xrefs, link correction, and processing tables and figures.</p>
                </li></ul>
            <p class="p">At this point, there is an ephemeral in-memory representation of the full set of content in an intermediate state that is <em class="ph i">nearly</em> final. The content is ready to be rapidly transformed into a final output format, like HTML. This process of building a content set in its <em class="ph i">nearly</em> final state is used by both active sync and manual deploy deployments. How the two deployment types use this process varies, as described below.</p>
            <dl class="dl"><dt class="dt dlterm">Active Sync Processing</dt><dd class="dd">
                        <p class="p">With an active sync deployment, the process is always on, hosting the content in its <em class="ph i">nearly</em> final state. The content in this case is hosted within <span class="ph">Deploy API</span>. </p>
                        <p class="p">There are two reasons it works this way. The content can be quickly returned in the final format to serve content requests. Additionally, the intermediate in-memory state is ideal for quickly integrating content changes from the CCMS.</p>
                        <p class="p">The primary benefit of this structure is the rapid integration of new content. That benefit comes with some expense:</p>
                        <ul class="ul"><li class="li">
                                <p class="p">The representation is ephemeral and must be reprocessed at restart</p>
                            </li><li class="li">
                                <p class="p">All content must fit in memory</p>
                            </li><li class="li">
                                <p class="p">An error in content can impact the APIs ability to respond to content requests</p>
                            </li><li class="li">
                                <p class="p">Auto scaling the API is slow because of the initial processing duration</p>
                            </li></ul>
                    </dd><dt class="dt dlterm">Manual Deploy Processing</dt><dd class="dd">
                        <p class="p">With a manual deployment, the process of building the set of content in its <em class="ph i">nearly</em> final state happens outside of <span class="ph">Deploy API</span>. When deployment publishing is triggered, a publishing job is initiated that performs the processing. At the end of processing the content, a snapshot is generated. The snapshot includes: all the files used for processing, an immutable database with all content in its final form, and search indexes. Upon completion of processing and storage, the <span class="ph">Deploy API</span> switches to serving content from the new immutable database.</p>
                        <p class="p">There are multiple benefits to this mode of operation:</p>
                        <ul class="ul"><li class="li">
                                <p class="p">All content processing happens outside of the production API, reducing the risk that a content error makes the API unavailable</p>
                            </li><li class="li">
                                <p class="p">Rapid auto scaling because all content is pre-processed</p>
                            </li><li class="li">
                                <p class="p">The code base for serving content is 90% smaller, leaving less surface area for issues</p>
                            </li><li class="li">
                                <p class="p">Highly efficient memory and content serving for a great experience</p>
                            </li><li class="li">
                                <p class="p">Content no longer needs to fit directly into memory, greatly increasing safety</p>
                            </li></ul>
                        <p class="p">The main tradeoff of manual deployments is that content updates take longer to become available, as the processing job must finish before new content is deployed.</p>
                    </dd></dl>
        </section></div></article><article class="topic concept nested1" aria-labelledby="ariaid-title4" lang="en-us" id="concept-4005"><h2 class="title topictitle2" id="ariaid-title4">Definitions</h2><div class="body conbody"><p class="shortdesc"></p><dl class="dl"><dt class="dt dlterm">Delivery Endpoint</dt><dd class="dd"><p class="p">A delivery endpoint is any final destination where users consume content that has been processed by <span class="ph">Heretto Deploy API</span>. Delivery endpoints can include <span class="ph">Heretto Portal</span>, websites, applications, devices, and machines.</p><p class="p">Delivery  endpoints receive content that is managed in <span class="ph">Heretto CCMS</span>, processed by <span class="ph">Deploy API</span>, and transformed into appropriate formats for end-user consumption.</p></dd><dt class="dt dlterm">Deployments</dt><dd class="dd"><p class="p">Deployments are configurations that connect content in the CCMS with delivery endpoints via <span class="ph">Deploy API</span>. They enable content publication to the appropriate delivery endpoint, like  <span class="ph">Heretto Portal</span> or other delivery endpoints such as websites, applications, devices, or machines.</p></dd><dt class="dt dlterm"><span class="ph">Heretto Deploy API</span></dt><dd class="dd">
                    <p class="p">A read-only API that enables you to deliver content from <span class="ph">Heretto CCMS</span> to different endpoints. The delivered content includes:</p>
                    <ul class="ul" id="concept-4005__ul_p1y_3lf_sjb"><li class="li">JSON data</li><li class="li">Media files</li><li class="li">Transformed XML content (HTML5) or compiled DITA</li></ul>
                </dd><dt class="dt dlterm">Serving Content</dt><dd class="dd"><p class="p">The process of requesting and receiving a final result from <span class="ph">Deploy API</span>, which may be content on a page or the structure required to serve that content. For example, when users access a page, they're essentially making an API request to <span class="ph">Deploy API</span>, which then delivers the requested content. This technical interaction forms the foundation of content delivery within the system.</p></dd><dt class="dt dlterm">Sitemaps</dt><dd class="dd">
                    <p class="p">Sitemaps are specialized DITA maps that determine the structure of your content. Depending on the environment you publish to, you may need to use different <span class="ph">sitemap</span> structures.</p>
                    <p class="p"><span class="ph">Deploy API</span> supports different <span class="ph">sitemap</span> structures.</p>
                </dd></dl></div></article></article></main></body>

Heretto Deploy API ensures that your content is processed and delivered for end-user consumption securely.

Deploy API Authentication and Security

Read the Deploy API specification and related resources

Heretto Deploy API

FAQs

Heretto Deploy API is the crucial content delivery service that processes content from Heretto CCMS and transforms it into formats that can be delivered to end-users. The processed content is then delivered through the Heretto Portal or other delivery endpoints such as websites, applications, devices, or machines.

Deploy API Overview

Use Heretto API Docs to publish API documentation for public and internal consumption within Heretto Portal.

API Docs Overview

<body id="topic-9225"><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1" id="ariaid-title1">Heretto Deploy Portal Overview</h1><div class="body"><p class="shortdesc"></p><iframe class="object iframe" controls="controls" src="https://www.youtube.com/embed/45CFJ3YhByI?list=PL4ZeW5ujwMiG-qroejPZ7DDYRf-potbdf" referrerpolicy="strict-origin-when-cross-origin" allowtransparency="true" frameborder="0" scrolling="no" allowfullscreen="true" mozallowfullscreen="true" webkitallowfullscreen="true" oallowfullscreen="true" msallowfullscreen="true" width="100%" height="270"></iframe><section class="section"><h2 class="title sectiontitle" id="heretto-deploy-portal-overview-0">Heretto Deploy Portal Overview</h2>
            
            <p class="p">Real-time content delivery anywhere</p>
        </section></div></article></main></body>

Heretto Deploy Portal Overview

<body id="topic-2626"><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1" id="ariaid-title1">Heretto UX Overview</h1><div class="body"><p class="shortdesc"></p><iframe class="object iframe" controls="controls" src="https://www.youtube.com/embed/qJNtVI2cKTA" referrerpolicy="strict-origin-when-cross-origin" allowtransparency="true" frameborder="0" scrolling="no" allowfullscreen="true" mozallowfullscreen="true" webkitallowfullscreen="true" oallowfullscreen="true" msallowfullscreen="true" width="100%" height="270"></iframe><section class="section"><h2 class="title sectiontitle" id="heretto-ux-overview-0">Heretto UX Overview</h2>
            
            <p class="p"><a class="xref external-video-link j-external-link" href="https://heretto.com/product-pulse/" target="_blank">View more videos</a></p>
        </section></div></article></main></body>

Heretto UX Overview

A new CCMS version with no end-user updates to report.

August 8, 2028

<body id="concept-9400"><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1" id="ariaid-title1">Endpoint URL Changes in <span class="ph">Deploy API</span> v4</h1><div class="body conbody"><p class="shortdesc">The endpoint URL structure in the next generation <span class="ph">Heretto Deploy API</span> (v4) has been improved. The changes affect both active sync and manual deployments. Customers delivering content to third-party endpoints must update their code.</p><section class="section"><h2 class="title sectiontitle" id="who-is-affected-0">Who is Affected</h2> <p class="p">Customers  who implemented custom scripts directly against <span class="ph">Deploy API</span> endpoints or  deliver content to third-party endpoints, like  devices  or machines, must update their endpoint URLs before during the three-month backward compatibility period, after which backward compatibility will cease.</p><div class="note note note_note" id="concept-9400__backward-compatybility"><span class="note__title">Note:</span> 
            <p class="p">Heretto will maintain backward URL compatibility for three months after the rollout of manual deployment v4 is complete. <span class="ph b">The  end date for </span><span class="ph">Deploy API</span><span class="ph b"> v3 support is August 31, 2025.</span>  Your <span class="ph">Customer Success Manager</span> (CSM) will notify you of the rollout completion date, which will also be provided here.</p></div><p class="p">No action is required for customers publishing only to the  <span class="ph">Heretto Portal</span>, as the portal automatically uses the improved URL structure.</p></section><section class="section"><h2 class="title sectiontitle" id="changes-in-the-endpoint-url-structure-0">Changes in the Endpoint URL Structure</h2>
            
            <p class="p">Key changes include:</p><ul class="ul"><li class="li"><p class="p">Endpoints now allow vanity URLs that indicate the  organization </p></li><li class="li"><p class="p">The <code class="ph codeph">v3</code> value changes to <code class="ph codeph">v4</code></p></li><li class="li"><p class="p">The <code class="ph codeph">org</code> segment has been removed</p></li><li class="li"><p class="p">The <code class="ph codeph">deploymentId</code> parameter has changed  to <code class="ph codeph">deploymentIdentifier</code> </p></li></ul><p class="p">The  previous <span class="ph">Deploy API</span> version (v3) URL structure was:</p>
        <pre class="pre codeblock language-json"><code>https://deploy.heretto.com/v3/org/{organizationId}/deployments/{deploymentId}/search</code></pre>
        
        
        <p class="p">The new <span class="ph">Deploy API</span> version (v4) URL structure is:</p>
        <pre class="pre codeblock language-json"><code>https://{organizationId}.deploy.heretto.com/v4/deployments/{deploymentIdentifier}/search</code></pre>
        <p class="p">For example, the endpoint structure for the company Thunderbird with a  <code class="ph codeph">deploymentIdentifier</code> of <code class="ph codeph">2x4B2ago1LP68DpJH5B</code> changes as follows:</p><div class="p">In v3, the search URL was:<pre class="pre codeblock language-json"><code>https://deploy.heretto.com/v3/org/thunderbird/deployments/2x4B2ago1LP68DpJH5B/search
</code></pre>In v4, the new URL reads:<pre class="pre codeblock language-json"><code>https://thunderbird.deploy.heretto.com/v4/deployments/2x4B2ago1LP68DpJH5B/search</code></pre></div><div class="note note note_note"><span class="note__title">Note:</span> <ul class="ul"><li class="li"><p class="p">All API methods remain unchanged; their syntax, parameters, and responses are the same</p></li><li class="li"><p class="p">Once Deploy API v4 is enabled, during the transition period, customers will be able to use both Deploy API v3 and v4 syntax</p></li></ul></div>
        </section></div></article></main></body>

Search pages

Defining audiences in a map or for a deployment enables your content to reach the recipients you intend for it. This way users receive the information that is relevant to them, and are restricted from accessing other content.

Filtering and Personalization

The endpoint URL structure in the next generation Heretto Deploy API (v4) has been improved. The changes affect both active sync and manual deployments. Customers delivering content to third-party endpoints must update their code.

Endpoint URL Changes in Deploy API v4

Access XML Details of a Referenced SVG File

Access XML Details of a Referenced Topic

Include Draft-comment Content in Output

Create a Variable Image on the Cover Page

<body id="concept-2615"><main role="main"><article role="article" aria-labelledby="ariaid-title1"><h1 class="title topictitle1" id="ariaid-title1">Advanced XSL Transformations</h1><div class="body conbody"><p class="shortdesc">You can use advanced XSL to perform complex transformations in <span class="ph">PDF Generator</span> outputs. When planning to use advanced XSLT in your <span class="ph">PDF Generator</span> scenarios, consider this important information.</p><section class="section"><h2 class="title sectiontitle" id="important-considerations-0">Important Considerations</h2><ul class="ul"><li class="li"><p class="p">We recommend that users experienced with advanced XSL complete these procedures.</p></li><li class="li"><p class="p">You need to be  assigned the <span class="ph">Administrator</span> role in <span class="ph">Heretto CCMS</span> to modify <span class="ph">PDF Generator</span>  publishing scenarios.</p></li><li class="li"><p class="p"><span class="ph">PDF Generator</span> uses an API call that calls the resource UUID. The path to a resource is <code class="ph codeph"><var class="keyword varname">UUID</var>.<var class="keyword varname">file-extension</var></code>. For example, <code class="ph codeph">33573366-bfc8-445c-8322-203d83bbc1mr.svg</code>.</p></li><li class="li"><p class="p">You need to add namespaces to your XSLT stylesheets. Add  <code class="ph codeph">xs:preservens="true"</code> as presented here: </p><pre class="pre codeblock lang-xsl"><code>&lt;xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"    xmlns:xs="http://www.w3.org/2001/XMLSchema" xs:preservens="true" exclude-result-prefixes="opentopic" version="2.0"&gt;</code></pre><pre class="pre codeblock lang-xsl"><code>xmlns:xs="http://www.w3.org/2001/XMLSchema"
xs:preservens="true"</code></pre></li></ul></section></div><article class="topic task nested1" aria-labelledby="ariaid-title2" id="task-8341"><h2 class="title topictitle2" id="ariaid-title2">Access XML Details of a Referenced SVG File</h2><div class="body taskbody"><div class="abstract"><span class="shortdesc">You can use XSLT to access XML details of an SVG file referenced in topic and use that information in the <span class="ph">PDF Generator</span> output transformation. This procedure can be completed only by users assigned the <span class="ph">Administrator</span> role in <span class="ph">Heretto CCMS</span>. </span></div><section class="section context"><p class="p">This procedure does not explain how to access details of annotated images with XSLT. It explains how to access details of images saved to the <span class="ph filepath">.svg</span> format, uploaded to <span class="ph">Heretto CCMS</span>, and added to a topic in a figure element (<code class="ph codeph">fig</code>) or image element (<code class="ph codeph">image</code>).</p></section><ol class="ol steps"><li class="li step stepexpand"><span class="ph cmd" id="task-8341__cmd_lzt_kpc_vkb">In the top-left corner, click the <span class="ph"><span class="keyword wintitle">Main Menu</span> <img class="image" src="https://heretto.deploy.heretto.com/v4/deployments/I9vA3KlK8201IYmECh5U/object/4d399120-0470-11ed-844a-02428d90e38c?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJodHRwczovL2pvcnNlay5jb20vZXpkX29yZ2FuaXphdGlvbiI6ImpvcnNlay1kb2NzIiwiaHR0cHM6Ly9qb3JzZWsuY29tL2V6ZC9vYmplY3RfdXVpZCI6IjRkMzk5MTIwLTA0NzAtMTFlZC04NDRhLTAyNDI4ZDkwZTM4YyIsImV4cCI6MTc1NTE5MTU3OSwianRpIjoiNTY2NzcyZjgyZTdmNGMwMGJkN2VkNzM4YWI1ZjViMzEiLCJodHRwczovL2pvcnNlay5jb20vZXpkX2ZpbGVzZXQiOiJ0eWp6dnJGOWI3Q3U3bmxYS2pXaSJ9.CYbhQjSh5MU8K2xMYbpfpmcHGIYwpavXB2q3-Eh-hN4"></span> and go to <span class="ph uicontrol">PDF Generator</span>.</span></li><li class="li step stepexpand"><span class="ph cmd">In the <span class="ph"><span class="keyword wintitle">PDF Generator scenarios</span> screen</span>, click the publishing scenario you want to edit.</span></li><li class="li step stepexpand"><span class="ph cmd">In the <span class="ph"><span class="keyword wintitle">XSLT</span> tab</span>, add this code:</span><div class="itemgroup info"><pre class="pre codeblock lang-xsl"><code>&lt;xsl:if test="contains(@href, '.svg')"&gt;
    &lt;xsl:attribute name="width" select="document(@href)//*[local-name()='svg']/@width"/&gt;
&lt;/xsl:if&gt;</code></pre><p class="p">This code is an example of accessing the width attribute of an SVG file. </p>
                    
                </div></li><li class="li step stepexpand"><span class="ph cmd">Modify the code to call the desired SVG detail. </span></li><li class="li step stepexpand"><span class="ph cmd">Click <span class="ph uicontrol">Save Scenario</span> and verify your changes by publishing test content with the scenario you modified.</span></li></ol></div></article><article class="topic task nested1" aria-labelledby="ariaid-title3" id="task-700"><h2 class="title topictitle2" id="ariaid-title3">Access XML Details of a Referenced Topic</h2><div class="body taskbody"><p class="shortdesc">You can use XSLT to access XML details of a topic that is referenced by a different topic and use that information in the <span class="ph">PDF Generator</span> output transformation. This procedure can be completed only by users assigned the <span class="ph">Administrator</span> role in <span class="ph">Heretto CCMS</span>.</p><div class="section prereq p">
            <p class="p">Ensure the cross-reference (<code class="ph codeph">xref</code>) that links the topic whose details you want to access has <code class="ph codeph">scope="local"</code> set. For example, <code class="ph codeph">&lt;xref href="topic.dita" scope="local"&gt;&lt;/xref&gt;</code>.</p>
        </div><ol class="ol steps"><li class="li step stepexpand"><span class="ph cmd" id="task-700__cmd_lzt_kpc_vkb">In the top-left corner, click the <span class="ph"><span class="keyword wintitle">Main Menu</span> <img class="image" src="https://heretto.deploy.heretto.com/v4/deployments/I9vA3KlK8201IYmECh5U/object/4d399120-0470-11ed-844a-02428d90e38c?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJodHRwczovL2pvcnNlay5jb20vZXpkX29yZ2FuaXphdGlvbiI6ImpvcnNlay1kb2NzIiwiaHR0cHM6Ly9qb3JzZWsuY29tL2V6ZC9vYmplY3RfdXVpZCI6IjRkMzk5MTIwLTA0NzAtMTFlZC04NDRhLTAyNDI4ZDkwZTM4YyIsImV4cCI6MTc1NTE5MTU3OSwianRpIjoiZjU1MTA0ZDU2M2E1NDA1Njk5YjMxZWYxODc1MzM3M2IiLCJodHRwczovL2pvcnNlay5jb20vZXpkX2ZpbGVzZXQiOiJ0eWp6dnJGOWI3Q3U3bmxYS2pXaSJ9.DwW6WaXbuLY7c0c3RVl5aK1FrmdG-MUFuEjTMOuLDgM"></span> and go to <span class="ph uicontrol">PDF Generator</span>.</span></li><li class="li step stepexpand"><span class="ph cmd">In the <span class="ph"><span class="keyword wintitle">PDF Generator scenarios</span> screen</span>, click the publishing scenario you want to edit.</span></li><li class="li step stepexpand"><span class="ph cmd">In the <span class="ph"><span class="keyword wintitle">XSLT</span> tab</span>, add this code:</span><div class="itemgroup info">
                    <div class="note important note_important"><span class="note__title">Important:</span> Before passing that attribute to the <code class="ph codeph">document()</code> function, it must be  prefixed with <code class="ph codeph">no-doctype:</code> to remove the <code class="ph codeph">&lt;!DOCTYPE&gt;</code> element from processing.</div><pre class="pre codeblock lang-xsl"><code>&lt;xsl:template match="*[contains(@class, ' topic/xref ')]" name="topic.xref"&gt;
        &lt;xsl:choose&gt;
            &lt;xsl:when test="@file-uuid and normalize-space(@file-uuid)"&gt;
                &lt;xsl:variable name="prefixedFileUuid" select="concat('no-doctype:', @file-uuid)"/&gt;
                &lt;xsl:comment&gt;
                    &lt;xsl:value-of select="$prefixedFileUuid"/&gt;
                &lt;/xsl:comment&gt;
                &lt;a&gt;
                    &lt;xsl:attribute name="title"&gt;
                        &lt;xsl:value-of select="document($prefixedFileUuid)//title"/&gt;
                    &lt;/xsl:attribute&gt;
                &lt;/a&gt;
            &lt;/xsl:when&gt;
            &lt;xsl:otherwise&gt;
                &lt;span&gt;
                    Not able to retrieve title from Document 
                &lt;/span&gt;
            &lt;/xsl:otherwise&gt;
        &lt;/xsl:choose&gt;        
    &lt;/xsl:template&gt;</code></pre><p class="p">This code looks for the <code class="ph codeph">file-uuid</code> attribute. </p>
                </div></li><li class="li step stepexpand"><span class="ph cmd">Modify the code to call for the desired topic detail. </span></li><li class="li step stepexpand"><span class="ph cmd">Click <span class="ph uicontrol">Save Scenario</span> and verify your changes by publishing test content with the scenario you modified.</span></li></ol></div></article><article class="topic task nested1" aria-labelledby="ariaid-title4" id="task-7442"><h2 class="title topictitle2" id="ariaid-title4">Include Draft-comment Content in Output</h2><div class="body taskbody"><p class="shortdesc">By default, content added within the <code class="ph codeph">draft-comment</code> element is excluded from outputs. However, you can use XSLT to ensure that a <span class="ph">PDF Generator</span> scenario includes it. This procedure can be completed only by users assigned the <span class="ph">Administrator</span> role in <span class="ph">Heretto CCMS</span>.</p><ol class="ol steps"><li class="li step stepexpand"><span class="ph cmd" id="task-7442__cmd_lzt_kpc_vkb">In the top-left corner, click the <span class="ph"><span class="keyword wintitle">Main Menu</span> <img class="image" src="https://heretto.deploy.heretto.com/v4/deployments/I9vA3KlK8201IYmECh5U/object/4d399120-0470-11ed-844a-02428d90e38c?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJodHRwczovL2pvcnNlay5jb20vZXpkX29yZ2FuaXphdGlvbiI6ImpvcnNlay1kb2NzIiwiaHR0cHM6Ly9qb3JzZWsuY29tL2V6ZC9vYmplY3RfdXVpZCI6IjRkMzk5MTIwLTA0NzAtMTFlZC04NDRhLTAyNDI4ZDkwZTM4YyIsImV4cCI6MTc1NTE5MTU3OSwianRpIjoiNjZlNDA4YzNhYzg3NDc1MWI5YTliOGQ5MDYxYjhjNTkiLCJodHRwczovL2pvcnNlay5jb20vZXpkX2ZpbGVzZXQiOiJ0eWp6dnJGOWI3Q3U3bmxYS2pXaSJ9.hdo_tFqGGXVajQ0QCh4NLmzXli4smCHbtKkueWwO-I4"></span> and go to <span class="ph uicontrol">PDF Generator</span>.</span></li><li class="li step stepexpand"><span class="ph cmd">In the <span class="ph"><span class="keyword wintitle">PDF Generator scenarios</span> screen</span>, click the publishing scenario you want to edit.</span></li><li class="li step stepexpand"><span class="ph cmd">In the <span class="ph"><span class="keyword wintitle">XSLT</span> tab</span>, add this code:</span><div class="itemgroup info">
                    <pre class="pre codeblock lang-xsl"><code>&lt;xsl:param name="DRAFT" select="'yes'"/&gt;</code></pre>
                </div></li><li class="li step stepexpand"><span class="ph cmd">Click <span class="ph uicontrol">Save Scenario</span> and verify your changes by publishing test content with the scenario you modified.</span></li></ol></div></article><article class="topic task nested1" aria-labelledby="ariaid-title5" id="task-9914"><h2 class="title topictitle2" id="ariaid-title5">Create a Variable Image on the Cover Page</h2><div class="body taskbody"><div class="abstract"><p class="shortdesc">You can use a combination of DITAVAL files and XSLT code to control the images that print on a PDF cover. By doing so, instead of creating unique publishing scenarios for each product, you can use one <span class="ph">PDF Generator</span> publishing scenario to print different images on PDF covers. </p><p class="p">Portions of this procedure can be completed only by users assigned the <span class="ph">Administrator</span> role in <span class="ph">Heretto CCMS</span>.</p></div><div class="section prereq p">
            <p class="p">You should have:</p>
            <ul class="ul"><li class="li">A working PDF Generator scenario</li><li class="li">A map that you've created for publishing</li><li class="li">Images to print on the PDF cover</li></ul>
        </div><div class="li stepsection">
                <p class="p">Create a <span class="ph">DITAVAL</span> file that identifies the product category</p>
            </div><ol class="ol steps"><li class="li step stepexpand"><span class="ph cmd">Create a new <span class="ph">DITAVAL</span> file named <span class="ph filepath"><var class="keyword varname">product_name_1</var>.ditaval</span>, where <var class="keyword varname">product_name_1</var> is the name of one of your products.</span><div class="itemgroup info">
                    <div class="note tip note_tip"><span class="note__title">Tip:</span> Create a <span class="ph">DITAVAL</span> for each product for which you want a different cover page image.</div>
                </div></li><li class="li step stepexpand"><span class="ph cmd">Set up the <span class="ph">DITAVAL</span> to include <var class="keyword varname">product_name_1</var> and exclude all other products. </span><div class="itemgroup stepxmp">
                    <p class="p">An example of a <span class="ph">DITAVAL</span> source code that includes <var class="keyword varname">product_name_1</var> and excludes <var class="keyword varname">product_name_2</var>:</p>
                    <pre class="pre codeblock lang-xml" id="task-9914__codeblock_vvs_kkk_ntb"><code>&lt;val&gt;
    &lt;prop action="include" att="product" val="product_name_1"/&gt;
    &lt;prop action="exclude" att="product" val="product_name_2"/&gt;
&lt;/val&gt;</code></pre>
                    <div class="note important note_important"><span class="note__title">Important:</span> If you copy-paste this example, replace the <span class="keyword parmname">val</span> attribute values <code class="ph codeph">product_name_1</code> and <code class="ph codeph">product_name_2</code> with the applicable product values. </div>
                </div></li></ol><div class="li stepsection">
                <p class="p">Add XSLT code to a <span class="ph">PDF Generator</span> scenario (Administrators only)</p>
            </div><ol class="ol steps" start="3"><li class="li step stepexpand"><span class="ph cmd" id="task-9914__cmd_lzt_kpc_vkb">In the top-left corner, click the <span class="ph"><span class="keyword wintitle">Main Menu</span> <img class="image" src="https://heretto.deploy.heretto.com/v4/deployments/I9vA3KlK8201IYmECh5U/object/4d399120-0470-11ed-844a-02428d90e38c?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJodHRwczovL2pvcnNlay5jb20vZXpkX29yZ2FuaXphdGlvbiI6ImpvcnNlay1kb2NzIiwiaHR0cHM6Ly9qb3JzZWsuY29tL2V6ZC9vYmplY3RfdXVpZCI6IjRkMzk5MTIwLTA0NzAtMTFlZC04NDRhLTAyNDI4ZDkwZTM4YyIsImV4cCI6MTc1NTE5MTU3OSwianRpIjoiNzA4MDk3ZDYxZmJmNGQ2NmFhNWIyNTRmOTdlNWRkOTciLCJodHRwczovL2pvcnNlay5jb20vZXpkX2ZpbGVzZXQiOiJ0eWp6dnJGOWI3Q3U3bmxYS2pXaSJ9.-QFC-4E47MIbmloaGX6b6LGRv_P3WQUeCD7zPfteYnc"></span> and go to <span class="ph uicontrol">PDF Generator</span>.</span></li><li class="li step stepexpand"><span class="ph cmd">In the <span class="ph"><span class="keyword wintitle">PDF Generator scenarios</span> screen</span>, click the publishing scenario you want to edit.</span></li><li class="li step stepexpand"><span class="ph cmd">In the <span class="ph"><span class="keyword wintitle">XSLT</span> tab</span>  of your <span class="ph">PDF Generator</span> scenario, add this XSLT code.</span><div class="itemgroup info">
                    <pre class="pre codeblock lang-xsl" id="task-9914__codeblock_pcm_dlk_ntb"><code>&lt;div class="cover-image"&gt;
  &lt;img&gt;
    &lt;xsl:attribute name="src" select="/normalized/map/topicmeta/data/image/@href"/&gt;
  &lt;/img&gt;
&lt;/div&gt;</code></pre>
                </div></li><li class="li step stepexpand"><span class="ph cmd">Click <span class="ph uicontrol">Save Scenario</span>.</span></li></ol><div class="li stepsection">
                <p class="p">Add image files to your map</p>
            </div><ol class="ol steps" start="7"><li class="li step stepexpand"><span class="ph cmd">Add this <code class="ph codeph">topicmeta</code> element to the root element of your DITA map.</span><div class="itemgroup info">
                    <pre class="pre codeblock lang-xml" id="task-9914__codeblock_dzl_hlk_ntb"><code>&lt;map id="ditamap-4870"&gt;
    &lt;title&gt;Map Title&lt;/title&gt;
    &lt;topicmeta&gt;
        &lt;data product="product_name_1"&gt;&lt;image href="../_global_shared/media/logos/LOGO1.png"/&gt;&lt;/data&gt;
        &lt;data product="product_name_2"&gt;&lt;image href="../_global_shared/media/logos/LOGO2.png"/&gt;&lt;/data&gt;
    &lt;/topicmeta&gt;
&lt;/map&gt;</code></pre>
                </div></li><li class="li step stepexpand"><span class="ph cmd">Replace the <code class="ph codeph">product</code> attribute values <code class="ph codeph">product_name_1</code> and <code class="ph codeph">product_name_2</code> with with the applicable product values.</span></li><li class="li step stepexpand"><span class="ph cmd">Modify the image <code class="ph codeph">href</code> attributes to link to your variable images in <span class="ph">Heretto CCMS</span>.</span></li></ol><div class="li stepsection">
                <p class="p">Publish content</p>
            </div><ol class="ol steps" start="10"><li class="li step stepexpand"><span class="ph cmd">Publish your map with the <span class="ph">PDF Generator</span> publishing scenario you modified and a DITAVAL file you created. </span></li></ol></div></article></article></main></body>

heretto-ccms/publish/pdf-generator/pdf-generator-templates-development-guide/heretto-pdf-generator-templates-development/developing-templates/develop-a-pdf-generator-template-in-heretto-ccms

Developing Templates

You customize the Heretto PDF Generator template
            style by using CSS. You can also use HTML to modify the cover page and XSLT to apply
            advanced structural customizations.

Heretto PDF Generator Templates Development

In Heretto CCMS, you can add annotations, for example, callouts to images. Annotations can be globally styled in PDF Generator publishing scenarios according to your branding
        needs.

Styling Annotated Images

You can use advanced XSL to perform complex transformations in PDF Generator outputs. When planning to use advanced XSLT in your PDF Generator scenarios, consider this important information.

Advanced XSL Transformations

Content Operations Platform For Knowledge Management | Heretto

Learn how to author, review, manage, translate, and publish to multiple channels

Heretto CCMS

Learn how to dynamically distribute your content to any audience, anytime

Heretto Portal

Learn what has changed in Heretto products

Release Notes

Heretto Component Content Management System (CCMS) is one platform to create, manage, and personalize enterprise knowledge for any audience, on any channel, in any language.

Under maintenance

Heretto Help

DITA Elements

Footer Section

Our Support Team is here to help