Viewpointe archive extract task

The Viewpointe task extracts all the transactions for a unit-of-work and creates a Viewpointe VLF-formatted file.

This task can append the pair count and the item count to the end of the file name, even though it is not in your file pattern specification. For example, pair-count.item-count.IND for the index file. The following list describes the count values that might be added to the file name.

Pair count is the number of file pairs (IND/OUT) that make up the unit-of-work being archived.
Item count is the number of items in the unit-of-work being archived.

You need to do the following steps to implement this archive extract task.

Register the task.
Configure the task.

Register the task

Use the task registry page in the Services Framework user interface. For more information, see Register a task. The following table describes the fields that are used to register the Viewpointe archive task.

Table 1. Fields to register the Viewpointe archive task
Field	Description	Value	Example
Task classname	Enter the Java class name for the task.	`com.ibm.fxh.archivetask.viewpointe.VPTask`
Task name	Enter a descriptive name for the task.	Customer specified.	Viewpointe archive extract
Description	Enter a detailed description about what the task does.	Customer specified.	Task that retrieves the transactions for the UOW and creates a VLF file for archiving.

The following table shows the runtime characteristics that this task supports.

Table 2. Runtime characteristics
Characteristic	Setting	Description
Manual Run	Allowed	This task can be run manually.
Scheduled Run	Not Allowed	This task cannot be scheduled.
Concurrent Run	Allowed	This task can run concurrently.

Configure the task

Services Framework tasks need to be configured before they can be used. The following list describes the configuration that the image archive tasks need.

Set the appropriate configuration parameters for the task. The parameters for this task are shown in the following tables.
The file is delivered to a configured target directory. This directory is normally configured as the source directory for an outbound Gateway.

Use the Services Framework task configuration page to provide the configuration parameters for the task. For more information, see Configure a task.

The following table shows the common parameters for the Services Framework tasks.

Table 3. Common parameters for Services Framework tasks
Parameter	Description	Example
Task	The name of the registered task.	Viewpointe archive extract task
Configuration	The descriptive name for the configuration.	Viewpointe archive extract configuration
Description	A detailed description to explain what the configuration does. This parameter is not mandatory. If entered, it must be 512 characters or less.
Activate task	This parameter identifies if the configuration is active.	Yes, No
Process end of day	This parameter indicates whether the task is to be called during end of day processing. Set this value to yes to call the task.	Yes
Process cleanup	Set this value to no because the task does not need to process cleanup.	No
Delete on complete	This parameter indicates whether the activity for this task is deleted when it is complete. If set to yes, the activity for this task is deleted when it successfully completes and is not deleted when it has errors or warnings. If set to no, the activity for this task is not deleted when it completes. Deleted task activities do not appear on the task activity page.	Yes, No
Allow Monitor	This parameter indicates whether Services Framework collects performance data for the task configuration.	Yes, No

The following table shows the common parameters for an image archive task.

Table 4. Image archive task common parameters
Parameter	Description	Examples or default
Target Output Directory	This parameter specifies the final output location.	/opt/ibm/ftm/
Target Working Directory	This parameter specifies the intermediate output location.	/opt/ibm/ftm/work/
Extension on the trigger file	This parameter specifies the file extension for the trigger file.	.eof
Extension on the routing file	This parameter specifies the file extension for the routing file.	.rte
Transmission Definition	This parameter specifies the transmission definition name.	VPVLFTRANS
UOW Complete State	This parameter specifies the state of the batch (ICL) to be set when complete.	ARCHIVED
Index Definition Filename	This parameter specifies the CSV file name that defines the index data.
User Exit	This parameter specifies the Java class name of the user exit.
Image Retrieval Mode	This parameter specifies whether the mode of image retrieval is either local or remote.	Local
Image Segments to Retrieve	This parameter specifies the image segments to retrieve.	FBW, RBW
Missing Image Percentage	This parameter specifies the threshold of missing images.	1.0,10
Substitute Image	This parameter specifies the TIFF file that is used as a substitute image.	SorryDoc.tif
Substitute Image Maximum Size	This parameter specifies the maximum file size of the substituted image.	100000

The following table shows the parameters for the Viewpointe archive extract task.

Table 5. Viewpointe archive extract task parameters
Parameter	Description	Examples or default
Maximum File Length	This parameter specifies the maximum size of the image file. After the file reaches the maximum size, a new image and index pair is created. The maximum size of the archive is 2 Gb.	500000000
Transmission Definition Lookup File	This parameter specifies the file name that serves as a lookup file to derive the transmission definition name, based on the endpoint of the transaction. Only the user exit can update this transaction attribute. Thus, transactions in a single UOW can be written to different index or image files. For more information, see Item Endpoint	/opt/ibm/ftm/endpointTransDef.csv
Image File Extension	This parameter specifies the file extension to be applied to the image file, by using the same name as the index file. The index file name is derived from the transmission definition file pattern attribute.	`.OUT`

File name pattern placeholder values

The VLF file name specifies that the archive application group, application name, destination, source, and customer ID are in the VLF, index, or image file name format. The task provides configuration properties where a transmission definition is specified. An attribute of the transmission definition is a file pattern. The index and image files have the same names, with different file extensions.

The following table shows the common file name pattern placeholder values that the task supports.

Table 6. 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.

The following table describes the file name pattern placeholder values that a Viewpointe archive extract task overrides.

Table 7. File name pattern placeholder overridden values
Name	Placeholder	Description
Uow Id	`%ID%`	This placeholder substitutes the value for the ID of the unit of work. The `S` component of the file name allows 5 digits. But to allow for file rollover, only 4 digits are applied and `%FILENUM%` is used as the fifth digit to keep the file names distinct.
Current Day	`%DT%`	This placeholder substitutes the same way as the common placeholder for current day except that it uses the 24-hour format. To get the 4-digit timestamp, configure the placeholder by using the `%DTHHmm%` format.
File Sequence #	`%FILENUM%`	This placeholder substitutes the same way as the file sequence number common placeholder except that only one digit is used in the file name.

Item Endpoint

A single image archive extract task can output multiple pairs of image and index files. The following are the reasons for these multiple pairs of image and index files.

Multiple pairs of files can be created when the image file reaches the maximum file size that was configured for the extract. The file sequence number placeholder %FILENUM% in the file name pattern makes sure that the names of these files are unique.
Some of the transactions need to be loaded into different places. For example, separating the on-us transactions from the transit transactions. The different target destinations for the transactions can affect the file names of the index and image files.

One way that you can separate the index and image file pairs, and name them with the correct naming convention, is to use transmission definitions and endpoints.

The following list shows the general steps to use endpoints to determine the names of the index and image files for the extract task.

Implement the updatePayment user exit method so that the setEndpoint attribute of the payment is called to assign an endpoint to a class of transactions or payments.
Create a transmission definition lookup file to identify the transmission definition that the task uses for each endpoint. A transmission definition has the file name pattern to use for the file where the transactions are written. The transmission definition lookup file maps the name of an endpoint with the name of the transmission definition to use for the endpoint. As the image archive task writes transactions, it uses this lookup file to find the transmission definition to use for the endpoint that was assigned to the transactions.
Configure the name of your transmission definition lookup file in the Transmission Definition Lookup File property of your task.
Create or configure any endpoints that you used in your transmission definition lookup file.

The task uses the endpoint for the transaction as the key to look up the transmission definition to use. The entries on each line of the transmission definition lookup file have the following format.

Endpoint,TransmissionDefinition

Because a comma is used to separate the name of the endpoint from the name of the transmission definition, you cannot use a transmission definition that has commas in its name. The following example shows a transmission definition lookup file with more than one endpoint.

1,ARCHTASKTRANSDEF01
4,ARCHTASKTRANSDEF04

Manually run the task

The Viewpointe archive extract task can run manually. The following table shows the parameters that are used for manual invocation of the Viewpointe archive extract task.

Table 8. Manual task configuration parameters
Parameter	Description	Value
UOW Id	This parameter indicates the ID for the unit of work. 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.	Batch/ICL
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 or 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 or N
Continue Extract if Too Many Missing Images	This parameter indicates whether to continue with the task processing if the task configuration’s missing image percentage exceeds the threshold. The default value is N.	Y or 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 or N