External System Guidelines for using AIP
Version: 1.0
Date 2007-09-11
Project:
Document:
Baseline
81913301
Version: 1.0
Date: 2007-09-11
Table of Contents
1
INTRODUCTION ........................................................................................................................................ 3
1.1
1.2
1.3
1.4
1.5
2
PURPOSE .................................................................................................................................................. 3
AUDIENCE ............................................................................................................................................... 3
VERSION HISTORY ................................................................................................................................... 3
REFERENCE DOCUMENTS ......................................................................................................................... 3
ABBREVIATIONS ...................................................................................................................................... 3
BASELINE GUIDELINES .......................................................................................................................... 4
2.1
2.2
2.3
2.4
2.5
SERVICE TYPES ........................................................................................................................................ 4
CONNECTING TO THE INTEGRATION PLATFORM ....................................................................................... 4
CONTRACTS ............................................................................................................................................. 4
BASELINE METADATA ............................................................................................................................. 5
RESPONSIBILITIES OF THE EXTERNAL SYSTEMS ....................................................................................... 5
2 (7)
Project:
Document:
Baseline
81913301
Version: 1.0
Date: 2007-09-11
1 Introduction
1.1 Purpose
This document specifies how an external system shall interact with Baseline.
1.2 Audience
System owners and developers
1.3 Version history
Version
Date
Description/comments
Responsible
1.0
2007-09-11
Created
Martin Rydman, Zystems
1.1
2007-09-18
Comment from Jakob Karlsen
Jakob Karlsen, RSD
1.4 Reference documents
1.5
Reference
Document name
Issued by
AIP
Integrationarkitektur RSD_til_godkendelse_ver
1 0 9.doc
RSD
Baseline
Metadata
Baseline Metadata Specification.doc
Zystems
Abbreviations
IP
Integration platform
PoD
Point of delivery. A specific hand-over point between a system and the
IP, such as a URL or a WMQ queue.
3 (7)
Project:
Document:
Baseline
81913301
Version: 1.0
Date: 2007-09-11
2 Baseline Guidelines
Baseline is a methodology for designing, implementing and documenting on the
integration platform. Any system that wants to use a Baseline should adhere to a
number of guidelines as described in this document. For a definition of the various
concepts used in this document, see [AIP].
2.1 Service types
Systems will be involved in one or more of the following scenarios:

As a consumer of an I-service

As a provider of an S-service

As a publisher of N-service events

As a subscriber to N-service events
2.2 Connecting to the Integration Platform
The platform supports the following message formats and protocols:
Message
layer
Transport
layer
JMS
HTTP
WMQ
SOAP
Preferred
Yes
YES
XML
Yes
Yes
YES
If a consumer or provider can’t handle a message using the above formats and
protocols, the connectivity between the system and the IP must be investigated and
separately developed. The IP can supply connectivity for other message types/protocols
through the use of adapters. This document does not cover the details of those.
2.3 Contracts
Baseline identifies each relationship between a Consumer/Provider and a Service
through a Contract. A Contract regulates

Information owner. Who is responsible for the message being transferred?

Frequency and volumes. How often will a Service accept messages, and how big
can they be?

Security considerations. What security considerations apply for the message
transfer?

Monitoring. Are there any special monitoring requirements?
4 (7)
Project:
Document:

Baseline
81913301
Version: 1.0
Date: 2007-09-11
PoD. See section 1.5
Each system acting as a consumer will have to know a unique ContractID for any
interaction it has with each I-service. This ContractID will be supplied by the Integration
Team.
2.4 Baseline Metadata
On a technical level, a system acting as a consumer will have to be able to supply the
message it creates and sends to the IP with a set of Metadata. Metadata are crucial to
enable the Baseline Logging framework.
The metadata elements are described in detail in [Baseline Metadata]. At a minimum it
should be able to supply the following metadata elements for the relevant protocol
(WMQ, JMS, or HTTP):

Transaction Id

Integration Id

Contract Id

Initial Message Id
Applications that are unable to supply metadata can still act as consumers. However,
steps will need to be taken in the solution design to add metadata to the message at the
earliest possible step.
2.5 Responsibilities of the External Systems
Consumer of an I-service
Consumer
System
Integration
Platform
Contract
I-service
An I-service consumer will have to adhere to the following guidelines:

Send data to the IP using one of the listed methods in section 2.2

Place the message in the PoD as defined in the Contract

Attach metadata to the message as described in 2.4

Otherwise fulfill the Contract
I-services will be expecting SOAP over JMS calls (even though other protocols may be
allowed). The definition of I-services will be supplied in a Baseline Service document,
including a WSDL document.
5 (7)
Project:
Document:
Baseline
81913301
Version: 1.0
Date: 2007-09-11
Provider of an S-service
Integration
Platform
Provider
System
Contract
S-service
An S-service provider will have to adhere to the following guidelines:

Accept data from the IP using one of the listed methods in section 2.2

Consume the message from the PoD as defined in the Contract

The system will not have to handle or act on any of the metadata, but it must be
able to consume a message containing metadata as described in 2.4.

Otherwise fulfill the Contract
Providers of S-services will have to supply a filled in Baseline Service document and, if
relevant, a WSDL document.
A special case of S-Service is a JMS based request/reply service. This involves the S-service
reading a request message from a queue and putting a reply on another queue. In this
case, the S-service provider must be able to correctly handle the JMSCorrelationID and
JMSReplyTo properties.
N-services
N-services are used to implement the Publish Subscribe integration pattern. This pattern
involves a Publisher and one or more Subscribers. The Publisher is a system that will emit
events in the form of messages. Events reflect changes in the publishing systems, such
as a New Employee or an Update Price.
Subscribing systems will be interested in these events, and will subscribe to them. The
IP makes sure that the publishing system is completely unaware of all subscribers.
Note! N-services must use JMS (not HTTP) since JMS has built-in support for Pub-Sub,
whereas HTTP does not.
Publisher of N-service events
Publishing
System
Contract
I-service
Integration
Platform
N-service
The publishing system will consume a regular I-service that expects the events on its
endpoint and then acts as the provider for the N-service. The actual N-service is also
exposed on the IP and is available to any system that wants to subscribe to the event.
The N-service’s endpoint is a topic. A topic classifies the type of message that is being
published. Subscriber systems subscribe to events by submitting subscriptions to the IP
on one or more topics. The actual configuration of a subscription can be either automatic
(by sending special subscription messages to the JMS provider) or manual (by an IP
administrator).
A Publisher of N-service events will have to adhere to the following guidelines:
6 (7)
Project:
Document:
Baseline
81913301
Version: 1.0
Date: 2007-09-11

Send data to the IP using one of the listed methods in section 2.2

Place the message in the PoD as defined in the Contract

Attach metadata to the message as described in 2.4

Otherwise fulfill the Contract
The definition of the I-services will be supplied in a Baseline Service document,
including a WSDL document. It is the responsibility of the IP to publish the Baseline
Service document, possibly including a WSDL document.
Subscribers to N-service events
Subscribing
System
Contract
Integration
Platform
Contract
N-service
Subscribing
System
The subscribing systems will subscribe to the N-service events using topics (as
described above). The subscribing systems act as Consumers, again with the difference
that they are passively listening for events. The Consumer will, as part of its
subscription, have a designated queue onto which the events are put.
A Subscriber of N-service events will have to adhere to the following guidelines:

Accept data from the IP over JMS

Consume the message from the PoD (always a queue) as defined in the Contract

The system will not have to handle or act on any of the metadata, but it must be
able to consume a message containing metadata as described in 2.4.

Otherwise fulfill the Contract
The definition of the N-services will be supplied in a Baseline Service document,
possibly including a WSDL document.
7 (7)