sfms-cbs interface specification document

INSTITUTE FOR DEVELOPMENT AND RESEARCHIN BANKING TECHNOLOGY,

HYDERABAD

SFMS-CBS Interface Specification Document

VERSION 1.0

1 Software Units Layout, Madhapur, Hyderabad – 500 081

November 2006


This is a controlled document. Unauthorised access, copying, replication and usage for a purpose other than for which this is intended are prohibited.


DOCUMENT RELEASE NOTICE

Notice No. : 1.0

Client : IDRBT

Project : SFMS Document Details:

Name Version No. Description


1.0 This document provides the specifications and pre-requisites for integrating SFMS with CBS

Revision Details:

Action taken (add/delete/change)

PrecedingPage No.

NewPage No.

RevisionDescription

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 Date: 22-Nov-2006 ( )

TATA CONSULTANCY SERVICES Page iii of 46


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

RevisionDate

RevisionDescription

PageNo

PrevPage No

Action Taken Addenda/New Page

ReleaseNotice Reference

TATA CONSULTANCY SERVICES Page iv of 46


ABOUT THIS DOCUMENT PurposeThis document explains step-by-step procedures to use the SFMS-CBS Interface.

ScopeThis 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 AudienceThis 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. IntroductionThis chapter contains an overview of SFMS, CBS and current Bank API.

2. ApproachThis 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 ConfigurationsThis chapter explains the MQ configuration details for the SFMS-CBS Interface

5. Regular Monitoring ActivitiesThis chapter details the Regular Monitoring Activities of the SFMS-CBS Interface.

6. CBS DirectoryThis chapter gives a brief introduction of the CBS IFSC Directory usage.

7. CBS Message ListingThis chapter gives a brief introduction of the CBS Message Listing.

8. CBS ReportThis chapter gives a brief introduction of the CBS Report usage.

9. SFMS HelpdeskThis chapter gives details of the SFMS Helpdesk

Mode of DistributionThis document and related documents will be placed on the INFINET website.

TATA CONSULTANCY SERVICES Page v of 46


Abbreviations and Acronyms Used

Term DescriptionANDB Andhra Bank API Application Programming InterfaceCA Certifying AuthorityCBS Core Banking SystemCNRB Canara BankCRL Certificate Revocation List HTTPS Secure Hypertext Transfer ProtocolIDRBT Institute for Development and Research in Banking

TechnologyIFSC Indian Financial System CodeINFINET Indian FINancial NETworkLDAP Lightweight Directory Access ProtocolMQ Message QueryMUR Message User ReferenceNEFT National Electronic Funds TransferPKI Public Key InfrastructurePI Participant InterfaceRA Registration AuthorityRMI Remote Method InvocationRTGS Real Time Gross SettlementSFMS Structured Financial Messaging System. SMAC Server Message Authentication CodeSTP Straight Through ProcessingTCS Tata Consultancy ServicesUMAC User Message Authentication CodeUTR Unique Transaction Reference

TATA CONSULTANCY SERVICES Page vi of 46


CONTENTS

1 Introduction.........................................................................................................81.1 SFMS Overview....................................................................................................81.2 CBS Overview......................................................................................................81.3 Current Bank API Overview..................................................................................82 Approach..........................................................................................92.1 Approach.............................................................................................................92.2 Mandatory Requirements..................................................................................122.3 Message Flow....................................................................................................132.4 Security.............................................................................................................143 Message Structures.........................................................................153.1 User Message....................................................................................................153.2 Acknowledgement Message..............................................................................203.3 Non-Delivery Warning Message.........................................................................213.4 Delivery Notification Message...........................................................................223.5 Open Notification Message................................................................................233.6 Negative Acknowledgement Message...............................................................243.7 User Negative Acknowledgement Message.......................................................253.8 BankAPI Response Message..............................................................................264 MQ Configurations...........................................................................274.1 Queue and Channel Configurations at SFMS......................................................274.2 Queue and Channel Configurations at CBS........................................................274.3 Procedure for creation of Queues and Channels................................................27

4.3.1 Queues....................................................................................................274.3.2 Channels.................................................................................................28

5 Regular Monitoring Activities...........................................................295.1 CBS Receiver.....................................................................................................315.2 Register CBS......................................................................................................325.3 Enable IFSC as CBS............................................................................................335.4 Delete IFSC from CBS........................................................................................346 CBS Directory..................................................................................356.1 CBS IFSC Directory Screen Description..............................................................356.2 CBS IFSC Details Screen....................................................................................366.3 CBS IFSC Listing................................................................................................36

6.3.1 View CBS IFSC Details.............................................................................366.3.2 Search.....................................................................................................36

7 CBS Message Listing........................................................................377.1 SFMS to CBS Messages......................................................................................387.2 CBS to SFMS Messages......................................................................................408 CBS Report.....................................................................................439 SFMS HelpDesk...............................................................................459.1 Using e-mail......................................................................................................459.2 Using Telephone................................................................................................459.3 SFMS Groups in Banks.......................................................................................45

TATA CONSULTANCY SERVICES Page vii of 46


1 INTRODUCTION1.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 of 46


2 APPROACH2.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.



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)



Figure 1: Diagrammatic Approach of the SFMS-CBS Interface Message Integration


CNRB BankCore banking Interface

SFMSCNRB Online Server

MQ Connection

CNRB Gateway

SFMS ANDB Online/Offline Server SFMS

CNRB Offline Server

ANDB Gateway

RTGS PI MQ

Connection

CNRBCore Banking 1

CNRB CBS Branch

CNRB CBS Branch

CNRB BankCore banking Interface

MQ Connection

CNRBCore Banking 2

CNRB CBS Branch

CNRB CBS Branch

All figures with this color are MQ Connections


2.2 Mandatory RequirementsGiven 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.

2.3 Message FlowThe 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.

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 server-to-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


3 MESSAGE STRUCTURES

3.1 User Message

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 Mandatory/Optional

Field Name

Field Length

Data Type

Description

1. M Block A Begin Identifier

3 Char Block A Begin Identifier should be {A:

2. M Sender Bank application identifier

3 Alpha Uniquely identifies the Bank application.This is the identifier with which bank application is registered at the branch server.

3. M Message Identifier

3 AlphaNumeric

Application IdentifierF01- User to User

4. M Input/ Output Identifier

1 Char I/O Identifier O-Output I-Input

5. M Message Type

3 AlphaNumeric

INFINET message type

6. M Sub Message Type

3 AlphaNumeric

INFINET Sub message type. If Sub Message Type is blank, then fill with XXX.

7. M Sender IFSC 11 AlphaNumeric

IFSC code of the Sender (IFSC code to which the bank application is registered.)

8. M Receiver IFSC

11 AlphaNumeric

IFSC code of the receiver

9. M Delivery Notification Flag

1 Number Users to specify whether delivery notification is required for the message. 1 – YES2 – NO

10. M Open Notification Flag

1 Number Users to specify whether open notification is required for the message.1 – YES2 – NO

11. M Non-delivery warning flag

1 Number Flag to inform the user whether the non-delivery warning message is required or not. The possible values are: 1 – Yes 2 – No



The default value for non-delivery warning flag is ‘2’.

12. M Obsolescence Period

3 Number Users to specify the period after which a non-delivery warning is to be sent to the sender, applicable only if non-delivery 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.

For example, Obsolescence period of 003 units is equivalent to 15 minutes.

13. M MUR (Message User Reference)

16 AlphaNumeric

Bank Application uses this field for identifying the message. If it is less than 16 then concatenate with X.

14. M Possible Duplicate Emission Flag

1 Number Flag to indicate possible duplicate emission 1 – YES2 – NO

15. M Service Identifier

3 Alpha Destination Bank Application identifier. If not applicable, it should be defaulted to XXX.

16. M Originating date

8 Number Date on which the message was created at Bank application – (YYYYMMDD)

17. M Originating time

4 Number Time on which the message was created at Bank application –(HHMM)

18. M Testing and Training flag

1 Number Flag to indicate test and training message. 1 – YES2 – NO



19. M Sequence Number

9 Number 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’

20. M Filler 9 Alpha Numeric

Filler for future use and default value is XXXXXXXXX.

21. M UTR (Unique Transaction Reference)

16 Alpha Numeric

Unique Transaction ReferenceGenerated for RTGS. Host applications should default it to XXXXXXXXXXXXXXXX

22. M Priority Flag 2 Number Priority flag is used for routing the messages in RTGS messages. For Host applications the default value is 99

23. M BlockA End Identifier

1 Char BlockA End identifier should be }

24. M Block4 Begin Identifier

3 Alpha Numeric

Block4 begin identifier should be{4:

25. M Block4 Alpha Numeric

Text block of the message.Length of the message cannot exceed 10 KB.

26. M Block4 End Identifier

2 Char Block4 End identifier should be -}

27. O Block5A Begin Identifier

6 Char If the bank application cangenerate the UMAC then thisshould be {UMAC:If the bank application doesnot have the capability toprepare the signature, this field can be left blank.

28. O Block 5A Alpha Numeric

Authoriser Signature. This is an optional field, which can befilled by Bank applications with signature prepared in PKCS7 standard on Block4Information.If the bank application doesnot have the capability toprepare 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.

29. O Block5A End Identifier

1 Char If the bank application cangenerate the UMAC then thisshould be }If the bank application doesnot have the capability toprepare the signature, this field can be left blank.



Example for the incoming message structure to the SFMS branch server from the bank application is shown below:{A:CBSF01O100XXXSBIN0001001SBIN0001002112005abcdefgh123456782XXX2003090910202000012345XXXXXXXXXXXXXXXXXXXXXXXXXX99}{4:: 20:TT/320:32A:20030909INR100,-}{UMAC:<Signature>}

{A: Block A begin Identifier CBS Bank Application Identifier F01 Message IdentifierO Input/output Identifier (either I or O) 100 Message type XXX Sub Message type (For IFN 298C01, this

field should be C01, for IFN100 Message, this field should be XXX).

SBIN0001001 Sender IFSC Code SBIN0001002 End receiver IFSC Code 1 Delivery notification flag1 Open Notification flag2 Non-delivery Warning flag005 Obsolescence Periodabcdefgh12345678 Message User Reference (MUR)2 Possible Duplicate flag XXX Service Identifier 20030909 Originating date 1020 Originating time 2 Testing and training flag 000012345 Sequence NumberXXXXXXXXXX FillerXXXXXXXXXXXXXXXX Unique Transaction Reference.99 Priority Flag}

Block A end Identifier{4: Block 4 Begin Identifier : 20:TT/320 Block 4 text message format:32A:20030909INR100, -} Block 4 End Identifier

{UMAC: Block 5A Begin Identifier<Signature> User Signature for Authorisation} Block 5A End Identifier



3.2 Acknowledgement MessageGiven below are the fields in the acknowledgement message sent by SFMS to CBS


Field Name Field Length

Data Type

Description

1 M Block Identifier

3 Char Block Identifier

2 M Bank Application Identifier

3 Alpha Bank Application Identifier

3 M Message Identifier

3 AlphaNumeric

Message IdentifierF20 – Acknowledgement Message

4 M Input/OutputIdentifier

1 Char Input/Output IdentifierI – Input O – Output

5 M Sequence number

9 Number External Application Sequence Number for which this acknowledgement is intended.

6 M Sender IFSC 11 AlphaNumeric

IFSC code of Originating SFMS branch.

7 M Date and Time

12 Number Date and Time on which message is acknowledged

8 M Block End Identifier

1 Char Block End Identifier

A sample acknowledgement message is given below:

{A:CBSF20O000001000SBIN0001001200703031325}

{A: Block Identifier CBS Bank Application IdentifierF20 Acknowledgment message O Input/Output Identifier 000001000 External Application Sequence NumberSBIN0001001 Originating IFSC 200703031325 Date and time on which the sender SFMS Gateway

acknowledges message} Block End Identifier



3.3 Non-Delivery Warning MessageGiven below are the fields in the non-delivery warning message sent by SFMS to CBS.


Field Name

Field Length

Data Type

Description



2 M Bank application Identifier

3 Char Bank Application Identifier


3 Alpha Numeric

Message IdentifierF22 - Non-delivery Warning message


1 Char Input/Output IdentifierI – InputO - Output

5 M Sequence number

9 Number External Application Sequence Number.

7 M Sender IFSC 11 Alpha Numeric


8 M Date and Time

12 Numeric Date and Time at which non-delivery warning message is generated.



A sample non-delivery warning message is given below:

{A:CBSF22O000001000SBIN0001001200701012227}

{A: Block Identifier CBS Bank Application IdentifierF22 Non-delivery Warning Message O Input/Output Identifier 000001000 Creation sequence number of the message SBIN0001001 Originating IFSC 200701012227 Date and time on which non-delivery warning message is

generated.} Block End Identifier



3.4 Delivery Notification MessageGiven below are the fields in the delivery notification message sent by SFMS to CBS.


Field Name

Field Length

Data Type

Description






3 Alpha Numeric

Message IdentifierF23 - Delivery Notification message


1 Char Input/Output IdentifierI – InputO – Output

5 M Sequence number

9 Number External Application sequence number

6 M Sender IFSC

11 AlphaNumeric


7 M Date and Time

12 Number Date and time on which the message is delivered.



A sample delivery notification message is given below:

{A:CBSF23O000001000SBIN0001001200701012227}

{A: Block Identifier CBS Bank Application IdentifierF23 Delivery Notification Message O Input/Output Identifier 000001000 Creation sequence number of the

message SBIN0001001 IFSC code of the originating SFMS branch.200701012227 Date and time on which the message is

delivered. } Block End Identifier



3.5 Open Notification MessageGiven below are the fields in the open notification message sent by SFMS to CBS.


Field Name

Field Length

Data Type

Description




3 Alpha Numeric

Bank Application Identifier


3 Alpha Numeric

Message IdentifierF24 - Open Notification message


1 Char Input/Output IdentifierI – InputO – Output

5 M Sequence number

9 Number External Application sequence number

6 M Sender IFSC 11 AlphaNumeric


7 M Date and Time

12 Number Date and time on which the message is opened at destination.



A sample open notification message is given below:

{A:CBSF24O000001000SBIN0001001200701081730}

{A: Block Identifier CBS Bank Application IdentifierF24 Open Notification Message O Input/Output Identifier 000001000 Creation sequence number of the message SBIN0001001 IFSC code of Originating SFMS branch.200701081730 Date and time on which message is opened.} Block End Identifier



3.6 Negative Acknowledgement MessageGiven below are the fields in the negative acknowledgement message sent by SFMS to CBS.


Field Name

Field Length

Data Type

Description






3 Alpha numeric

Message IdentifierF25-Negative Acknowledgement

4 M Input/Output Identifier

1 Char Input/Output IdentifierI-InputO - Output

5 M Sequence Number

9 Number External Application Sequence Number

6 M Sender IFSC

11 Alpha Numeric

IFSC of originating SFMS branch

7 M Date and Time

12 Number Date and Time

M Error code 4 Number Reason code for NACk9 M Filler 9 Alpha

NumericFiller for future Use



A sample negative acknowledgement message is given below:

{A:CBSF25O000001000SBIN00000012007030313252105XXXXXXXXX}

{A: Block IdentifierCBS Bank Application IdentifierF25 Negative Acknowledgment messageI Input/Output Identifier000001000 External Application Sequence NumberSBIN0000001 Originating IFSC200703031325 Date and time on which the sender SFMS gateway negatively

acknowledged the message2105 Error occurred while creating PKCS#7 structure XXXXXXXXX Filler for future use} Block End Identifier



3.7 User Negative Acknowledgement MessageGiven below are the fields in the user negative acknowledgement message sent by SFMS to CBS.


Field Name

Field Length

Data Type

Description






3 Alpha numeric

Message IdentifierF26-User NAck Message


1 Char Input/Output IdentifierI-InputO-Output

5 M Sequence Number


6 M Sender IFSC 11 Alpha Numeric


7 M Date and Time


8 M Error code 4 Number Will be empty for Unak message

10 M Filler 9 Alpha Numeric

Filler for future Use



A sample user negative acknowledgement message is given below:

{A:CBSF26O000001000SBIN0000001200703031325XXXXXXXXXXXXX}

{A: Block IdentifierCBS Bank Application IdentifierF26 User Nack MessageI Input/Output Identifier000001000 External Application Sequence NumberSBIN0000001 IFSC code of Originating SFMS branch200703031325 Date and time on which the message got user nackedXXXX Error Code will be empty for Unak messageXXXXXXXXX Filler for future use} Block End Identifier



3.8 BankAPI Response MessageGiven below are the fields in the BankAPI response message exchanged between SFMS to CBS.


Field Name

Field Length

Data Type

Description






3 Alpha numeric

Message IdentifierF27-Bank API Response Message


1 Char Input/Output IdentifierI-InputO-Output

5 M Sequence Number


6 M Sender IFSC

11 Alpha Numeric


7 M Date and Time


8 M BankAPI Response Code

11 Alpha Numeric

BankAPI Response Code


2 Alpha Numeric

Filler for future Use



A Sample bankapi response message is given below

{A: CBSF27I000001000SBIN0000002200703031325PBAPI000000XX}

{A: Block IdentifierCBS 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]

F27 Bank API Response MessageI Input/Output Identifier000001000 External Application Sequence NumberSBIN0000002 IFSC code of Originating SFMS branch [Sender IFSC in case of an

outgoing message and Receiver IFSC in case of incoming message]

200703031325 Date and time of the response messagePBAPI000000 Bank API Response codeXX Filler for future Use} Block End Identifier



4 MQ CONFIGURATIONSThis chapter describes the various types of queue and channel configurations at SFMS and CBS.

4.1 Queue and Channel Configurations at SFMSThis 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 Object NameLocal Queue SFMS.INCOMINGRemote Queue CBS.INCOMINGTransmission Queue Queue Manager name of

CBSSender Channel SFMS.TO.CBSReceiver Channel CBS.TO.SFMS

The Remote Queue for SFMS is CBS.INCOMING, provided the Application ID is CBS.

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 CBSThis section describes the queue and channel configurations to be done at CBS end.

MQ Objects Object NameLocal Queue CBS.INCOMINGRemote Queue SFMS.INCOMINGTransmission Queue Queue Manager name of

SFMS BranchSender Channel CBS.TO.SFMSReceiver Channel SFMS.TO.CBS

The Local Queue for CBS is CBS.INCOMING, provided the Application ID is 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.

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.



5 REGULAR MONITORING ACTIVITIESThis 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.



Figure 3: SFMS Administration Branch

Admin interface contains different tabs as follows:

StartUp/ShutDownTo start and shutdown services.

MonitorDisplays the user status.

Back upProcedures for taking backup of database and MQ logs

ParameterFacilitates 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).



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.



5.2 Register CBSGiven below are the steps to register the external application:

1. Select CBS tab in admin interface.2. Select Register CBS tab.3. Enter ‘External App’ and ‘Confirm Ext App’ fields.4. Click on Register Button to Register the External App5. 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.




5.3 Enable IFSC as CBSGiven below are the steps to enable IFSC as CBS:

1. Select CBS tab in admin interface 2. Select Enable IFSC as CBS tab 3. Select any CBS from the drop down control (For Single CBS it is not required)4. Select any SFMS IFSC from the list box on the left.5. Click on Enable as CBS button to Enable IFSC as CBS6. Now the SFMS IFSC will be enabled as CBS




5.4 Delete IFSC from CBSGiven below are the steps to delete IFSC from CBS:

1. Select CBS tab in admin interface 2. Select Delete IFSC from CBS tab 3. Enter ‘IFSC’ and ‘Confirm IFSC’ fields4. Select any CBS from the drop down control (For Single CBS it is not required)5. Click on Delete Button to delete IFSC from CBS6. The IFSC will be deleted from CBS successfully




6 CBS DIRECTORYThis chapter describes the CBS directory provided in the SFMS for checking the details of IFSCs enabled under CBS.

6.1 CBS IFSC Directory Screen DescriptionLogin 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 DescriptionIFSC Opens the IFSC Details screen, once IFSC is clickedBank Displays the bank nameBranch Displays the branch nameCity Displays the city in which branch locatedAddress Displays the address of the branchExt App Displays the External Application nameSearch On Allows criterion selection on which the search is based. The drop-down list

displays the following:



IFSC Branch City Ext App

Value Allows you to enter a value for the selected search criterionClick to proceed with the search

6.2 CBS IFSC Details ScreenClick 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 DescriptionIFSC Displays IFSC in all modes. This field cannot be modifiedBank Name Field, max 35 alphanumeric charactersBranch Name Field, max 35 alphanumeric charactersCity Field, max 15 alphanumeric charactersAddress Field, max 100 alphanumeric charactersUser 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 DetailsOn the CBS IFSC Directory screen, click an IFSC to open the CBS IFSC Details screen.

6.3.2 SearchGiven 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 .



7 CBS MESSAGE LISTINGThis 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.



7.1 SFMS to CBS MessagesThis 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



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 DescriptionSearch On Select a parameter to start a search based on the

parameter in the drop-down list.Value 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

Search Click to proceed with the search



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 DescriptionExt Sequence Number Text field, max of nine digits. Enter the number.SFMS Sequence Number Text field, max of nine digits. Enter number.Sender IFSC Text field, max of 11 characters. Enter the 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 MessagesThis 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



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 DescriptionSearch On Drop-down list. Select a parameter to start a search based on the

parameterValue 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

Search Click to proceed with the Search

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:

Item DescriptionExt Sequence Number Text field, max of nine digits. Enter the number.SFMS Sequence Number Text Field, max of nine digits. Enter number.Sender IFSC Text field, max of 11 characters. Enter the 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 Drop-down list. Select the Message StatusExt App ID Text field. Three characters.Created On Drop-down lists for the date (yyyymmdd)



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 DescriptionReport Type Drop-down list. Select CBS ReportExt App Id Drop-down list, Select Ext App IdIFSC The IFSC whose report has to be

generated. If the IFSC is not selected, then the report will be generated for all the IFSCs

Period Use the date list boxes to specify the start and end dates of the period for the report



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.



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-mailThe users may send mails to [email protected] 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 TelephoneThe 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 BanksBanks 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 ***


mailto:[email protected]

sfms-cbs interface specification document

Documents