Relationships task

The Relationships task loads relationships data (SSI - Standing Settlement Instruction) from Swift. It defines the relationship between a bank and its currency correspondent.

There are two types of source files consumed by the relationships 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 relationships 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 Registering a task. The following table shows the fields that are needed to register this task.
Table 1. Fields to register the relationships task
Field Description Value Example
Task classname Enter the Java class name for the task. com.ibm.fxh.swiftref.tasks.RelationshipsTask  
Task name Enter a descriptive name for the task. Customer specified. Relationships task.
Description Enter a detailed description about what the task does. Customer specified. Loads relationships data (SSI - Standing Settlement Instruction) from Swift.
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 relationship task 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.

The following table shows the common parameters for the Services Framework tasks.
Table 3. Common parameters for Services Framework tasks
Parameter Description Example
Source directory Place either the full or delta Relationships file in this directory before running the task. Ensure that only one file is present during each run.
  • RELATIONSHIPS-ALL-V1-F-2024-03-02.xml
  • RELATIONSHIPS-ALL-V1-M-2024-03-02.txt
Error directory Store any relationships files that fail during processing.  
Processed directory Store completed relationship files in this directory after you finish processing.  
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.
Mode Select the mode for loading records:
  • BICS_ONLY: Load only records that include a defined Business Identifier Code (BIC).
  • ALL_RECORDS: Load all records, regardless of whether a BIC is defined.
 The default value is BICS_ONLY.

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 mode used during the task run is BICS_ONLY or ALL_RECORDS.
  • File attributes indicating the product type, file type (delta or full), and file date.
  • 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.