Image archive Services Framework tasks

The image archive Services Framework tasks are a set of tasks that are based on a common internal framework to create transaction image files for the targeted archive system. These tasks share a set of common task configuration properties, the same index definition formatting, and the same generic user exit interface. For these tasks, the actual delivery of the files to their destination relies on outbound Gateway and the transmission definitions that are configured.

The following list shows the available image archive tasks.
  • CIFF archive extract task
  • Content Manager OnDemand (CMOD) archive extract task
  • NCR archive extract task
  • OnDemand archive extract task
  • Titan archive extract task
  • Viewpointe archive extract task

The following sections provide information about the common configuration and reports for the image archive tasks.

Common task configuration parameters

The following table describes the common task configuration parameters that the specific tasks refer to.
Table 1. Common task configuration parameters
Parameter Description
Target Output Directory This directory is where the output file is written when the task’s processing of the unit of work is complete.
Target Working Directory This directory is where the output file is stored as it is actively being written. The task moves the file to the target output directory if the unit of work was processed successfully.
Transmission Definition This parameter is the transmission definition name. For more information, see Manage Transmission Definitions page. The task retrieves the file name pattern and the data file extension from the transmission definition. The transmission name is included in the routing file that is created for the outbound Gateway.
Extension on the Routing (RTE) File This parameter is the file extension that is added to the base file name to constitute the routing file name. The task uses the same file name for the routing file as the data file.
Extension on the Trigger File This parameter is the file extension that is added to the base file name to constitute the trigger file name. The task uses the same file name for the routing file as the data file.
UOW Complete State This parameter is the name of the state that the task sets after the archiving is complete.
Index Definition Filename This parameter is the file name where the index data and format are specified. Each row in this file specifies an item data element. For more information, see Index definition table - file format.
User Exit This parameter is the class name that specifies the custom user exit. The class must conform to the ArchiveWriterUserExitInterface.
Image Retrieval Mode
This parameter specifies the mode of item image retrieval. The following list shows the modes of image retrieval.
  • Local mode indicates that the task reads the images direct from the file system location. This mode is faster if Services Framework has access to the image location.
  • Remote mode indicates that RMI calls are made to the Transaction Server to retrieve the images.
Image Segments to Retrieve

This parameter specifies the image segments that are retrieved for each transaction. This parameter is specified as a comma-delimited list of the following values.

  • FBW (for front black-and-white)
  • RBW (for rear black-and-white)
  • FGS (for front grayscale)
  • RGS (for rear grayscale)
Missing Image Percentage This parameter specifies the missing image percentage threshold for the unit of work. If this threshold is exceeded, the task instance goes into an error state. The format of this parameter is the percentage of missing images that are allowed and followed by the minimum missing image count.

For example, 1.0, 10 means that the task has an error when one percent of the transactions have missing images, but only after at least 10 images are missing.
Substitute Image This parameter specifies the name of a TIFF file that the task uses as a transaction segment image, if the transaction is missing a segment.
Substitute Image Maximum Size This parameter specifies the maximum file size for the file that is specified in the substitute image property. Specifying the maximum image file size prevents the user from configuring a large image as the substitute image. Set the parameter to 0 to disable the file size validation.

Common task manual configuration parameters

The following table describes the common task manual configuration parameters that the specific tasks can reference.
Table 2. Common manual task configuration parameters
Parameter Description Value
UOW Id This parameter indicates the ID for the unit of work that is to be processed. This ID is associated with the parameter UOW Type. This parameter is mandatory.
Note: If the UOW Type is Entry, the UOW ID field is found on the Entry details page and is not the entry number.
 1
UOW Type This parameter indicates the type of unit of work the ID refers to. This parameter is mandatory.
  • Entry
  • Batch/ICL
  • Transmission
Set State This parameter indicates whether the batch state associated with the unit of work is set when the processing is complete. The default value is Y. Y, N
State to Set This parameter specifies the state to use when the processing is complete. This parameter overrides the state that is specified in the task configuration. If no value is specified, the task uses the state in its task configuration.  
Prevent if State is Set This parameter indicates to prevent the task from processing if the state is already set. The default value is Y. Y, N
Continue Extract if Too Many Missing Images This parameter indicates whether to continue with the task processing even if the task configuration’s missing image percentage threshold is exceeded. The default value is N. Y, N
Continue Extract if Image Mismatch Failures This parameter indicates whether to continue with the task processing if image mismatch conditions are detected, even if the task is removing the mismatched images and replacing them with the substitute image. The default value is N. Y, N

Common file name pattern placeholder values

The tasks use the transmission definition’s file name pattern attribute to name the output archive files. When the task runs, this file name pattern specifies the placeholder tags with the respective values of unit of work, date, or time. The transmission definition also specifies the target data file’s extension, including the period.

The following table shows the common file name pattern placeholder values that the task supports.
Table 3. Common file name pattern placeholder values
Name Placeholder Description
Uow Type %TYPE% This placeholder substitutes the value for the type of unit of work. The following are some examples.
  • Entry = ENT
  • Transmission = TRA
  • Batch (ICL) = BAT
Uow Id %ID% This placeholder substitutes the value for the ID of the unit of work.
Entry # %EN% This placeholder substitutes the value for an entry number of the unit of work. This number is only replaced if triggered by entry, or by using entry for manual invocation.
Business Day %BD% This placeholder substitutes the value for the business day in the YYYYMMDD format.
Category %BC% This placeholder substitutes the value for the category.
Current Day %DT% This placeholder substitutes the value for the current day or time.
File Sequence # %FILENUM% This placeholder substitutes the value for the file sequence number. The value starts at 0 and increments if a unit of work rolls to another file during the same invocation. This placeholder is 2 digits and is padded on the left with zeros.

Image retrieval report

For each archive extract task that runs, a report is generated. This report shows the transactions that are missing an image segment or has an image mismatch error. An image fingerprint is captured when the transaction image is loaded. The saved image fingerprint is compared with the current fingerprint when the image is extracted. The image mismatch occurs when the saved image fingerprint does not match with the current fingerprint.

This report is written to the location /opt/ibm/ftm/debug-data/Reports/cycle date on the <ftm-instance>-services-engine container. The report file name is specified as ImageRetrieval_Taskname_UowType_UowId.CSV. The UowType is one of ENTRY, TRANSM, or BATCH.

The transaction specifications on the report aid in research.