Sanction screening 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 list.
  • <prefixes>.REQUEST.TO.SANCTION
  • <prefixes>.RESPONSE.FROM.SANCTION
  • <prefixes>.SIM.SANCTION.STORE.ACK
  • <prefixes>.SIM.SANCTION.TRIGGER.ACK
  • <prefixes>.SIM.FAILED

Broker artifacts

This simulator uses the following artifacts:
  • The artifacts for The Clearing House (TCH) are:
    • TCHSanctionSim.msgflow
    • FTM IP TCH Simulator LIB
    • FTM IP Simulator Common LIB
  • The artifacts for SCTInst are:
    • SCTInstSanctionSim.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 1. Common flow properties
Property name Default value Description
SimInputQueue FXR.IP.REQUEST.TO.SANCTION Simulator request queue.
SimOutputQueue FXR.IP.RESPONSE.FROM.SANCTION Simulator response queue.
SimStoreAckQueue FXR.IP.SIM.SANCTION.STORE.ACK Simulator store acknowledgment queue.
SimTriggerAckQueue FXR.IP.SIM.SANCTION.TRIGGER.ACK Simulator trigger acknowledgment queue.
FailedMsgOutputQueue FXR.IP.SIM.FAILED The queue to use for messages that fail schema validation.
LogFailedMsgToQueue TRUE Indicates whether failed messages are logged to a queue.
DataSource FTMDB The 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.
Table 2. User defined properties
Property name Default value Description
SOS_Name_PEND SOS.PEND Controls the status code that is used in the response. For more information, see Status codes and user defined properties.
SOS_Name_RJCT SOS.RJCT Controls the status code that is used in the response. For more information, see Status codes and user defined properties.
SOS_Name_PEND_RJCT SOS.ACK.RJCT After a response with the pending status is sent, another response with the reject status is stored.
SOS_CrdtAgtRCLRspRjct
  • SCTInst: BBBBUS92
A credit return request of a payment return(pacs.004) is rejected when the specified value corresponds to the BIC of the CdtrAgt. SOS_CrdtAgtRCLRspRjct is compared to the pacs.004 field:
PmtRtr
+TxInf
++OrgnlTxRef
+++CdtrAgt
++++FinInstnId
+++++BIC
SOS_CretrAgtRspRjct
  • TCH: 021200283
A return of funds request of a payment (pacs.008) is rejected when the specified value corresponds to the agent ID of the case creator in the camt.029.:
CxlDtls
+OrgnlGrpInfAndSts
++RslvdCase
+++Cretr
++++Agt
+++++FinInstnId
++++++ClrSysMmbId
+++++++MmbId
SOS_MsgRcptIdRjct
  • TCH: 021200281
A remittance advice request is rejected when the specified value corresponds to the message recipient ID in the remt.001.
RmtAdvc
+GrpHdr
++MsgRcpt
+++Id
++++OrgId
+++++Othr
++++++Id
SOS_CrdtAcctROIRjct
  • SCTInst: DE29A12000194212188884
A result of investigation request(camt.029) is rejected when the specified value corresponds to the creditor account of the camt.029.
CxlDtls
+TxInfAndSts
++OrgnlTxRef
+++CdtrAgt
++++FinInstnId
+++++BIC
SOS_DbtrAgtToAddLtcy
  • TCH: 021200298
  • SCTInst: BBBBUS95
If the following debtor agent ID is defined, latency is added:
In pacs.008 for TCH:
FIToFICstmrCdtTrf
+CdtTrfTxInf
++DbtrAgt
+++FinInstnId
++++ClrSysMmbId
+++++MmbId
In pacs.008 for SCTInst:
FIToFICstmrCdtTrf
+CdtTrfTxInf
++DbtrAgt
+++BIC

For more information, see Latency processing.

SOS_StoredAckExpiry 30000 Expiration time for messages stored on SimStoreAckQueue.
SOS_Latency 100 Simulates the latency. This property is specified in milliseconds. For more information, see Latency processing.
SOS_AddtlLtcy 6000 Additional latency to add to cause a timeout during processing. For more information, see Latency processing.
SOS_FixedLatencyMode TRUE Indicates whether the latency is added independently of the IBM® MQ wait time. For more information, see Latency processing.
DB_SCHEMA FTM The name of the database schema.
ApplicationName FTM IP TCH Application or FTM IP SCTInst Application Configurable application name
ApplicationCode TCH or SCTI Configurable application code
StsCodeAccept ACTC or ACCP Configurable acceptance status code
RjctReasonCode NARR Configurable reject reason code