Copyright OASIS, 2004 Team Leader [email protected] Chair OASIS CAM TC Presentation November 16 th XML 2004 Washington DC ebXML Registry Interoperability

Copyright OASIS, 2004

Team [email protected] OASIS CAM TC

Presentation November 16th

XML 2004 Washington DC

ebXML RegistryebXML RegistryInteroperability DemonstrationInteroperability Demonstration

mailto:[email protected]


Scenario Showcase use of ebXML Registry to manage a

large community of participants in an e-Service and e-Business system

The service provider deploys the Registry as a central resource to allow partners to quickly join the community and integrate their own applications into the e-Service network

Partners can select the business process they want to use, pick the version(s) of transactions they can support, create their CPA configuration(s), test compliance, certify their ebMS systems and begin interacting


Scenario Interaction Roles

Industry Partners

XMLStructure

Rules

XMLStructure

Rules

TransportebMSserver

TransportebMSserver

Oracledatabase

Oracledatabase

CentralebXMLRegistry

CentralebXMLRegistry

CPAcheckCPA

checkCAM datavalidator

CAM datavalidator

PartnerManagementWeb forms


(Persistent Storage)CPA

instances

CPAinstances

CPAinstances

CPAinstances

System AdministratorsManage PartnerInteractions

ApplicantCompany

ApplicantInstitution

Proxy SubmissionService Provider

MessagesMessages

2222

1111

33334444

5555e-Service authority systemMessages

Messages


Sample Target Communities Typical applications include regulatory

submissions to e-Government e-Healthcare network providers Marketplace service providers such as

DOD EMall For this demonstration - focus is on

showing an e-Service based application


ebXML in a nutshell Globally developed standard (ISO15000)

for: Exchanging business messages

Conducting trading relationships

Defining and registering business processes

Communicating data in common terms

Assembling business transactions

Using Internet as delivery vehicle


ebXML in the News "As ebXML becomes standardized, it will

become the de facto way everyone does business."

--Tony Scott, CTO, General Motors

Interview in Information Week – March, 2004

http://www.informationweek.com/shared/printableArticle.jhtml?articleID=18201098




Industry Groups Backing

The Open Healthcare Group


How do you put this all together?

Action Event

InformationRuleWhatWhy

How When

Where / Who Where / Who Where / Who

Action Event


How When

Action Event


How When


OASIS standards utilized

ebXML Registry ebMS CPA BPSS CAM

version 2.5 version 2.0 version 2.0 version 2.0 version 1.0


Team Member Contributors :- Cyclone Commerce Adobe ebXMLsoft Registry NIST OASIS Registry, BPSS, CPA, ebMS

and CAM TC members


Agenda Who, What, Why and How?

Functional overview + Summary of components

Demonstration – Part1 Scenario walk-through

Message exchanges + Data Handler (application integration)

Component Drill-down – Part2

CPA setup + CPA validation

Transaction validation + Error handling

Summary


Functional OverviewFunctional Overview

Scenario and Deployment Constraints


Scenario Management

The service provider can post new releases of business processes to the registry and establish connections to the e-Service business applications using discreet CPA profiles that point to the appropriate production and test environments.

Partners then simply select the appropriate CPA ID to connect to.

Participant organization profiles, CPAs, schemas and business rule templates are all managed by the registry and are classified according to the domain structure in the e-Service community.


Technology Constraints Cross-platform support Work with common SQL databases Must be scalable and extensible Easy integration to back-end systems Should use open public and industry

standards wherever possible Security must be robust without being

restrictive


Processing Constraints Use XML based messaging Support exchange of PDF format document

attachments; as large as 50Mb size and up Handle peak daily volume of 1,000+ exchanges Be easy to deploy for typical internet enabled

partners server environment Provide self-service facilities with versioning Secure and legally sound approach that extends

existing paper based process authentication and intent models


Software Components Open Source components

‘Hermes’ freebXML ebXML messaging server ‘OMAR’ freebXML Registry system jCAM content assembly mechanism and

validation component with versioning capability Oracle database server Tomcat Server Cyclone messaging server ebXMLSoft Registry server


ebXML Solution Architecture

Capture Process Details withParticipant Roles / Contextand Message ExchangingDefinitions

Reference – Domain Ontology and

Semantic Information

Reference - Domain Transactions +

Business Process Models

References

Business AgreementTemplates

1111

Messaging System

Drives

Messaging System

Partner A Partner B

Exchanges 2222

Enveloping + RoutingTransactions + Validation

Handles

Queue Integration Agent

Controlled by3333

Processes – state management,

linking and switching

Integration – application system interactions

Manages4444BPSS + Workflow – Models of Interaction

Service / Actions

CAM XML templates – Business Exchange Formats and Rules

CPA – Exchange Agreements

Produces


Example Hub Deployment Setup

Application Integrationhandler

Application Integrationhandler

XMLStructure

Rules

XMLStructure

Rules

HubebMSserver

HubebMSserver

OracledatabaseOracle

database

ebXMLRegistryebXMLRegistry

CPAcheckCPA

checkMessagesMessages

PartnerebMSserver

PartnerebMSserver

ContentvalidationContent

validation

CPAinstances

CPAinstances



AdminServicesAdmin

Services

Audit and Control

Web forms

Audit and Control

Web formsExisting

Web-based Registration

Interface

Existing Web-based Registration

Interface

Existing backendApplication(s)

Existing backendApplication(s)

Application handler(staged delivery)

Application handler(staged delivery) Oracle App ServerOracle App Server


Building the BPSS model

DemoDemoDemoDemo


ebXML CPA / BPSS functions

ebXML BP identifies Business processes

including multi-party, multi-step exchanges

Roles an organization must play

Business transactions Messages being exchanged Context variables Business rules of edge

conditions Transaction handling

services Error handling

ebXML CPA provides: Service name and parameters Endpoint for invocation Role of an organization in the context

of a service Organization demographic information Failure scenarios Business process scenario and

business transaction activity step Link to partner responsibilities Transaction Messages being

exchanged Transport level QOS parameters Certificate and Encryption

configuration Business status of agreement


ebXML CPA visual editing

ParticipantInformation

Messagingpreferences

Message exchange details

(DUNSParty IDCompanyContactWeb siteProcessRoleStatusDescription)

DemoDemoDemoDemo

ProcessLinkage


Interaction Model

Data Handle rto / from Business

Application(s)

jCAMvalidationm odule

INTERNET

e-ServiceProvider

e-Serviceparticipant

Partne rCPA(s) Partne r

CPA(s)11

ebXMLebMS

ebXMLebMS

ebXMLRegistry

3

Exchan geDocume n ts

Exchan geDocume n ts

2

2

Excha ngeTra nsa ctions

Excha ngeTra nsa ctions

De live ryQue ueDe live ry

Que ue

Clie n t Use rIn te rface

Us e r Profile sCPA look upDocum e nt De fin itionsSche m a XSD

XM L s che m a

XM L s che m a

Data Handle rto / from Business

Application(s)

ebXM Lenveloping

anddelivery

S OA Pm essaging

4

4

5

5

6 6

configure

s

configures

EXCHANGING

TRANSACTIONS


Functional Summary Each hub consists of the following functional

components: ebXML messaging server for transaction exchange –

configured by CPA definitions ebXML registry server for management of CPA

documents and transaction definitions Verification component for exchange details – who and

what is allowed – (controlled via CPA) Validation component for exchange transactions –

business content information and format received (handled via jCAM XML template scripts)

User interface components to manage exchanges and partners

Transaction handler and integration emulation


Processing Configuration Details

ebM S

Partner CPA

SOAPm e s s age

ReceiveQ ueue

SendQ ueue

database

p artn e rp ro file s

ce rtificatesto re

activitylog

transactionhandler

applicationhandler

Registryservices

ebXMLRegistry

X M Lpa yl oa d

P DFdoc

Digita lCertifica te

ebX M Lenvel ope

CPA lookup

ebM Sprocessor

Hub CPA

schema check

business rules

jCA Mengine

integrationprocessor

GUI - CPAm anage m e nt

CPAinstance

files

ebXM Lm essages

ebXM Lm essages

CPA ID

CPA ID

Functionality: CPA management CPA driven validation Registry interfacing Content validation Messaging handling


DemonstrationDemonstration

Scenario walk-through Message exchangesData handler (application integration emulation)CPA setupCPA validationTransaction validationError handling


Scenario Walkthrough We have two servers setup, each with

Hermes server, Cyclone server, and then one with the Registry servers as well.

The two servers exchange messages with one acting as the central server (hub) that references the Registry to validate the CPA details it receives. This also runs the jCAM service to check transactions.

The data integration servlets provide the backend integration and workflow control


CPA lookupCPA lookup

UnpackSOAP

message

UnpackSOAP

message

Transaction Interaction

Integrationhandler

IntegrationhandlerXML

StructureRules

XMLStructure

Rules

ReceiveQueue

ReceiveQueue

ebXMLRegistryebXMLRegistry

RequestRequestPartnerebMSserver

PartnerebMSserver

CPAinstances

CPAinstances

HubebMSserver

HubebMSserver

AckAck

CPA checkCPA checkErrorError

Message Data Handler

Message Data Handler

ErrorError

ResponseResponse

jCAMvalidatorjCAM

validator

Staged Deliveryhandler

Staged Deliveryhandler


Demonstration1. Action – partner sends a message

Response – error – incorrect CPA details

2. Partner uses Registry to setup CPA and re-sends

Re-sends message with attachment Round-trip works and sends back response

3. Partner makes new message test Sends new message Validation checks if it is OK Sends back results

4. CPA action validation CPA is on-file – but that type of action not valid

DemoDemoDemoDemo


Part 2 – Specific Components

Drilldown into components


CPA Editing and Management We have created a screen

storyboard for the following scenarios: Existing partner wants to use

electronic submissions Proxy Service provider for participants Transaction validation services System Administration of CPA profiles

ViewViewFormsFormsViewView

FormsForms


Summary - CPA handling and use From messaging server – check that

CPA information does not match registry entry CPA entry missing from registry New CPA entry in registry

CPA management considerations Issuing secure CPA id values + hash to grantee details Sequencing CPA id based on service Secure unique lookup of CPA via registry API Managing incoming message versions Transitioning partners from test to production Remote management of partner systems

Review Review CPACPA

Review Review CPACPA


Aspects of Registry used Storage and retrieval in registry and

repository using registry services http-binding queries to retrieve CPA

instances Content Management Capabilities

Content classification Organization and user management Typing of content Security profiles and access control Associations (between CPA, Schema and jCAM)


Demonstration of ebXMLsoft Registry Functional components:

User and Organization management Security model Classification of content Generic XML content upload Content management: approval, status,

commenting, history, and user activity log Search features Accessing content programmatically

http accessing Servlet API

Ease of installation considerations Content Archiving

Demo Demo ofof

RegistryRegistry

Demo Demo ofof

RegistryRegistry

http://165.112.121.112:8081/registry/webgui/


jCAM validation error handling Overview of jCAM functionality Example of jCAM rules for

example transactions jCAM in action

valid transaction processing Invalid transaction processing

Integration with registry as validation service

On-lineOn-lineTestingTestingOn-lineOn-lineTestingTesting

MessageMessageReportingReportingMessageMessageReportingReporting

SimpleSimpleTemplateTemplateSimpleSimple

TemplateTemplate

ViewViewInput XMLInput XML

ViewViewInput XMLInput XML

ExtendedExtendedTemplateTemplateExtendedExtendedTemplateTemplate

OutputOutputFormattingFormatting

OutputOutputFormattingFormatting


Preview - jCAM and Registry Noun management is currently being

developed Noun format for storage in Registry Retrieval of noun definition from registry

using http-binding and LID() method on UID values from CAM template

Allows jCAM to automatically match rules from Registry noun definitions against XML content instances

For more details see OASIS CAM TC site


Linkage - Cyclone API Interchange SDK Document submission:

Enables a backend system to programmatically invoke the messaging capabilities of Interchange. (Usage of this API in 5.2 requires assistance of Cyclone Professional Services).

Eventing is already supported in CI 5 as a feature. It’s no longer an API.

Extensibility APIs: In-line processing. Allows user-defined Java classes to be

executed as the message is processed, produced or consumed.

Pluggable transports. Allows user-defined Java classes to implement transport protocols not supported out of the box, e.g. database-based transport.

Startup Services. User-defined Java classes can be run in the same JVM with the rest of the Cyclone application. As an example, this API may be used to set up services that need to be co-located for efficiency or consistency.


SummarySummary

Review of Demonstration


What You Just Saw ebXML components and configuration Installation details and operational details CPA management and configuration XML templates for validation via jCAM Review of message traffic and queues Management of automatic response messages Storyboard of user screens for CPA management Demonstration of on-line transaction testing service Configuration of application integration handlers


Lessons Learned Infrastructure exists today off-the-shelf to

create communities of partners You can use ebXML to manage and run an

e-Service environment The Registry provides crucial management

and facilitation services Providing self-service facilities is key to

rapid adoption


Implementation Planning Understand your business needs Identify business process and transactions Build community buy-in Create prototype deployment Verify with pathfinder partners Refine, configure, deploy!


www.freebXML.org

www.ebxml.org

www.oasis-open.org

www.ebxmlbook.com/interop

www.ebxmlbook.com/benefits

Resources:

Documents

Copyright OASIS, 2004 Team Leader [email protected] Chair OASIS CAM TC Presentation November 16 th XML 2004 Washington DC ebXML Registry Interoperability