Вы находитесь на странице: 1из 10

Rabobank International

<System name> : <Interface name + Interface


version>
System Interface Specification (SIS)
Version

x.x

Revision History
Date (dd/mmm/yy)
2/9/2012

Version
1.0

Description

Author

Document creation

Luis Avila

This specification was based on the SIS template version v1.4.

Sign off
This document has been reviewed and agreed upon by:
Role

Name

Lead developer of the


providing system

Sebastian Munizaga

Lead developer of the


consuming system

Jonathan Baez

Version

Date

1.0
1.0

Each SIS should be signed off by the lead developers of the providing and the consuming systems.

Review
This document has been reviewed by:
Role

Name

Architect of the
providing system

Luis Avila

Architect of the
consuming system

Luis Avila

Version

Date

Business analyst of the


providing system
Business analyst of the
consuming system
Tester of the
providing system
Tester of the
consuming system

SIS: <System name> : <Interface name + Interface version>


Template version: v1.4

ii

Table of Contents
Introduction................................................................................................................................4
Definition of an interface....................................................................................................4
Purpose of this document..................................................................................................4
Author and Ownership of this document.............................................................................4
Definitions, Acronyms and Abbreviations...........................................................................4
References........................................................................................................................4
Purpose, ownership, consumer(s)..............................................................................................5
Purpose of this interface....................................................................................................5
Ownership of the interface.................................................................................................5
Interface Provider(s)..........................................................................................................5
Interface Consumer(s).......................................................................................................5
Relationship to other interfaces..........................................................................................5
Overview...................................................................................................................................5
Logical Overview................................................................................................................5
Physical Overview, locations..............................................................................................5
Responsibilities, Availability, Timing, Sizing, Security.........................................................5
Message(s)................................................................................................................................7
Generic additional message specifications.........................................................................7
Data Types.............................................................................................................................7
Formats..................................................................................................................................7
Other generic message characteristics....................................................................................7
Message: (BA) Balance....................................................................................................7
Message transport name.........................................................................................................7
Business Logic / Selection criteria...........................................................................................8
Message Signature.................................................................................................................8
Formal description of message layout...................................................................................10
Sample data..........................................................................................................................10

SIS: <System name> : <Interface name + Interface version>


Template version: v1.4

iii

System Interface Specification


<System name> : <Interface name + Interface
version>
Introduction
Definition of an interface
An interface defines one of the communication boundaries of a system. It refers to an abstraction that a
system provides of itself to the outside. This separates the methods of external communication from
internal operation. Through its interfaces, the services of a system can be used.
An interface is
provided (or exposed) by one system; it is consumed by zero or more systems.
defined by a signature and a protocol.
a well-defined entry point of a system.
Purpose of this document
The purpose of this System Interface Specification (SIS) is to describe the interface Flows for
operations (FL) provided by system BAC and consumed by system SIGIR (NEOSOFT) .
The SIS is intended to describe all the functional and technical aspects of this system interface: one
small but whole document as the basis of trust between systems.
It is not intended as:

a document to describe an SLA.

the technical design of a system component which realizes or consumes the interface.

The intended audience is everyone involved in the development or maintenance of the provision or
consumption of the interface.
Author and Ownership of this document
The author of this document is the development team of the system providing the interface. The
ownership of this document lies with the technical owner of the system providing the interface (see:
Interface Provider(s)).
Definitions, Acronyms and Abbreviations
Term
SIS

Description
System Interface Specification
Table 1: Definitions, acronyms, and abbreviations

References
Title

Version

Date
(dd/mmm/yy)

Author

IBA / Rabobank Group service


architectuur (Dutch)
<title>

<x.x>

<dd mmm yy>

<name>

Table 2: References

SIS: <System name> : <Interface name + Interface version>


Template version: v1.4

Purpose, ownership, consumer(s)


Purpose of this interface

Ownership of the interface


The provider of the interface is the owner of the interface. Both parties (the teams responsible for the
maintenance of the systems) must agree on the ownership of the interface.
The below paragraphs specify interface ownership (provider) and consuming party.
Interface Provider(s)
The provider of the interface is a system. The technical owner of the providing system is therefore
technical owner of the interface.
Below the providing system(s) of the interface are listed:
Providing system
<sysname>

Technical owner
<Rabobank International IS&D
department >

Business owner
<bus owner>

Table 3: Interface providers


The technical owner is responsible for the correct behavior of the interface. Existing interfaces should
not be altered; instead a new version of the interface should be defined to eventually replace the old
one.
Interface Consumer(s)
Below the consumers of the interface are listed:
Consuming system
<sysname>

Technical owner
<tech system owner>

Business owner
<bus owner>

Table 4: Interface consumers


Relationship to other interfaces

Overview
Logical Overview

Physical Overview, locations

Responsibilities, Availability, Timing, Sizing, Security


COMPLETAR CON INFO INDICADA
Explicitly mention what the responsibilities of the systems are, such as:
system ABC will place the data file at the specified location every day at 04:00 CET
the interface will be available on working days between 9:00 and 17:00 CET
And any other special requirements such as

data volumes, frequency,

security

Monitoring

SIS: <System name> : <Interface name + Interface version>


Template version: v1.4

Resolving errors. Retransmissions. Fall back to full load.

SIS: <System name> : <Interface name + Interface version>


Template version: v1.4

Message(s)
The definition(s) of the message or messages which are part of this interface are given in this chapter.
Each message has its own sub chapter.
Generic message specifications are in Generic additional message specifications.
Generic additional message specifications
The information in this section applies to all messages below.
Data Types
In the message layout tables below the following standard is used to denote the data type of the fields
(column Data Type):
Text fields are specified by Char(X). In this case X is the maximum allowed number of
characters.
Numeric fields are specified by Num(X:Y). In this case X is the maximum allowed number of
digits before the decimal separator, Y is the maximum allowed number of digits after the
decimal separator.
For complex (nested) types (used for instance in XML), specify the name for the complex type
and refer to a separate section for the message layout of this complex type.
For other data types such as Boolean use the Constraints column to list the allowed values.
Formats

Date format is YYYYMMDD unless stated otherwise.


Time format is HHMMSS unless stated otherwise.
Numeric values format:
No thousand separators
Decimal separator is the dot: "."
Sign (negative/positive): Negative numbers have a leading minus-sign i.e. -314. Positive
numbers are not marked with any sign character.
Trailing spaces should be removed.
How to handle the mandatory property:
Type
Mandatory=Y
Mandatory=N
Integer
A valid integer value
To supply no input, the element should not be
must be provided
provided
Note: this means the receiving party should
support null-able integers
Boolean, date,
similar to integers
similar to integers
datetime and
other value types
String
a non empty string
To supply no input, the element should not be
(length > 0) must be
provided OR an empty string should be
provided
provided. The receiving party should process
both equally as no input.
Complex types
Provide the element
To supply no input, the element should not be
including it is
provided
mandatory subelements.

Other generic message characteristics


Message: (BA) Balance
Message transport name
File

SIS: <System name> : <Interface name + Interface version>


Template version: v1.4

Business Logic / Selection criteria


EOD
Message Signature

SIS: <System name> : <Interface name + Interface version>


Template version: v1.4

Logical
fieldname

Description

Data
type

Constraints / Notes

Sample data

Very short
description of the
information
contained in the
field

This description should


completely define and explain
what the data in the field
means.

physical
name of the
field (e.g.
in .csv
header or
xml-tags)

Specifies
what
kind of
informati
on to
expect.

Describes the validation rule(s) for


the field. This includes ranges etc.

Present real
examples of
the
information
which may be
returned.

This is the
how the
business
analyst would
call the field.

Complete description of
the meaning

This is the
how the
developer
would call
the field.

This row should be removed


from a real SIS

provide
enough
sample
data to
remove
any
confusion

COUNTRY

Country code

ctry

VARCHA
R(3)

CL for Chile

CL

Generation Date

Interface generation date

intf_dt

DATE

Format YYYYMMDD

20120217

Interface ID

Unique identifier for the interface

src_id

VARCHA
R(14)

704

Identifier, in
this case is
704

Company code

Internal company code

cem

VARCHA
R(3)

Constant 1.

Product code

Internal code of the product


whose transaction is being
informed

prod

VARCHA
R(16)

BCC for Spot transactions


FWD for Forward transactions
BTR for trading transactions
PCS for Swap transactions
EXTRA for loans transactions
( external credits)
BONOS for liabilities transactions
( bonds)

Transaction
number

Transaction unique id
composed by Transaction
number and option component
number

con_no

VARCHA
R(20)

A formula exists to obtain the number


that must be informed. Always it is a
number of length 11 characters

Quota payment
date

Quota payment date

coup_dt

DATE

Format YYYYMMDD

Quota amount in
local currency

Amount of the quota to pay in


local currency

lcy_coup_amt

NUMBE
R(19,2)

Amount of the quota to pay in local


currency

Amount
Amortization in
Local Currency

Amount Amortization in Local


Currency

lcy_amrt_amt

NUMBE
R(19,2)

It is the amount of amortization


included in the quota

Amount in local
aggregate
Currency

Amount accrual in Local


Currency

lcy_int_amt

NUMBE
R(19,2)

Amount of accrual in the operation, in


local currency.

Internal code of
branch

Internal code of branch

br

VARCHA
R(4)

Constant 101

Code of center of
cost

Code of center of cost

cc

VARCHA
R(10)

Constant 4040112

M Technical
1
name

Mandatory: Y/N; indicates if the field is mandatory

SIS: <System name> : <Interface name + Interface version>


Template version: v1.4

Formal description of message layout


Sample data
This is a example for some transactions :
CL,20120101,704,1,BCC,34081010009,20111230,453921127.00,453921127.00,0.00,101,4040112
CL,20120101,704,1,BCC,34082010003,20111230,417090615.00,417090615.00,0.00,101,4040112
CL,20120101,704,1,BONOS,00885011110,20160930,45267285671.3,44592380000.00,674905671.3,101,4040112
CL,20120101,704,1,BONOS,00885011110,20150330,674905671.3,0.00,674905671.3,101,4040112
CL,20120101,704,1,BONOS,00885011110,20150930,674905671.3,0.00,674905671.3,101,4040112
CL,20120101,704,1,BONOS,00885011110,20160330,674905671.3,0.00,674905671.3,101,4040112
CL,20120101,704,1,BONOS,00885011110,20130930,674905671.3,0.00,674905671.3,101,4040112
CL,20120101,704,1,BONOS,00885011110,20140330,674905671.3,0.00,674905671.3,101,4040112
CL,20120101,704,1,BONOS,00885011110,20140930,674905671.3,0.00,674905671.3,101,4040112
CL,20120101,704,1,BONOS,00885011110,20120330,674905671.3,0.00,674905671.3,101,4040112
CL,20120101,704,1,BONOS,00885011110,20120930,674905671.3,0.00,674905671.3,101,4040112
CL,20120101,704,1,BONOS,00885011110,20130330,674905671.3,0.00,674905671.3,101,4040112
CL,20120101,704,1,EXTRA,00870011103,20120222,10966757.00,0.00,10966757.00,101,4040112
CL,20120101,704,1,EXTRA,00870011103,20120522,10728349.00,0.00,10728349.00,101,4040112
CL,20120101,704,1,EXTRA,00870011103,20120822,10966757.00,0.00,10966757.00,101,4040112
CL,20120101,704,1,EXTRA,00870011103,20121123,10966757.00,0.00,10966757.00,101,4040112
CL,20120101,704,1,EXTRA,00870011103,20130222,10966757.00,0.00,10966757.00,101,4040112
CL,20120101,704,1,EXTRA,00870011103,20130522,10609142.00,0.00,10609142.00,101,4040112
CL,20120101,704,1,EXTRA,00870011103,20130822,10966757.00,0.00,10966757.00,101,4040112
CL,20120101,704,1,EXTRA,00870011103,20131122,3911191757.00,3900225000.00,10966757.00,101,4040112
99,20120101,20,,,,,,,,,

The last line of the file has the following format :


99,YYYYMMDD,XXXXXXXXX,,,,,,,,,,,,,,,
XXXXXXXX = Quantity of records
This file is daily and has the following fixed name
11100704YYYYMMDD.TCL

SIS: <System name> : <Interface name + Interface version>


Template version: v1.4

10

Вам также может понравиться