Xerox 5 manual CommandTemplate, TimeOut, LogStdOut, LogStdErr, FailOnWarning

CommandTemplate

The template from which the command (passed to the operating system representing the execution of the subtask) is derived. An example:

blat c:\xvtp\bin\bodytemp.txt -t $mailto

where mailto is a field of the splitfile index record or RuleVars name having the value jones@ip.com would result in the file c:\xvtp\bin\bodytemp.txt being mailed to jones@ip.com via the SMTP batch tool, blat, (assuming that blat.exe was somewhere on the execution path of the VIPOD process).

The command template is preprocessed to produce the actual command string that is passed to the OS. Command template fields that begin with the reserved character “$” are substituted by the respective splitfile index record field or RuleVars value. VIPOD assumes that a single target executable will be called when the command is executed. Multi-step executions are not supported by VIPOD. If a multi-step subtask is desired for a given VIPOD job, it should be realized by calling a single batch process, which is responsible for executing the multiple steps and reporting status back to VIPOD.

A command template cannot be empty and to be valid, must contain at least one index file record fieldname reference beginning with the reserved character “$.” Otherwise, the Dispatch Rule will not be associated with any job when evaluating the job's eligibility against the Dispatch Rule's CommandTemplate definition.

TimeOut

Specifies the length of time between when the OS command is executed and a timeout error is declared, in seconds. A timeout value of “0” indicates an infinite waiting period. An OS command that triggers a timeout should be terminated by VIPOD and treated as having returned with an error return value.

LogStdOut

A boolean (.INI false: 0, or true: 1) indicating whether the stdout of the executing OS command should be appended to the log file for the VIPOD job associated with this Dispatch Rule.

LogStdErr

A boolean (.INI false: 0, or true: 1) indicating whether the stderr of the executing OS command should be appended to the log file for the VIPOD job associated with this Dispatch Rule.

FailOnWarning

A boolean (.INI false: 0, or true: 1) indicating whether detection of a warning during execution of the OS command should cause the VIPOD job to halt processing (transition from “current” to “complete,” with a status of “failure”) at the record that generated the warning.

VI PDF Originator User’s Guide