W3C

Web Services Choreography Description Language Version 1.0

W3C Working Draft 27 April12 October 2004

This version:
http://www.w3.org/TR/2004/WD-ws-cdl-10-20040427/http://www.w3.org/TR/2004/WD-ws-cdl-10-20041012/
Latest version:
http://www.w3.org/TR/ws-cdl-10/
Previous version:
http://www.w3.org/TR/2004/WD-ws-cdl-10-20040427/
Editors:
Nickolaos Kavantzas, Oracle <nickolas.kavantzas@oracle.com>
David Burdett, Commerce One <david.burdett@commerceone.com>
GregGregory Ritzinger, Novell <gritzinger@novell.com>
Yves Lafon, W3C <ylafon@w3.org>

Abstract

The Web Services Choreography Description Language (WS-CDL) is an XML-based language that describes peer-to-peer collaborations of Web Services participantsparties by defining, from a global viewpoint, their common and complementary observable behavior; where ordered message exchanges result in accomplishing a common business goal.

The Web Services specifications offer a communication bridge between the heterogeneous computational environments used to develop and host applications. The future of E-Business applications requires the ability to perform long-lived, peer-to-peer collaborations between the participating services, within or across the trusted domains of an organization.

The Web Services Choreography specification is targeted for composing interoperableinteroperable, peer-to-peer collaborations between any type of Web Service participantparty regardless of the supporting platform or programming model used by the implementation of the hosting environment.

Status of this Document

This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at http://www.w3.org/TR/.

This is the First Publicsecond published Working Draft of the Web Services Choreography Description Language document. It should be the last version before Last Call WD.

It has been produced by the Web Services Choreography Working Group, which is part of the Web Services Activity.

Although the Working Group agreed to request publication of this document, this document does not represent consensus within the Working Group about Web Services choreography description language.This document is a chartered deliverable of the Web Services Choreography Working Group. It is an early stage document and major changesSome issues are expectedalready identified and in the near future.process of being fixed before going to Last Call, see the group's issue section.

This document is based upon the Working Draft published on 27 April 2004. Changes between these two versions are described in a diff document.

Comments on this document should be sent to public-ws-chor-comments@w3.org (public archive). It is inappropriate to send discussion emails to this address.

Discussion of this document takes place on the public public-ws-chor@w3.org mailing list (public archive) per the email communication rules in the Web Services Choreography Working Group charter.

This document has been produced under the 24 January 2002 CPP as amended by the W3C Patent Policy Transition Procedure. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) with respect to this specification should disclose the information in accordance with section 6 of the W3C Patent Policy. Patent disclosures relevant to this specification may be found on the Working Group's patent disclosure page.

Publication as a Working Draft does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.

Table of Contents

1 Introduction
    1.1 Notational Conventions
    1.2 Purpose of the Choreography Language
    1.3 Goals
    1.4 Relationship with XML and WSDL
    1.5 Relationship with Business Process Languages
2 Choreography Model
    2.1 Model Overview
    2.2 Choreography Document Structure
        2.2.1 Package
        2.2.2 Choreography document Naming and Linking
        2.2.3 Language Extensibility and Binding
        2.2.4 Semantics
    2.3 Coupling Web Service participantsCollaborating Parties
        2.3.1 RolesRole Types
        2.3.2 ParticipantsParticipant Types
        2.3.3 RelationshipsRelationship Types
        2.3.4 ChannelsChannel Types
    2.4 Information Driven Collaborations
        2.4.1 Information Types
        2.4.2 Variables
            2.4.2.1 Expressions
        2.4.3 Tokens
        2.4.4 Choreographies
        2.4.5 WorkUnits
            2.4.5.1 Reacting        2.4.6 Reusing existing Choreographies             2.4.6.1 Composing Choreographies             2.4.6.2 ImportingIncluding Choreographies
        2.4.7 Choreography Life-line
        2.4.8 Choreography Recovery
            2.4.8.1 Exception Block
            2.4.8.2 Finalizer Block
    2.5 Activities
        2.5.1 Ordering Structures
            2.5.1.1 Sequence
            2.5.1.2 Parallel
            2.5.1.3 Choice
        2.5.2 InteractionInteracting
            2.5.2.1 Interaction State Changes             2.5.2.2 InteractionBased Information Alignment
            2.5.2.3            2.5.2.2 Protocol Based Information Exchanges
            2.5.2.4            2.5.2.3 Interaction Life-line
            2.5.2.4 Interaction Syntax
        2.5.3 Performed ChoreographyComposing Choreographies
        2.5.4 Assigning Variables
        2.5.5 Marking Silent Actions
        2.5.6 Marking the Absence of Actions
with non-observable effects3 Example
4 Relationship with the Security framework
5 Relationship with the Reliable Messaging framework
6 Relationship with the Transaction/Coordination framework
7 Acknowledgments
8 References
9 WS-CDL XSD Schemas
10 WS-CDL Supplied Functions


1 Introduction

For many years, organizations have being developing solutions for automating their peer-to-peer collaborations, within or across their trusted domain, in an effort to improve productivity and reduce operating costs.

The past few years have seen the Extensible Markup Language (XML) and the Web Services framework developing as the de-facto choices for describing interoperable data and platform neutral business interfaces, enabling more open business transactions to be developed.

Web Services are a key component of the emerging, loosely coupled, Web-based computing architecture. A Web Service is an autonomous, standards-based component whose public interfaces are defined and described using XML. Other systems may interactioninteract with thea Web Service in a manner prescribed by its definition, using XML based messages conveyed by Internet protocols.

The Web Services specifications offer a communication bridge between the heterogeneous computational environments used to develop and host applications. The future of E-Business applications requires the ability to perform long-lived, peer-to-peer collaborations between the participating services, within or across the trusted domains of an organization.

The Web Service architecture stack targeted for integrating interacting applications consists of the following components:

The Web Services Choreography specification is targeted for composing interoperable, peer-to-peer collaborations between any type of Web Service participantparty regardless of the supporting platform or programming model used by the implementation of the hosting environment.

1.1 Notational Conventions

The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC-2119 [2].

The following namespace prefixes are used throughout this document:

Prefix Namespace URI Definition
wsdl http://www.w3.org/2004/03/wsdlhttp://www.w3.org/2004/08/wsdl WSDL namespace for WSDL framework.
cdl http://www.w3.org/2004/04/ws-chor/cdlhttp://www.w3.org/2004/10/ws-chor/cdl WSCDL namespace for Choreography language.
xsi http://www.w3.org/2000/10/XMLSchema-instancehttp://www.w3.org/2001/XMLSchema-instance Instance namespace as defined by XSD [10].[11].
xsd http://www.w3.org/2000/10/XMLSchemahttp://www.w3.org/2001/XMLSchema Schema namespace as defined by XSD [10].[12].
tns (various) The "this namespace" (tns) prefix is used as a convention to refer to the current document.
(other) (various) All other namespace prefixes are samples only. In particular, URIs starting with "http://sample.com""http://example.com" represent some application-dependent or context-dependent URIURIs [4].

This specification uses an informal syntax to describe the XML grammar of a WS-CDL document:

  • The syntax appears as an XML instance, but the values indicate the data types instead of values.

  • Characters are appended to elements and attributes as follows: "?" (0 or 1), "*" (0 or more), "+" (1 or more).

  • Elements names ending in "" (such as <element/> or <element>) indicate that elements/attributes irrelevant to the context are being omitted.

  • Grammar in bold has not been introduced earlier in the document, or is of particular interest in an example.

  • <-- extensibility element --> is a placeholder for elements from some "other" namespace (like ##other in XSD).

  • The XML namespace prefixes (defined above) are used to indicate the namespace of the element being defined.

  • Examples starting with <?xml contain enough information to conform to this specification; others examples are fragments and require additional information to be specified in order to conform.

XSD schemas are provided as a formal definition of WS-CDL grammar (see Appendix A).Section 9).

1.2 Purpose of the Choreography Language

Business or other activities that involve multiple different organizations or independent processes that collaborate usingare engaged in a collaborative fashion to achieve a common business goal, such as Order Fulfillment.

For the Web Services technology cancollaboration to work successfully, the rules of engagement between all the interacting parties must be successful if theyprovided. Whereas today these rules are properly integrated. To solve this problem,frequently written in English, a standardized way for precisely defining these interactions, leaving unambiguous documentation of the parties and responsibilities of each, is missing.

The Web Services Choreography specification is targeted for precisely describing peer-to-peer collaborations between any type of party regardless of the supporting platform or programming model used by the implementation of the hosting environment.

Using the Web Services Choreography specification, a contract containing a "global" definition of the common ordering conditions and constraints under which messages are exchanged is produced that describes from a global viewpoint the common and complementary observable behavior of all the Web Services participantsparties involved. Each participantparty can then use the global definition to build and test solutions that conform to it.

The main advantage of a contract with a global definition approach is that it separates the process being followed by an individual business or system within a "domain of control" from the definition of the sequence in which each business or system exchanges information with others. This means that, as long as the "observable" sequence does not change, the rules and logic followed within the domain of control can change at will.

In real-world scenarios, corporate entities are often unwilling to delegate control of their business processes to their integration partners. Choreography offers a means by which the rules of participation within a collaboration can be clearly defined and agreed to, jointly. Each entity may then implement its portion of the Choreography as determined by theirthe common view.

The figure below demonstrates a possible usage of the Choreography Language.

diagram of integration of different Web Services based applications

Figure 1: Integrating Web Services based applications using WS-CDL

In Figure 1, Company A and Company B wish to integrate their Web Services based applications. The respective Businessbusiness analysts at both companies agree upon the services involved in the collaboration, their interactions and their common ordering and constraint rules under which the interactions occur and then generate a Choreography Language based representation. In the case of Company A, relies onthis example, a BPEL4WS [18] solution. Company B, having greater legacy driven integration needs, relies on a J2EE [25] solution incorporating Java and Enterprise Java Bean Components or a .NET [26] solution incorporating C#. In this example,Choreography specifies the interoperability and interactions between services across business entities, while leaving actual implementation decisions in the hands of each individual company.company:

  • Company "A" relies on a WS-BPEL [18] solution to implement its own part of the Choreography

  • Company "B", having greater legacy driven integration needs, relies on a J2EE [25] solution incorporating Java and Enterprise Java Bean Components or a .NET [26] solution incorporating C# to implement its own part of the Choreography

Similarly, a Choreography can specify the interoperability and interactions between services within one business entity.

1.3 Goals

The primary goal of a Choreography Language for Web Servicesis to specify a declarative, XML based language that defines from a global viewpoint theirthe common and complementary observable behavior, where message exchanges occur, and when the jointly agreed ordering rules are satisfied.

Some additional goals of this definition language are to permit:

  • Reusability. The same choreographyChoreography definition is usable by different participantsparties operating in different contexts (industry, locale, etc.) with different software (e.g. application software)

  • CooperativeCooperation. Choreographies define the sequence of exchanging messages between two (or more) independent participantsparties or processes by describing how they should cooperate

  • Multi-Party Collaboration. Choreographies can be defined involving any number of participantsparties or processes

  • Semantics. Choreographies can include human-readable documentation and semantics for all the components in the choreographyChoreography

  • Composability. Existing Choreographies can be combined to form new Choreographies that may be reused in different contexts

  • Modular.Modularity. Choreographies can be defined using an "import""inclusion" facility that allows a choreographyChoreography to be created from componentsparts contained in several different Choreographies

  • Information Driven Collaboration. Choreographies describe how participants that take part in Choreographies maintain where they are in the Choreography by recording theirparties make progress within a collaboration, when recordings of exchanged information and theobservable state changes caused by these exchanges ofinformation and also their reactionschanges cause ordering constraints to thembe fulfilled

  • Information Alignment. Choreographies allow the participantsparties that take part in Choreographies to communicate and synchronize their observable stateinformation changes and the actual values of the exchanged information as well

  • Exception Handling. Choreographies can define how exceptional or unusual conditions that occur whilstwhile the choreographyChoreography is performed are handled

  • Transactionality. The processes or participantsparties that take part in a choreographyChoreography can work in a "transactional" way with the ability to coordinate the outcome of the long-lived collaborations, which include multiple, often recursive collaboration units, each with its own business rules and goals

  • Compatibility with other SpecificationsSpecification Composability. This specification will work alongside and complement other specifications such as the WS-Reliability [22], WS-Composite Application Framework (WS-CAF) [21], WS-Security [24], Business Process Execution Language for WS (BPEL4WS)(WS-BPEL) [18], etc.

1.4 Relationship with XML and WSDL

This specification depends on the following specifications: XML 1.0 [9], XML-Namespaces [10], XML-Schema 1.0 [11, 12] and XPath 1.0 [13]. In addition, support for importingincluding and referencing service definitions given in WSDL 2.0 [7] is a normative part of this specification.

1.5 Relationship with Business Process Languages

A Choreography Language is not an "executable business process description language" [16, 17, 18, 19, 20] or an implementation language [23]. The role of specifying the execution logic of an application will be covered by these specifications; by enabling the definition of the control flows (such as conditional, sequential, parallel and exceptional execution) and the rules for consistently managing their non-observable business data.specifications.

A Choreography Language does not depend on a specific business process implementation language. Thus, it can be used to specify trullytruly interoperable, peer-to-peer collaborations between any type of Web Service participantparty regardless of the supporting platform or programming model used by the implementation of the hosting environment. Each participantparty, adhering to a Choreography Language collaboration representation, could be implemented byusing completely different languagesmechanisms such as:

  • Web Services applications,Applications, whose implementation is based on executable business process languages [16, 17, 18, 19, 20]

  • Web Services applications,Applications, whose implementation is based on general purpose programming languages [23, 26]

  • Or human controlled software agents

2 Choreography Model

This section introduces the Web Services Choreography Description Language (WS-CDL) model.

2.1 Model Overview

WS-CDL describes interoperable, peer-to-peer collaborations between Web Service participants.parties. In order to facilitate these collaborations, services commit on mutual responsibilities by establishing Relationships. Their collaboration takes place in a jointly agreed set of ordering and constraint rules, whereby messages are exchanged between the participants.parties.

The Choreography model consists of the following notations:

  • Participants, Roles and Relationships - In a ChoreographyChoreography, information is always exchanged between Participants,Participants within the same or across trust boundaries

  • Types, Variables and Tokens - Variables contain information about commonly observable objects in a collaboration, such as the messages exchanged or the stateobservable information of the Roles involved. Tokens are aliases that can be used to reference parts of a Variable. Both Variables and Tokens have Types that define the structure of what the Variable or Token contains

  • Choreographies - A Choreography allows defining collaborations between peer-to-peerinteracting business processes:peer-to-peer parties:

  • Choreography Composition allows the creation of new Choreographies by reusing existing Choreography definitions

  • Choreography Life-line expresses the progression of a collaboration. Initially, the collaboration is started at a specific business process, then work is performed within itby following the Choreography and finally itthe Choreography completes, either normally or abnormally

  • Choreography Recovery consists of:

    • Choreography Exception Block - describes how to specify what additional interactions should occur when a Choreography behaves in an abnormal way

    • Choreography Finalizer Block - describes how to specify what additional interactions should occur to reverse the effect of an earlier successfully completed choreographyChoreography

  • Channels - A Channel realizes a point of collaboration between participantsparties by specifying where and how to exchangeinformation is exchanged

  • WorkUnits - A WorkUnitWork Unit prescribes the constraints that must be fulfilled for making progress and thus performing actual work within a Choreography

  • Interactions - An Interaction is the basic building block of a Choreography, which results in exchange of messages between participants and possible synchronization of their states and the actual values of the exchanged informationActivities and Ordering Structures - Activities are the lowest level components of the Choreography that perform the actual work. Ordering Structures combine activities with other Ordering Structures in a nested structure to express the ordering conditions in which the messages in the choreographyChoreography are exchanged

  • SemanticsInteraction Activity - Semantics allowAn Interaction is the creationbasic building block of descriptionsa Choreography, which results in an exchange of messages between parties and possible synchronization of their observable information changes and the actual values of the exchanged information

  • Semantics - Semantics allow the creation of descriptions that can record the semantic definitions of almostevery single component in the model

2.2 Choreography Document Structure

A WS-CDL document is simply a set of definitions. The WS-CDL definitions areEach definition is a named constructsconstruct that can be referenced. There is a package element at the root, and the individual Choreography type definitions inside.

2.2.1 Package

A WS-CDL package contains a set of one or more Choreographies andChoreography Package aggregates a set of one or more collaborationChoreography type definitions, allowingprovides a namespace for the definitions and through the various types whoseuse may be wider than a singleof XInclude [27], syntactically includes Choreography to betype definitions that are defined once. Thein other Choreography Packages.

The syntax of the package construct is:;

<package  
   name="ncname" 
   author="xsd:string"?
   version="xsd:string"
   targetNamespace="uri"
   xmlns="http://www.w3.org/2004/10/ws-chor/cdl/">
   informationType*
   token*
   tokenLocator*
   roleType*
   relationshipType*
   participantType*
   channelType*
   Choreography-Notation*
</package>

The Choreography Package contains:

  • Zero or more Import definitions Zero or moreInformation Types

  • Zero or more Token typesTokens and Token Locators

  • Zero or more Role typesTypes

  • Zero or more Relationship typesTypes

  • Zero or more ParticipantsParticipant Types

  • Zero or more Channel typesTypes

  • Zero or more, package-levelmore Package-level Choreographies

The syntaxtop-level attributes name, author, and version define authoring properties of the package construct is:; <package name="ncname" author="xsd:string"? version="xsd:string" targetNamespace="uri" xmlns="http://www.w3.org/2004/04/ws-chor/cdl"> importDefinitions* informationType* token* tokenLocator* role* relationship* participant* channelType* Choreography-Notation* </package> The package construct allows aggregating a set ofChoreography definitions, where the elements informationType, token, tokenLocator, role, relationship, participant and channelType are shared by all the Choreographies defined within this package.document.

The targetNamespace attribute provides the namespace associated with all definitions contained in this package.Package. Choreography definitions importedincluded to this packagePackage using the inclusion mechanism, may be associated with other namespaces.

The top-level attributes author,elements informationType, token, tokenLocator, roleType, relationshipType, participantType and version, define authoring properties ofchannelType are shared by all the Choreography document.Choreographies defined within this Package.

Within a WS-CDL Package, language constructs that need to be uniquely named MUST use the attribute name for specifying a distinct name.

2.2.2 Choreography document Naming and Linking

WS-CDL documents MUST be assigned a name attribute of type NCNAME that serves as a lightweight form of documentation.

The targetNamespace attribute of type URI MUST be specified.

The URI MUST NOT be a relative URI.

A reference to a definition is made using a QName.

Each definition type has its own name scope.

Names within a name scope MUST be unique within a WS-CDL document.

The resolution of QNames in WS-CDL is similar to the resolution of QNames described by the XML Schemas specification [11].

2.2.3 Language Extensibility and Binding

If desired to extendTo support extending the WS-CDL language, this specification allows inside a WS-CDL documentthe use of extensibility elements and/or attributes defined in other XML namespaces. Extensibility elements and/or attributes MUST use an XML namespace different from that of WS-CDL. All extension namespaces used in a WS-CDL document MUST be declared.

Extensions MUST NOT change the semantics of any element or attribute from the WS-CDL namespace.

2.2.4 Semantics

Within a WS-CDL document, descriptions will be required to allow the recording of semantics definitions. The optional description sub-element is used as a textual description for documentation purposes. This element is allowed inside any WS-CDL language element.

The information provided by the description element will allow for the recording of semantics in any or all of the following ways:

  • Text. This will be in plain text or possibly HTML and should be brief

  • Document Reference. This will contain a URLURI to a document that more fully describes the component. For example on the top level Choreography Definition that might reference a complete paper

  • Structured Attributes. This will contain machine processable definitions in languages such as RDF or OWL

Descriptions that are Texttext or Document Referencesdocument references can be defined in multiple different human readable languages.

2.3 Coupling Web Service participantsCollaborating Parties

The WSDL specification [7] describes the functionality of a service provided by a participantparty based on a stateless, connected,client-server model. The emerging Web Based applications require the ability to exchange messages in a peer-to-peer environment. In these typetypes of environmentenvironments a participantparty represents a requester of services provided by another participantparty and is at the same time a provider of services requested from other participants,parties, thus creating mutual multi-participantmulti-party service dependencies.

A WS-CDL document describes how a Web Service participantparty is capable of engaging in peer-to-peer collaborations with the same participantparty or with different participants. Within a Choreography, information is always exchanged between Participants .parties.

The RolesRole Types, Participant Types, Relationship Types and ChannelsChannel Types define the coupling of the collaborating Web Services participants.parties.

2.3.1 RolesRole Types

A Role Type enumerates the observable behavior a participantparty exhibits in order to collaborate with other participants.parties. For example the Buyer Role Type is associated with purchasing of goods or services and the Supplier Role Type is associated with providing those goods or services for a fee.

The syntax of the roleroleType construct is:;

 <role name="ncname" ><roleType name="ncname">
   <behavior name="ncname" interface="qname"? />+
 </role></roleType>

The attribute name is used for specifying a distinct name for each roleType element declared within a Choreography Package.

Within the roleroleType element, the behavior element specifies a subset of the observable behavior a participantparty exhibits. A Role Type MUST contain one or more behavior elements.

The behavior element defines an optional interface attribute, which identifies a WSDL interface type. A behavior without an interface describes a Role Type that is not required to support a specific Web Service interface.

2.3.2 ParticipantsParticipant Types

A Participant Type identifies a set of related Roles. For example a Commercial Organization could take both a BuyerRole when purchasing goods and a Seller Role when selling them.Types that MUST be implemented by the same entity or organization. Its purpose is to group together the parts of the observable behavior that MUST be implemented by the same process.

The syntax of the participantparticipantType construct is:;

 <participant<participantType name="ncname">
   <role type="qname" />+
 </participant> 2.3.3 Relationships A</participantType>

The attribute name is used for specifying a distinct name for each participantType element declared within a Choreography Package.

An example is given below where the "SellerForBuyer" Role Type belonging to a "Buyer-Seller" Relationship Type is implemented by the association of two Roles forParticipant Type "Broker" which also implements the "SellerForShipper" Role Type belonging to a purpose."Seller-Shipper" Relationship Type:

<participantType name="Broker">
   <role type="tns:SellerForBuyer" />
   <role type="tns:SellerForShipper" />
</participantType>

2.3.3 Relationship Types

A Relationship representsType identifies the possible ways in whichRole Type and Behaviors where mutual commitments between two Roles can interact.parties MUST be made for them to collaborate successfully. For example the RelationshipsRelationship Types between a Buyer and a Seller could include:

  • A "Purchasing" Relationship,Relationship Type, for the initial procurement of goods or services, and

  • A "Customer Management" Relationship Type to allow the Supplier to provide service and support after the goods have been purchased or the service provided

Although RelationshipsRelationship Types are always between two Roles,Role Types, Choreographies involving more than two RolesRole Types are possible. For example if the purchase of goods involved a third-party Shipper contracted by the Supplier to deliver the Supplier's goods, then, in addition to the Purchasing and Customer Management RelationshipsRelationship Types described above, the following RelationshipsRelationship Types might exist:

  • A "Logistics Provider" Relationship Type between the Supplier and the Shipper, and

  • A "Goods Delivery" Relationship Type between the Buyer and the Shipper

The syntax of the relationshiprelationshipType construct is:;

 <relationship<relationshipType name="ncname">
   <role type="qname"  behavior="ncname"behavior="list of ncname"? />
   <role type="qname"  behavior="ncname"behavior="list of ncname"? />
 </relationship></relationshipType>

The attribute name is used for specifying a distinct name for each relationshipType element declared within a Choreography Package.

A relationshiprelationshipType element MUST have exactly two role typesRole Types defined.

Within the role element, the behavioroptional attribute points tobehavior identifies the commitment of a party as a list of behavior types belonging to the Role Type specified by the type withinattribute of the role typeelement. If the behavior attribute is missing then all the behaviors belonging to the Role Type specified by the type attribute of the role element.element are identified as the commitment of a party.

2.3.4 ChannelsChannel Types

A Channel realizes a point of collaboration between participantsparties by specifying where and how to exchange information.information is exchanged. Additionally, Channel information can be passed among participants.parties. This allows modeling howthe destinationmodeling of messages is determined, staticallyboth static and dynamically,dynamic message destinations when collaborating within a Choreography. For example, a Buyer could specify Channel information to be used for sending delivery information. The Buyer could then send the Channel information to the Seller who then forwards it to the Shipper. The Shipper could then send delivery information directly to the Buyer using the Channel information originally supplied by the Buyer.

A Channel Type MUST describe the Role Type and the type of a Web Servicereference type of a participant,party, being the target of an Interaction, which is then used for determining where and how to send/receive information to/into the participant.party.

A Channel Type MAY specify the instance identity of a business processan entity implementing the behaviorbehavior(s) of a participant,party, being the target of an Interaction.

A Channel Type MAY describe one or more logical conversations between participants,parties, where each conversation groups a set of related message exchanges.

One or more Channel(s) MAY be passed around from one Role to another. A Channel Type MAY restrict the types of Channel(s)Channel Type(s) allowed to be exchanged between the Web Services participants,parties, through a Channel of this Channel.Channel Type. Additionally, a Channel Type MAY restrict its usage by specifyingthe number of times a Channel can beof this Channel Type is used.

The syntax of the channelType construct is:;

<channelType  name="ncname"
    usage="once"|"unlimited"?
    action="request-respond"|"request"|"respond"? >
  <passing  channel="qname"
        action="request-respond"|"request"|"respond"?
         new="true"|"false"?new="xsd:boolean"? />*
  <role  type="qname"  behavior="ncname"? />
  <reference>
     <token  type="qname"/>+type="qname"/>
  </reference>
  <identity>
     <token  type="qname"/>+
   </identity>*</identity>?
</channelType>

The attribute name is used for specifying a distinct name for each channelType element declared within a Choreography Package.

The optional attribute usage is used to restrict the number of times a Channel can be used.

The optional element passing restrictsdescribes the Channel(s) allowed to beChannel Type(s) that are exchanged from one Role Type to another Role,Role Type, when using a Channel of this Channel Type in an Interaction. In the case where the operation used to exchange the Channel is of request-response type, then the attribute action within the passing element defines if the Channel will be exchanged during the request or during the response. The Channels exchanged canMAY be used in subsequent Interaction activities. If the element passing is missing then this Channel canType MAY be used for exchanging business documents and all types of ChannelsChannel Types without any restrictions.

The element role is used to identify the Role Type of a participant,party, being the target of an Interaction, which is then used for statically determining where and how to send/receivesend or receive information to/intoto or into the participant.party.

The element reference is used for identifyingdescribing the WSDL servicereference type of a participant,party, being the target of an Interaction, which is then used for dynamically determining where and how to send/receivesend or receive information to/intoto or into the participant.party. The service reference of a participantparty is distinguished by a set ofToken typesas specified by the token element within the reference element.

The optional element identity MAY be used for identifying an instance of a business processan entity implementing the behavior of a participantparty and for identifying a logical conversation between participants.parties. The businessprocess identity and the different conversations are distinguished by a set of Token typesTokens as specified by the token element within the identity element.

The following rule applies for Channel Type:

  • If two or more Channel Types SHOULD point to Role Types that MUST be implemented by the same entity or organization, then the specified Role Types MUST belong to the same Participant Type. In addition the identity elements within the Channel Types MUST have the same number of Tokens with the same informationTypes specified in the same order

The example below shows the declarationdefinition of the Channel typeType RetailerChannel. The Channel Type identifies the Role type tns:Retailer.Type as the "tns:Retailer". The address of the Channel is specified in the reference element, whereas the businessprocess instance can be identified using the identity element.element for correlation purposes. The passing element allows only a Channel instance of the ConsumerChannel Type to be sent over the RetailerChannel.;RetailerChannel Type.;

<channelType name="RetailerChannel">
  <passing channel="ConsumerChannel" action="request" />
  <role type="tns:Retailer" behavior="retailerForConsumer"/>
  <reference>
    <token type="tns:retailerRef"/>
  </reference>
  <identity>
    <token type="tns:purchaseOrderID"/>
  </identity>
</channelType>

2.4 Information Driven Collaborations

Parties make progress within a collaboration, when recordings of exchanged information and observable information changes cause ordering constraints to be fulfilled. A WS-CDL document allows defining information within a Choreography that can influence the observablebehavior of the collaborating participants.parties.

Variables containcapture information about objects in the ChoreographyChoreography, such as the messages exchanged or the stateobservables information of the Roles involved. TokensToken are aliases that can be used to reference parts of a Variable. Both Variables and Tokens have Information Types that define the data structuretype of whatinformation the Variable or Token contains.contain.

2.4.1 Information Types

Information types describe the type of information used within a Choreography. By introducing this abstraction, a Choreography definition avoids referencing directly the data types, as defined within a WSDL document or an XML Schema document.

The syntax of the informationType construct is:;

<informationType name="ncname";                 type="qname"? | element="qname"? />

The attribute name is used for specifying a distinct name for each informationType element declared within a Choreography Package.

The attributes type, and element describe the document to be an XML Schema type, or an XML Schema element respectively. The document is of one of these types exclusively.

2.4.2 Variables

Variables capture information about objects in a Choreography as defined by the Variable Usagetheir usage:

  • Information Exchange Capturing Variables that, which contain information such as an Order that is used to:to

    • Populate the content of a message to be sent, or

    • Populated as a result of a message received

  • State Variables thatCapturing Variables, which contain observableinformation about the Stateobservable changes of a Role as a result of information being exchanged. For example: Whenexample when a Buyer sends an orderOrder to a Seller, the Buyer could have a StateVariable called "OrderState" set to a value of "OrderSent" and once the message was received by the Seller, the Seller could have an Statea Variable called "OrderState" set to a value of "OrderReceived". Note that the variableVariable "OrderState" at the Buyer is a different variableVariable to the "OrderState" at the Seller

  • Once an order is received, then it might be validated and checked for acceptability in other ways that affect how the Choreography is performed. This could require additional states to be defined for "Order State", such as: "OrderError", which means an error was detected that stops processing of the message, "OrderAccepted", which means that there were no problems with the Order and it can be processed, and "OrderRejected", which means, although there were no errors, it cannot be processed, e.g. because a credit check failedChannel Capturing Variables. For example, a Channel Variable could contain information such as the URL to which the message shouldcould be sent, the policies that are to be applied, such as security, whether or not reliable messaging is to be used, etc.

The value of Variables:

  • Is available to all theRoles by initializing them prior to the start ofwithin a Choreography CommonChoreography, when the Variables thatcontain information that is common knowledge to two or more Roles, e.g.knowledge. For example the Variable "OrderResponseTime" which is the time in hours in which a response to an Order must be sent is initialized prior to the initiation of a Choreography and can be used by all Roles within the Choreography

  • Can be made available as a result of an Interaction

    • Information Exchange Capturing Variables are populated and become available at the Roles in the ends of an Interaction

    • State Capturing Variables, that contain information about the observable information changes of a Role by populating themas a result of an Interactioninformation being exchanged, are recorded and become available

  • Can be created or changed and made available locally at a Role by assigning data from other information Locally Defined Variables that contain information created and changed locally by a Role.information. They can be Information Exchange, State or Channel Variables as well as variables of other types.Capturing Variables. For example "Maximum Order Amount" could be data created by a sellerSeller that is used together with an actual order amount from an Order received to control the ordering of the Choreography. In this case how Maximum"Maximum Order AmountAmount" is calculated and its value would not be known by the other Roles

  • Can be used to determine the decisions and actions to be taken within a Choreography

The variableDefinitions construct is used for declaringdefining one or more variablesVariables within a Choreography block.

The syntax of the variableDefinitions construct is:;

<variableDefinitions>
   <variable   name="ncname"
       informationType="qname"|channelType="qname"
       mutable="true|false"?
       free="true|false"?
        silent-action="true|false"? role="qname"?silentAction="true|false"?
       roleType="qname"? />+
</variableDefinitions>

The declared variablesdefined Variables can be of the following types:

  • Information Exchange Capturing Variables, State Capturing Variables. The attribute informationType describes the type of the variableobject captured by the Variable

  • Channel Capturing Variables. The attribute channelType describes the type of the Channelchannel object captured by the Variable

The optional attribute mutable, when set to "false" describes that the variableVariable information when initialized, cannot change anymore. The optionaldefault value for this attribute is "true".

The optional attribute free, when set to "true" describes that a variable declaredVariable defined in an enclosing Choreography is also used in this Choreography, thus sharing the variableVariables information. When the attribute free is set to "true", the variableThe following rules apply in this case:

  • The type of a free Variable MUST match the type of the variable declaredVariable defined in thean enclosing Choreography.Choreography

  • A perform activity MUST bind a free Variable defined in an enclosed Choreography with a Variable defined in an enclosing Choreography when sharing the Variables information

The optional attribute free, when set to "false" describes that a variableVariable is declareddefined in this Choreography.

WhenThe default value for the attributefree attribute is set to "false", the variable resolves to the closest enclosing Choreography, regardless of the type of the variable."false".

The optional attribute silent-action,silentAction, when set to "true" describes that activitiesthere SHOULD NOT be any activity used for makingcreating or changing this variable available MUST NOT be presentVariable in the Choreography.Choreography, if these operations should not be observable to other parties. The default value for this attribute is "false".

The optional attribute roleroleType is used to specify the locationRole Type of a party at which the variableVariable information will reside.

The following rules apply to Variable Declarations: IfDefinitions:

  • The attribute name is used for specifying a distinct name for each variable iselement declared within a variableDefinitions element when needed. The Variables with Role Type not specified MUST have distinct names. The Variables with Role Type specified MUST have distinct names, when their Role Type is the same

  • A Variable defined without a Role, itRole Type is impliedequivalent to a Variable that itis declareddefined at all the RolesRole Types that are part of the RelationshipsRelationship Types of the Choreography.Choreography where the Variable is defined. For example if Choreography C1 has Relationship Type R that has a tuple (Role1, Role2), then a variableVariable x defined in ChreographyChoreography C1 without a RoleroleType attribute means it is declareddefined at Role1 and Role2

The variable with channelType MUST be declared without a role attribute2.4.2.1 Expressions

Expressions are used in an assign activitywithin WS-CDL to obtain existing information and to create new variable information by generating it from a constant value.or change existing information.

Predicate expressions are used in a Work Unitwithin WS-CDL to specify its Guard condition.conditions. Query expressions are used within WS-CDL to specify query strings.

The language used in WS-CDL for specifying expressions and query or conditional predicates is XPath 1.0.

Additionally,WS-CDL defines XPath function extensions as described in Appendix B.Section 10. The function extensions are defined in the standard WS-CDL namespace "http://www.w3.org/2004/10/ws-chor/cdl". The prefix "cdl:" is associated with this namespace.

2.4.3 Tokens

A Token is an alias for a piece of data in a variableVariable or message that needs to be used by a Choreography. Tokens differ from Variables in that Variables contain values whereas Tokens contain information that defines the piece of the data that is relevant. For example a Token for "Order Amount" within an Order businessXML document could be an alias for an expression that pointed to the Order Amount element within anthe Order XML document. This could then be used as part of a condition that controls the ordering of a Choreography, for example "Order Amount > $1000".

All Tokens MUST have a type,an informationType, for example, an Order Amount"Order Amount" would be of type amount, Order Id"amount", "Order Id" could be alphanumeric and a counter an integer.

Tokens types reference a document fragment within a Choreography definition and Token Locators provide a query mechanism to select them. By introducing these abstractions, a Choreography definition avoids depending on specific message parts,types, as described by WSDL, or a specific query string, as specified by XPATH, but instead the parts orthe query string can change without affecting the Choreography definition.

The syntax of the token construct is:;

<token  name="ncname"  informationType="qname" />

The attribute name is used for specifying a distinct name for each token element declared within a Choreography Package.

The attribute informationType identifies the type of the document fragment.

The syntax of the tokenLocator construct is:;

<tokenLocator  tokenName="qname" 
      informationType="qname" 
      query="XPath-expression"? />

The attribute tokenName identifies the name of the token typeToken that the document fragment locator is associated with.

The attribute informationType identifies the type on which the query is performed to locate the token.Token.

The attribute query defines the query string that is used to select a document fragment within a document.

The example below shows that the token purchaseOrderIDToken "purchaseOrderID" is of type xsd:int. The two tokenLocators show how to access this token in "purchaseOrder" and "purchaseOrderAck" messages.;

<token name="purchaseOrderID" informationType="xsd:int"/>
<tokenLocator tokenName="tns:purchaseOrderID" informationType="purchaseOrder"       
                 part="PO"query="/PO/OrderId"/>
<tokenLocator tokenName="tns:purchaseOrderID" informationType="purchaseOrderAck" 
                 part="POAck"query="/POAck/OrderId"/>

2.4.4 Choreographies

A WS-CDL document explicitly prescribes the rules, agreed between Web Service participants, that govern the ordering of exhanged messages and the provisioning of alternative patterns of behavior.. The operational semantics of these rules are based on the information-driven computational model, where availability of variable information causes a guarded unit-of-work and its enclosed actions to be enabled.

A Choreography allows constructing global compositions of Web Service participants by explicitly asserting theirChoreography. defines re-usable the common rules, that govern the ordering of exhanged messages and complementary observable behaviors.the provisioning patterns of collaborative behavior, agreed between two or more interacting peer-to-peer parties

A Choreography declareddefined at the packagePackage level is called a top-level Choreography, and does not share its context with other top-level Choreographies. A Choreography performed within another Choreography is called an enclosed Choreography. APackage MUSTMAY contain exactly one top-level Choreography, that is explicitlymarked explicitly as the root Choreography.

The rootA Choreography isdefines the only top-level Choreographyre-usable the common rules, that govern the ordering of exhanged messages and the provisioning patterns of behavior, as the action(s) performing the actual work, such as exchange of messages, when the specified ordering constraints are satisfied.

The re-usable behavior encapsulated within a Choreography MAY be initiated.performed within an enclosing Choreography, thus facilitating recursive composition. The rootperformed Choreography is enabled when itthen called an enclosed Choreography.

The Choreography that is initiated. All non-root, top-level Choreographiesperformed MAY be enabled when performed. Adefined either:

  • Locally - they are contained, in the same Choreography facilitates recursive composition, where combining two or more Choreographies can form a new enclosingdefinition as the Choreography that may be re-usedperformed them

  • Globally - they are specified in different contexts. Aa separate top-level Choreography definition that is defined in the same or in a different Choreography Package and can be used by other Choreographies and hence the contract is reusable

A Choreography MUST contain at least one Relationship type,Type, enumerating the observable behavior this Choreography requires its participantsparties to exhibit. One or more RelationshipsRelationship Types MAY be defined within a Choreography, modeling multi-participantmulti-party collaborations.

A Choreography acts as a lexical name scoping context as it restricts the visibility of variable information.for Variables. A variableVariable defined in a Choreography is visible for use in this Choreography and all its enclosed Choreographies,Choreographies up-to the point that the Variable is re-defined as an non-free Variable, thus forming a Choreography Visibility Horizon for this Variable.

A Choreography MUST containsMAY contain one or more Choreography definitions that MAY be performed only locally within this Choreography.

A Choreography MUST contain an Activity-Notation. The Activity-Notation specifies the enclosed actions of the Choreography that perform the actual work.

A Choreography can recover from exceptional conditions and provide finalization actions by defining:

  • One Exception block, which MAY be defined as part of the Choreography to recover from exceptional conditions that can occur in that enclosing Choreography

  • One Finalizer block, which MAY be defined as part of the Choreography to provide the finalization actions for that enclosing Choreography

The Choreography-Notation is used to define a root or a top-levelChoreography. The syntax is:;

<choreography  name="ncname"
      complete="xsd:boolean XPath-expression"?
       isolation="dirty-write"| "dirty-read"|"serializable"?isolation="dirty-write"|"dirty-read"|"serializable"?
      root="true"|"false"? >
   <relationship  type="qname" />+
   variableDefinitions?
   Choreography-Notation*
      Activity-Notation
   <exception  name="ncname">
        WorkUnit-Notation+
   </exception>?
   <finalizer  name="ncname">
        WorkUnit-Notation
   </finalizer>?
</choreography>

The attribute name is used for specifying a distinct name for each choreography element declared within a Choreography Package.

The optional complete attribute allows to explicitly complete a Choreography as described below in the Choreography Life-line section.

The optional isolation attribute specifies when a variableVariable information that is declareddefined in an enclosingenclosing, and changed within an enclosed Choreography is visibleavailable to its enclosing andsibling Choreographies:

  • When isolation is set to "dirty-write", the variableVariable information canMAY be immediately overwritten by actions in other Choreographies

  • When isolation is set to "dirty-read", the variableVariable information isMAY be immediately visible for read but not for write to other Choreographies

  • When isolation is set to "serializable", the variableVariable information isMUST be visible for read or for write to other Choreographies only after this Choreography has ended successfully

The relationship element within the choreography element enumerates the Relationships this Choreography MAY participate in.

The optional variableDefinitions element declaresenumerates the variables that are visibleVariables defined in this Choreography and all its enclosed Choreographies and activities.Choreography.

The optional root element marks a top-level Choreography as the root Choreography of a package.Choreography Package.

The optional Choreography-Notation within the choreography element declaresdefines the Choreographies that MAY be performed only within this Choreography.

The optional exception element defines the Exception block of a Choreography by specifying one or more Exception Work Unit(s).

The optional finalizer element defines the Finalizer block of a Choreography by specifying one Finalizer Work Unit.

2.4.5 WorkUnits

A Work Unit prescribes the constraints that must be fulfilled for making progress and thus performing actual work within a Choreography. Examples of a Work Unit include:

  • A Send PO Work Unit that includes Interactions for the Buyer to send an Order, the Supplier to acknowledge the order, and then later accept (or reject) the order.Order. This work unitWork Unit would probably not have a Guardguard condition

  • An Order Delivery Error Work Unit that is performed whenever the Place Order Work Unit did not reach a "normal" conclusion. This would have a Guardguard condition that identifies the error, see also Choreography Exceptions and Transactionserror

  • A Change Order Work Unit that can be performed whenever an order acknowledgement message has been received and an order rejection has not been received

A Work Unit canMAY prescribe the explicit rules for enforcing theconstraints that preserve the consistency of the collaborations commonly performed between the Web Service participants.parties. Using a Work Unit an application canMAY recover from faults that are the result fromof abnormal actions and also MAY finalize completed actions that need to be logically rolled back.

AWhen enabled, a Work Unit specifies the data dependencies that must be satisfied before enabling one or more enclosed actions. These dependencies expressexpresses interest(s) on the availability of variableone or more Variable information that already existsexist or will be created in the future.

The Work UnitsUnit's interest(s) are matched when all the required, one or more variablerequired Variable information are or become available.available and the specified matching condition on the Variable information is met. Availability of some variableVariable information does not mean that a Work Unit matches immediately. Only when all variableVariable information required by a Work Unit become available, in the appropriate Visibility Horizon, does matching succeed. Variable information available within a Choreography MAY be matched with a Work Unit that will be enabled in the future. One or more Work Units MAY be matched concurrently if their respective interests are matched. When the matching succeeds thea Work Unit ismatching succeeds then its enclosed actions are enabled.

A Work Unit MUST contain an Activity-Notation , which is enabled when its enclosing Work Unit is enabled.that performs the actual work.

A Work Unit completes successfully when all its enclosed actions complete successfully.

A Work Unit that completes successfully MUST be considered again for matching (based on its Guardguard condition), if its repetition condition evaluates to "true".

The WorkUnit-Notation is defined as follows:;

<workunit  name="ncname"
      guard="xsd:boolean XPath-expression"?                 
      repeat="xsd:boolean XPath-expression"? 
       block="true|false"block="true|false"? >
      Activity-Notation
</workunit>

The Activity-Notation specifies the enclosed actions of a Work Unit.

The guard condition of a Work Unit, specified by the optional guard attributeattribute, describes the reactiveinterest on the availability of one or more, existing or future variable information and its usage is explained in section 2.4.5.1.Variable infor