Gateway FCUBSMessagingService

23
Gateway Documentation - Contract Messaging Service Oracle FLEXCUBE Universal Banking Release FCUBS_12.0.3.0.0 [April] [2014]

description

Gateway FCUBSMessagingService

Transcript of Gateway FCUBSMessagingService

  • Gateway Documentation - Contract Messaging ServiceOracle FLEXCUBE Universal Banking

    Release FCUBS_12.0.3.0.0[April][2014]

  • 1. BACKGROUND ................................................... 12. FCUBSMessagingService ................................................... 2 2.1.GetContractMsgs ................................................... 2 2.1.1. MS-GetContractMsgs-Req-IO-MSG.xsd ............................................................ 2 2.1.2. MS-GetContractMsgs-Res-Full-MSG.xsd ............................................................ 8

    Table Of Contents_______________________

  • 1.BACKGROUND

    Integration of different applications and solutions is a key area in todays systems. A variety of specialized applicationsdeployed on disparate platforms and using different infrastructure need to be able to communicate and integrateseamlessly with FLEXCUBE UBS in order to exchange data.The FLEXCUBE UBS Integration Gateway (referred to asGateway) will cater to these integration needs.The integration needs supported by the Gateway can be broadly categorized from the perspective of the Gateway asfollows:

    1. Inbound application integration used when any external system needs to add, modify or query informationwithin FLEXCUBE UBS 2. Outbound application integration used when any external system needs to be notified of the various events thatoccur within FLEXCUBE UBSThe following sections provide detailed XSD documentation of all operations available in FCUBSMessagingService ofCore-Module

    1

  • 2.FCUBSMessagingServiceContract Messaging ServiceContract Messaging Service

    2.1.GetContractMsgsGet Contract Messages

    2.1.1.MS-GetContractMsgs-Req-IO-MSG.xsd

    FCUBS_HEADER SOURCE UBSCOMP MSGID CORRELID USERID BRANCH MODULEID SERVICE OPERATION SOURCE_OPERATION SOURCE_USERID DESTINATION MULTITRIPID FUNCTIONID ACTION MSGSTAT PASSWORD ADDL PARAM NAME VALUE FCUBS_BODY ContractMessages-IO FCCREFFCUBS_HEADER

    TOP

    SOURCE

    Attribute DescriptionName FCUBS_HEADERDatatypeDescription

    Attribute DescriptionName SOURCEDatatype StringDescription

    2

  • TOP

    UBSCOMP

    TOP

    MSGID

    TOP

    CORRELID

    TOP

    USERID

    TOP

    BRANCH

    Restrictions Restrictions Descriptionpattern [a-zA-Z_0-9]*

    Attribute DescriptionName UBSCOMPDatatype StringDescriptionRestrictions Restrictions Description

    enumeration FCUBS,FCIS

    Attribute DescriptionName MSGIDDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    pattern [a-zA-Z_0-9]*

    Attribute DescriptionName CORRELIDDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    pattern [a-zA-Z_0-9]*

    Attribute DescriptionName USERIDDatatype StringDescriptionRestrictions Restrictions Description

    maxLength 12pattern [A-Z_0-9]*

    Attribute Description

    3

  • TOP

    MODULEID

    TOP

    SERVICE

    TOP

    OPERATION

    TOP

    SOURCE_OPERATION

    Name BRANCHDatatype StringDescriptionRestrictions Restrictions Description

    length 3pattern [a-zA-Z_0-9]{3}

    Attribute DescriptionName MODULEIDDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0

    Attribute DescriptionName SERVICEDatatype StringDescriptionAttributes Attribute Description

    nillable trueRestrictions Restrictions Description

    pattern [a-zA-Z_0-9]*

    Attribute DescriptionName OPERATIONDatatype StringDescriptionAttributes Attribute Description

    nillable trueRestrictions Restrictions Description

    pattern [a-zA-Z_0-9]*

    Attribute DescriptionName SOURCE_OPERATIONDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    pattern [a-zA-Z_0-9]*

    4

  • TOP

    SOURCE_USERID

    TOP

    DESTINATION

    TOP

    MULTITRIPID

    TOP

    FUNCTIONID

    TOP

    ACTION

    Attribute DescriptionName SOURCE_USERIDDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0

    Attribute DescriptionName DESTINATIONDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    pattern [a-zA-Z_0-9]*

    Attribute DescriptionName MULTITRIPIDDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    pattern [a-zA-Z_0-9]*

    Attribute DescriptionName FUNCTIONIDDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    maxLength 8pattern [A-Z_0-9]*

    Attribute Description

    5

  • TOP

    MSGSTAT

    TOP

    PASSWORD

    TOP

    ADDL

    TOP

    PARAM

    Name ACTIONDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    pattern [a-zA-Z_0-9]*

    Attribute DescriptionName MSGSTATDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    enumeration SUCCESS,WARNING,FAILURE

    Attribute DescriptionName PASSWORDDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    maxLength 128pattern [a-zA-Z_0-9=+/]*

    Attribute DescriptionName ADDLDatatypeDescriptionAttributes Attribute Description

    minOccurs 0

    Attribute DescriptionName PARAMDatatypeDescription

    6

  • TOP

    NAME

    TOP

    VALUE

    TOP

    FCUBS_BODY

    TOP

    ContractMessages-IO

    TOP

    FCCREF

    TOP

    Attributes Attribute DescriptionmaxOccurs unboundedminOccurs 0

    Attribute DescriptionName NAMEDatatype StringDescription

    Attribute DescriptionName VALUEDatatype StringDescription

    Attribute DescriptionName FCUBS_BODYDatatypeDescription This XSD Gives Information about IORequest

    Attribute DescriptionName ContractMessages-IODatatypeDescription Contract Message IO Type

    Attribute DescriptionName FCCREFDatatype StringDescription Indicates Flex Cube Contract Reference NumberAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    maxLength 16

    7

  • 2.1.2.MS-GetContractMsgs-Res-Full-MSG.xsd

    FCUBS_HEADER SOURCE UBSCOMP MSGID CORRELID USERID BRANCH MODULEID SERVICE OPERATION SOURCE_OPERATION SOURCE_USERID DESTINATION MULTITRIPID FUNCTIONID ACTION MSGSTAT PASSWORD ADDL PARAM NAME VALUE FCUBS_BODY CHOICE ContractMessages-PK FCCREF ContractMessages-IO FCCREF MessageDetails ESN MSGTYPE RECEIVER MSGSTATUS MESSAGE ContractMessages-Full FCCREF MessageDetails ESN MSGTYPE RECEIVER MSGSTATUS MESSAGE

    8

  • FCUBS_ERROR_RESP ERROR ECODE EDESC FCUBS_WARNING_RESP WARNING WCODE WDESCFCUBS_HEADER

    TOP

    SOURCE

    TOP

    UBSCOMP

    TOP

    MSGID

    TOP

    CORRELID

    Attribute DescriptionName FCUBS_HEADERDatatypeDescription

    Attribute DescriptionName SOURCEDatatype StringDescriptionRestrictions Restrictions Description

    pattern [a-zA-Z_0-9]*

    Attribute DescriptionName UBSCOMPDatatype StringDescriptionRestrictions Restrictions Description

    enumeration FCUBS,FCIS

    Attribute DescriptionName MSGIDDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    pattern [a-zA-Z_0-9]*

    9

  • TOP

    USERID

    TOP

    BRANCH

    TOP

    MODULEID

    TOP

    SERVICE

    Attribute DescriptionName CORRELIDDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    pattern [a-zA-Z_0-9]*

    Attribute DescriptionName USERIDDatatype StringDescriptionRestrictions Restrictions Description

    maxLength 12pattern [A-Z_0-9]*

    Attribute DescriptionName BRANCHDatatype StringDescriptionRestrictions Restrictions Description

    length 3pattern [a-zA-Z_0-9]{3}

    Attribute DescriptionName MODULEIDDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0

    Attribute DescriptionName SERVICEDatatype StringDescriptionAttributes Attribute Description

    nillable true

    10

  • TOP

    OPERATION

    TOP

    SOURCE_OPERATION

    TOP

    SOURCE_USERID

    TOP

    DESTINATION

    TOP

    MULTITRIPID

    Restrictions Restrictions Descriptionpattern [a-zA-Z_0-9]*

    Attribute DescriptionName OPERATIONDatatype StringDescriptionAttributes Attribute Description

    nillable trueRestrictions Restrictions Description

    pattern [a-zA-Z_0-9]*

    Attribute DescriptionName SOURCE_OPERATIONDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    pattern [a-zA-Z_0-9]*

    Attribute DescriptionName SOURCE_USERIDDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0

    Attribute DescriptionName DESTINATIONDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    pattern [a-zA-Z_0-9]*

    11

  • TOP

    FUNCTIONID

    TOP

    ACTION

    TOP

    MSGSTAT

    TOP

    PASSWORD

    Attribute DescriptionName MULTITRIPIDDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    pattern [a-zA-Z_0-9]*

    Attribute DescriptionName FUNCTIONIDDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    maxLength 8pattern [A-Z_0-9]*

    Attribute DescriptionName ACTIONDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    pattern [a-zA-Z_0-9]*

    Attribute DescriptionName MSGSTATDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    enumeration SUCCESS,WARNING,FAILURE

    Attribute Description

    12

  • TOP

    ADDL

    TOP

    PARAM

    TOP

    NAME

    TOP

    VALUE

    TOP

    FCUBS_BODY

    Name PASSWORDDatatype StringDescriptionAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    maxLength 128pattern [a-zA-Z_0-9=+/]*

    Attribute DescriptionName ADDLDatatypeDescriptionAttributes Attribute Description

    minOccurs 0

    Attribute DescriptionName PARAMDatatypeDescriptionAttributes Attribute Description

    maxOccurs unboundedminOccurs 0

    Attribute DescriptionName NAMEDatatype StringDescription

    Attribute DescriptionName VALUEDatatype StringDescription

    Attribute DescriptionName FCUBS_BODYDatatypeDescription This XSD Gives Information about FullResponse

    13

  • TOP

    CHOICE

    TOP

    ContractMessages-PK

    TOP

    FCCREF

    TOP

    ContractMessages-IO

    TOP

    FCCREF

    TOP

    MessageDetails

    Attribute DescriptionName CHOICEDatatypeDescription

    Attribute DescriptionName ContractMessages-PKDatatypeDescription Contract Message PK Type

    Attribute DescriptionName FCCREFDatatype StringDescription Indicates Flex Cube Contract Reference NumberAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    maxLength 16

    Attribute DescriptionName ContractMessages-IODatatypeDescription Contract Message IO Type

    Attribute DescriptionName FCCREFDatatype StringDescription Indicates Flex Cube Contract Reference NumberAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    maxLength 16

    Attribute Description

    14

  • TOP

    ESN

    TOP

    MSGTYPE

    TOP

    RECEIVER

    TOP

    MSGSTATUS

    Name MessageDetailsDatatypeDescription Message DetailsAttributes Attribute Description

    maxOccurs unboundedminOccurs 0

    Attribute DescriptionName ESNDatatype NumberDescription Indicates Event Sequence NumberAttributes Attribute Description

    minOccurs 0

    Attribute DescriptionName MSGTYPEDatatype StringDescription Indicates Message TypeAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    maxLength 15

    Attribute DescriptionName RECEIVERDatatype StringDescription Indicates ReceiverAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    maxLength 11

    Attribute DescriptionName MSGSTATUSDatatype StringDescription Indicates Message StatusAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    maxLength 1

    15

  • TOP

    MESSAGE

    TOP

    ContractMessages-Full

    TOP

    FCCREF

    TOP

    MessageDetails

    TOP

    ESN

    Attribute DescriptionName MESSAGEDatatype StringDescription Indicates MessageAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    maxLength 0

    Attribute DescriptionName ContractMessages-FullDatatypeDescription Contract Message Full Type

    Attribute DescriptionName FCCREFDatatype StringDescription Indicates Flex Cube Contract Reference NumberAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    maxLength 16

    Attribute DescriptionName MessageDetailsDatatypeDescription Message DetailsAttributes Attribute Description

    maxOccurs unboundedminOccurs 0

    Attribute DescriptionName ESNDatatype NumberDescription Indicates Event Sequence Number

    16

  • TOP

    MSGTYPE

    TOP

    RECEIVER

    TOP

    MSGSTATUS

    TOP

    MESSAGE

    Attributes Attribute DescriptionminOccurs 0

    Attribute DescriptionName MSGTYPEDatatype StringDescription Indicates Message TypeAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    maxLength 15

    Attribute DescriptionName RECEIVERDatatype StringDescription Indicates ReceiverAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    maxLength 11

    Attribute DescriptionName MSGSTATUSDatatype StringDescription Indicates Message StatusAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    maxLength 1

    Attribute DescriptionName MESSAGEDatatype StringDescription Indicates MessageAttributes Attribute Description

    minOccurs 0Restrictions Restrictions Description

    maxLength 0

    17

  • TOP

    FCUBS_ERROR_RESP

    TOP

    ERROR

    TOP

    ECODE

    TOP

    EDESC

    TOP

    FCUBS_WARNING_RESP

    TOP

    WARNING

    Attribute DescriptionName FCUBS_ERROR_RESPDatatypeDescription Error Response DetailsAttributes Attribute Description

    maxOccurs unboundedminOccurs 0

    Attribute DescriptionName ERRORDatatypeDescriptionAttributes Attribute Description

    maxOccurs unbounded

    Attribute DescriptionName ECODEDatatype StringDescription

    Attribute DescriptionName EDESCDatatype StringDescription

    Attribute DescriptionName FCUBS_WARNING_RESPDatatypeDescription Warning Response DetailsAttributes Attribute Description

    maxOccurs unboundedminOccurs 0

    Attribute Description

    18

  • TOP

    WCODE

    TOP

    WDESC

    TOP

    Name WARNINGDatatypeDescriptionAttributes Attribute Description

    maxOccurs unbounded

    Attribute DescriptionName WCODEDatatype StringDescription

    Attribute DescriptionName WDESCDatatype StringDescription

    19

  • Account Service[April][2014]

    Oracle Financial Services software LimitedOracle ParkOff Western Express HighwayGoregaon (East)Mumbai, Maharashtra 400 063India

    Worldwide Inquiries:Phone: +91 22 6718 3000Fax:+91 22 6718 3001www.oracle.com/financialservices/

    Copyright [2007], [2013], Oracle and/or its affiliates. All rights reserved.

    Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of theirrespective owners.

    U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programsinstalled on the hardware, and/or documentation, delivered to U.S. Government end users are commercial computersoftware pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. Assuch, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system,integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms andlicense restrictions applicable to the programs. No other rights are granted to the U.S. Government.

    This software or hardware is developed for general use in a variety of information management applications. It is notdeveloped or intended for use in any inherently dangerous applications, including applications that may create a risk ofpersonal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take allappropriate failsafe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliatesdisclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

    This software and related documentation are provided under a license agreement containing restrictions on use anddisclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement orallowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit,perform, publish or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilationofthis software, unless required by law for interoperability, is prohibited.

    The information contained herein is subject to change without notice and is not warranted to be error-free. If you find anyerrors, please report them to us in writing.

    This software or hardware and documentation may provide access to or information on content, products and servicesfrom third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any

    20

  • kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not beresponsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, orservices.

    21