Osb Bam Integration

Integrating OSB 10gR3 with Oracle BAM 11g
A SOA Technology Article
by Aritza Iratzagorria (aritza.iratzagorriagaray@osakidetza.net) and Nacho
Lafuente (nacho.lafuente.botella@oracle.com)
Last Updated on May 13 2010

1 Introduction.................................................................................................. 2
1.1 Oracle Service Bus (OSB).................................................................... 2
1.2 Oracle Business Activity Monitoring (BAM) .......................................... 3
1.3 The need for OSB and BAM Integration............................................... 6
2 OSB 10gR3 Integration with BAM ............................................................... 6
2.1 Integration Scenarios ........................................................................... 6
2.2 Architecture .......................................................................................... 7
2.3 OSB BAM Feeder................................................................................. 8
2.4 Deployment .......................................................................................... 9
2.5 Testing ............................................................................................... 13
2.6 Error Handling .................................................................................... 15
2.6.1 Handling System Errors .............................................................. 16
2.6.2 Handling Application Errors......................................................... 19
3 Electronic Prescription Example ................................................................ 20
3.1 Osakidetza and Electronic Prescription .............................................. 20
3.2 Integrating Prescriptions to BAM ........................................................ 22
3.3 Testing the solution ............................................................................ 36
4 Key Takeaways and Recommendations ................................................... 38

1 Introduction
1.1 Oracle Service Bus (OSB)
Oracle Service Bus (OSB) is a key component of SOA Suite and Event Driven
Architecture Suite in the Oracle Fusion Middleware product family.
OSB is a proven, lightweight SOA integration platform, designed for connecting,
mediating and managing interactions between heterogeneous services, not just
web services, but also Java and .Net, messaging services and legacy
endpoints.

Figure 1: OSB functional view
The functional features of Oracle Service Bus can be categorized into the
following layers:
Connectivity Layer: that reliably connects any service by leveraging
standards web service transports, traditional messaging protocols and
configuration of enterprise-specific custom transports.
o Web Service Transports: HTTP/SOAP, WS-Security, WS-Policy,
WS-Addressing, WS-RM
o Traditional Messaging: JMS, MQ, EJB/RMI, Tuxedo, FTP/SFTP,
SMTP, File, Native Database Lookup
o Transport SDK: Enterprise-specific custom transports
o Interoperability: .NET, Tibco EMS, IBM MQ, IBM WebSphere,
Apache Axis, B2B Interchange, iWay 5.5 adapters
Security Layer: a rapid service configuration and integration
environment that abstracts policies associated with routing rules,
security, and service end-point access.

o Transport Security: SSL/Basic Auth, Custom security credentials
o Message Security: WS-Policy/WS-Security, SAML,
UserID/Password, X509, Signing & Encryption, Custom security
credentials
o Console Security: Supports Web Single-Sign-On, Role based
access
o Policy-based Security: Leverages WS-Security & WS-Policy,
Oracle Web Services Manager
Mediation Layer: a meta-data driven feature-rich configuration interface
for service discovery and validation capabilities for automatic import and
synchronization of services with UDDI registries, allows message flow
modeling, transformations, third-party service callouts and a test console.
o Message Flow Modeling: Graphical modeling tools, Content based
routing, Mixed modes - Async/Sync, Pub/Sub, Exception
management
o Discovery & Validation: Automatic import and sync w/ UDDI
Registry or Repository, Validates integrity and reconciles conflicts
before deployment
o Transformation: XML and non-XML transformation, Xquery or
XSLT
o Service Call-out: Java exit (Plain Old Java Object), Web Services
call-out
o Test Console: Tracing & trouble-shooting
Service Management Layer: a service management environment that
includes dynamic service and policy configuration, centralized usage and
performance monitoring, and management of services - not just Web
services, but also Java, .Net, messaging services, and legacy end points.
o Endpoint URI Management: API to grow and shrink the pool of
Endpoint URI
o Dashboard: Fault and performance metrics, Summaries for
aggregated ESB
o Monitoring: Monitor alerts on single node or entire ESB server,
SLA Application-based Alerts, Alerts on operation metrics, Alerts
from message pipeline
o Reporting: Out of the box reporting provider, Custom reporting
providers
o Open interfaces: JMX Monitoring Interfaces, SNMP Alerts
o Operational Customization: One screen for operational
customization, Advanced searching capabilities

1.2 Oracle Business Activity Monitoring (BAM)
Oracle Business Activity Monitoring (Oracle BAM) gives business executives
the ability to monitor their business services and processes in the enterprise, to

correlate Key Performance Indicators (KPIs) down to the actual business
process themselves, and most important, to change business processes quickly
or to take corrective action if the business environment changes.
Oracle BAM is a component of both SOA Suite and BPM Suite and it is aimed
to provide meaningful and event-driven intelligence for end-users through
different features:
Monitor business processes & services in real-time
o Key Performance Indicators (KPIs)
o Service-Level Agreements (SLAs)
Analyze events as they occur
o Correlate events & KPIs
o Identify trends as they emerge
o Alert users to bottlenecks & solutions
Act on current conditions
o Event-driven alerts
o Real-time dashboards
o BPEL processes & web services integration
Figure 2 represents a high-level diagram of the Oracle BAM architecture.

Figure 2: Oracle BAM High-Level Architecture
Following information explains each high-level architectural component.
1. Information Sources
The primary source of data is messages that help Oracle BAM update
reports and generate alerts very quickly. Oracle BAM can accept tens

of thousands of updates per second into a memory-based persistent
cache that is the center of the Oracle BAM architecture.
Any application can send events using Web services or over any
JMS-based messaging protocols.
JEE applications can integrate using the Oracle JCA BAM Adapter.
This is the preferred method for applications deployed to Oracle SOA
Suite.
In addition to integrating real-time information coming out of these
message queues, you can also integrate historical data or information
coming out of any operational database or any data warehouse.
2. Oracle BAM
The Enterprise Integration Framework connects Oracle BAM to
enterprise information sources such as database server, flat files, and
XML sources. It is also capable of reading messages from all of the
major message queue providers, and then running that data through
real-time data integration plans. Real-time integration plans cleanse
the data, aggregate it, filter it, correlate it, and perform other
necessary actions.
Active Data Cache (ADC) is a high-performance, persistent, memory-
based storage system, designed to support active data and
monitoring. It provides access to current business information for
event-based reporting and alerting and supports both data objects
and external data objects.
The Report Cache assembles and formats the data for a live report to
be displayed. It applies the report definitions to the data sets retrieved
from the ADC for presentation in a browser. It manages information
paging for viewing and printing reports. After reports are created, they
are stored in the ADC, so that report creation is not repeated each
time.
The Event Engine monitors complex data conditions and implements
user-defined rules. The Event Engine continuously monitors the
information in the ADC for certain conditions and executes the related
actions defined in associated rules. It takes a variety of actions in
response to those changes, including notifying the appropriate user
with an alert and/or report(s).
The Report Server (BAM Web Apps & ADF) renders views and
reports to be displayed in a client browser, either user dashboards or
ADF Pages. Find more information on Oracle Application
Development Framework (ADF) technology at the ADF Home.
3. Interactions channels
Alerts are one of the interaction channels for BAM. Alerts are
launched by a set of specified events and conditions, known as a rule.
Alerts can be launched by data changing in a report or can send a
report to users daily, hourly, or at set intervals. Events in an alert rule
can be an amount of time, a specific time, or a change in a specific

report. Conditions restrict the alert rule to an event occurring between
two specific times or dates. As a result of events and conditions,
reports can be sent to users through email.
Dashboards are the main source to provide interactive information to
users. The BAM dashboards are accessed through the BAM Viewer
using a web browser anddisplay active data presentations where data
continuously updates, formats, and is displayed. When data changes,
the display changes in real-time. Oracle BAM Active Studio is the thin
user interface for power user handling the design and development of
the dashboards. Dashboards can be shared with other users and
rules can be created for determining the scheduling and delivery of
the reports.
ADF components may be leveraged to interact with BAM 11g active
data. This feature unleashes the power of ADF to build up interactive
applications that are based on data handled by BAM and provide the
final user with highly tailored interfaces.

1.3 The need for OSB and BAM Integration
OSB is a common entry point for customers leveraging service oriented
architectures. Many customers introduce OSB a the key technology to
intermediate between service consumers and service consumers. Once OSB
infrastructure is in place, several benefits are perceived:
Inventory – services are inventored so further governance activities may
take place.
Control – services are centrally managed and monitored.
Configuration – service properties (transport, security, transactions) and
service flow is configured without coding.
Although OSB is used as the main backbone for the SOA Infrastructure, OSB
technology is usually positioned as very focused on technical issues. Business
users benefit from OSB technology and assume that services are just a
commodity.
This is exactly the point of view that a SOA Center of Excellence pursues:
services are a commodity and functional users should design their business
process using a top-down approach. Once business users have agreed upon
this point, services play a central role in the enterprise business. Services are
the business process itself – for example, how many patients have been
prescribed today, how many orders are in process or what is the average price/
time for completion.
This paper explores the different alternatives to integrate Oracle Service Bus
10gR3 with Oracle BAM 11g.

2 OSB 10gR3 Integration with BAM
2.1 Integration Scenarios
Several OSB/BAM integration scenarios exist.

Using BAM Adapter - Oracle BAM Adapter 11g is certified with SOA
11g . It is not certified or supported on OSB 10gR3 at this time. Refer to
Oracle SOA Suite Developer’s Guide for more information on using BAM
Adapter from SOA Suite 11g.
Developing a custom OSB Reporting Provider - OSB defines an
extensible Reporting Framework that permits adding custom providers.
This OSB/BAM Integration approach consists of developing a custom
reporting provider that enables selecting information to be sent out to
BAM. This is accomplished by configuring the reporting action inside an
OSB service flow and BAM EMS picking up the message via EMS.
Refer to OSB Operations Guide for further information on Reporting
action and Reporting Providers.
Leveraging BAM Web Services – this scenario uses the BAM web
services that Oracle BAM publishes. The DataObjectOperationsById
service has operations to insert, delete, update and upsert existing BAM
Data Objects, so that information gathered at OSB may be easily
integrated into BAM.
The following table contains a summary of the integration scenarios.
Scenario Pros Cons
Very simple to Although not complicated, the
OSB
use custom reporting provider must be
Reporting
Provider Implicit & developed.
Intuitive Same message goes to default
Mapping OSB reporting provider (JMS
Reporting Provider) and BAM
Reporting Provider
JMS Reporting Provider may be
undeployed to prevent message
duplication, but OSB reporting
console funcionality becomes
unavailable.
BAM Web Simple to use Requires custom OSB assets
Services (services and transformations) to
be designed
BAM Strategic and Not available today on OSB 10gR3
Adapter available for BAM Adapter 11g not supported
OSB 11g on OSB 10gR3

The rest of this paper focuses on an OSB/BAM integration solution based on
the BAM Web Services approach.

2.2 Architecture
The selected integration architecture is represented at Figure 3. The OSB-BAM
integration component is called OSB BAM Feeder and it creates an integration
link between client candidates and Oracle BAM. The BAM Feeder is designed
as an OSB user project so it automatically benefits from all OSB existing
features.Clients may be internal (other OSB projects) or external (other

applications). The BAM Feeder itself may be represented as an integration
service that complies to a service contract. This contract defines the service
responsibities, operations, semantics and other operational values as quality of
service or availability.

Figure 3: OSB-BAM Integration Architecture
Figure 4 represents the messaging implications regarding the OSB-BAM
Integration. Each source message to be integrated into BAM will have its own
format (MyPrescription in the example). BAM defines a basic component called
Data Object – a Data Object represents a data entity whose information is to be
stored in BAM. Each new message to be integrated into BAM must be validated
against an underlying XML Schema specific for the selected Data Object
(BAMPrescription in the example).
Independently of the integration scenario, client messages must be transformed
into BAM messages at some point. This transformation must always be defined
and may be implemeted using different technologies. Currently, XQuery and
XSLT transformations are the methods provided by OSB. The transformation
should be packaged along the client service because it depends on the source
message.

Figure 4: OSB-BAM Integration Messaging

2.3 OSB BAM Feeder
This integration scenario has been designed and developed from scratch and
called OSB BAM Feeder. It leverages the BAM web services and specifically,
the DataObjectOperationsById service. This web service has operations to

insert, delete, update and upsert existing BAM Data Objects, also supporting a
batch mode to execute several operations in a single call.
Figure 5 contains a diagram for the OSB-BAM Feeder components that made
up the integration solution. These OSB artifacts have been designed and
configured in order to create a service that can be used to effectively provide
OSB-BAM integration. Following section contain a step-by-step guide to deploy
this solution and test it on a SOA Suite installation.

Figure 5: OSB BAM Feeder components
OSB BAM Feeder has been designed to meet several requirements:
Performance: messages are integrated into BAM asynchronously to
avoid client’s performance overhead.
Reliability: messages delivered in asynchronous mode are transported
using JMS/XA that enables persistence (to avoid losing messages in
case of server failure) and transactions (to permit Exactly Once delivery).
Transport independence: inbound transports currently include local
access (for internal OSB clients) and HTTP (for external clients).
Availability: the solution is designed to provide the same availability
level as the OSB infrastructure does. By leveraging OSB proxy services,
JMS transport and error handling techniques, OSB BAM Feeder will be
available at least if one OSB instance is alive.

2.4 Deployment
Follow these instructions to deploy OSB BAM Feeder to your environment.
Some OSB and WLS background knowledge is assumed. If you need further
information please refer to WLS 10.3 Documentation or OSB 10gR3
Documentation. Scripts delivered with this sample only work for Windows
environments.
1. Unzip OSBBamFeeder.zip to your local environment. You should have
the following contents.

a. bam: BAM resources (data objects, dashboard)
b. osb: OSB resources (BAM Feeder project and Mortgage Broker
testing services)
c. testing: XML testing payloads
d. wls: WebLogic Server applications & JMS resources
e. setEnv.cmd: script to set required environment variables.
2. Adjust the environment variables defined in setEnv.cmd to reflect your
local environment.
a. OSB_HOME: OSB 10gR3 installation home, needed to locate
OSB libraries and tools.
b. WLS_HOME: Leave default value (WLS packed with OSB),
c. SOASUITE_HOME: SOA Suite installation home, needed to
locate BAM libraries and tools.
d. JAVA_HOME: Path to JDK 1.6 (default path points to JRockit
bundled with OSB).
3. Create or get access to an OSB Domain – the rest of the steps assume
that OSB instance is called AdminServer and listening in localhost at
port 7021.
4. Adjust the WebLogic Server variables defined in
wls/serverEnv.properties to reflect your deployment environment.
a. wls_url: Administration URL (default is t3://localhost:7021)
b. wls_user: Administration user
c. wls_password: Administration password
d. target: Administration instance name (default AdminServer)
5. Deploy Mortgage Broker sample application to WebLogic Server.
a. Execute wls/deployApplications.cmd script.
b. Four web service applications and one web application should be
deployed.
c. Open the WLS Console at http://localhost:7021/console and
verify that these new deployments are active.
d. Access http://localhost:7021/examplesWebApp/index.jsp when
deployment is finished to double-check.
6. Deploy JMS resources to WebLogic Server.
a. Execute wls/deployJms.cmd script.
b. This script creates several JMS resources:
i. A File Store to persist JMS messages
ii. A JMS Server called OSBBAMJMSServer. This server
persists messages on a file store.

iii. A new JMS Module called OSBBAMJMSModule. This
module contains the JMS resources required by OSB BAM
Feeder to work properly.
c. Double-check the created JMS resources by using WLS Console
at http://localhost:7021/console.

d. In case JMS resources are to be deployed on a cluster:
i. Create one JMSServer for each instance in the cluster.
Enable message persistence.
ii. The Connection Factory should be targetted to the cluster
iii. The queues should be created as distributed queues
iv. The subdeployment should be targetted to all JMS Servers
belonging to the cluster.
7. Deploy BAM Feeder project to OSB
a. Execute osb/deployOsb.cmd script.
b. Double-check the imported project by using OSB Console at
http://localhost:7021/sbconsole. You should see the projects
Oracle/BamFeeder and Oracle/BamMortgageBroker imported.

8. Now it’s time to deploy BAM resources. Create or get access to a BAM
Domain – the rest of the steps assume that BAM instance is listening in
localhost at port 9001. For more information on creating a BAM Domain
please refer to the Oracle SOA Suite Installation Guide.
a. Execute bam/import_all.cmd script. This script imports a sample
Data Object definition and a dashboard.
b. Double-check the imported assets by opening the BAM Console
at http://localhost:9001/OracleBAM/.
c. Login and select “Architect” view.
i. Select “Data Objects” from the upper-left combo box.

ii. Navigate to OSB folder and select “Loan” data object. You
should see an object layout like the following.

d. Close the window and select “Active Viewer” from the main menu.
i. Click on “Select Report” button.
ii. Select “Shared Reports/OSB/OSB Loan Gateway 1”
Report.
iii. You should get a dashboard similar to the following
(changes may exist due to different data).

2.5 Testing
Sample Mortgage Broker application will be used to test that everything is
deployed and configured as expected. The Mortgage Broker application is
shipped with OSB to demonstrate basic OSB service configuration. The OSB
BAM Feeder deploys a modified version of the Mortgage Broker application that
features BAM Integration.
1. Open BAM Console available at http://localhost:9001/OracleBAM/
a. Select “Active Viewer”
b. Select “Shared Reports/OSB/OSB Loan Gateway 1” Report.
c. Arrange this window in one side/corner of the screen.
2. Open Mortgage Broker application available at
http://localhost:7021/examplesWebApp/
a. Select “Routing a Loan Application” example and click on “Run
the example”.

b. Now you have a Loan Request form that submits information over
OSB services. The OSB service has been intercepted to extract
information from the loan service and send it out to BAM using
the BAM Feeder component. Whenever a new loan request is
submitted the BAM Dashboard will reflect that information in real
time.

c. Test several loan rates (i.e. 3.0 and 5.3) to see how the BAM
Dashboard reacts to integrated information.
You can also test directly some of the services that OSB BAM Feeder provides.
The folder testing/ provides different payload messages that may be used as
input.
1. Open OSB Console available at http://localhost:7021/sbconsole
2. Select Project Explorer menu and navigate to
Oracle/BamFeeder/ProxyServices. Launch Test Console for the
BamInternalFeederPS Proxy Service.

3. Copy and paste payload testing/BamFeeder-Insert.txt into the Test
Console. Unselect “Direct Call” checkbox so that the request goes
through the JMS request queue.

4. If everything runs as expected, you should get no response and OSB log
file won’t tell anything. The OSB BAM Feeder is designed for a
production environment, so no logging is generated if everything is OK.
However, the BAM dashboard should reflect your last request.

2.6 Error Handling
The BAM Feeder has been designed to meet production environment quality.
One of the most important issues for Operations & Administration is error
handling. Once the BAM Feeder goes live it should be shaped to permit
monitoring, alerts and troubleshooting.
The OSB BAM Feeder benefits from generic OSB system administration best
practices and features. Further information on these topics may be accessed at
the OSB Operations Guide.
The goal of efficient error handling is to silently work under normal operation
and provide an specific procedure for each unexpected error situation.
The main entry points for OSB BAM Feeder are the BamAsyncFeederHttpPS
and BamAsyncFeederLocalPS Proxy Services. These services follow the
Fire&Forget design pattern (no response is ever returned) and are
asynchronous (request payload is queued up).
Errors will be notified later at the BamInternalFeederPS Proxy Service. This
service is responsible for dequeuing messages and processing the payload to
create a valid BAM request.

OSB BAM Feeder differenciates system and application errors.
System Errors – those related to communication (i.e. BAM Server is
down or not reachable) or internal (i.e. some JMS resource is
unavailable). System errors are notified to OSB administrators and
message is retried using JMS error handling parameters. If retry limit is
reached, message is forwarded to an error queue and persisted.
Whenever the error condition is solved (i.e. BAM Server is started again
after maintenance is done), the administrator may decide to re-queue the
messages to allow normal processing.
Application Errors – those related to the client application, mainly due
to invalid payload or other error reported at BAM side. An application is
error is identified because the BAM web service used to send out
messages is returning a SOAP Fault. Application errors are notified and
message is discarded (and invalid payload is not expected to change
over time).

2.6.1 Handling System Errors
This example shows how OSB BAM Feeder handles system errors in case of
BAM Server being down for maintenance.
1. This test must be executed with OSB instance up&running and BAM
instance not available.
BamInternalHttpFeederPS Proxy Service.
Console and click on Execute
5. The service response is empty because is not designed to return any
response. Remember that BAM Feeder is asynchronous to maximize
performance at runtime.
6. Whenever this request is dequeued and executed it will raise a system
error because BAM is not running. The JMS redelivery error
configuration will handle the different retries. Every request is dequeued
inside the context of a transaction – if routing is not possible, transaction
is aborted and message is not processed until redelivery limit is
reached. When this limit is reached, the configured redelivery policy
states that is should be forwarded to an error queue.
a. Every time the transaction is aborted the OSB log file will reflect
the following stack trace.
<17-nov-2009 19H47' CET> <Info> <EJB> <BEA-010213> <Message-Driven EJB:
RequestEJB-2669023879117828128-bf3182a.124fc2335c6.-7fd6's transaction was
rolled back. The transaction details are: Xid=BEA1-
01768203F36FFB121A37(29935953),Status=Rolled back.
[Reason=weblogic.transaction.internal.AppSetRollbackOnlyException],numReplies
OwedMe=0,numRepliesOwedOthers=0,seconds since begin=0,seconds
left=60,XAServerResourceInfo[WLStore_osbDomain_FileStore]=(ServerResourceInfo
[WLStore_osbDomain_FileStore]=(state=rolledback,assigned=AdminServer),xar=WLS
tore_osbDomain_FileStore1367845,re-Registered =
false),SCInfo[osbDomain+AdminServer]=(state=rolledback),OwnerTransactionManag

er=ServerTM[ServerCoordinatorDescriptor=(CoordinatorURL=AdminServer+192.168.2
40.1:7021+osbDomain+t3+, XAResources={cgDataSource, wlsbjmsrpDataSource,
WLStore_osbDomain_WseeFileStore,
weblogic.deployment.jms.WrappedXAResource_weblogic_transaction_internal_Trans
actionManagerImpl$TMXAResource, WLStore_osbDomain_FileStore,
WLStore_osbDomain__WLS_AdminServer},NonXAResources={})],CoordinatorURL=AdminS
erver+192.168.240.1:7021+osbDomain+t3+).>

b. Following picture shows the JMS transport configuration for the
BamInternalFeederPS Proxy Service. These parameters define
how error handling proceeds.

c. The OSB exception handling procedure also includes a Log
Action to further describe the system error.
<17-nov-2009 19H47' CET> <Warning> <ALSB Logging> <BEA-000000> < [null,
null, null, ERROR] System error routing to BAM (retried): Fault: BEA-
380002None of the URIs are online for Business service BamDOOByIdBSRoute to
BAM servicerequest-pipeline>

d. Finally, the OSB exception handling procedure raises a Pipeline
Alert to notify system administrators about the system error. The
Operations dashboard, at Pipeline Alerts tab will show two alerts
(because 1 additional retry has been configured).

e. The Operations dashboard may also be used to monitor services
with problems. A simple search to locate services with offline
URIs will detect the BAM BamDOOOById Business Service, as
this service is not currently reachable and OSB has decided to
take its URI offline to improve performance.

7. System errors are configured to always persist the message. Whenever
the error condition is cleared (i.e. BAM server is up again after
maintenance) the stored messages may be retried again. All messages
that have reached redelivery limit are stored at the BAM Feeder JMS
error queue.
a. Open the WLS Console at http://localhost:7021/console and login
with using system user/password.
b. Select Services > Messaging > JMS Modules >
OSBBAMJMSModule
c. Select jms.OSBBAMFeederErrorQueue queue.
d. Select Monitoring tab.
e. Select the checkbox by
OSBBAMJMSModule!jms.OSBBAMFeederErrorQueue queue
and click on Show Messages button.
f. All messages stored at the error queue will be shown.

g. To resume processing those messages just click on Move >
Move All option. Follow the steps to select OSBBAMJMSServer
as destination JMS Server and
OSBBAMJMSModule!jms.OSBBAMFeederQueue as destination
queue. This procedure could be easily automated using
WebLogic Script Tool (WLST) if needed.
8. After messages are moved to main processing queue, to process starts
over again with no previous memory. So if the system error condition is
still there, if will fall over the exception handling procedure.

2.6.2 Handling Application Errors
This example shows how OSB BAM Feeder handles applications errors in case
of an invalid payload being sent out.
1. This test must be executed with both OSB and BAM instances
up&running.
BamInternalHttpFeederPS Proxy Service.
Console.
5. Modify the request to indicate an invalid BAM data object identifier.
Change /OSB/Loan to any other value so that the request looks like the
following.
<bam:request xmlns:bam="http://xmlns.oracle.com/bam">
<bam:operation>insert</bam:operation>
<bam:objectType>/OSB/Loan/BlaBlaBla</bam:objectType>
<bam:payload>
<_Loan>
<_SSN>002</_SSN>
<_Name>Nacho</_Name>
<_Rate>12</_Rate>
<_Amount>14000</_Amount>
<_NumOfYear>2</_NumOfYear>
<_Notes>hola caracola</_Notes>
</_Loan>
</bam:payload>
</bam:request>

6. The service response is empty because is not designed to return any
response. Remember that BAM Feeder is asynchronous to maximize
performance at runtime.
7. Whenever this request is dequeued and executed it will be routed to
BAM web service. This web service is based on standard SOAP
envelopes, so any error with be returned using a SOAP Fault. As the
indicated BAM data object is invalid, the BAM web service will reply with
an error. The BAM Feeder error handling procedure will detect this
SOAP Fault and manage the application error. Application errors are due
to malformed or invalid payloads and the offending request message will
be discarded after notifying this situation.
a. The transaction that dequeued the message will be roll-backed
and the message discarded. The log file will show the following
error information.
<17-nov-2009 22H56' CET> <Info> <EJB> <BEA-010213> <Message-Driven EJB:
RequestEJB-2669023879117828128-bf3182a.124fc2335c6.-7fd6's transaction was
rolled back. The transaction details are: Xid=BEA1-
0B178203F36FFB121A37(11845418),Status=Rolled back.
[Reason=weblogic.transaction.internal.AppSetRollbackOnlyException],numReplies
OwedMe=0,numRepliesOwedOthers=0,seconds since begin=0,seconds
left=60,XAServerResourceInfo[WLStore_osbDomain_FileStore]=(ServerResourceInfo
[WLStore_osbDomain_FileStore]=(state=rolledback,assigned=AdminServer),xar=WLS
tore_osbDomain_FileStore1367845,re-Registered =
false),SCInfo[osbDomain+AdminServer]=(state=rolledback),OwnerTransactionManag
er=ServerTM[ServerCoordinatorDescriptor=(CoordinatorURL=AdminServer+192.168.2
40.1:7021+osbDomain+t3+, XAResources={cgDataSource, wlsbjmsrpDataSource,
WLStore_osbDomain_WseeFileStore,
weblogic.deployment.jms.WrappedXAResource_weblogic

_transaction_internal_TransactionManagerImpl$TMXAResource,
WLStore_osbDomain_FileStore,
WLStore_osbDomain__WLS_AdminServer},NonXAResources={})],CoordinatorURL=AdminS
erver+192.168.240.1:7021+osbDomain+t3+).>

b. The OSB exception handling procedure also includes a Log Action
to further describe the application error.
<17-nov-2009 22H57' CET> <Warning> <ALSB Logging> <BEA-000000> < [null, null,
null, ERROR] Application error routing to BAM (discarded): Application Error:
BAM-06003: El objeto de datos /OSB/Loan/BlaBlaBla no existe.; nested
exception is:
java.lang.NullPointerException; nested exception is:
java.rmi.RemoteException: BAM-06003: El objeto de datos
/OSB/Loan/BlaBlaBla no existe.; nested exception is:
java.lang.NullPointerException Fault: BEA-380001Internal Server
ErrorRoute to BAM serviceresponse-pipeline>

c. Finally, the OSB exception handling procedure raises a Pipeline
Alert to notify system administrators about the application error,
clearly stating that this message has been discarded. The
Operations dashboard, at Pipeline Alerts tab will show the alert.

8. Application errors should seldom be reported at production
environments. These errors indicates a configuration problem, either at
OSB side (the client is sending out malformed/invalid payload) or BAM
side (data object configuration or any other internal server issue).

3 Electronic Prescription Example
3.1 Osakidetza and Electronic Prescription
The Basque Country (Basque: Euskadi, Spanish: País Vasco) is an
Autonomous Region in Northern Spain with a total area of 7,234 sq km (2,793.1
sq mi) and a population of 2.155.546 (2008).
Osakidetza is the organization that manages the Public Health Service for
Basque Country and depends on the Health Department (Basque Country
Government).
Osakidetza manages 29 autonomous health services:
7 health regions
11 general hospitals
9 specialized hospitals
Emergencies
Tissue & Blood
Electronic Prescription will enable prescribers – such as GP or specialized
doctors – to send prescriptions electronically to a dispenser (such as a

pharmacy) of the patient's choice. This will make the prescribing and dispensing
process safer and more convenient for patients and staff. The Health
Departament has engaged a project to roll-out electronic prescription to all
health services in Euskadi.
Osakidetza IT manages several Health Information Systems (HIS) to support
the different health services. A Service Oriented Architecture (SOA) approach
has been selected to evolve these systems. The Electronic Prescription has
being designed and deployed on top of the new SOA Reference Architecture.
This SOA Reference Architecture, among others products and technologies,
includes Oracle Service Bus and Oracle BAM.
Figure 6 represents the Electronic Prescription high-level Architecture.
Physicians use the Electronic Prescription HIS Application to prescribe
whatever is needed to a patient. This HIS application is eventually consuming
the Prescription Notification Service that is published at Oracle Service Bus.
The main goal of this service is intermediating between the consumer (HIS
application) and the provider (Health Department Prescription Processing
Service), but the OSB BAM Feeder solution is also being leveraged to publish
prescription information to Oracle BAM. Inside BAM, a new Prescription data
object has been defined to store that information, and a Prescription Dashboard
is designed to enable business users monitor the business process and
eventually act on certain conditions (i.e. if some hospital suddenly stops
prescribing).

Figure 6: Electronic Prescription Architecture

3.2 Integrating Prescriptions to BAM
This section contains a detailed step-by-step guide to describe how the
prescription information is integrated into Oracle BAM.
1. Prescription Notification Service is published at Oracle Service Bus
a. This service is assumed to be already defined so no additional
instructions will be indicated.

b. This service contains a proxy service (RecetasEnvioPS), a
business service (RecetasEnvioBS) and an XML Schema
(RecetasEnvioXSD) that defines the messaging format.
2. Design BAM Prescription Data Object
a. A data object is required at BAM to store information related to
prescriptions. This data object depends on the business itself and
will be defined by business users.
b. Detailed instructions on how to create a BAM Data Object may be
found at BAM 11g Developer Guide.
c. The figure represents the
/Osakidetza/Asistencial/Comun/Prescripcion data object that has
been defined and will be used through this example.

3. Retrieve BAM data object XML Schema
a. BAM data objects are defined by business users and have their
own format. This format is defined by an XML Schema and is
needed to automate the transformation from the source message
format in OSB to target message format in BAM.
b. Regarding the prescription service, a transformation is needed to
convert the original message format (defined by

RecetasEnvioXSD schema) to
/Osakidetza/Asistencial/Comun/Prescripcion BAM data object.
c. JDeveloper 11g will be used to automate this transformation. You
should have at least JDeveloper 11.1.1.1 with SOA Composite
editor installed.
- Download JDeveloper from the JDeveloper Home Page.
- Install JDeveloper
- Run JDeveloper and select Help > Check for Updates
- Select the Oracle SOA Composite Editor and finish the
update process.
d. Select File > New and create a new SOA Application. This
application will only be used to create the required transformation
assets. When finished, these assets will be imported into Oracle
Service Bus and this SOA Application is no longer needed.

e. Click on composite.xml to open the SOA Composite Editor. The
selected composite is empty.

f. Click on composite.xml to open the SOA Composite Editor. The
selected composite is empty.
g. You need a connection to the BAM server to view the data objects
that are available to enable JDeveloper to automatically generate
appropriate assets.
- Create a connection to the BAM server by right-clicking
on Connections in the Application Resources navigator
and choosing “New Connection”, “BAM”.

- In Step 1 (the Name screen), select Application
Resources, accept the default name
“BAMServerConnection1” and click “Next”.

- Enter the host name of your server for “BAM Web Host”
and “BAM Server Host”. Enter the HTTP port for BAM in
the “HTTP Port” field.

- On the Test Connection page, click the "Test Connection"
button. Success is displayed in the Status window when
you achieve a successful connection.
- Click the “Finish” button.
- In the Application Navigator, Application Resources pane,
the new BAM Server connection is listed in the
Connections section under the BAM node.
h. Now the BAM Adapter will be used to retrieve the XML Schema
that defines the BAM Prescription data object.
- Drag and drop a BAM Service Adapter into the SOA
Composite.

- This will automatically open the configuration wizard for
the BAM Adapter.
- Give the service any name and click “Next”.
- Use the browse button to select the “Prescripcion” data
object under the correct patch and click the “OK” button.

- Click the “Next” button until the dialog is finished.
i. The XML Schema that defines the Prescription data object is now
stored under the “xsd” folder.

4. Create the transformation from OSB source message format to target
BAM message format.
a. This transformation may be created using either XQuery or XSLT,
both are supported transformation technologies in OSB.
b. If you feel comfortable hand-coding XQuery/XSLT skip to next
step.
c. You may use some tooling or manually edit the transformation.
For the rest of this example, Oracle Workshop for WebLogic
10gR3 will be used. This IDE currently supports the graphical
edition of OSB 10gR3 assets.
d. Click on “Oracle Workshop for WebLogic 10gR3” to open the IDE.
This IDE is packed with Oracle Service Bus 10gR3 installation and
contains a graphical XQuery editor that will ease the
transformation edition and testing. More information on this
product may be found at the Workshop Home.
e. You could reuse an existing OSB Project to create the required
transformation. Developing OSB projects with Workshop is out of
the scope of this paper – you may find additional information at
the OSB Plug-ins for Workshop Page.
f. Click on “File”, “New” and create a new OSB Project. Click “Next”
until wizard is finished.

g. Drag and drop the source and target XML schemas into the OSB
Project. Click on F2 to rename the files if required.

h. Click on “File”, “New”, “XQuery Transformation” to create the
required transformation. Give a name to the transformation.

i. Select source format type. This type should match the message
payload at the OSB service side. Click on “Add” to select the type.

j. Select target message type. This type should match the BAM
prescription data object type. Click on “Add” to select the type.

k. Click on “Finish” to close the wizard and open the XQuery editor.
The editor should be used to create the transformation that
converts the information in OSB format to BAM format. The
transformation depends on the business itself and should be
defined by business users. The following picture shows a sample
transformation that copies some information.

l. You can test the transformation using the “Test” tab. Copy a
sample request payload and execute the transformation to retrieve
an XML payload in BAM format.

5. Introduce some changes into the XQuery transformation
a. Just could proceed directly to this step and ignore last one if you
feel comfortable editing XQuery.
b. Some manual changes are required to the recently created
XQuery transformation. These changes are needed to create a
payload that matchs the BAM Feeder request. The BAM request
contains additional information like the operation to be executed
(insert, update, upsert, batch, remove) and the BAM data object
identifier.
c. BAM data objects are easly represented in XML by placing an
underscore prefix before the identifier. Using this coding, a data
object called “Foo” transforms into “<_Foo>” XML, and a data
object column “Identificator” transforms into “<_Identificator>”
XML.
d. The following code contains the original XQuery transformation as
created in the last step.
(:: pragma bea:global-element-parameter parameter="$recetas1" element="ns1:Recetas"
location="Recetas_Envio.xsd" ::)
(:: pragma bea:global-element-return element="ns0:_PrescripcionCollection"
location="BAM_Prescripcion.xsd" ::)

declare namespace ns1 = "http://xmlns.osakidetza.net/services/RecetaElectronica";
declare namespace ns0 = "http://xmlns.oracle.com/bam";
declare namespace xf =
"http://tempuri.org/OSB%20Project%201/RecetasToBAMPrescripcion/";

declare function xf:RecetasToBAMPrescripcion($recetas1 as element(ns1:Recetas))
as element(ns0:_PrescripcionCollection) {
<ns0:_PrescripcionCollection>
{

for $Receta in $recetas1/ns1:Receta
return
<ns0:_Prescripcion>
<ns0:_Centro>{ data($Receta/ns1:CODCENPRES) }</ns0:_Centro>
<ns0:_Fecha>{ data($Receta/ns1:FECHAPRES) }</ns0:_Fecha>
<ns0:_IdProfesional>{ data($Receta/ns1:CODPRONALTIT)
}</ns0:_IdProfesional>
<ns0:_TotalRecetas>{
data($recetas1/ns1:Receta[1]/ns1:NUMRECETAS) }</ns0:_TotalRecetas>
<ns0:_TipoReceta>{ data($Receta/ns1:TIPORECETA)
}</ns0:_TipoReceta>
<ns0:_IdReceta>{ data($recetas1/ns1:Receta[1]/ns1:CODREC)
}</ns0:_IdReceta>
<ns0:_IdProducto>{ concat($recetas1/ns1:Receta[1]/ns1:CODUAP
, $recetas1/ns1:Receta[1]/ns1:CODFOR , $recetas1/ns1:Receta[1]/ns1:CODPF)
}</ns0:_IdProducto>
<ns0:_TipoProducto>{ data($Receta/ns1:TIPO)
}</ns0:_TipoProducto>
<ns0:_Id>{ data($recetas1/ns1:Receta[1]/ns1:CODPRES)
}</ns0:_Id>
</ns0:_Prescripcion>
}
</ns0:_PrescripcionCollection>
};

declare variable $recetas1 as element(ns1:Recetas) external;

xf:RecetasToBAMPrescripcion($recetas1)

e. This code contains the XQuery transformation with the changes
required to build a valid BAM Feeder request. Code is commented
to explain the reasoning behind the change. The BAM Feeder
distribution contains a set of request payload that may be used to
better understand how a request should bu built.
(:: pragma bea:global-element-parameter parameter="$recetas1" element="ns1:Recetas"
location="Recetas_Envio.xsd" ::)
(: The ‘request’ type is the root node for this document :)
(:: pragma bea:global-element-return element="ns0:request"
location="BamFeederXSD.xsd" ::)

declare namespace ns1 = "http://xmlns.osakidetza.net/services/RecetaElectronica";
declare namespace ns0 = "http://xmlns.oracle.com/bam";
(: Simplified this temporal namespace :)
declare namespace xf = "http://tempuri.org/RecetasToBAMPrescripcion/";

(: Return type is ‘request’ :)
declare function xf:RecetasToBAMPrescripcion($recetas1 as element(ns1:Recetas))
as element(ns0:request) {
<ns0:request>
(: Operation to execute (insert, remove, batch, upsert, update) :)
<ns0:operation>batch</ns0:operation>
(: BAM data object identificator :)
<ns0:objectType>/Osakidetza/Asistencial/Comun/Prescripcion</ns0:objectType>
(: Request payload :)
<ns0:payload>
{
for $Receta in $recetas1/ns1:Receta
return
(: The ‘batch’ operation requires an additional attribute :)
<ns0:_Prescripcion operation="insert">
<ns0:_Centro>{ data($Receta/ns1:CODCENPRES) }</ns0:_Centro>
<ns0:_Fecha>{ data($Receta/ns1:FECHAPRES) }</ns0:_Fecha>
<ns0:_IdProfesional>{ data($Receta/ns1:CODPRONALTIT)
}</ns0:_IdProfesional>
<ns0:_TotalRecetas>{
data($recetas1/ns1:Receta[1]/ns1:NUMRECETAS) }</ns0:_TotalRecetas>
<ns0:_TipoReceta>{ data($Receta/ns1:TIPORECETA)
}</ns0:_TipoReceta>
<ns0:_IdReceta>{ data($recetas1/ns1:Receta[1]/ns1:CODREC)
}</ns0:_IdReceta>
<ns0:_IdProducto>{ concat($recetas1/ns1:Receta[1]/ns1:CODUAP
, $recetas1/ns1:Receta[1]/ns1:CODFOR , $recetas1/ns1:Receta[1]/ns1:CODPF)
}</ns0:_IdProducto>

<ns0:_TipoProducto>{ data($Receta/ns1:TIPO)
}</ns0:_TipoProducto>
<ns0:_Id>{ data($recetas1/ns1:Receta[1]/ns1:CODPRES)
}</ns0:_Id>
</ns0:_Prescripcion>
}
</ns0:payload>
</ns0:request>
};

declare variable $recetas1 as element(ns1:Recetas) external;

xf:RecetasToBAMPrescripcion($recetas1)

f. Unless this changes are done to XQuery transformation (or any
other transformation you’ve created) the resulting payload will be
malformed.
6. Import required resources into OSB
a. Once every required resource has been created, they should be
imported into OSB to be used during runtime.
b. Log into OSB Console available at
http://localhost:7021/sbconsole. Create a change session and
select the project that contains the Prescription Notification
Service.
c. Some assets are required before modifying this service to use the
BAM Feeder. Import the BAM XML Schema and XQuery
transformation into the project.
- Select “Create Resource”, “XML Schema” and locate the
BAM XML Schema for the Prescription data object.
- Select “Create Resource”, “XQuery Transformation” and
locate the XQuery Transformation created in the last step.
d. Click on “Activate” to commit the changes in this session.

7. Update OSB service to publish BAM message
a. Now it’s time to close the loop and publish the transformed
payload to BAM using the BAM Feeder component.
b. Log into OSB Console available at
http://localhost:7021/sbconsole. Create a change session and
select the project that contains the Prescription Notification
Service.

c. Edit the proxy service flow. The message should only be
transformed and published to BAM on certain conditions – these
conditions depend on the business and should be defined by
business users. This example shows how the message is
transformed and published using the Routing node.
d. Edit the route node and add a Publish action to leverage OSB
BAM Feeder component. Click on “Add an action”,
“Communication”, “Publish”. Select
Oracle/BamFeeder/ProxyServices/ BamAsyncFeederLocalPS as
the service to publish the message.

e. The message to be published to BAM Feeder needs some
transformation. Otherwise, BAM server would receive a payload
with OSB service format that would be rejected.
f. Inside the Request Actions for the Publish Action, select “Add an
Action”, “Message Processing”, “Replace”. This action will be used
to replace the body with a transformed payload that matches the
BAM data object format.
- Set “.” as selected XPath.
- Set “body” as the variable
- Check “Replace node contents”

g. Click on “Expression” to select the XQuery transformation.
- Click on “XQuery Resources” in the upper menu.
- Click on “Browse” to select the XQuery resource. Select
the XQuery resource previously imported that transforms
from OSB source format to BAM target format.
- Use the “Variable Structures” menu options to navigate
the request and select the Xpath expression that binds
the XQuery input variable.
- Click on “Validate” and “Save”.

h. Click on “Save All” and “Activate” to commit the changes in this
session.
8. The Prescription Notification OSB Service is now intercepted and
configured to publish messages to BAM using the BAM Feeder. Next
section describes how to test it all.

3.3 Testing the solution
This section explains how to test the solution all together. At this point, the BAM
data object has been created and the OSB service leverages the BAM Feeder
to publish messages to BAM.
1. Monitor BAM Data Object
a. Open the BAM Console at http://localhost:9001/OracleBAM/.
b. Login and select “Architect” view.
c. Select “Data Objects” from the upper-left combo box. Navigate to
the prescription data object and click on “Contents”. You should
see an empty data object if no information has been published yet.
d. Keep this window open to monitor how this data object receives
published messages from OSB.

2. Test OSB BAM Feeder Integration
a. The Prescription Notification service at OSB has been intercepted
to publish messages to BAM using the BAM Feeder component.
b. Open the OSB Test Console for this service to execute a sample
request. Edit the request or load a preconfigured request payload
and click on “Execute”.

c. Get back to the BAM Architect window. Click on “Content” to
refresh the view. If the BAM Feeder integration is working and the
message payload is being transformed as expected, you should
now see the published items.

d. To further refine this example, a BAM Dashboard is created so
that prescriptions may be monitored by business users. To find

out more information on BAM Dashboards please refer to BAM
11g User Guide.

4 Key Takeaways and Recommendations
Oracle Service Bus is one the most valued products to solve integration issues
during the initial steps of a SOA initiative. OSB is specially designed to provide
solutions to deal with point-to-point integration, tight coupling and enterprise
application integration.
Effective monitorization becomes a key requirement once the OSB
infrastructure is in place and usage is widespread. OSB provides functionality to
monitor service’s health using metrics and alerts – however, this monitoring is
mostly oriented to technical users.
Oracle Business Activity Monitoring is the preferred product to give business
users the functional monitorization on their business services and processes in
the enterprise. Oracle BAM provides a real-time monitorization to correlate Key
Performance Indicators (KPIs) that is conceptually nearer to the business
domain.
Integrating OSB with BAM enables business users to leverage a huge amount
of information that is being intermediated at OSB services. This information may
be used fully exploit BAM capabilities and monitor business process, analyze
events as they occur and act on certain conditions.
There are different technical alternatives to integrate OSB with BAM. Regarding
BAM 11g, the prefered integration uses the BAM JCA adapter when this
configuration is supported. Other integration scenarios, like OSB 10gR3 and 3rd
party products, should leverage BAM Web Services.
This paper explores the technical details regarding the OSB-BAM integration for
OSB 10gR3 and BAM 11g using the BAM Web Services. A custom OSB
configuration is designed and analyzed so that using BAM Web Services from
within OSB becomes really simple.

About the Authors
Aritza Iratzagorria is the Lead Architect for Centralized IT at Osakidetza
(Basque Country Health Service). He has been working at the middleware
space for 9 years in different roles – operations, system administration and
corporate architecture. He’s currently focused on the SOA strategy deployment
at Osakidetza and has actively sponsored the SOA Center of Excellence for
Osakidetza IT Departament.
aritza.iratzagorriagaray@osakidetza.net

Nacho Lafuente is a Consulting Technical Manager at Oracle SOA Consulting.
He has been related to technology solutions in the middleware stack over the
last 10 years and has delivered many integration solutions to customers. He is
the SOA Client Architect for Osakidetza and helps this customer as a lead
member of the Osakidetza’s SOA Center of Excellence.
nacho.lafuente.botella@oracle.com

Osb Bam Integration

More Related Content

What's hot (20)

Similar to Osb Bam Integration (20)

Recently uploaded (20)

Osb Bam Integration