Batch Job Service Description and Assumptions
- Aron Roberts (Unlicensed)
Description
The Batch Job service allows the user to invoke batch jobs in a specific context, such as in the context of a single record, a list of records, or a group of records. Some batch jobs may also be invoked with no externally-provided context.
Batch jobs are written in Java, and conform to a specific Java interface. These jobs have access to a broad cross-section of the services RESTful APIs; they can create, update, delete and search records; relate records; and perform many other actions. The results (output) of the batch jobs are returned as service invocation responses.
Assumptions
Key Concepts
Dependencies
Background Documentation
Implementers can add batch jobs by creating new Java classes that implement the Batch Invocable (and hence, Invocable) interfaces.
A sample batch job, CreateAndLinkLoanOutBatchJob, is included in the batch module in the services source code repository.
This batch job demonstrates partial automation of the process of loaning out a CollectionObject. The job:
- Accepts the CSID of a single CollectionObject record as its invocation context.
- Creates a new Loan Out record.
- Relates that Loan Out record to the specified CollectionObject.
- Returns the CSID of the newly-created Loan Out record.