You can use the following XML elements to enable data transforms
for your ODF distributions.
Parent
element
Each transform is uniquely defined by the <TransformName> element. Each
transform definition used by ODF contains elements where the text value is not editable. There are
also elements where the user provides the element text value required by the transform. Element
names are case sensitive. Some elements might be found in the sample that are not used by ODF. ODF
uses only the following elements:
- <transform>
- This is an empty element that contains the definition and characteristic
of a transform.
Child elements
- <TransformName>
- This is a text element. The value is the transform name which
identifies a transform program. The naming convention follows this
format: OD_input type2output type,
where input type is the data type of the document
to be transformed, and output type is the data
type into which the data is transformed. Some transform names include OD_LINE2PDF, OD_LINE2UTF8, OD_AFP2PDF,
and OD_AFP2UTF8. For example:
- <TransformDescription>
- This is a text element. The value is the description of the transform
and can be changed.
- <CmdParms>
- This is an empty element with children text elements. The children
text elements can be used to map transform options to the Content Manager OnDemand document specifications.
- The following are the text elements. The value is the transform
program parameter that Content Manager OnDemand uses
to pass the specified information to the transform program command
line. See the OnDemand Administrator help text for the Field
Information page in the application definition for more
information on many of these fields.
- <AG_NAME/>
Specify which transform program
parameter to use to pass the application group name to the transform
program.
- <APPL_NAME/>
Specify which transform program
parameter to use to pass the application name to the transform program.
- <RECORDFORMATFIXED/>
Specify which transform
program parameter to pass to the transform program if RECFM is
set to Fixed in the Content Manager OnDemand application
definition.
- <RECORDFORMATVARIABLE/>
Specify which transform
program parameter to pass to the transform program if RECFM is
set to Variable.
- <RECORDFORMATSTREAM/>
Specify which transform
program parameter to pass to the transform program if RECFM is
set to Stream.
- <RECORDLENGTH/>
Specify which transform program
parameter to use to pass the record length of the document to the
transform program.
- <CARRIAGECONTROL/>
Specify which transform
program parameter to use to pass the carriage control of the document
to the transform program.
- <DOCROTATION/>
Specify which transform program
parameter to use to pass the rotation of the document to the transform
program.
- <CODEPAGE/>
Specify which transform program
parameter to use to pass the code page of the document to the transform
program.
- <LINEDELIMITER/>
Specify which transform program
parameter to use to pass the line delimiter of the document to the
transform program.
- <LINEPERPAGE/>
Specify which transform program
parameter to use to pass the lines per page of the document to the
transform program.
- <TRCYES/>
Specify which transform program
parameter to pass to the transform program if TRC is set to Yes in
the Content Manager OnDemand application
definition.
- <TRCNO/>
Specify which transform program parameter
to pass to the transform program if TRC is set to No.
- <PRMODENONE/>
Specify which transform program
parameter to pass to the transform program if PRMODE is set
to None in the Content Manager OnDemand application
definition.
- <PRMODESOSI1/>
Specify which transform program
parameter to pass to the transform program if PRMODE is set
to SOSI1.
- <PRMODESOSI2/>
Specify which transform program
parameter to pass to the transform program if PRMODE is set
to SOSI2.
- <PRMODESOSI3/>
Specify which transform program
parameter to pass to the transform program if PRMODE is set
to SOSI3.
- <CCANSI/>
Specify which transform program
parameter to pass to the transform program if CC is set to Yes and CC
Type is set to ANSI in the Content Manager OnDemand application definition.
- <CCMACHINE/>
Specify which transform program
parameter to pass to the transform program if CC is set to Yes and CC
Type is set to Machine.
- <CCNONE/>
Specify which transform program
parameter to pass to the transform program if CC is set to No.
- <INPUTFILE/>
Specify which transform program
parameter to use to pass the input file name to the transform program.
This is a required child element of the <CmdParms> element.
If your transform program does not require a parameter (such as -i)
to be specified along with the input file name, leave this element
value blank. This element might need to be specified as the last element,
depending on your transform program requirements.
- <OUTPUTFILE/>
Specify which transform program
parameter to use to pass the output file name to the transform program.
This is a required child element of the <CmdParms> element.
- <CmdLineExe>
- This is a text element. The value is the full qualified path
name of an executable transform program. The user is responsible
for setting the text value.
- For example, the <CmdLineExe/> entry for a transform
program called line2pdf might look similar to the following.
The actual path depends on the install path you choose when you install
the transform.
On an AIX®
or Linux® server:<CmdLineExe>/opt/line2pdf/line2pdf</CmdLineExe>
On a Windows server:<CmdLineExe>c:\\opt\\line2pdf\\line2pdf.exe</CmdLineExe>
On a z/OS® server:<CmdLineExe>/opt/line2pdf/line2pdf</CmdLineExe>
On an IBM® i
server:<CmdLineExe>/transforms/line2pdf/line2pdf</CmdLineExe>
- <Passthru>
- This is an empty element with a child text element, <cmdlineparm/>.
These values are passed directly to the transform program. You can
specify command parameters and associated option values if the options
cannot be matched with the Content Manager OnDemand values.
- ODF will not parse or validate the text value of this <cmdlineparm/> element.
The text value will be passed directly to the third party transform
program.