Enable output to Madcap Central

You can configure the IXIA CCMS Output Generator to publish a map to an existing project in Madcap Central.

About this task

The CCMS Output Generator includes all the files needed to enable output to Madcap Central. You only need to make a few changes to set everything up.

Procedure

  1. Copy output type Central - Publish to Project from conf\client\outputtypes.xml.central to conf\client\outputtypes.xml.

    You do not have to make any changes to this output type.

  2. Copy preprocessor ccms2central.project from conf\client\preprocessors.xml.central to conf\client\preprocessors.xml.
  3. Edit the ccms2central.project preprocessor:
    1. In the project.name property, replace the default value with the name of the Madcap Central project you want to publish to.
    2. In both project.id properties, replace the default value with the id of the Madcap Central project you want to publish to.

    You can get this information from Madcap Central itself or from your Madcap Central administrator.

    The steps described here create a scenario where you can publish to one Madcap Central project only. If you need to publish to multiple projects, you must set up a separate preprocessor for each project, with a separate output type for each.

    Alternatively, you can set up a user parameter to enable end users to select the project on the Generate Output dialog. Implementing a user parameter means that the user doing the publishing needs to know both the project name and id. While it's reasonable to know the project name, it's less likely to know the project id, so the user parameter approach might not be as practical as separate output types and preprocessors.

  4. Copy the six taskdefs from data\outgen-init-client.xml.central.orig to data\outgen-init-client.xml.

    These taskdefs are near the beginning of the file, in the section with the header "Define any global taskdefs here".

  5. In \data, remove the .orig suffix from the file conductor-central.xml.orig.
  6. In \data, remove the .orig suffix from the file commontargets-client.xml.orig.
  7. In \data, copy the target from commontargets-client.xml.central.orig to commontargets-client.xml.
  8. In data\resources\client\MadCapCentral, remove the .orig suffix from the file central.properties.orig.
  9. In central.properties, edit the properties as follows:
    • repos.local.dir={the name of the CCMS Output Generator folder where Madcap Central data is stored} For example, D:/outgen/MadCapCentral
    • central.api.url={the url of the Madcap Central server you are publishing to} For example, https://acme123456789098765.api.acmecentral.com
    • username={the Madcap Central user name of the user publishing to Central} For example, walter.write@acme.com
    • password={the Madcap Central password of the user publishing to Central} For example, MyReallyLong123Password&56
    • branch.name={the name of the branch you are publishing to} For example, master

    The user name and password allow IXIA CCMS to connect to Madcap Central. They can be the credentials for a service account, for example.

  10. In data\resources\client\MadCapCentral, remove the .orig suffix from the file copy-target.xslt.orig.
  11. In data\resources\client\MadCapCentral, remove the .orig suffix from the file index2fltoc.xslt.orig.
  12. Review line 29 of index2fltoc.xslt to ensure it reads as follows:
    <xsl:apply-templates select="html:ul[contains(@class, 'map')]"/>

    If not, change it.

    Early distributions of this file contained an error in this line which prevented Central TOCs from being created for bookmaps. The syntax shown here corrects that error.

  13. Restart the CCMS Output Generator.