Run XML File Job operation

Invokes a service that is part of LiveCycle using parameters read from each record of an XML 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 that will be invoked for each batch item that is read.

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

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

Input batch items are read from this XML file.

Input Item Tag Name

This element name represents the root of each fragment that represents an input batch item.

Batch Output properties

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

An XML file that contains the output parameters values written from the LiveCycle service invocation. If null or empty, no output file is generated.

Output Item Element Name

The name of the element that contains each batch output item.

Output Field Names

Service output parameters matching the names in this (comma-delimited) list of names are included in the batch output.

Root Tag Name

The name of the root element in the output XML file.

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. The number of input items per partition or the number partitions, depending on the partition strategy.

Commit Interval

The number of input items that will be processed before the transaction is committed. 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.