Gretyl's Portal

Heretto Help

Show Page Sections

Manage DITA Open Toolkits in Heretto CCMS

Users assigned the Administrator role in Heretto CCMS can download, replace, and remove DITA Open Toolkit (DITA-OT) files in Heretto CCMS. When you replace or remove a DITA-OT, we recommend always first downloading it and saving locally or in a shared cloud location as a backup.

Download a DITA Open Toolkit from Heretto CCMS

You can download a DITA Open Toolkit (DITA-OT) from Heretto CCMS to save a backup copy of a toolkit or to edit it locally. We recommend always saving a backup copy of the toolkit before modifying it locally.

To complete this procedure, you need to be an Administrator in Heretto CCMS.

  1. Log in to Heretto CCMS.
  2. In the top-left corner, click the Main Menu and go to DITA-OT.
  3. In the Toolkits section, hover over a toolkit and click More actions .
  4. Click Download.
A ZIP file is saved to your local computer.

Replace a DITA Open Toolkit in Heretto CCMS

You can easily replace a DITA Open Toolkit (DITA-OT) with a newer version. When you replace a toolkit, neither its name nor the ZIP file name in Heretto CCMS are changed, even when your ZIP file name is different from the original one. If you need the toolkit or file name to change, delete the toolkit and add a new one.

To complete this procedure, you need to be an Administrator in Heretto CCMS.

  1. Log in to Heretto CCMS.
  2. In the top-left corner, click the Main Menu and go to DITA-OT.

Save a copy of the toolkit as a backup

  1. In the Toolkits section, hover over a toolkit and click More actions .
  2. Click Download.
    A ZIP file is saved to your local computer. Consider adding it to a shared cloud location as a backup.

Replace the toolkit

  1. In the Toolkits section, hover over a toolkit and click More actions .
  2. Click Replace.
  3. In the Replace toolkit window, click Choose file and navigate to a toolkit of your choice. Click Replace.

Your DITA-OT Cloud publishing scenarios now use the new toolkit. Publish a document with those scenarios to ensure the toolkit works as expected.

Delete a DITA Open Toolkit from Heretto CCMS

You can delete redundant DITA Open Toolkit (DITA-OT) versions from Heretto CCMS. You can delete all toolkits that are not used by any DITA-OT publishing scenario with the exception of two default toolkits: [default] dita-ot-2.5.4 and [default] dita-ot-3.6.1.

To complete this procedure, you need to be an Administrator in Heretto CCMS.

Warning:

This action is irreversible. You cannot restore deleted toolkits.

  1. Log in to Heretto CCMS.
  2. In the top-left corner, click the Main Menu and go to DITA-OT.

Save a copy of the toolkit as a backup

  1. In the Toolkits section, hover over a toolkit and click More actions .
  2. Click Download.
    A ZIP file is saved to your machine. For example, dita-ot-3.6.1.zip. Consider adding it to a shared cloud location.

Delete the toolkit from Heretto CCMS

  1. In the Toolkits section, hover over the toolkit and click More actions .
    • If you can see the Delete option, click it to delete the toolkit. If prompted, confirm the deletion.

    • If instead of the Delete option you see Toolkit in use in (...), it means that the toolkit is used by one or more publishing scenarios and therefore can't be deleted. Modify the existing publishing scenarios to use a different toolkit.

Modify existing scenarios to use a different toolkit

  1. In the DITA-OT scenarios section, click a scenario that uses the toolkit you want to delete.
  2. In the Toolkit name drop-down menu, select a different toolkit. Click Save.

    You can't delete a toolkit that is used by a publishing scenario. Repeat this step for any other publishing scenario that uses the toolkit you want to delete. Then, delete th toolkit that is no longer needed.

The Toolkits section refreshes and the toolkit is no longer listed.