Add a custom output type

Output types 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.

New output types are defined in the %OutputGenDir%/conf/client/outputtypes.xml file in an <outputtype> element.

Note: By default, IXIA CCMS provides both user and system output types.

Sample user output type:

<outputtype name="Dita2Pdf" timeout="60000" system="false">
   <preprocessing>
      <preprocessor name="dita2pdf" />
   </preprocessing>
   <renderer/>
</outputtype>

For each output type, you must define the information identified in the table.

Note: To avoid exposing system default output types to your users, edit the access rights for the output type names to only include roles and groups who can view and use that output type. See Output access rights. If you do use access rights as described, always leave the System Administrator group for the following: Dita2Pdf, Dita2Html, Export, and Export (DRM).

Table 1. Mandatory output type definition
Field	Description
`name` attribute	Name of the output type Note: If the output type is visible to the user, this name displays in the Generate Output dialog. Important: If you are customizing a IXIA CCMS transformation scenario, such as Dita2RedlinePdf, you *must* keep the output type name as it is. You cannot modify it or rename it. For example, copy the Dita2RedlinePdf output type and rename it, such as acme.Dita2RedlinePdf, otherwise the CCMS will not be able to use it. The CCMS expects the system output types to be named as follows: Dita2RedlinePdf: For redlining Dita2ReviewPdf: For PDF reviews Dita2TranslationPdf: For the localization Dita2xhtml.preview: For the snapshot feature
`timeout` attribute	Value for amount of time, in milliseconds, that the system allows for a completely rendered version to be returned to the user Note: If generating the output takes longer than the specified value, IXIA CCMS Output Generator aborts the job.
`system` attribute	Specification for output type as internal to the system or visible to the user `false` – Output available as option in Generate Output dialog. `true` – Output used by the system and not available to users. For example, defines the Dita2TranslationPdf output as system-only, because the system automatically generates PDFs during preparation of the localization kit. Note: You should set the system attribute to `false` when debugging a new system preprocessor so that you can generate and test the output directly from the Generate Output dialog.
One or more `<preprocessor>` element	Specification of preprocessors to call during output type selection Note: The preprocessor that contains the instructions to generate the output must be the last one in the list.
`<renderer/>` element	Unused Important: This element must be present and empty, otherwise the build fails.

To add a custom output type:

Open the %OutputGenDir%/conf/client/outputtypes.xml file.

Important: Always update the file in the conf/client directory. Do not update the outputtypes.xml file in the conf directory. This separation protects your customization from overwrite when you update the IXIA CCMS Output Generator.

Note: If this is your first time modifying the outputtypes.xml file, open the outputtypes.xml.orig file and save it as outputtypes.xml after you remove the .orig suffix.

When the IXIA CCMS Output Generator invokes an output type, it first looks for the output types defined in the conf/ directory and then adds any additional output types in the conf/client directory. If you define an output type with the same name as an output type defined in conf/outputtypes.xml, the output type in conf/client overrides the one in conf.
Create an <outputtype> element and define the name, timeout, and system attributes for the output type.
Creation for a custom PDF output type for the Acme company.
```

   <outputtype name="Dita2Pdf-Custom" timeout="60000" system="false">
```
Create a <preprocessing> element and add a <processor> element for each processor initiated when calling the output type.
The output type with the Dita2Pdf-Custom name, is defined for the dita2pdf.Custom preprocessor under the same name.
```
<preprocessing>




   <preprocessor name="dita2pdf.custom" />
</preprocessing>
```
The preprocessor also contains instructions for calling the appropriate target in the conductor file.

CAUTION: If you defined multiple preprocessors, the preprocessor that contains the instructions to initiate the transformation must be the last one in the list.

Note: The preprocessors specified in the name attribute must also be defined in the preprocessors.xml file.
The final output type definition for Dita2Pdf-Custom.
```
<outputtype name="Dita2Pdf-Custom" timeout="600000" system="false">

<preprocessing>




<preprocessor name="dita2pdf.custom" />
</preprocessing>
<renderer/>
</outputtype>
```
Save and close outputtypes.xml.
Restart the IXIA CCMS Output Generator service to apply your changes.