Migrate CCMS Output Generator configuration for 3.x DITA-OT versions

Now that you installed the latest version of [Output_Generator], the final task is to migrate your configuration to the new version. Follow this procedure if your CCMS Output Generator uses a DITA Open Toolkit in the DITA-OT 3.x family.

To migrate the configuration:

  1. Copy the contents of the %OutputGenDir%/conf/client/ folder from your previous version to the folder in the new version.
    For example, copy the contents of the following folder:

    C:\ixiasoft\OutputGenerators\Prod_[previous version]\conf\client\

    to this folder:

    C:\ixiasoft\OutputGenerators\Prod_[new version]\conf\client\

  2. Copy the contents of the %OutputGenDir%/data/resources/client/ folder from your previous version to the folder in the new version.
    For example, copy the contents of the following folder:

    C:\ixiasoft\OutputGenerators\Prod_[previous version]\data\resources\client\

    to this folder:

    C:\ixiasoft\OutputGenerators\Prod_[new version]\data\resources\client\

  3. Copy the contents of the %OutputGenDir%/libs/client/ folder from your previous version to the folder in the new version.
    For example, copy the contents of this folder:

    C:\ixiasoft\OutputGenerators\Prod_[previous version]\libs\client\

    to this folder:

    C:\ixiasoft\OutputGenerators\Prod_[new version]\libs\client\

  4. Copy all your custom transformation scenarios (e.g., conductor-acme.xml) from the %OutputGenDir%/data/ folder to the folder in the new version.
  5. Copy all the *-client.xml files from the %OutputGenDir%/data/ folder to the folder in the new version.
    For example, copy the following files:
    • bmanifest-extension-client.xml
    • bmanifest-init-client.xml
    • commontargets-client.xml
    • conductor-client.xml
    • outgen-init-client.xml
  6. Copy the outgen-init.properties file from the %OutputGenDir%/data/ folder in the previous version and paste it in the same folder in the new version.
  7. Copy the outgen-init-cr.properties file from the %OutputGenDir%/data/ folder in the previous version and paste it in the same folder in the new version.
  8. Copy the entire DITA-OT folder from your previous version of the CCMS Output Generator and paste it in the same location in the new version of the CCMS Output Generator.
    For example, paste the copy in the %OutputGenDir%/data/DITA-OTx.x.x folder.
  9. Export a copy of your company's DTD plugin from the Content Store:
    1. Open the TEXTML Administration perspective by clicking the TEXTML Administration shortcut on the tool bar. If the shortcut is not displayed, follow these steps:
      1. In the TEXTML Administration view, double-click the server. If your server is not displayed in the view, you must add it to the view.
      2. When the Connect as dialog opens, type your username and password and click OK.
      3. Double-click the name of your docbase to open a connection to the Content Store.
    2. Expand the Content Store's Repository node and browse to /system/plugins to locate your company's DTD plugin.
      For example: com.company.dita.dtd
    3. Right-click the plugin and click Export.

      The plugin is saved as a folder locally as Content\system\plugins\com.company.dita.dtd where company is the name of your company.

      Important: DO NOT export the com.ixiasoft.dita.dtd plugin or com.ixiasoft.dita13.dtd and use it in the CCMS Output Generator.
  10. Copy the com.company.dita.dtd plugin from the location where you exported it and paste it into your DITA-OTx.x.x/plugins folder in the new version of the CCMS Output Generator.
    For example, the %OutputGenDir%/data/DITA-OT3.1.3/plugins folder, where 3.1.3 is your DITA-OT version.
  11. In the conf folder in the new version of the CCMS Output Generator, do the following:
    1. Copy these files:
      • corba.properties.empty
      • outputgenerator.xml.empty
      • wrapper.conf.empty
    2. For each file, remove the .empty suffix from the copy and configure the file as needed.
    3. If you are using authentication, copy krb5.ini.orig, removing the .orig suffix from the copy and then configure the file.
  12. In the data\catalogs folder, take the following actions:
    1. Copy catalog-dita-outgen.xml.empty.
    2. Remove the ".empty" suffix from the copy and configure the file to point to the appropriate DITA-OT catalog.
  13. Download the DITA-OT 3.x version you want to use and add it to the data folder.
    Note: You can download the DITA-OT at www.dita-ot.org/download.

    If you have a DITA-OT configured in another CCMS Output Generator that you want to continue to use, copy it to the new CCMS Output Generator 7.3.

  14. If they are not already present, add the following plugins to the plugins folder of the DITA-OT 3.x that you added:
    • com.ixiasoft.dita13.dtd
    • com.ixiasoft.images
    • com.ixiasoft.pdf.review20
    • com.ixiasoft.xhtml.cr
    • org.w3c.html.doctypes
    • org.w3c.svg1.0
    • org.w3c.svg1.1
    • org.w3c.xhtml.doctypes

    You can copy the identified plugins from an existing DITA-OT or from the DITA-OT 2.3.1 that ships with CCMS Output Generator 7.3.

  15. Copy your DTD plugin and your custom output plugins from your existing DITA-OT to the new DITA-OT 3.x.
    Note: While your DTD plugin is compatible with DITA-OT 3.x (provided it is based on DITA 1.3), there is no guarantee that your custom output plugins will be compatible with DITA-OT 3.x. Make sure you test them.
  16. In the data folder, choose one of the following files, based on your deployment, and copy it.
    • For Windows: _DITA-OT-2.3.1-install.bat
    • For Linux: _DITA-OT-2.3.1-install.sh
  17. Rename the file to reflect the DITA-OT 3.x version your deployment uses.
  18. Edit line 7 of the .bat file or line 5 of the .sh file to reflect the folder name of the DITA-OT version your deployment uses.
  19. Double-click the renamed _DITA-OT-3.x-install.bat or _DITA-OT-3.x-install.sh files to integrate the copied plugins into the DITA-OT 3.x.

    Make sure your action results in the DITA OT install ran successfully notification before you continue.

  20. In the data folder, take the following actions:
    1. Copy outgen-init.properties.orig, remove the ".orig" suffix from the copy, and set the appropriate default DITA-OT version.
    2. Copy outgen-init-client.xml.orig, remove the ".orig" suffix from the copy, and configure the file.
    3. Copy outgen-init-cr.properties.orig, remove the ".orig" suffix from the copy, and set the default DITA-OT version you want to use for Collaborative Reviews and Approvals.