INSTITUTE FOR DEVELOPMENT AND RESEARCH IN BANKING TECHNOLOGY, HYDERABAD SFMS-CBS Interface Specification Document VERSION 1.0 1 Software Units Layout, Madhapur, Hyderabad – 500 081 November 2006 SFMS-CBS Interface Specification Document This is a controlled document. Unauthorised access, copying, replication and usage for a purpose other than for which this is intended are prohibited. SFMS-CBS Interface Specification Document DOCUMENT RELEASE NOTICE Notice No. : 1.0 Client : IDRBT Project : SFMS Document Details: Name Version No. Description SFMS-CBS Interface Specification Document 1.0 This document provides the specifications and prerequisites for integrating SFMS with CBS Revision Details: Action taken (add/delete/change) Preceding New Page No. Page No. Revision Description Change Register serial numbers covered: The documents or revised pages are subject to document control. Please keep them up-to-date using the release notices from the distributor of the document. These are confidential documents. Unauthorised access or copying is prohibited. Approved by: Date: dd-mmm-yyyy ( ) Authorised by: Project Leader ( ) TATA CONSULTANCY SERVICES Date: 22-Nov-2006 Page iii of 45 SFMS-CBS Interface Specification Document DOCUMENT REVISION LIST Client : IDRBT Project : SFMS Document Name: SFMS-CBS Interface Specification Document Release Notice Reference (for Release): SFMS-CBS Interface Specification Document version 1.0 Note: The revised sentences are marked with left borders. Rev. No Revision Revision Date Description TATA CONSULTANCY SERVICES Page Prev Action Taken No Page No Addenda/ Release New Notice Page Reference Page iv of 45 SFMS-CBS Interface Specification Document ABOUT THIS DOCUMENT Purpose This document explains step-by-step procedures to use the SFMS-CBS Interface. Scope This document provides the specifications and pre-requisites for SFMS-CBS Interface on Windows Server. Apart from providing the basic installation and configuration procedures, this document also deals with Regular Monitoring Activities and user parts of managing SFMS-CBS Integration on Windows. Intended Audience This document is intended for the bank’s system administrators and support personnel. Administrators are presumed to have sufficient operational knowledge of the IBM MQ Series. Structure of this Document 1. Introduction This chapter contains an overview of SFMS, CBS and current Bank API. 2. Approach This chapter explains the approach for the SFMS-CBS Interface. 3. Message Structures This chapter explains the message structures used for the SFMS-CBS Interface. 4. MQ Configurations This chapter explains the MQ configuration details for the SFMS-CBS Interface 5. Regular Monitoring Activities This chapter details the Regular Monitoring Activities of the SFMS-CBS Interface. 6. CBS Directory This chapter gives a brief introduction of the CBS IFSC Directory usage. 7. CBS Message Listing This chapter gives a brief introduction of the CBS Message Listing. 8. CBS Report This chapter gives a brief introduction of the CBS Report usage. 9. SFMS Helpdesk This chapter gives details of the SFMS Helpdesk Mode of Distribution This document and related documents will be placed on the INFINET website. TATA CONSULTANCY SERVICES Page v of 45 SFMS-CBS Interface Specification Document Abbreviations and Acronyms Used Term ANDB API CA CBS CNRB CRL HTTPS IDRBT IFSC INFINET LDAP MQ MUR NEFT PKI PI RA RMI RTGS SFMS SMAC STP TCS UMAC UTR TATA CONSULTANCY SERVICES Description Andhra Bank Application Programming Interface Certifying Authority Core Banking System Canara Bank Certificate Revocation List Secure Hypertext Transfer Protocol Institute for Development and Research in Banking Technology Indian Financial System Code Indian FINancial NETwork Lightweight Directory Access Protocol Message Query Message User Reference National Electronic Funds Transfer Public Key Infrastructure Participant Interface Registration Authority Remote Method Invocation Real Time Gross Settlement Structured Financial Messaging System. Server Message Authentication Code Straight Through Processing Tata Consultancy Services User Message Authentication Code Unique Transaction Reference Page vi of 45 SFMS-CBS Interface Specification Document CONTENTS 1 Introduction ......................................................................................... 8 1.1 SFMS Overview ........................................................................................ 8 1.2 CBS Overview .......................................................................................... 8 1.3 Current Bank API Overview ........................................................................ 8 2 Approach .............................................................................................. 9 2.1 Approach ................................................................................................. 9 2.2 Mandatory Requirements ......................................................................... 12 2.3 Message Flow ......................................................................................... 13 2.4 Security................................................................................................. 14 3 Message Structures .............................................................................15 3.1 User Message ......................................................................................... 15 3.2 Acknowledgement Message ...................................................................... 20 3.3 Non-Delivery Warning Message ................................................................ 21 3.4 Delivery Notification Message ................................................................... 22 3.5 Open Notification Message ....................................................................... 23 3.6 Negative Acknowledgement Message ........................................................ 24 3.7 User Negative Acknowledgement Message ................................................. 25 3.8 BankAPI Response Message ..................................................................... 26 4 MQ Configurations ...............................................................................27 4.1 Queue and Channel Configurations at SFMS ............................................... 27 4.2 Queue and Channel Configurations at CBS ................................................. 27 4.3 Procedure for creation of Queues and Channels .......................................... 27 4.3.1 Queues ........................................................................................ 27 4.3.2 Channels ...................................................................................... 28 5 Regular Monitoring Activities ...............................................................29 5.1 CBS Receiver ......................................................................................... 31 5.2 Register CBS .......................................................................................... 32 5.3 Enable IFSC as CBS ................................................................................ 33 5.4 Delete IFSC from CBS ............................................................................. 34 6 CBS Directory ......................................................................................35 6.1 CBS IFSC Directory Screen Description ...................................................... 35 6.2 CBS IFSC Details Screen .......................................................................... 36 6.3 CBS IFSC Listing ..................................................................................... 36 6.3.1 View CBS IFSC Details ................................................................... 36 6.3.2 Search ......................................................................................... 36 7 CBS Message Listing ............................................................................37 7.1 SFMS to CBS Messages ........................................................................... 38 7.2 CBS to SFMS Messages ........................................................................... 40 8 CBS Report ..........................................................................................43 9 SFMS HelpDesk ....................................................................................45 9.1 Using e-mail .......................................................................................... 45 9.2 Using Telephone ..................................................................................... 45 9.3 SFMS Groups in Banks ............................................................................ 45 TATA CONSULTANCY SERVICES Page vii of 45 SFMS-CBS Interface Specification Document 1 INTRODUCTION 1.1 SFMS Overview Structured Financial Messaging System (SFMS) is an Inter and Intra bank messaging system with a three-tier architecture (HubGatewayBranch Server (Offline/Online)). Some of the major functions and features of the SFMS are: SFMS branch server is the source for creating messages and the SFMS Gateway and HUB route the message from one branch to another. SFMS is a modularised and integrated web-enabled multi-layered messaging software that runs on the central server (HUB), bank gateways and online/offline servers facilitating the electronic exchange of financial and non-financial messages. SFMS caters to the message security requirements of authentication, authorisation, integrity, privacy, non-repudiation and key management. SFMS has a well-defined External Application Programs Interface (API) to send and receive messages using Straight Through Processing (STP). Providing appropriate Message Query (MQ) facilities at each level. 1.2 CBS Overview To be filled by CBS 1.3 Current Bank API Overview The current bank API, based on RMI technology, is an external application interface for legacy banking packages. This development is a part of the branch server component for the benefit of external applications like Core Banking, Integrated Accounting System (IAS) etc. The External Interface Specifications are defined in the SFMS External Applications Specifications Document v 3.0. New bank API, based on MQ Series is defined in the subsequent sections. TATA CONSULTANCY SERVICES Page 8 of 45 SFMS-CBS Interface Specification Document 2 APPROACH 2.1 Approach The prime requirement of the SFMS-CBS Interface is to have a minimum of one online server represented in the approach diagram below. The SFMS–CBS interface approach is as follows. 1. CBS must be registered with the concerned SFMS online branch server. 2. All the messages sent from CBS must have a Sender IFSC, External Sequence Number & External Application ID 3. Sender and Receiver functionalities developed at SFMS using MQ Series to send/receive messages at SFMS are: Sender Functionality: This functionality constructs the messages meant for Core Banking Interface based on the Receiver IFSC Code and Application Identifier in a pre-defined BlockA and Block4 format. The messages are stored in the corresponding MQ Queue connected to the CBS. Receiver Functionality: This functionality continuously polls on the MQ queue connected to the CBS and gets the available messages. It also verifies and validates the messages and updates the same in the SFMS database. During the verification and validation of messages, the reason for failure is returned in a pre-defined message format to the corresponding CBS. 4. CBS gets messages from the SFMS in a designated MQ queue. There will be two MQ queues configured at both SFMS and CBS. One for sending and another for receiving messages. 5. The SFMS user messages should be in BlockA and Block4 format. Please refer to User message section for the format. 6. The messages routed from SFMS to CBS will be based on IFSC Code and External Application ID. The messages routed from CBS to SFMS will be based on the Sender IFSC and External Application ID. 7. A message sent from CBS to SFMS can be uniquely identified using the combination of Sender IFSC, External Application ID and Sequence number. Similarly, a message received from SFMS to CBS can be uniquely identified using the Receiver IFSC Code, Service Identifier and Sequence number 8. The IFSCs participating in CBS must be added as online branches at SFMS Gateway. They must be added in the online branch server as well. These IFSCs must be proliferated as functional. 9. CBS branches will generate messages in the SFMS format and send to SFMS through MQ queue. TATA CONSULTANCY SERVICES Page 9 of 45 SFMS-CBS Interface Specification Document 10. A message from any external application like PI or from any SFMS branch meant for CBS branches will flow through SFMS online server to the corresponding CBS. It is the responsibility of the CBS to further process the message. 11. The CBS IFSC listing is provided at the branch to view the IFSCs enabled as CBS. 12. The CBS message listing and CBS report is provided at the branch to view the messages that have been sent to and received from the CBS. Note: The messages sent/received between SFMS and CBS through the queues are in string format. The message communication between SFMS and CBS is not in encrypted mode. If a CBS branch is connected to the PI server as a PI client and has been added to the SFMS branch and identified as a CBS branch as per the current approach, necessary changes need to be done at PI server so that the messages will flow from SFMS. The resend option for messages sent to CBS, is not provided due to functional constraints at CBS. In case of rejection messages in NEFT like N03 and N09, CBS should be able to handle the transactions under the message as it may contain the transactions which are not actually generated by CBS (These may be created from the same IFSC but not through CBS interface, for example, Create message option) TATA CONSULTANCY SERVICES Page 10 of 45 SFMS-CBS Interface Specification Document RTGS PI MQ Connection CNRB Gateway ANDB Gateway CNRB CBS Branch CNRB Core Banking 1 CNRB Bank Core banking Interface MQ Connection CNRB CBS Branch SFMS CNRB Online Server CNRB CBS Branch CNRB Core Banking 2 CNRB Bank Core banking Interface SFMS CNRB Offline Server SFMS ANDB Online/ Offline Server MQ Connection CNRB CBS Branch Figure 1: Diagrammatic Approach of the SFMS-CBS Interface Message Integration All figures with this color are MQ Connections TATA CONSULTANCY SERVICES Page 11 of 45 SFMS-CBS Interface Specification Document 2.2 Mandatory Requirements Given below are the mandatory requirements for the SFMS-CBS Interface: 1. The online server should be installed for the SFMS-CBS Interface. 2. The sender/receiver functionalities for the SFMS-CBS Interface should be at the online server. 3. UMAC is mandatory for all the messages originating from the CBS for Straight Through Processing (STP). 4. Incase of failures in message format or certificate problems SFMS will send response message to the CBS. Please refer to Message Structures section for BankAPI response message format 5. The message length should not be greater than 10 KB as per the SFMS system requirement specifications 6. SFMS will send acknowledgement/negative acknowledgment, delivery notification, open notification, user Nack and non-delivery warning for the messages sent by CBS depending on the scenario. 7. For all the user messages sent by the SFMS to CBS, CBS should send a response back to SFMS for updating the status at SFMS. The BankAPI Response format will be used for this purpose. 8. All inward RTGS messages sent by PI will be routed to CBS along with the UTR and MUR. Incase of inward RTGS messages (R90/R09), CBS has to compare with the corresponding outward RTGS messages (R41/R42) sent from CBS, on the basis of MUR. Incase of Inward RTGS messages (R41/R42), CBS has to check for uniqueness on the basis of UTR. 9. Incase of NEFT messages flow will be the same as that of the normal SFMS messages. 10. SFMS will validate the uniqueness of the messages sent by CBS on the basis of Sender IFSC, Sequence Number and External Application ID specified in BlockA. 11. SFMS expects the message in a predefined BankAPI user message format. Messages that are not in the predefined format will be written into a log file at the SFMS end. Messages that cannot be processed at SFMS would also be written into a log file at the SFMS end. 12. Once the online server is enabled with the SFMS-CBS interface, the SFMS administrator should set the values for the parameters for Admin IFSC and default CBS. Please refer to the ‘After Installation’ section in the Readme_SFMS_3.1.2 file for setting the above parameters. TATA CONSULTANCY SERVICES Page 12 of 45 SFMS-CBS Interface Specification Document 2.3 Message Flow The flow of messages from SFMS to CBS and vice versa is mentioned below. Case 1: CNRB CBS Branch / CNRB Core Banking to RTGS PI Message flows from CNRB CBS Branch / CNRB Core Banking -> CNRB Core Banking Interface -> CNRB SFMS Online Server -> CNRB SFMS Gateway -> RTGS PI. Case 2: RTGS PI to CNRB CBS Branch / CNRB Core Banking Message flows from RTGS PI -> CNRB SFMS Gateway -> CNRB SFMS Online Server -> CNRB Core Banking Interface -> CNRB CBS Branch / CNRB Core Banking. Case 3: ANDB SFMS Online Server to CNRB CBS Branch / CNRB Core Banking Message flows from ANDB SFMS Online Server -> ANDB SFMS Gateway-> SFMS HUB -> CNRB SFMS Gateway -> CNRB SFMS Online Server -> CNRB Core Banking Interface -> CNRB CBS Branch / CNRB Core Banking. The vice versa is also true. Case 4: CNRB SFMS Offline to CNRB CBS Branch / CNRB Core Banking Message flows from CNRB SFMS Offline -> CNRB SFMS Gateway -> CNRB SFMS Online server -> CNRB Core Banking Interface -> CNRB CBS Branch / CNRB Core Banking. The vice versa is also true. Note: If multiple CBS are configured under the SFMS-CBS Interface, the message routing will be based on the external application ID specified in the message. If multiple CBS are configured, it must be ensured that one among them is identified as default CBS. Please refer to the installation procedure in the Readme_SFMS_3.1.2 file for setting the default CBS. If IFSC is registered under a single CBS: All the user messages received by the branch will automatically be routed to the queue corresponding to the CBS. If IFSC is registered under multiple CBS: Messages received with the external application ID as the name of the CBS will be routed to the corresponding CBS queue. Messages received without any external application id will be routed to the default CBS queue. TATA CONSULTANCY SERVICES Page 13 of 45 SFMS-CBS Interface Specification Document Messages received with an external application id which does not match the CBS names under which the IFSC is configured will be routed to the default CBS. 2.4 Security In SFMS we have 2 signatures as follows: UMAC SMAC UMAC is generated on non-encrypted message using a smart card. It fulfills user security requirements. SMAC is generated on encrypted message using server certificate. It fulfills serverto-server security requirements When a message is coming from external applications to SFMS, it can have the user signature (UMAC). For security reasons, SFMS uses Open SSL with PEM format. The message structure that is being sent through MQ to the next Node should be in the format of BlockA, Block4 and UMAC (Optional in case of Non STP). BlockA Block 4 UMAC TATA CONSULTANCY SERVICES Page 14 of 45 SFMS-CBS Interface Specification Document 3 MESSAGE STRUCTURES User Message 3.1 The following fields (BlockA of the SFMS messages to and from external applications) are required for the external applications in order to generate a valid SFMS message. Index 1. Mandatory/ Optional M 2. M 3. M 4. M 5. M 6. M 7. M 8. M 9. M 10. M Open Notification Flag 1 Number 11. M Nondelivery warning flag 1 Number TATA CONSULTANCY SERVICES Field Name Block A Begin Identifier Sender Bank application identifier Field Length 3 Data Type Char Description 3 Alpha Message Identifier Input/ Output Identifier Message Type 3 Alpha Numeric Char 3 Alpha Numeric Uniquely identifies the Bank application. This is the identifier with which bank application is registered at the branch server. Application Identifier F01- User to User I/O Identifier O-Output I-Input INFINET message type Sub Message Type Sender IFSC 3 Alpha Numeric 11 Alpha Numeric Receiver IFSC Delivery Notification Flag 11 1 Alpha Numeric Number 1 Block A Begin Identifier should be {A: INFINET Sub message type. If Sub Message Type is blank, then fill with XXX. IFSC code of the Sender (IFSC code to which the bank application is registered.) IFSC code of the receiver Users to specify whether delivery notification is required for the message. 1 – YES 2 – NO Users to specify whether open notification is required for the message. 1 – YES 2 – NO Flag to inform the user whether the non-delivery warning message is required or not. The possible values Page 15 of 45 SFMS-CBS Interface Specification Document are: 1 – Yes 2 – No 12. M Obsolescen ce Period 3 Number The default value for nondelivery warning flag is ‘2’. Users to specify the period after which a non-delivery warning is to be sent to the sender, applicable only if nondelivery warning flag is specified. If Non-delivery warning flag is 2, then this value should be set to ‘000’. If Non-delivery warning flag is 1, then obsolescence value should be greater than or equal to 002. Range of the values for this field can be between 002 to 999. This is represented in absolute number of units. Each unit is internally interpreted as equal to 5 minutes. 13. M MUR (Message User Reference) Possible Duplicate Emission Flag Service Identifier 16 Alpha Numeric 14. M 1 Number 15. M 3 Alpha 16. M Originating date 8 Number 17. M Originating time 4 Number TATA CONSULTANCY SERVICES For example, Obsolescence period of 003 units is equivalent to 15 minutes. Bank Application uses this field for identifying the message. If it is less than 16 then concatenate with X. Flag to indicate possible duplicate emission 1 – YES 2 – NO Destination Bank Application identifier. If not applicable, it should be defaulted to XXX. Date on which the message was created at Bank application – (YYYYMMDD) Time on which the message was created at Bank application –(HHMM) Page 16 of 45 SFMS-CBS Interface Specification Document 18. M Testing and Training flag 1 Number 19. M Sequence Number 9 Number 20. M Filler 9 21. M 16 22. M UTR (Unique Transaction Reference) Priority Flag Alpha Numeric Alpha Numeric 2 Number 23. M 1 Char 24. M 3 Alpha Numeric 25. M BlockA End Identifier Block4 Begin Identifier Block4 26. M 2 Char 27. O Block4 End Identifier Block5A Begin Identifier 6 Char 28. O Block 5A TATA CONSULTANCY SERVICES Alpha Numeric Alpha Numeric Flag to indicate test and training message. 1 – YES 2 – NO Unique sequence number generation by the external application for the identification of the message in external application system. System messages for the user messages generated by external applications will carry this sequence number. SFMS API rejects the message if there is no sequence number. Ex: If sequence number is 5 then user should send the sequence number as ‘000000005’ Filler for future use and default value is XXXXXXXXX. Unique Transaction Reference Generated for RTGS. Host applications should default it to XXXXXXXXXXXXXXXX Priority flag is used for routing the messages in RTGS messages. For Host applications the default value is 99 BlockA End identifier should be } Block4 begin identifier should be {4: Text block of the message. Length of the message cannot exceed 10 KB. Block4 End identifier should be -} If the bank application can generate the UMAC then this should be {UMAC: If the bank application does not have the capability to prepare the signature, this field can be left blank. Authoriser Signature. This is an optional field, which can be filled by Bank applications with signature prepared in Page 17 of 45 SFMS-CBS Interface Specification Document 29. O TATA CONSULTANCY SERVICES Block5A End Identifier 1 Char PKCS7 standard on Block4 Information. If the bank application does not have the capability to prepare the signature, this field can be left blank. If this field is blank the messages will be forced to be in “PENDING AUTHORISATION” state in SFMS Offline/Branch Server. If the bank application can generate the UMAC then this should be } If the bank application does not have the capability to prepare the signature, this field can be left blank. Page 18 of 45 SFMS-CBS Interface Specification Document Example for the incoming message structure to the SFMS branch server from the bank application is shown below: {A:CBSF01O100XXXSBIN0001001SBIN0001002112005abcdefgh123456782XXX2003 090910202000012345XXXXXXXXXXXXXXXXXXXXXXXXXX99}{4: : 20:TT/320 :32A:20030909INR100, -} {UMAC:<Signature>} {A: CBS F01 O 100 XXX SBIN0001001 SBIN0001002 1 1 2 005 abcdefgh12345678 2 XXX 20030909 1020 2 000012345 XXXXXXXXXX XXXXXXXXXXXXXXXX 99 } {4: : 20:TT/320 :32A:20030909INR100, -} {UMAC: <Signature> } TATA CONSULTANCY SERVICES Block A begin Identifier Bank Application Identifier Message Identifier Input/output Identifier (either I or O) Message type Sub Message type (For IFN 298C01, this field should be C01, for IFN100 Message, this field should be XXX). Sender IFSC Code End receiver IFSC Code Delivery notification flag Open Notification flag Non-delivery Warning flag Obsolescence Period Message User Reference (MUR) Possible Duplicate flag Service Identifier Originating date Originating time Testing and training flag Sequence Number Filler Unique Transaction Reference. Priority Flag Block A end Identifier Block 4 Begin Identifier Block 4 text message format Block 4 End Identifier Block 5A Begin Identifier User Signature for Authorisation Block 5A End Identifier Page 19 of 45 SFMS-CBS Interface Specification Document 3.2 Acknowledgement Message Given below are the fields in the acknowledgement message sent by SFMS to CBS Index 1 Mandatory/ Optional M Field Name 2 M 3 M 4 M Input/Output Identifier 1 Char 5 M Sequence number 9 Number 6 M Sender IFSC 11 7 M 12 8 M Date and Time Block End Identifier Alpha Numeric Number 1 Char Block Identifier Bank Application Identifier Message Identifier Field Length 3 Data Type Char Description 3 Alpha Bank Application Identifier 3 Alpha Numeric Message Identifier F20 – Acknowledgement Message Input/Output Identifier I – Input O – Output External Application Sequence Number for which this acknowledgement is intended. IFSC code of Originating SFMS branch. Date and Time on which message is acknowledged Block End Identifier Block Identifier A sample acknowledgement message is given below: {A:CBSF20O000001000SBIN0001001200703031325} {A: CBS F20 O 000001000 SBIN0001001 200703031325 } TATA CONSULTANCY SERVICES Block Identifier Bank Application Identifier Acknowledgment message Input/Output Identifier External Application Sequence Number Originating IFSC Date and time on which the sender SFMS Gateway acknowledges message Block End Identifier Page 20 of 45 SFMS-CBS Interface Specification Document 3.3 Non-Delivery Warning Message Given below are the fields in the non-delivery warning message sent by SFMS to CBS. Index 1 Mandatory/ Optional M Field Name Block Identifier Bank application Identifier Message Identifier Field Length 3 Data Type Char Description 2 M 3 Char Bank Application Identifier 3 M 3 Alpha Numeric Input/Outp ut Identifier Sequence number Sender IFSC 1 Char 9 Number 11 Alpha Numeric Message Identifier F22 - Non-delivery Warning message Input/Output Identifier I – Input O - Output External Application Sequence Number. IFSC code of Originating SFMS branch. 4 M 5 M 7 M 8 M Date and Time 12 Numeric 9 M Block End Identifier 1 Char Block Identifier Date and Time at which nondelivery warning message is generated. Block End Identifier A sample non-delivery warning message is given below: {A:CBSF22O000001000SBIN0001001200701012227} {A: CBS F22 O 000001000 SBIN0001001 200701012227 } TATA CONSULTANCY SERVICES Block Identifier Bank Application Identifier Non-delivery Warning Message Input/Output Identifier Creation sequence number of the message Originating IFSC Date and time on which non-delivery warning message is generated. Block End Identifier Page 21 of 45 SFMS-CBS Interface Specification Document 3.4 Delivery Notification Message Given below are the fields in the delivery notification message sent by SFMS to CBS. Index 1 Mandatory/ Optional M 2 M 3 M 4 M 5 M 6 M 7 M 8 M Field Name Block Identifier Bank applicatio n Identifier Message Identifier Field Length 3 Data Type Char Description 3 Alpha Bank Application Identifier 3 Alpha Numeric Input/Out put Identifier Sequence number Sender IFSC 1 Char 9 Number 11 Alpha Numeric Message Identifier F23 - Delivery Notification message Input/Output Identifier I – Input O – Output External Application sequence number IFSC code of Originating SFMS branch. Date and Time Block End Identifier 12 Number 1 Char Block Identifier Date and time on which the message is delivered. Block End Identifier A sample delivery notification message is given below: {A:CBSF23O000001000SBIN0001001200701012227} {A: CBS F23 O 000001000 SBIN0001001 200701012227 } TATA CONSULTANCY SERVICES Block Identifier Bank Application Identifier Delivery Notification Message Input/Output Identifier Creation sequence number of the message IFSC code of the originating SFMS branch. Date and time on which the message is delivered. Block End Identifier Page 22 of 45 SFMS-CBS Interface Specification Document 3.5 Open Notification Message Given below are the fields in the open notification message sent by SFMS to CBS. Index 1 Mandatory/ Optional M Field Name Block Identifier Bank application Identifier Message Identifier Field Length 3 2 M 3 M 4 M Input/Outp ut Identifier Sequence number Sender IFSC 1 Char 5 M 9 Number 6 M 11 Alpha Numeric 7 M Date and Time 12 Number 8 M Block End Identifier 1 3 3 Data Type Char Description Alpha Numeri c Alpha Numeric Bank Application Identifier Char Block Identifier Message Identifier F24 - Open Notification message Input/Output Identifier I – Input O – Output External Application sequence number IFSC code of Originating SFMS branch. Date and time on which the message is opened at destination. Block End Identifier A sample open notification message is given below: {A:CBSF24O000001000SBIN0001001200701081730} {A: CBS F24 O 000001000 SBIN0001001 200701081730 } TATA CONSULTANCY SERVICES Block Identifier Bank Application Identifier Open Notification Message Input/Output Identifier Creation sequence number of the message IFSC code of Originating SFMS branch. Date and time on which message is opened. Block End Identifier Page 23 of 45 SFMS-CBS Interface Specification Document 3.6 Negative Acknowledgement Message Given below are the fields in the negative acknowledgement message sent by SFMS to CBS. Index 1 Mandatory/ Optional M 2 M 3 M 4 M 5 M 6 M 7 M 9 M M 10 M Field Name Block Identifier Bank Applicatio n Identifier Message Identifier Field Length 3 Data Type Char Description 3 Alpha Bank Application Identifier 3 Alpha numeric Input/Out put Identifier Sequence Number Sender IFSC Date and Time Error code Filler 1 Char 9 Number 11 Alpha Numeric Number Message Identifier F25-Negative Acknowledgement Input/Output Identifier I-Input O - Output External Application Sequence Number IFSC of originating SFMS branch Date and Time Block End Identifier 1 12 4 9 Number Alpha Numeric Char Block Identifier Reason code for NACk Filler for future Use Block End Identifier A sample negative acknowledgement message is given below: {A:CBSF25O000001000SBIN00000012007030313252105XXXXXXXXX} {A: CBS F25 I 000001000 SBIN0000001 200703031325 2105 XXXXXXXXX } Block Identifier Bank Application Identifier Negative Acknowledgment message Input/Output Identifier External Application Sequence Number Originating IFSC Date and time on which the sender SFMS gateway negatively acknowledged the message Error occurred while creating PKCS#7 structure Filler for future use Block End Identifier TATA CONSULTANCY SERVICES Page 24 of 45 SFMS-CBS Interface Specification Document 3.7 User Negative Acknowledgement Message Given below are the fields in the user negative acknowledgement message sent by SFMS to CBS. Index Mandatory/ Optional 1 M 2 M 3 M 4 M 5 M 6 M 7 M 8 Field Name Field Lengt h 3 Data Type Description Char Block Identifier 3 Alpha Bank Application Identifier 3 1 Alpha numeric Char 9 Number 11 12 Alpha Numeric Number M Sequence Number Sender IFSC Date and Time Error code Message Identifier F26-User NAck Message Input/Output Identifier I-Input O-Output External Application Sequence Number IFSC of originating SFMS branch Date and Time 4 Number 10 M Filler 9 11 M Block End Identifier 1 Alpha Numeric Char Block Identifier Bank Application Identifier Message Identifier Input/Outp ut Identifier Will be empty for Unak message Filler for future Use Block End Identifier A sample user negative acknowledgement message is given below: {A:CBSF26O000001000SBIN0000001200703031325XXXXXXXXXXXXX} {A: CBS F26 I 000001000 SBIN0000001 200703031325 XXXX XXXXXXXXX } Block Identifier Bank Application Identifier User Nack Message Input/Output Identifier External Application Sequence Number IFSC code of Originating SFMS branch Date and time on which the message got user nacked Error Code will be empty for Unak message Filler for future use Block End Identifier TATA CONSULTANCY SERVICES Page 25 of 45 SFMS-CBS Interface Specification Document 3.8 BankAPI Response Message Given below are the fields in the BankAPI response message exchanged between SFMS to CBS. Index 1 Mandatory/ Optional M 2 M 3 M 4 M 5 M 6 M 7 M 8 M 10 M 11 M Field Name Block Identifier Bank Applicatio n Identifier Message Identifier Field Length 3 Data Type Char Description 3 Alpha Bank Application Identifier 3 Alpha numeric Input/Out put Identifier Sequence Number Sender IFSC Date and Time BankAPI Response Code Block End Identifier Block End Identifier 1 Char 9 Number 11 Alpha Numeric Number Message Identifier F27-Bank API Response Message Input/Output Identifier I-Input O-Output External Application Sequence Number IFSC of originating SFMS branch Date and Time 12 Block Identifier 11 Alpha Numeric BankAPI Response Code 2 Alpha Numeric Char Filler for future Use 1 Block End Identifier A Sample bankapi response message is given below {A: CBSF27I000001000SBIN0000002200703031325PBAPI000000XX} {A: CBS F27 I 000001000 SBIN0000002 200703031325 PBAPI000000 XX } Block Identifier Bank Application Identifier [Bank Application Identifier in case the response is for outgoing user message and service identifier in case the response is for incoming user message] Bank API Response Message Input/Output Identifier External Application Sequence Number IFSC code of Originating SFMS branch [Sender IFSC in case of an outgoing message and Receiver IFSC in case of incoming message] Date and time of the response message Bank API Response code Filler for future Use Block End Identifier TATA CONSULTANCY SERVICES Page 26 of 45 SFMS-CBS Interface Specification Document 4 MQ CONFIGURATIONS This chapter describes the various types of queue and channel configurations at SFMS and CBS. 4.1 Queue and Channel Configurations at SFMS This section describes the queue and channel configurations to be done at SFMS end. Create the following queues and channels under SFMS branch queue manager MQ Objects Local Queue Remote Queue Transmission Queue Sender Channel Receiver Channel Object Name SFMS.INCOMING CBS.INCOMING Queue Manager name of CBS SFMS.TO.CBS CBS.TO.SFMS Please refer to section 4.3 for more details on the procedure for creation of queues and channels 4.2 Queue and Channel Configurations at CBS This section describes the queue and channel configurations to be done at CBS end. MQ Objects Local Queue Remote Queue Transmission Queue Sender Channel Receiver Channel Object Name CBS.INCOMING SFMS.INCOMING Queue Manager name of SFMS Branch CBS.TO.SFMS SFMS.TO.CBS Please refer to section 4.3 for more details on the procedure for creation of queues and channels 4.3 Procedure for creation of Queues and Channels 4.3.1 Queues To create different Queues, follow the path using MQ Explorer. Console Root WebSphere MQ Queue Managers Queues 4.3.1.1 Local Queue To create Local Queue: 1. Right-Click on Queues New Local Queue. 2. Give the Queue name, description, default persistence as Persistent and usage as Normal. TATA CONSULTANCY SERVICES Page 27 of 45 SFMS-CBS Interface Specification Document 4.3.1.2 Transmission Queue To create Transmission Queue 1. Right-Click on Queues New Local Queue. 2. Give the Queue name (this will be the name of the CBS queue manager), description, default persistence as Persistent and usage as Transmission. 4.3.1.3 Remote Queue To create Remote Queue 1. Right-Click on Queues New Remote Queue Definition. 2. Give the Queue name, description, default persistence as Persistent, remote queue name, remote queue manager name, and transmission queue name. 4.3.2 Channels To create different Channels, follow the path using MQ Explorer. Console Root WebSphere MQ Queue Managers <queue manager name> Advanced Channels. 4.3.2.1 Sender Channel To create Sender Channel 1. Right-Click on Channels New Sender Channel. 2. Give the channel name, description, connection name (ex: ‘172.16.2.123(1414)’ IP Address of the CBS to which you are connecting.), and transmission queue name in General tab. 3. In Extended tab, disconnect interval is set to 0 and Batch size is set to 1. 4. Click OK button to create the Sender channel. 4.3.2.2 Receiver Channel To create Receiver Channel 1. Right-Click on Channels New Receiver Channel. 2. In General tab give the channel name, description. 3. In Extended tab Batch size is set to 1. 4. Click OK button to create the Receiver channel. Note: The Receiver channel name should be same as Sender Channel name at the Remote Queue Manager. TATA CONSULTANCY SERVICES Page 28 of 45 SFMS-CBS Interface Specification Document 5 REGULAR MONITORING ACTIVITIES This chapter describes the regular monitoring activities to be performed by the SFMS administrator. ‘Admin Interface’ is a Graphical User Interface (GUI) developed for facilitating the system administrators in monitoring various services essential to SFMS. Following are the steps to login to the ‘Admin Interface’: 1. Click on the ‘Admin SFMS’ shortcut icon on the desktop. A dialog box prompting for User Id and Password appears as shown in Figure 2. 2. Enter the User Id as SFMSBR and Password as SFMS. In order to ensure security and restrict unauthorized access to the system, the SFMS Admin login password can be changed by the designated system administrators once the SFMS is installed. Figure 2 : SFMS Admin Login The administrator gains access to the following essential services of SFMS once logged in: Tomcat Reports Scheduler Sender Receiver Sender SFT Receiver SFT File Upload File Download CBS Receiver These services should always be running to access SFMS. These services can be started by clicking the ‘Start’ button against the respective services under Start Up/Shut Down tab as shown in figure 3. Please refer SFMS Online Manual for the details of services that need to be running to access SFMS. TATA CONSULTANCY SERVICES Page 29 of 45 SFMS-CBS Interface Specification Document Figure 3: SFMS Administration Branch Admin interface contains different tabs as follows: StartUp/ShutDown To start and shutdown services. Monitor Displays the user status. Back up Procedures for taking backup of database and MQ logs Parameter Facilitates defining and altering file locations for File Upload and File Download at the branch. It also facilitates changing SFMS Admin password & database password. It should be noted that the Admin and database passwords are one and the same. It also facilitates changes in the key value of parameters such as change of archive period, session timeout etc., (This is also same as the database password). TATA CONSULTANCY SERVICES Page 30 of 45 SFMS-CBS Interface Specification Document 5.1 CBS Receiver Given below are the various approaches to start the CBS Receiver service: 1. Select StartUp/ShutDown tab in admin interface and click on ‘Start’ button against CBS Receiver. 2. The process can also be started by using the following command at command prompt. C:\>java sfmsbr.bankapi.ReceiverCBS This method is required when the above process started from the admin tool is terminated due to some error. TATA CONSULTANCY SERVICES Page 31 of 45 SFMS-CBS Interface Specification Document 5.2 Register CBS Given below are the steps to register the external application: 1. 2. 3. 4. 5. Select CBS tab in admin interface. Select Register CBS tab. Enter ‘External App’ and ‘Confirm Ext App’ fields. Click on Register Button to Register the External App The External App registers successfully Note: Once a new CBS is registered, the necessary queue configurations needs to be completed to establish the connectivity between SFMS and CBS. Please refer to MQ Configurations section for the steps to be followed. SFMS Administration window needs to be restarted once a new CBS is registered. Figure 4: SFMS Administration Branch TATA CONSULTANCY SERVICES Page 32 of 45 SFMS-CBS Interface Specification Document 5.3 Enable IFSC as CBS Given below are the steps to enable IFSC as CBS: 1. 2. 3. 4. 5. 6. Select CBS tab in admin interface Select Enable IFSC as CBS tab Select any CBS from the drop down control (For Single CBS it is not required) Select any SFMS IFSC from the list box on the left. Click on Enable as CBS button to Enable IFSC as CBS Now the SFMS IFSC will be enabled as CBS Figure 5: SFMS Administration Branch TATA CONSULTANCY SERVICES Page 33 of 45 SFMS-CBS Interface Specification Document 5.4 Delete IFSC from CBS Given below are the steps to delete IFSC from CBS: 1. 2. 3. 4. 5. 6. Select CBS tab in admin interface Select Delete IFSC from CBS tab Enter ‘IFSC’ and ‘Confirm IFSC’ fields Select any CBS from the drop down control (For Single CBS it is not required) Click on Delete Button to delete IFSC from CBS The IFSC will be deleted from CBS successfully Figure 6: SFMS Administration Branch TATA CONSULTANCY SERVICES Page 34 of 45 SFMS-CBS Interface Specification Document 6 CBS DIRECTORY This chapter describes the CBS directory provided in the SFMS for checking the details of IFSCs enabled under CBS. 6.1 CBS IFSC Directory Screen Description Login to SFMS and click the links Directory-> CBS IFSC Listing to view the CBS IFSC Directory screen. Using the CBS IFSC Directory screen you can perform a search and view CBS IFSC details. The screen appears as follows: Note: The CBS IFSC Directory screen can be accessed only at branch node Figure 7: CBS IFSC Directory The CBS IFSC Directory screen displays the following columns: Item IFSC Bank Branch City Address Ext App Search On Description Opens the IFSC Details screen, once IFSC is clicked Displays the bank name Displays the branch name Displays the city in which branch located Displays the address of the branch Displays the External Application name Allows criterion selection on which the search is based. The drop-down list TATA CONSULTANCY SERVICES Page 35 of 45 SFMS-CBS Interface Specification Document displays the following: IFSC Branch City Ext App Allows you to enter a value for the selected search criterion Click to proceed with the search Value 6.2 CBS IFSC Details Screen Click any entry in the IFSC column on the CBS IFSC Directory screen to open the CBS IFSC Details screen. The IFSC Details screen displays the following: Item IFSC Bank Name Branch Name Description Displays IFSC in all modes. This field cannot be modified Field, max 35 alphanumeric characters Field, max 35 alphanumeric characters City Field, max 15 alphanumeric characters Address Field, max 100 alphanumeric characters User ID User ID of the User who has authorised this IFSC’s Proliferation message. 6.3 CBS IFSC Listing Login to SFMS and Click the links Directory-> CBS IFSC listing to view the CBS IFSC Directory screen. Using the CBS IFSC Directory screen you can perform the following tasks: View CBS IFSC Details Search 6.3.1 View CBS IFSC Details On the CBS IFSC Directory screen, click an IFSC to open the CBS IFSC Details screen. 6.3.2 Search Given below are the steps to perform the search: 1. Select the search criteria on the CBS IFSC Directory screen. 2. Enter the search value. 3. Click . TATA CONSULTANCY SERVICES Page 36 of 45 SFMS-CBS Interface Specification Document 7 CBS MESSAGE LISTING This chapter describes message listing for the messages sent/received from CBS. This includes the message sent from CBS to SFMS and vice versa. The CBS Messages screen is as follows: Figure 8: SFMS CBS Messages Screen Login to SFMS and Click the links Message Routing -> CBS Messages menu to view the following: SFMS to CBS Messages CBS to SFMS Messages. Note: If the logged in IFSC is a CBS Admin, then the user will be able to view all the messages sent/received from all the IFSCs under CBS. Otherwise the view will display only messages related to the logged in CBS IFSC. TATA CONSULTANCY SERVICES Page 37 of 45 SFMS-CBS Interface Specification Document 7.1 SFMS to CBS Messages This section describes the listing of the messages sent from SFMS to CBS Figure 9: SFMS TO CBS Message Listing The above screen depicts the listing if the logged in IFSC is CBS Admin TATA CONSULTANCY SERVICES Page 38 of 45 SFMS-CBS Interface Specification Document Figure 10: SFMS TO CBS Message Listing The above screen shot depicts the listing if the logged in IFSC is a normal IFSC. Login to SFMS and Click the links Message Routing ->CBS Messages ->SFMS to CBS Messages to open the messages from SFMS to CBS screen. Given below are the tasks that can be performed in this screen: Perform Search View message Status The screen consists of the following fields and buttons: Item Search On Value Search TATA CONSULTANCY SERVICES Description Select a parameter to start a search based on the parameter in the drop-down list. Drop-down list or text box, depending upon the search on parameter selected. Lists the criteria available for the selected parameter. Select a criterion or enter the value Click to proceed with the search Page 39 of 45 SFMS-CBS Interface Specification Document The Search function is available on all messages from SFMS to CBS. Using this function, you can perform searches based on a parameter selected from the Search On list. The following table describes the list options available on the Search On list: Item Description Text field, max of nine digits. Enter the number. Ext Sequence Number SFMS Sequence Number Text field, max of nine digits. Enter number. Text field, max of 11 characters. Enter the Sender IFSC Sender IFSC Receiver IFSC Text field, max of 11 characters. Enter the Receiver IFSC (This field is visible only to CBS Admin IFSC) Ext App ID Text field, three characters. Received On Drop-down lists for the date (yyyymmdd) 7.2 CBS to SFMS Messages This section describes the listing of the messages sent from CBS to SFMS Figure 11: CBS TO SFMS Message Listing The above screen depicts the listing if the IFSC logged in as CBS Admin TATA CONSULTANCY SERVICES Page 40 of 45 SFMS-CBS Interface Specification Document Figure 12: CBS TO SFMS Message Listing The above screen shot depicts the listing if the logged in IFSC is a normal IFSC Click Message Routing -> CBS Messages ->CBS to SFMS Messages to open the messages from CBS to SFMS screen. Given below are the tasks that can be performed in this screen: Perform Search View message Status The screen consists of the following fields and buttons: Item Search On Value Search Description Drop-down list. Select a parameter to start a search based on the parameter Drop-down list or text box, depending upon the Search On parameter selected. Lists the criteria available for the selected parameter. Select a criterion or enter the value Click TATA CONSULTANCY SERVICES to proceed with the Search Page 41 of 45 SFMS-CBS Interface Specification Document The Search function is available on all Messages from CBS to SFMS. Using this function you can perform searches based on a parameter selected from the Search On list. The following table describes the list options available in the Search On list: Description Item Text field, max of nine digits. Enter the number. Ext Sequence Number SFMS Sequence Number Text Field, max of nine digits. Enter number. Text field, max of 11 characters. Enter the Sender IFSC Sender IFSC (This field is visible only to CBS Admin IFSC) Receiver IFSC Text field, max of 11 characters. Enter the Receiver IFSC Status at SFMS Ext App ID Created On Drop-down list. Select the Message Status Text field. Three characters. Drop-down lists for the date (yyyymmdd) TATA CONSULTANCY SERVICES Page 42 of 45 SFMS-CBS Interface Specification Document 8 CBS REPORT The CBS Report contains information of the CBS messages sent/received from your node during a specified period. The selection of IFSC is simplified by providing the text box and IFSC Button to select the IFSC’s as shown in the screen below. 1. Login to SFMS and Click the links Reports->Demand Reports. Figure 13: Demand Reports in SFMS 2. Specify the following: Item Report Type Ext App Id IFSC Period TATA CONSULTANCY SERVICES Description Drop-down list. Select CBS Report Drop-down list, Select Ext App Id The IFSC whose report has to be generated. If the IFSC is not selected, then the report will be generated for all the IFSCs Use the date list boxes to specify the start and end dates of the period for the report Page 43 of 45 SFMS-CBS Interface Specification Document 3. Click to generate a report. The report consists of the following information: Serial Number Ext Seq No SFMS Seq No In-Out Indicator Message Type Sender IFSC Receiver IFSC Message Status Received On Block 4 4. To print the report, in the Report pop-up window, click File->Print. (Or Press Ctrl+p) Figure 14: Sample CBS Report Note: If the logged in IFSC is a CBS Admin, then the user will be able to view all the messages sent/received from all the IFSCs under CBS. Otherwise the view will display only the messages related to the logged in CBS IFSC. TATA CONSULTANCY SERVICES Page 44 of 45 SFMS-CBS Interface Specification Document 9 SFMS HELPDESK SFMS Help Desk is managed by TCS / IDRBT at IDRBT, Hyderabad. The Gateway Administrators, Project Managers and other officials, who want to utilise the services of SFMS Help Desk, should follow the procedure given below: 9.1 Using e-mail The users may send mails to sfmshelp@idrbt.ac.in to report problems and seek guidance of SFMS Help Desk. The e-mail could also be used to follow up any call already logged in and/or if there is need to send an attachment to the Help Desk. In such a case, the ‘Request No’ of call must be quoted in the mail. 9.2 Using Telephone The users should try to avoid logging in the help desk calls on telephone unless this is absolutely necessary and urgent. In any case, the users should first send e-mail and then call on telephone in case of urgency. The telephone number allotted to SFMS Help Desk managed by TCS is 040-23535186 and IDRBT SFMS Group can be reached on 040-23534981-84 Ext: 5214/15 9.3 SFMS Groups in Banks Banks should arrange to form an SFMS Group, preferably at the Gateway location. The group may consist of the Gateway Administrator and other officials managing SFMS within the bank. These officials should register as members and all the calls should be routed through this group only, in order to maintain continuity. *** End of the document *** TATA CONSULTANCY SERVICES Page 45 of 45