Generic Transform Interface XML definition

Use a set of defined XML tag names to communicate to ODWEK the necessary details required for the transform invocation.

About this task

The XML file that is used by ODWEK must be created in the format as shown in the following example.

<Transforms>  
   <transform>
      <TransformName></TransformName>
      <TransformDescription></TransformDescription>
      <OutputMimeType></OutputMimeType>
      <OutputExtension></OutputExtension>
      <ODFileType></ODFileType>
      <CmdLineExe></CmdLineExe> (or <ClientClass></ClientClass>)
      <CmdParms>
                <!—insert tags with document details here -->
      </CmdParms>
      <Passthru>
          <cmdlineparm></cmdlineparm>
      </Passthru>
   </transform>
</Transforms>

Details of the XML tags are included in the following table.

Table 1. Transform tag details
XML tag name	ODTransform.FIELD	Description
Transforms	N/A	Root node.
transform	N/A	One element per defined transform.
TransformName	TransformName	Name of the Transform. This will be used as the Viewer argument that is passed to the ODWEK retrieve function. Cannot be one of the reserved transform names.
TransformDescription	TRANSFORM_DESC	Description of the transform.
ClientClass	TRANSFORM_CLIENTCLASS	The class name of the custom Java transform class. Used only with advanced implementation.
CmdLineExe	TRANSFORM_CMDLINEEXE	Fully qualified name of the transform executable. Used only with basic implementation.
ODFileType	TRANSFORM_INPUTFILETYPE	The input file type handled by the transform. Optional. Used to filter and define transforms for ODServer.getTransformViewersForDocType.
OutputMimeType	TRANSFORM_MIMETYPE	The mime type of the data as it is returned from the transform.
OutputExtension	TRANSFORM_OUTPUTEXT	The extension of the data that is returned from the transform.
CmdParms	TRANSFORM_PARMS	The mappings of Content Manager OnDemand values to custom variables. Valid child node options can be found in Permitted document detail tag names.
Passthru	TRANSFORM_PASSTHRU	Values are passed through ODWEK directly to the transform.
cmdlineparm	TRANSFORM_PASSTHRU_CMDLINE	Element contents are passed through ODWEK directly to the transform cmdline. Used only with basic implementation.