Entry Allocation and Extraction Tasks

During entry allocation, batches (ICLs) are aggregated into entries, which are called marking. The marking process uses an entry services profile to control how the batches (ICLs) are aggregated as they are assigned to entries. For more information about the entry services profile, see Entry Services Profile.

Occasionally, available batches (ICLs) are not marked because the minimum aggregation requirements are not met. This action usually happens because the business day to which these batches (ICLs) belong is an active business day. When the business day is closed, the marking process ignores the minimum threshold limits so that all of the remaining batches (ICLs) in the business day are not left deallocated.

After the batches (ICLs) are marked, information about the entry to which it is assigned is applied to each batch (ICL) in the entry. This task is called allocation. Allocation requires an entry number allocation parameter to control how entry numbers are assigned to the entries.

Entry allocation is performed by the following Services Framework tasks:
  • EntryMarkerTask
  • EntryAllocationTask
  • CPCSTxsExtractTask

Configure as many entry marking tasks as are needed to support the aggregation and threshold requirements of the business. Use a different profile name in the entry services profile file for each task instance.

Only one entry allocation task is needed because it can support multiple entry marking tasks. Likewise, only one CPCS extract task is needed as it also can support multiple entry marking tasks. If only entry allocation, and not extraction, is required, use the entry allocation task. If entry allocation and extracts are required, use the CPCS extract task.

To ensure that entry marking occurs regularly during the business day, create a Services Framework scheduled configuration to periodically run the entry marking tasks. Set the start time of each task to run at different times to avoid database contention. As an entry marker task successfully completes aggregating batches into an entry group, it forwards the group to the entry allocation task or CPCS extract task to assign the entry number and complete the allocation, and if a CPCS extract task, create the extract files. Since the entry marker tasks start them, the entry allocation task and CPCS extract tasks do not need to be a scheduled task. For more information about creating scheduled configurations, see New Scheduled Configuration.

The entry marking task also supports running when a presentment or presentment group event occurs. The task ignores the unit of work (UOW) ID from the event and uses its configuration in the entry services profile to begin marking. To enable this function, configure a Transaction Server event handler for the specific presentment or presentment group events. For more information about configuring event handlers for these event types, see Available Messaging API Event Handlers.
Note: Scheduling the entry marker tasks is preferred over using events. Scheduling the tasks ensures that event marking is run throughout the day and also reduces the risk of introducing database performance problems.

These tasks must be registered and configured before they are available for use. For more information about registering and configuring these tasks in Services Framework, see Services Framework task registration and configuration.

Runtime Characteristics

These tasks have the runtime characteristics that are shown in Table 1, Table 2, Table 3, and Table 4.
Table 1. Entry Allocation Task Runtime Characteristics
Characteristic Setting Description
Manual run Allowed This task can be run manually.
Scheduled run Allowed This task can be scheduled to run by using a Services Framework scheduled configuration.
Concurrent run Allowed The entry allocation task can run concurrently.
Table 2. Entry Marker Task Runtime Characteristics
Characteristic Setting Description
Manual run Allowed This task can be run manually.
Scheduled run Allowed This task can be scheduled to run by using a Services Framework scheduled configuration.
Concurrent run Allowed The entry marker task can run concurrently.
Table 3. CPCS Extract Task Runtime Characteristics
Characteristic Setting Description
Manual run Allowed This task can be run manually.
Scheduled run Allowed This task can be scheduled to run by using a Services Framework scheduled configuration.
Concurrent run Allowed The CPCS extract task can run concurrently.
Table 4. Preload ISN Task Runtime Characteristics
Characteristic Setting Description
Manual run Allowed This task can be run manually.
Scheduled run Allowed This task can be scheduled to run by using a Services Framework scheduled configuration.
Concurrent run Allowed The preload ISN task can run concurrently.