Codes task

The Codes task loads different codes (such as Country and Currency) from Swift. The file lists various sets of codes related to payments, including currency codes and country codes.

There are two types of source files consumed by the codes task:
  • Full: Contains all the data known by Swift, usually a large file.
  • Delta: Contains only the data that has changed since the last released delta file. This file is used to keep the data in FTM updated.

After the codes task is complete, a tactical activation message is sent to the Business Rules Server to reload the data. For more information about tactical activation, see Tactical activation.

Register the task

Use the task registry page in the Services Framework user interface. For more information, see Register a task. The following table shows the fields that are needed to register this task.
Table 1. Fields to register the Codes task
Field Description Value Example
Task classname Enter the Java class name for the task. com.ibm.fxh.swiftref.tasks.CodesTask  
Task name Enter a descriptive name for the task. Customer specified. Load the Swift codes into FTM
Description Enter a detailed description about what the task does. Customer specified. Loads Swift codes such as country codes and currency codes.
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 Allowed This task be scheduled to run using the Services Framework timed interface.
Concurrent Run Not Allowed The task cannot run concurrently.
This task can be run manually but no manual run configuration is available.

Configure the task

Services Framework tasks need to be configured before they can be used. The following list describes the configuration that the codes 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 Task Configuration page.
Table 3. Common parameters for Services Framework tasks
Parameter Description Example
Source directory The directory where the CODES file is to be delivered. Only one file must exist in this folder during any given run. This task supports either CODES-ALL or CODES-ISO files. Supported formats are TXT (.txt) and XML (.xml).
  • CODES-ALL-V1-F-2024-03-02.xml
  • CODES-ALL-V1-M-2024-03-02.txt
  • CODES-ISO-V1-F-2024-03-02.xml
  • CODES-ISO-V1-M-2024-03-02.txt
Error directory Store any codes files that fail during the loading process.  
Processed directory Store completed codes files in this directory after the task completes successfully.  
Structures to load Specify which structures from the codes file to load. At least one structure must be configured. This task support the following structures:
  • COUNTRY
  • CURRENCY
 When loading multiple structures, separate each structure with commas. Example: COUNTRY, CURRENCY
File format Choose the format of the file to process. You can use one of the following:
  • XML: Use an XML file from Swift. The root node must start with <dataexport>.
  • TXT: Use a TXT file from Swift. The file must be structured with CR/LF line breaks, and each data field must be tab-delimited.
 The default value is XML.

Information displayed during data loading

During various stages of data loading processing, the task displays the following information.
  • Whether the task execution is a manual run or a regular scheduled run.
  • Task execution messages that are appropriate for the stage of processing.
  • Task error messages.
  • The total number of records read from the source file.
  • The total number of records that are inserted into the database.
  • The total number of records that are updated in the database.
  • The total number of records that are bypassed in the database.
  • The total number of records that are deleted in the database.
  • The total time taken by the task.