Configure External Processor Jobs

You can create an external processor job to integrate existing, or new, capabilities with Content Capture. These capabilities can include types of document conversions, perhaps to Microsoft PowerPoint or other image formats. Or, the external processor could assign metadata values based on document content or sender’s email address. In general, an external processor job is a means to extend the functionality of Content Capture as a document flows through a procedure.

When an external processor job is created, a process step ID is assigned to it. This ID is used by an external processor in the REST API to find the documents waiting to be processed. When a procedure is imported into Content Capture, the step IDs of jobs, including an external processor job, are changed. This change must be noted and the configuration of the external processor that uses it must be updated. If it isn't updated, the external processor will fail to communicate with Content Capture as the REST API resource will not be found.

Note:

You cannot create external processor jobs in Oracle Content Management Starter Edition. To use this feature, you need to upgrade to Oracle Content Management Premium Edition. For more information, see Starter vs. Premium Edition.

1. In the procedures pane on the left, select your procedure.

   The configuration pages for the selected procedure appear on the right.

2. Open the Processing tab.

3. In the External Processor Jobs table, click , or to edit an existing job, click .

   You can also copy an external processor job by selecting it, clicking , and entering a new name when prompted. Copying a job allows you to quickly duplicate and modify it.

4. On the Document Selection page, do the following and then click Next:

   • Enter a name and description for the job.

   • Select the Online check box to enable the use of your external processor job in your procedure.

   • To process the external processor job for specific document profiles, select one or more document profiles listed in the Restrict to Document Profiles field, or select All to process documents for all defined document profiles.

   • Select the original file in the Preserve Original as Attachment Type drop-down list if you want to preserve it.

5. On the External Processor page, set the external processor definition by selecting Custom External Processor from the External Processor Engine drop-down list, and then click Next. Optionally set the time until failure or accept the default value.

   Note:

   The default connection type is Processor Pull from Capture.
6. On the Security page, find and select security members in the Add Security Member dialog and then click Next. Only these members can update the documents when they are in this position, or step, of the procedure. When the external processor 'releases' the document back to Content Capture, one of these users or groups must make the request.
7. On the Post-Processing page, specify based on the following what happens after an external processor job completes:

   • No system error situations are cases in which all the criteria on the previous page were met. A successful transformation can flow to commit.
   • System errors are any cases in which the transformation fails: no records found, too many records found, and so on. For unsuccessful transformations, the batch returns to the Content Capture Client for repair.

   See Configure Post-Processing and Monitoring of an External Processor Job

8. Review settings on the Summary page and click Submit to save the job.

9. Configure how batches flow to external processor jobs.

10. Test the external processor job you created.

Configure Post-Processing and Monitoring of an External Processor Job

Use post-processing options of an external processor job to specify what happens after processing completes.

To configure post-processing and monitoring of an external processor job:

1. In the procedures pane on the left, select your procedure.
   The configuration pages for the selected procedure appear on the right.
2. Open the Processor tab.
3. In the External Processor Jobs table, add or edit an external processor job.
4. Click the Post-Processing page to display the processing options for successful processing (no system errors) and unsuccessful processing (one or more system errors). The next steps apply to both sections: When there is no system error and When there are system errors.
5. In the Batch Processor and Batch Processor Job fields, specify which processing step, if any, occurs after the external processor job completes. Only those batch processor jobs that you have defined for your procedure are available for selection. For example, if you didn't define a recognition processor job, then the recognition processor option will not be available in the Batch Processor field. If you choose recognition processor or conversions to TIFF/PDF in the Batch Processor field, then specify the corresponding processor job.
6. In the email address field, optionally enter an address to which to send an email after processing completes successfully or fails. While configuring and testing an external processor job, you might set yourself to receive email notifications upon system errors, then later automatically alert an administrator of processing errors.
7. In the remaining fields, specify how to change processed batches.

   • Rename batches by adding a prefix. For example, rename batches that were unsuccessful with the prefix ERR for follow-up.

   • Change batch status or priority. For example, you might change the status of batches with system errors, then create a client profile with batch filtering set to this status to allow qualified users to manually edit and complete batches that encountered errors.

8. Click Submit to save the job.

Configure Batch Flow to an External Processor Job

To run an external processor job, you must configure batches to flow to the job for processing. You do this by setting the external processor job as a post-processing step in a client profile, an import processor job, or a processing job discussed under processing settings. See the post-processing information for the job or client profile from which you want to configure a batch flow, under Configure Processing Settings or Configure Capture Settings.

Deactivate or Delete an External Processor Job

When you delete an external processor job, it no longer remains available for batches for which it is set as a post-processing step. If a job specified for post-processing is not available, an error results for the batch. You may want to change a job to offline for a time before deleting it, allowing you to resolve unexpected issues with its deletion. Online external processor jobs run when they are selected in a client profile or on the Post-Processing page of a processor job. You can temporarily stop a job (take it offline) or change a deactivated job to run again. You cannot delete batch processing jobs if they are configured as a post processing job in another batch processor.

To deactivate or delete an external processor job:

1. In the procedures pane on the left, select your procedure.
   The configuration pages for the selected procedure are displayed on the right.
2. Open the Processing tab.
3. To deactivate a job, select it in the External Processor Jobs table and click .

   You can also deactivate or activate an external processor job by selecting or deselecting the Online field on the Document Selection page.

4. Select the deactivated job in the External Processor Jobs table and click .
5. When prompted, click Yes to confirm that you want to delete this job.