<body><main xmlns:jcm-link-man="http://jorsek.com/content-management/modules/linkmanagement" role="main"><article role="article" id="concept-9947" aria-labelledby="ariaid-title1"><h1 class="title topictitle1" id="ariaid-title1">Writing for Reuse Conventions</h1><div class="body refbody"><p class="shortdesc">We develop content in a way that enables us to maximize reuse.</p><section class="section">
            <table class="table" id="concept-9947__table_atg_wmp_lnb"><caption></caption><thead class="thead"><tr class="row"><th class="entry" id="concept-9947__table_atg_wmp_lnb__entry__1">Use</th><th class="entry" id="concept-9947__table_atg_wmp_lnb__entry__2">Avoid</th></tr></thead><tbody class="tbody"><tr class="row"><td class="entry" headers="concept-9947__table_atg_wmp_lnb__entry__1 concept-9947__table_atg_wmp_lnb__entry__2 "><span class="q">“In the <span class="ph b">following</span> example”</span></td><td class="entry" headers="concept-9947__table_atg_wmp_lnb__entry__1 concept-9947__table_atg_wmp_lnb__entry__2 "><span class="q">“In the example <span class="ph b">below</span>”</span></td></tr><tr class="row"><td class="entry" headers="concept-9947__table_atg_wmp_lnb__entry__1 concept-9947__table_atg_wmp_lnb__entry__2 "><span class="q">“In the <span class="ph b">previous</span> example”</span></td><td class="entry" headers="concept-9947__table_atg_wmp_lnb__entry__1 concept-9947__table_atg_wmp_lnb__entry__2 "><span class="q">“In the example <span class="ph b">above</span>”</span></td></tr><tr class="row"><td class="entry" headers="concept-9947__table_atg_wmp_lnb__entry__1 concept-9947__table_atg_wmp_lnb__entry__2 ">Nouns</td><td class="entry" headers="concept-9947__table_atg_wmp_lnb__entry__1 concept-9947__table_atg_wmp_lnb__entry__2 ">Personal demonstrative, and possessive pronouns</td></tr></tbody></table></section></div></article></main></body>

Annie Chen <annie.chen@easydita.com>

heretto-ccms/get-started/introduction-to-instructional-content/dita-for-learning-and-training

Introduction to Instructional Content

Establishing content development strategies promotes consistency and
                        reduces questions about the development process.

Heretto Strategies

File Statuses

We develop content in a way that enables us to maximize reuse.

Writing for Reuse Conventions

heretto-ccms/get-started/introduction-to-content-development/heretto-strategies/writing-for-reuse-conventions

get-started/introduction-to-content-development/heretto-strategies/writing-for-reuse-conventions

<body><main xmlns:jcm-link-man="http://jorsek.com/content-management/modules/linkmanagement" role="main"><article role="article" id="topic-8515" 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/" 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/7524e870-6bc0-11ee-ac47-0242d8e432a4?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJodHRwczovL2pvcnNlay5jb20vZXpkX29yZ2FuaXphdGlvbiI6ImpvcnNlay1kb2NzIiwiaHR0cHM6Ly9qb3JzZWsuY29tL2V6ZC9vYmplY3RfdXVpZCI6Ijc1MjRlODcwLTZiYzAtMTFlZS1hYzQ3LTAyNDJkOGU0MzJhNCIsImV4cCI6MTc5MDQ0MTUxNSwianRpIjoiNTk1MTFlYmY5NGVmNGFlNTk0YmE1NTFjNmE1Mzc3NDAiLCJodHRwczovL2pvcnNlay5jb20vZXpkX2ZpbGVzZXQiOiJJOXZBM0tsSzgyMDFJWW1FQ2g1VSJ9.e_weuCsw5rPPU5pY0r-CjkV2vth3Aie8ct4HKipgre0"></a></p>
            <p class="p footer-section-title">Love this help site?</p>
            <p class="p">You can have one, too! Using the Heretto CCMS as a foundation, 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">© 2026 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://x.com/helloHeretto" target="_blank"><img class="image social-logo" src="https://heretto.deploy.heretto.com/v4/deployments/I9vA3KlK8201IYmECh5U/object/bd7a3620-6bc0-11ee-ac47-0242d8e432a4?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJodHRwczovL2pvcnNlay5jb20vZXpkX29yZ2FuaXphdGlvbiI6ImpvcnNlay1kb2NzIiwiaHR0cHM6Ly9qb3JzZWsuY29tL2V6ZC9vYmplY3RfdXVpZCI6ImJkN2EzNjIwLTZiYzAtMTFlZS1hYzQ3LTAyNDJkOGU0MzJhNCIsImV4cCI6MTc5MDQ0MTUxNSwianRpIjoiMmIwYTFmMjhlZmU2NDM3NDllMDQyZjAzNzQ0MjlhN2MiLCJodHRwczovL2pvcnNlay5jb20vZXpkX2ZpbGVzZXQiOiJJOXZBM0tsSzgyMDFJWW1FQ2g1VSJ9.I51r8EhA4Z3NXUtGyTbc_Fy-MsEL7iEaA54A1GM53ao"></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/bd6e0120-6bc0-11ee-ac47-0242d8e432a4?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJodHRwczovL2pvcnNlay5jb20vZXpkX29yZ2FuaXphdGlvbiI6ImpvcnNlay1kb2NzIiwiaHR0cHM6Ly9qb3JzZWsuY29tL2V6ZC9vYmplY3RfdXVpZCI6ImJkNmUwMTIwLTZiYzAtMTFlZS1hYzQ3LTAyNDJkOGU0MzJhNCIsImV4cCI6MTc5MDQ0MTUxNSwianRpIjoiYmI1N2FiZTJkN2YxNGQ4NWIwM2Y2NTBlZWFkZWZhMTQiLCJodHRwczovL2pvcnNlay5jb20vZXpkX2ZpbGVzZXQiOiJJOXZBM0tsSzgyMDFJWW1FQ2g1VSJ9.y7UlbokG_HS2S9CrX_i9Yk1Z4_xOJI38V3-2zuAX1Vw"></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

Gosia Radymiak <gosia.radymiak@heretto.com>

Deploy API Functions

Deploy API Content Flow

Deploy API Definitions

Gosia Radymiak
            <gosia.radymiak@heretto.com>

Deploy API Operation and Guidelines

<body class="page-break-after"><main xmlns:jcm-link-man="http://jorsek.com/content-management/modules/linkmanagement" role="main"><article role="article" id="concept-925" 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>
        
        <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 it to all channels, typically significantly reducing publishing time compared to traditional multi-channel publishing workflows.</p></div><article class="topic concept nested1" id="concept-5440" aria-labelledby="ariaid-title2" lang="en-us"><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>, the functions of processing and serving content are separated to make it resilient and scalable. This change is currently only applicable to manual deployments. <span class="ph">Deploy API</span> 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" id="concept-875" aria-labelledby="ariaid-title3" lang="en-us"><h2 class="title topictitle2" id="ariaid-title3"><span class="ph">Deploy API</span> 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" id="concept-4005" aria-labelledby="ariaid-title4" lang="en-us"><h2 class="title topictitle2" id="ariaid-title4"><span class="ph">Deploy API</span> 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 class="topic concept nested1" id="concept-4780" aria-labelledby="ariaid-title5" lang="en-us"><h2 class="title topictitle2" id="ariaid-title5"><span class="ph">Deploy API</span> Operation and Guidelines</h2><div class="body conbody"><p class="shortdesc">Before you start using <span class="ph">Heretto Deploy API</span>, familiarize yourself with important facts and guidelines about working with it.</p><dl class="dl"><dt class="dt dlterm">General</dt><dd class="dd"><ul class="ul"><li class="li"><p class="p"><span class="ph">Deploy API</span> processes content from <span class="ph">Heretto CCMS</span> and serves it to an endpoint like <span class="ph">Heretto Portal</span> or a third-party endpoint, like a device or machine.</p></li><li class="li"><p class="p">Content that <span class="ph">Deploy API</span> uses must be organized into a sitemap, a specialized DITA map that lives in <span class="ph">Heretto CCMS</span>. It can contain other sitemaps, maps, bookmaps, topics, and other files. It can also contain elements that enable you to organize and present all components of your content. For example, <code class="ph codeph">sitesection</code>, <code class="ph codeph">topichead</code>, and <code class="ph codeph">topicgroup</code>.</p></li><li class="li"><p class="p">Content in <span class="ph">Heretto CCMS</span> is published with <span class="ph">Deploy API</span> through a deployment. A deployment is a configuration in the CCMS that defines which sitemap is published to which endpoint. Deployments carry information like the deployment type, audience, locales (target languages), or metadata.</p></li><li class="li"><p class="p">Each deployment must have a sitemap associated with it. One deployment can use only one sitemap. One sitemap can be used in multiple deployments.</p></li><li class="li"><p class="p">Once a sitemap is added to a deployment and changes are saved,  it cannot be replaced by a different sitemap. Instead, a new deployment must be configured.</p></li></ul></dd></dl></div></article></article></main></body>

Rafał Karoń <rafal.karon@jorsek.com>

Heretto Deploy API ensures secure processing and delivery of your content for end-user consumption. Deploy API employs two API authentication methods to securely distribute content from Heretto CCMS to various delivery endpoints: Simple API Keys and JSON Web Tokens (JWTs). Both methods are managed as API keys within Heretto CCMS. API keys are also known as secret keys or secrets.

Deploy API Authentication

Read the Deploy API specification and related resources

Heretto Deploy API

Get publishing scenarios

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><main xmlns:jcm-link-man="http://jorsek.com/content-management/modules/linkmanagement" role="main"><article role="article" id="topic-9225" 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><main xmlns:jcm-link-man="http://jorsek.com/content-management/modules/linkmanagement" role="main"><article role="article" id="topic-2626" 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 version of cloud publishing is now available with a change to the PDF Generator Preview feature.

August 21, 2026

Find Content

Find & Replace Options Reference

Find an Element in Your DITA Files

Find Broken External Links (Advanced)

Examples of Find & Replace Usage

Organizing files in your Content Library in a consistent way makes it
            easier, to manage, find, and reuse content.

Content Organization Examples

heretto-ccms/get-started/heretto-ccms-system-requirements

Get Started

Heretto CCMS provides you with a robust search engine that enables you to find resources in the CCMS efficiently. The search engine combines a search mechanism available through  the   Search bar, where you initiate the search, and filters available in the Search tab, where you refine your search results.

Search

Heretto CCMS includes a robust Find & Replace feature that enables you to search a branch, folder, map, or a mix of those, preview your search results, and replace content, XML syntax, DITA attributes, and more in your XML files.

Find & Replace (Beta)

View a Reuse Report

Customize Reuse Report Scope Settings

Gosia Radymiak <[CURRENT_USERNAME]>

Schedule Reuse Report Snapshots

Legacy Reports

Heretto CCMS provides two categories of reports: the Quality Report and Insights reports. The
  Quality Report scans your content for schema, rule, and link-based issues. Insights reports  surface metrics and trends about your content set so you can
  understand it at scale. The Insights family includes the Content
  Report, the Localization Report, and the Reuse Report, each focused on a different lens:
  content composition, localization progress, and content reuse, respectively.

Reports (Beta)

The Localization Report gives your team a single place to check localization progress across your content.

Localization Report (Insights)

The Reuse Report shows how much of your content is reused across topics, text, and media, and highlights the maps, topics, and variables driving that reuse.

Reuse Report (Insights)

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

Writing for Reuse Conventions

Footer Section

Our Support Team is here to help

Use	Avoid
“In the following example”	“In the example below”
“In the previous example”	“In the example above”
Nouns	Personal demonstrative, and possessive pronouns