CCMS Output Generator transformation scenarios

To transform a DITA object, IXIA CCMS Output Generator uses transformation scenarios.

Note: In a dedicated SaaS deployment, your access to the Output Generator is limited. Some tasks require the use of the Output Generator Access Tool (OGAT).

A transformation scenario is a set of commands and properties that convert source DITA files into an output format such as PDF or HTML.

Many transformation scenarios use the DITA Open Toolkit, which is a set of open source tools used to transform DITA objects. However, you can use any other tool or script to transform your content.

By default, the IXIA CCMS provides several transformation scenarios that are available to the end user and some that are used by the system.

User transformation scenarios

User transformation scenarios allow users to generate their output in specific formats.

Table 1. User transformation scenarios

Type

Function

Dita2Pdf

Generates PDF documents from objects

Dita2EclipseHelp

Generates help files for CCMS Desktopfrom objects

Dita2htmlhelp

Generates HTML help (.chm file) from objects

Dita2xhtml

Generates HTML files from objects

Export

Note: If you are using the DRM module, use the Export [DRM] transformation scenario.

Exports topics so that they can be reused in another project

Note: In the default configuration, this output type is available only to System Administrators.

System transformation scenarios

System transformation scenarios allow the CCMS to generate output for tasks such as content review and approval or content localization.
Note: System transformation scenarios are not available to system users and do not appear in the Generate Output dialog.
Table 2. System transformation scenarios

Type

Function

Dita2ReviewPdf

Generates PDF versions of topics for review during the Edit/Review cycle

Dita2TranslationPdf

Generates PDF versions of topics during the Localization cycle

Dita2RedlinePdf

Compares a map with an earlier version of itself

Dita2xhtml.preview

Generates a snapshot preview

BuildManifest

Generates an established output, based on the Build Manifest file

Dita2xhtmlcr

Generates Collaborative Review output

Dita2xhtmlapproval

Generates output for an Approval

Transformation scenario components

A transformation scenario uses the following items to perform its function:

  • Output types fall into two categories: user and system output types, and specify the type of output into which the source DITA files will be transformed, such as PDF or HTML, and link the output type to the preprocessor
  • Preprocessors define the conductor file that contains user parameters and the related target files within the conductor file, thus linking to the output type selected by the user
  • Conductor files are build files that contain at least one project, one target, and one transformation type necessary for output generation
  • Targets include one or more Apache Ant tasks, which are small pieces of code that use property values to direct final output processing
    Note: You can add custom conductor targets, but do not modify the default output types already provided in conductor files.