Participants task

The details of the financial institutions that participate in Real-Time Gross Settlement (RTGS) are stored in the participants data. The Participants task is used to load the participants data from Swift.

The files that are used by this task are shown in the following list.

  • The Full file contains the data that is recorded in Swift. This file is a large file.
  • The Delta file is used to keep the data updated in FTM. This file contains only the data that changed since the last released delta file.

After the participants task is complete, a tactical activation message is sent to the Business Rules Manager 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 participants task
Field Description Value
Task classname Enter the Java class name for the task. com.ibm.fxh.swiftref.tasks.ParticipantsTask
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 can be scheduled to run by using the Services Framework timed interface.
Concurrent Run Not allowed This 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 Participants task needs.
  • 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. Participants task
Configuration The descriptive name for the configuration. Participants task configuration
Description A detailed description that explains 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 parameters for the participants task.
Table 4. Participants task parameters
Parameter Description Examples or default
Source directory This parameter specifies the directory where the participants file is delivered. Only one file, either the full or delta file exists in this folder during a specific run.
  • PARTICIPANTS-ALL-V1-F-2024-03-02.xml
  • PARTICIPANTS-ALL-V1-M-2024-03-02.txt
Error directory This parameter specifies the error directory that the Participants task use to store the failed participants file.  
Processed directory This parameter specifies the processed directory that the Participants task use to store the completed participants file.  
Structures to load This parameter specifies the configuration that identifies structures that need to be loaded in the file.
The multiple structures that the Swift PARTICIPANTS-ALL file supports are shown in the following list.
  • PMI
  • SNET
  • SNETFIN

This task currently supports only the PMI structure.
File format This parameter specifies the format of the file that the Participants task processes. The file formats that this task supports are shown in the following list.
  • XML. The root node of the XML starts with <dataexport>.
  • TXT. This file is structured with CR/LF and each data field is tab-delimited.
 The default value is XML.
Mode This parameter specifies the mode of the file load. The types of modes are shown in the following list.
  • BICS_ONLY. The task loads only those records that have a Business Identifier Code (BIC) defined for that record.
  • ALL_RECORDS. The task loads all records regardless of the content.
 The default value is BICS_ONLY.

Information displayed by the task

Depending on the various stages of the data loading processing, you can see 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 that the task is using (BICS_ONLY or ALL_RECORDS).
  • File attributes that indicate 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 to 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 used by the task.