|
Runs a batch job using a comma-delimited text file. Invokes
a LiveCycle service using parameters read from each row of a delimited
text file.
For information about the General and Route Evaluation property
groups, see
Common operation properties
.
Job Identification properties
Property that identifies the job run.
Run Identifier
A
string
value that uniquely identifies
this job run among all job runs with the same parameters. If null
or empty, a unique value is generated.
Service Operation properties
Properties that identify the service and operation to invoke
for each batch item read.
Service
The name of the LiveCycle service
or process to invoke for each input batch item.
Operation
The operation to invoke for
each batch item that is read. When the service is a process, the
value is always
invoke
. When the service is a Document
Service Component, the value is the name of the service operation.
Static Service Parameters properties
Properties that identify static service parameters.
Static Parameters
A map that contains
the parameters that are applied to the LiveCycle service that is
called for each item.
Batch input
Properties that identify the name of the input file and
the names of the service input parameters that correspond to the
fields in the input file.
Input File Name
The name of the text file
that input items will be read from.
The input file is a text
file encoded as UTF-8. Each line represents a batch input item.
Lines starting with # are treated as comments.
Within each
line, input parameter values are delimited by commas. You can use double-quote
characters to escape commas or line endings that are part of values.
Use double instances of the double-quote character to escape the double-quote
character.
The input text is assumed to be encoded as UTF-8
text. Do not edit the input file in a text editor such as Microsoft ® Notepad and then
save as UTF-8 text as it saves the file with a byte order mark.
Input Field Names
A comma-delimited list
of the names of the service input parameters that correspond to
fields in the input file.
Batch output
Properties that identify the name of the output file and
the names of the service input parameters that correspond to the
fields in the output file.
Output File Name
The name of the text
file where the output items are written. The file contains one line
for each output item. Each line consists of a comma-delimited list
of the output parameter values written from the LiveCycle service
invocation. If null or empty, no output file is generated.
Output Field Names
Output parameters are
mapped to fields in a line of the output file using this comma-delimited
list of names. If left empty, no output file is generated, using this
comma-delimited list of parameter names.
Optimization properties
Properties that identify the partition strategy, its parameters,
and commit interval.
Partition Strategy
Determines how the
input items will be partitioned for parallel processing. Use any
of the following values:
-
No Partitioning. Input
items are processed sequentially.
-
Each partition has a specified number of input items.
-
The input items are split into a specified number of partitions.
Partition Strategy Parameters
Arguments
used by the partitioning strategy. Each partition has a specified number
of input items. The input items are split into a specified number
of partitions. This is an integer value.
Commit Interval
The number of items that
will be processed before the batch processing state is committed
to persistent store. Setting this value too low may use more resources. Setting
this value too high may risk transaction time outs. If a failure
occurs, the batch processor needs to retry processing those items.
Result properties
Batch processing return code. Can return any of the following
values:
-
COMPLETED
-
FAILED
-
STOPPED
-
UNKNOWN
-
ALREADY_RUNNING
-
RESTART_FAILED
-
ALREADY_COMPLETE
Exceptions
This operation can throw a BatchProcessorException.
|
|
|
