Read Me
The legacy DITA Open Toolkit (DITA-OT) integration has been retired and replaced by the DITA Open Toolkit (DITA-OT) Cloud integration. For more information, see DITA Open Toolkit Cloud Publishing..
DITA-OT Cloud Benefits and Overview
Because the Heretto DITA-OT Cloud is a cloud solution, your publishing jobs do not compete for memory and processing resources in the CCMS. The benefit is that the system does not slow down, even when you are publishing a large publication or to multiple languages or output types.
The DITA-OT Cloud publishing engine provides you with the following benefits:
- Publishing does not affect the CCMS performance as it happens in a separate space in the cloud
- You can have parallel publishing (available by default with select CCMS license types)
- Modern, Google Chrome™-compatible scenarios management interface
The default number of DITA-OT Cloud workers depends on the CCMS license type and is at least one worker. One worker is equivalent to what the legacy DITA-OT integration offered. One worker can run one publishing job at a time which means that additional jobs are queued and processed one by one as the worker completes jobs. For example, if your publishing job on average takes four minutes to publish and you start three publishing jobs, with one worker the first job will complete at four minutes, the second at eight minutes, with the third job completing at 12 minutes from the start. DITA-OT Cloud enables you to use more workers to run more publishing jobs at the same time, increasing throughput. Using the previous example, if you have three workers enabled, all jobs would run simultaneously and complete in four minutes. You can purchase additional workers regardless of your CCMS license type.
Major Differences Between Legacy DITA-OT and DITA-OT Cloud Integrations
|
Item |
DITA-OT Legacy |
DITA-OT Cloud |
|---|---|---|
|
Browser compatibility |
Mozilla Firefox only |
Mozilla Firefox and Google Chrome™ |
| DITA-OT compatibility and quantity |
Any version of DITA-OT from 1.7.5 or later. No restriction on the number of toolkits you can upload. |
Any version of DITA-OT from 2.5.4 through 3.7.4. No restriction on the number of toolkits you can upload. |
|
System resources impact |
Publishing large content sets may impact CCMS performance for users. |
No impact to CCMS users when any publishing job is under way. Publishing processing occurs in the cloud and not on the CCMS. |
|
Custom toolkit plugins, including specialized document types (doctype) and publishing plugins |
Typically uploaded individually into Heretto CCMS and then included as needed in a publishing scenario. |
Embedded in a DITA Open Toolkit in the /plugins folder. |
|
Supporting files used by a plugin, for example, a logo image file, a template file, or an options file |
Added to the CCMS and referred to in a relevant parameter in a publishing scenario. |
Embedded in a DITA Open Toolkit in a folder that you add to the toolkit folder. |
|
Custom fonts for publishing |
Uploaded into Heretto CCMS by the Heretto team. |
Embedded in a DITA Open Toolkit in a /custom-fonts folder or, if you use Antenna House, in the ah-formatter/fonts folder. No reliance on the Heretto team to maintain or update fonts on your behalf. |
|
Commercial PDF formatter engines Important:
Currently Heretto CCMS supports only the Linux-based Antenna House PDF Formatter. Any usage of Antenna House requires a valid license file. |
Uploaded into Heretto CCMS by the Heretto team. |
Embedded in a DITA Open Toolkit in an /ah-formatter folder. No reliance on the Heretto team to maintain or update Antenna House on your behalf. |
The pdf.formatter parameter For more information, go to https://www.dita-ot.org/ and review PDF parameters for a specific toolkit version. Important: DITA-OT Cloud supports toolkit versions 2.5.4 through 3.7.4. | For a DITA Open Toolkit that uses both Antenna House and FOP, include the pdf.formatter parameter in your publishing scenario to indicate the formatter to use, or if you want the option to select the formatter at the time of publishing. If you have more than one PDF formatter available in a toolkit, and you don't specify this parameter, the DITA-OT publishing uses FOP by default. | For a DITA Open Toolkit that uses both Antenna House and FOP, include the pdf.formatter parameter in your publishing scenario to indicate the formatter to use, or if you want the option to select the formatter at the time of publishing. If you have more than one PDF formatter available in a toolkit, and you don't specify this parameter, the DITA-OT publishing uses FOP by default. |
Important Considerations
- Publishing Automation (Webhooks or Assignment Triggers)
-
If your publishing is automated through assignments or webhooks, the Heretto team may need to assist you with the migration process. If you run into publishing automation issues, contact your Customer Success Manager.
- Development/Prototyping Server
-
If you have a development server, migrate to DITA-OT Cloud on the development server first so you learn the process and have a chance to test before updating the production server.