Convert

CONV-#Number#

Nr.

Parameter

Example

4000

 

JobMode_Convert

1

Sets the JobMode to be used in the Convert step

4001

 

ConvertIgnoreCase

Yes

Based on a file type extension the conversion tool to use is determined. If this parameter is set to “Yes”, the case of this extension is ignored and it doesn’t matter if lower or upper case letters are used.

4002

 

ConvertDeleteFiles

Yes

If this parameter is set to “Yes”, the original file is explicitly deleted after executing an external conversion tool. This can be useful if the conversion tool itself does not offer an option for such an automated deletion in case of a successful conversion.

4003

 

ConvertExt?

tif

Via this parameter a file extension can be specified that is targeted by the conversion tool given with the command <ConvertCmd?>. Multiple extensions can be given each with their own specific conversion tool. This is indicated by the question mark, which must be replaced by some integer number starting with 1, for example:

ConvertExt1=tif
	ConvertCmd1=/bin/OurTifConvert …
	ConvertExt2=png
	ConvertCmd2=/bin/MyPngConverter …

4004

 

 

ConvertCmd?

alchemy [FILE] --d 4 -U ---U

Via this parameter (with an integer number instead of the question mark) the external command is specified that is used as conversion tool for the belonging file type extension.

The file to be converted is specified via a concatenation of the three following parameters, where the question mark indicates an integer number:

<ConvertFilePrefix?><ConvertFileName?>.<ConvertExt?>

An additional command can be specified, which is executed after the conversion:

<ConvertMergeCmd?>

The parameters (except for the extension and the command ConvertCMD) can be left empty to ignore them. For examples see further down below.

The following placeholders are supported:

[FILE]

the current file to be converted

[TEMPFILE]

a temporary file which is deleted after conversion (JobMode 4)

[OUTPUTFILE]

a temporary file:

  • which after conversion is renamed into [FILE]
  • where the original file [FILE] is deleted (JobMode 4)

Example based on the conversion tool “alchemy”:

# Convert all files with extension tif to pdf:
ConvertExt1 = tif
ConvertCmd1 = alchemy [FILE] --d 4 -U ---U
ConvertMergeCmd1 =
ConvertFilePrefix1 =
ConvertFileName1 =
# Convert ABCD*.jpg to pdf:
ConvertExt2 = jpg
ConvertCmd2 = alchemy [FILE] –d
ConvertMergeCmd2 =
ConvertFilePrefix2 = ABCD
ConvertFileName2 =

4005

 

ConvertBinaryPath

/ima/sysadm/alchemy/solaris/alchemy

This parameter specifies the path of the conversion tool.

4006

 

ConvertOutputName

Multipage.tif

This parameter specifies the name to use for the output file of the conversion tool.

4007

 

ConvertStopOnNoFile

No

If this option is set to “Yes”, the Convert step is stopped with an error if no file is found in a folder. Otherwise, the Convert step continues.

4008

 

ConvertRenameIdenticalFiles

If there are multiple files with the same name (not considering extensions), duplicate files are renamed by appending an underscore with a number, e.g. “YourFile_2”, “YourFile_3”.

4009

 

ConvertOutputPath

/cache/cold/output/{INPUT5}

This parameter specifies the output path of the Convert step. For example, JobMode 50 turns “index.dtl” files into XML files, which are written into the dedicated output directory.

Here, via {INPUT5} the first row can be read from file <Spool>/<SpoolType.Generation> and {INPUT5} is then replaced in the output path by the element on the 5th position.

4010

 

ConvertTemplateFile

<ColdConfigDirectory>/Template.xml

This parameter specifies a template file for conversion.

In JobMode 50 the file “index.dtl” is read, and e.g. {4} is replaced by the content of COL4. The template file is written into the output directory for each file “index.dtl”.

4011

 

ConvertOkFilename

Convert-ok.done

If this parameter is set, before executing the conversion it is verified if this file exists in the directory. If this file exists, the directory is NOT converted. This file is generated after a successful conversion in the docs directory. It can be deleted automatically after a conversion via the CleanupSpecial step.

4012

 

ConvertType

TOSINGLE

This parameter specifies the type of conversion.

Possible values in JobMode 3 are: TOSINGLE or TOMULTI

4013

 

ConvertPageCountBinary

/usr/bin/identify -quiet -format %n [FILE]

This parameter is used in JobMode 3 to detect the page number. It represents a command that must return a positive, single integer number.

4014

ConvertTransformationFile

<ColdConfigDirectory>/split/convertTransformation.<SpoolType>.[METADOCTYPEID].cfg

 

When converting from DTL to meta.xml, this parameter indicates which index values are mapped to which columns.

4015

ConvertConvertIndexFiles

No

 

If this parameter is set to “Yes”, the character set conversion tool “iconv” is run, which must be located in the system path. This is useful if the incoming indexing files must be converted e.g. from UTF-8 to ISO8859-1.

4016

ConvertConvertFrom

UTF-8

 

If <ConvertConvertIndexFiles> is set to “Yes”, this parameter defines the source encoding of the incoming data. Supported encodings can be listed with “iconv –l”.

4017

ConvertConvertTo

ISO8859-1

 

If <ConvertConvertIndexFiles> is set to “Yes”, this parameter defines the target encoding of the conversion output. Supported encodings can be listed with “iconv –l”.

4018

ConvertIndexFileName

index.dtl

 

This value specifies the filename of the index file (without any path).

4019

ConvertXMLInputElementList

Reply.File

 

This parameter has the same meaning for the Convert step as <PrepXMLInputElementList> for the Prepare step. For details see <PrepXMLInputElementList>.

4020

ConvertXMLInputElementSeparator

;

 

This parameter has the same meaning for the Convert step as <PrepXMLInputElementSeparator> for the Prepare step. For details see <PrepXMLInputElementSeparator>.

4021

ConvertTerminateOnError

Yes

 

This parameter controls whether the step chain stops with an error when conversion errors occur, or merely logs them.

4022

ConvertSpoolInsteadOfDocsDirectory

No

 

By default, the source directory in the Convert step is the Docs directory. If this value is set to true, the spool directory is used instead. This is useful if the Convert step occurs before the Splitting step.

4023

ConvertFileNameColumn

18

 

This parameter is only relevant for JobMode 5, which expects an index file in CSV format. The parameter contains the 1-based column number in which the files to be converted are located in the index file.

4024

ConvertEmailText

Errors occurred for delivery package [PACKAGE] in spool <SpoolType.Generation> on [DATE] at [TIME].[ENTER]Please refer to the attached report file [ERRORFILE] for details of the errors that have occurred.

 

Defines the text that is used for the e-mail if errors occur during conversion using JobMode 5.

The following placeholders are available:

[DATE]

This is replaced by the start date of the conversion.

[ENTER] This is replaced by a line break.
[ERRORFILE] This is replaced by the name of the attachment file, which should normally be <ConvertAttachmentFileName>.
[PACKAGE]

If the files to be converted were delivered in a tar, zip or similar file, this is replaced by the name of the delivery package.

[TIME] The placeholder is replaced by the start time of the conversion.

4025

ConvertAttachmentFileName

ErrorEntries.txt

 

This parameter defines the name of the file that can be sent as an e-mail attachment if errors occur during conversion. The default is “ErrorEntries.txt”.

Table 102: Convert configuration parameters