Clearing and settlement mechanism (CSM) simulator for EBA setup and configuration

This topic describes the artifacts that must be set up and the properties that must be configured for this simulator.

Queues

The queues used by this simulator are shown in the following table.
Table 1. Queues
Queue type Queue name Related property name
Outbound payment, Inbound response <prefixes>.TO.CSM ToCSMQueue
Outbound response, Inbound payment <prefixes>.FROM.CSM FromCSMQueue
Inbound payment <prefixes>.REQUEST.TO.CSM.EXTERNAL PaymentToCSMExternal
Inbound payment (internal queue) <prefixes>.SIM.CSM.EXPIRYREPORT SimCSMExpiryReportQ
Inbound payment (internal queue) <prefixes>.SIM.CSM.TIMEOUT SimCSMTimeOutQ
Internal queue <prefixes>.SIM.CSM.TRIGGER.RPTRSP TriggerRepeatResponse
Internal queue <prefixes>.SIM.CSM.CONTROL SimCSMControlQueue
Error queue <prefixes>.SIM.FAILED FailedMessageOutputQueue

Broker artifacts

This simulator uses the following artifacts:
  • SCTInstCSMSimulator.msgflow
  • FTM IP SCTInst Simulator LIB
  • FTM IP Simulator Common LIB

Common flow properties

The common flow properties used by this simulator are shown in the following table.
Table 2. Common flow properties
Property name Default value Description
PaymentToCSMExternal FXR.IP.REQUEST.TO.CSM.EXTERNAL Simulator input queue for the following messages from an external debtor application:
  • Payment requests (pacs.008)
  • Payment status investigation requests (pacs.028)
  • Recall requests (camt.056)
ToCSMQueue FXR.IP.TO.CSM Simulator input queue for the following messages from Immediate Payments:
  • Payment requests (pacs.008)
  • Payment status investigation requests (pacs.028)
  • Status reports (pacs.002).
  • Result of investigation requests (camt.029).
  • Return of funds requests (camt.056.
  • Payment return requests (pacs.004).
FromCSMQueue FXR.IP.FROM.CSM Simulator output queue for the following messages:
  • Request messages received on the PaymentToCSMExternal queue
  • Cancellation messages for payment requests that timed out (pacs.002 messages that have a reject status
  • Status reports sent to Immediate Payments (pacs.002)
FailedMsgOutputQueue FXR.IP.SIM.FAILED The queue to use for messages that fail schema validation.
CSM_ExpiryReportQ and SimCSMExpiryReportQ FXR.IP.SIM.EXPIRYREPORT The queue to use for IBM® MQ expiry reports. The expiry reports cause cancellation requests to be generated for the payment requests.
SimCSMTimeoutQ FXR.IP.SIM.CSM.TIMEOUT The queue to use to store payment requests that expire based on the value defined in the CSM_ExpirationTimeToCancel property.
TriggerRepeatResponse FXR.IP.SIM.CSM.TRIGGER.RPTRSP The queue to use to initiate sending the responses to repeated messages.
SimCSMControlSimCSMControlQueue FXR.IP.SIM.CSM.CONTROL The queue allows to simulate a schema validation error for all requests and answers with an pacs.002 reject message with reason code 'FF01'.
LogFailedMsgToQueue TRUE Indicates whether failed messages are logged.
Data source FTMDB Name of the database that is running the application.

User defined properties

The user defined properties (UDP) for this simulator are shown in the following table.

For UDPs related to repeat scenarios, refer to Repeating messages scenarios.

Table 3. User defined properties
Property name Default value Description
DB_SCHEMA FTM The name of the database schema.
CSM_BIC_ID BANKDE90 The BIC used by the simulator in the ID fields of the messages it generates.
CSM_TimeoutProcessing TRUE This property enables and disables the timeout mechanism.
CSM_ExpirationTimeToCancel 5000 The amount of time to wait, in milliseconds, before timeout processing begins.
CSM_LimitCTRjct 800 The amount limit for a payment request (pacs.008) that controls the return code used in the status report response (accept or reject). For more information about the codes returned, see Status codes and user defined properties.
CSM_DbtrAgtPSRRjct BBBBUS98 A payment status investigation request (pacs.028) is rejected when the specified value corresponds to the BIC of the DbtrAgt.
CSM_DbtrAgtPSRRjct is compared to the pacs.028 field:
FIToFIStsReq
+TxInf
++OrgnlTxRef
+++DbtrAgt
++++FinInstnId
+++++BICFI
CSM_CrdtAgtRCLROI BBBBUS97 For a recall request (camt.056) for outbound payment scenarios, the simulator responds with a resolution of investigation message (camt.029) when the specified value corresponds to the BIC of the CdtrAgt.

Otherwise it responds with a payment return request (pacs.004).

CSM_CrdtAgtRCLROI is compared to the camt.056 field:
Undrlyg
+TxInf
++OrgnlTxRef
+++CdtrAgt
++++FinInstnId
+++++BICFI
CSM_TxInfAndSts_Status FALSE In status report messages (pacs.002) that are received by the CSM simulator, the status is checked in both OrgnlGrpInfAndSts and TxInfAndSts. OrgnlGrpInfAndSts is checked before TxInfAndSts.
In status report messages (pacs.002) that are sent by the CSM simulator, this property controls which fields the status is set in:
  • The reject status, RJCT, is set in TxInfAndSts when this property is set to true, and in OrgnlGrpInfAndSts when it is false.
  • The accept status, ACCP is always set in OrgnlGrpInfAndSts. When this property is set to true, an optional TxInfAndSts is created.
CSM_UpdateTimestamps FALSE Updates CreDtTm, IntrBkSttlmDt, AccptncDtTm to locale timestamp in messages received by CSM simulator in REQUEST.TO.CSM.EXTERNAL queue.
CSM_Latency 100 Simulates the latency. This property is specified in milliseconds. For more information, see Latency processing.
CSM_FixedLatencyMode TRUE Indicates whether the latency is added independently of the IBM MQ wait time. For more information, see Latency processing.
CSM_DbtrAgtToAddLtcy BBBBDEFF For inbound payment scenarios, additional latency is added when the value corresponds to the BIC of the DbtrAgt.
CSM_DbtrAgtToAddLtcy is compared to the pacs008 field in the payment request:
FIToFICstmrCdtTrf
+CdtTrfTxInf
++DbtrAgt
+++FinInstnId
++++BIC
CSM_AddtlLtcy 6000 The amount of latency to add when DbtrAgt is matched.
ApplicationName FTM IP SCTInst Application Configurable application name