integration specification document

8/11/2019 Integration Specification Document

1/14


2/14

Integration Specification



3/14


Revision History

Date Version Description Author


4/14


Table of Contents

1. INTRODUCTION .............................................................................................................................. 5

2. ........................................................................................................... 6

2.1 TECHNICAL ASSUMPTIONS .............................................................................. 6

2.2 BUSINESS RULES ........................................................................................... 6

2.3 INTERFACE DESCRIPTION .................................................................................................................... 7

2.4 INTERFACE FREQUENCY AND SCHEDULE ................................................................................................ 7

2.5 MESSAGE DETAILS ............................................................................................................................ 8

2.6 DATA MAPPING AND TRANSFORMATION RULES ..................................................................................... 8

2.7 INTEGRATION INTERFACE DESIGN ....................................................................................................... 11

2.7.1 Flowchart .............................................................................................................................. 11

2.7.2 Design time components ...................................................................................................... 11

2.7.3 Global Variables .................................................................................................................... 11

2.7.4 Database Queries ................................................................................................................. 112.7.5 Class diagram ....................................................................................................................... 12

2.7.6 Exception Rules ..................................................................................................................... 12

2.7.7 Adapters ............................................................................................................................... 12

2.7.8 Integration Standard ............................................................................................................ 12

2.8 PERFORMANCE SPECIFICATIONS ......................................................................................................... 12

2.9 AUDIT SPECIFICATIONS..................................................................................................................... 13

2.10 LOGGING SPECIFICATIONS................................................................................................................. 13

2.11 SYSTEM SPECIFICATIONS................................................................................................................... 13


5/14


1. Introduction

[The purpose of this document is to detail the design of all the web services

created for an application by subsystem. It is to include all the design andimplementation time components for integration such as interfaces exposed bythe web services to the end systems, business and validation rules,transformation rules, data field mappings and implementation logic.The integration design specification is used to translate what needs to bedeveloped into how an integration interface will be developed for each of the webservices.

Also, provide a summary of the document highlighting the key points in eachsection, if applicable.]


6/14


2.

[This section is intended to be repeated for as many application subsystems

within an application that contain web services. Further, each section is to beelaborated with the design details for each web service within that subsystem. ]

2.1 Technical Assumpt ion s

[This section documents any technical assumptions made during the design andimplementation of this web service for this subsystem.]

Sr No Assumption Comments

Table 1:Technical Assumptions

2.2 Business Rules

[This section describes the business events and rules that trigger the web serviceto perform an action. The interfaces exposed by the integration subsystem toimplement the business flow are defined. The message elements critical toimplement the business functionality and the business logic implemented by the

interface to implement the business rule is documented. Refer them to thebusiness Rules Specification for the details of the rules.]

The table below provides a high level description only. These rules are at a fieldlevel.

Requirement #

Business Rule RuleDescription

InterfaceName

Message name BusinessLogic

Description

Example:

The employeeshould exist inthe currentemployeedatabase to beeligible.


7/14


Requirement #

Business Rule RuleDescription

InterfaceName

Message name BusinessLogic

Description

search in theEmployeedatabase. If the

Employee flagis set toActive, then

retrieve theemployeeaddress andsend an emailnotification toxxxx. >

Table 2:Business rules

2.3 Interface Descrip t ion

[This section describes the interfaces exposed by the integration sub-system toall the end systems in order to implement the required business functionality. Thebusiness functionality performed on the interface invocation including any postand pre conditions that should be met when the interface is invoked aredocumented.]

InterfaceName

Actors Involved Context goal Preconditions Post conditions

Example:

The interfacefetches all theactiveemployeesbased onrequestparameters>

Table 3:Interface details

2.4 Interface Frequency and Schedu le[This section describes the frequency and schedule for the invocation of theinterface for the integration sub-system.]

Immediate (real-time)On demandHourly Day: ___________ Time: ___________ Push/Pull: ___________Daily Day: ___________ Time: ___________ Push/Pull: ___________


8/14


9/14


The table below lists the message elements for the integration sub-system(source) and documents the message element name, description of its purposewithin the sub-system, the data type and length.

Field Name Description Type Length (if applicable)

Example:

Employee.FirstName

Example:

Contains the first name ofthe employee

Example:

String

Example:

NA

Table 5:Source Message

The table below lists the message elements for the end system (target) anddocuments the message element name, description of its purpose within the sub-system, the data type and length.


Example:

Name

Example:

Contains the first name andlast name delimited byspace

Example:

Char

Example:

100

Table 6:Target Message

The table below lists the message elements for the canonical model that is usedwithin the interface and documents the message element name, description of itspurpose within the sub-system, the data type and length.


Example:

Name

Example:

Contains the first name andlast name delimited byspace

Example:

Char

Example:

100

Table 7:Canonical Message

The table below lists the Source message to Target message mapping detailsincluding any transformation logic that has to be applied during the messageexchange.


10/14


Source System>Data Element

Required (Y/N)

DataElement

Required (Y/N) Mapping Logic

Example:

Employee.FirstName

Example:

Y

Example:

Name

Example:

Y

Example:

Concatenate or SegregateEmployee.FirstName intoName

Table 8:Source to Target Message mapping

The table below lists the Source message to Canonical message mapping detailsincluding any transformation logic that has to be applied during the message

exchange.

Data ElementCanonical Data

ElementMapping Rule Cross Reference

Details (if any)Notes

Example:

Employee.FirstName

Example:

Person.FirstName

Example:

One to one mappingbetween

Employee.FirstNameandPerson.FirstName

Example:

Check thatEmployee.LastNameis not NULL

Table 9:Source to Canonical Message mapping

The table below lists the Canonical message to Target message mapping detailsincluding any transformation logic that has to be applied during the messageexchange.

Canonical Data

Element

DataElement

Mapping Rule Cross Reference

Details (if any)

Notes

Example:

Person.FirstName

Example:

Name


11/14


Canonical DataElement

Data

Element

Mapping Rule Cross ReferenceDetails (if any)

Notes

Example:

Concatenate orSegregate

Person.FirstNameinto Name

values etc >

Example:

Check thatPerson.LastName isnot NULL

Table 10:Canonical to Target Message mapping

2.7 Integration Interface des ign

[This section provides details on the business logic implemented by the interface,the components of this interface that are called into action and in what order thecomponents are invoked. This section also describes any external componentsthat are triggered by the interface.]

2.7.1 Flowchart

[This section gives a detailed description of the implementation logic within theinterface.]

Figure 1:

2.7.2 Design time components[This section describes any design time components or libraries that are used toimplement the business logic of the integration sub-system.]

2.7.3 Global Variables

[This section describes any global variables that are used within the interface toimplement the business functionality.]

Global Variable Value Description

Table 11:Global Variables

2.7.4 Database Queries

[This section documents the any SQL queries that are used by the interface toretrieve or insert data in the database.]


12/14


2.7.5 Class diagram

[This section provides a class diagram for any custom programming required forthe interface.]

2.7.6 Exception Rules

[This section documents the any exceptions that that should be logged by theinterface when an error is encountered by the interface.]

Exception Rule Exception Id Description

Example:

The interface throws anexception when there aremultiple entries for thesame employee in the

database

Example:

Duplicate_Employee: 1234

Example:

Duplicate entries found in Employeedatabase

2.7.7 Adapters

[This section provides a description of the adapters used by the within theintegration sub-system such as database adapter, email adapter, adapter for

proprietary tools etc.]

Adapter Name Description

Example:Email adapter

Example:This adapter is used to configure the email server and send email notifications.

Table 12:Adapters

2.7.8 Integration Standard

Includes: security, hosting, transactions, bindings and transport

Hosting = within IIS, windows service, AppFabric, etc.Binding and transport = HTTPS, MSMQ, named pipes, NetTCP, etc.Transactions= two phase commits or not, etc. If using, what transaction

standards, like WS-transactionsSecurity = NTLM, tokens, etc.]

Table 13:

2.8 Performanc e speci f icat ions

[This section documents the performance parameters that the interface shouldmeet and the corresponding values. The performance requirements are defined


13/14


as part of the non-functional requirements Software Requirements Specification(SRS). The performance requirements capture parameters such as expectednormal/peak frequency of the interface, response time, data load etc.]

Performance

Parameter

Values Comments

Example:

Response time

Example:

2 secs

Table 14:Performance specifications

2.9 Audi t speci f icat ions

[This section documents the transaction data that needs to be have an auditentry as defined in the business requirements.]

Audit Parameter Values Comments

Example:

Employee.FirstName

Example:

xxxxx

Example:

The request message containing the employee name isinserted in the audit history table.

Table 15:Audit specifications

2.10 Logg ing speci f icat ions

[This section documents the fields to be logged and the level of logging. Thishelps log the functionality as it gets executed within the sub-systems and isuseful to debug any issues by checking the log files. The logging framework isdefined as part of the common services framework defined in the designapproach.]

Logging Parameter Values Comments

Example:

Employee.FirstName

Example:

Received datasuccessfully fromPortal:

Table 16:Logging specifications

2.11 System speci f icat ions

[This section documents the system parameters and the corresponding valuesfor the integration subsystem.]


14/14


Environment Location Logical Server Name Comments

Example:

Portal

Production

Example:

Client networkxxx

Table 17:System specifications

integration specification document

Documents