IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Building mediation flows > Changing the format of mediation flows

Mediation flow schema reference

Mediation flows have an XML schema format that is useful for developers who want to create patterns.


mediationFlow

This is the root element of a mediation flow document.

Attributes of the mediationflow element

<mediationFlow xmlns="http://www.ibm.com/xmlns/prod/websphere/2010/MediationFlow" 
               xmlns:HelloService="http://HelloService/HelloService" 
               xmlns:HelloWorld="http://HelloWorldLibrary/HelloWorld" 
               xmlns:XMLSchema="http://www.w3.org/2001/XMLSchema" 
               xmlns:mfcex="http://www.ibm.com/xmlns/prod/websphere/2010/MediationFlowExtension" name="HelloWorldMediation" 
                            targetNamespace="http://HelloWorldMediation/HelloWorldMediation">

Attributes of the mediationFlow element
Attribute Required Description
xmlns Yes Default namespace “http://www.ibm.com/xmlns/prod/websphere/2010/MediationFlow”
xmlns:xsi Yes XML schema instance namespace “http://www.w3.org/2001/XMLSchema-instance”
xsi:type Yes Mediation Flow element name “mediationFlow”
name Yes The name of the mediation flow document
targetNamespace Yes The target namespace of the mediation flow document
xmlns:XMLSchema No If anyType is used in the document, declare the XML schema namespace.
xmln s: interfacePrefix=interfaceNamespace No Declares the namespace of the interface used in this document (where interfacePrefix is the name of the interface and interfaceNamespace is the namespace).

Child elements of mediationflow

Child elements of the mediationFlow element
Child elements Constraints Description
import minOccurs="0" maxOccurs="unbounded" Declares an import for an interface or business object to be used in this document.
promotedProperty minOccurs=“0” maxOccurs=“unbounded” Declares a promoted property.
reference minOccurs="0" maxOccurs="unbounded" Adds a reference interface to use in this mediation flow.
interface minOccurs="0" maxOccurs="unbounded" Adds an interface to use in this mediation flow.
requestFlow minOccurs="0" maxOccurs="unbounded" Only applicable when the mediation flow document is saved into multiple files. References the operation flow: <requestFlow ref="tns:callHello"/>
responseFlow minOccurs="0" maxOccurs="unbounded" Only applicable when the mediation flow document is saved into multiple files. References the operation flow: <responseFlow ref="tns:callHello"/>
subflow minOccurs="0" maxOccurs="1" Only applicable when the mediation flow document is saved as a mediation subflow (.mfcsubflow).
errorFlow minOccurs="0" maxOccurs="1" Only applicable when the mediation flow document is saved into multiple files. References the operation flow: <errorFlow ref="tns:callHello"/>


import

Attributes of the import element

<import location="HelloWorld.wsdl" namespace="http://HelloWorldLibrary/HelloWorld"/>

Attributes of the import element
Attribute Required Description
location Yes Location of an external document to be imported. The supported document types are .mfcflow, .wsdl, and .xsd.
namespace No The namespace of the external document.


reference

Attributes of the reference element

<reference name="HelloServicePartner" portType="HelloService:HelloService"/>

Attributes of the reference element
Attribute Required Description
name Yes The name of the partner reference.
portType Yes The WSDL portType of the partner reference.


interface

Attributes of the interface element

<interface portType="HelloWorld:HelloWorld">

Attributes of the interface element
Attribute Required Description
name Yes The name of the interface
portType Yes The WSDL portType that contains a set of operations.

Child elements of the interface element

Child elements of interface
Child Element Constraints Description
Operation minOccurs=“0” maxOccurs=“unbounded” The operation for which the mediation flow is being defined.


operation

Attributes of the operation element

<operation name="callHello">

Attributes of the operation element
Attribute Required Description
name Yes The name of the operation

Child elements the operation element

Child elements of operation
Child Element Constraints Description
requestFlow minOccurs=“1” maxOccurs=“1” The request flow of the operation.
responseFlow minOccurs=“0” maxOccurs=“1” The response flow of the operation
errorFlow minOccurs=“0” maxOccurs=“1” The error flow of the operation.


requestFlow

Attributes of the requestFlow element

<requestFlow mfcex:showInputResponse="false" mfcex:showInputFault="false">

Attributes of the requestFlow element
Attribute Required Description
mfcex:showInputResponse No Show or hide the input response node in the mediation flow editor.
mfcex:showInputFault No Show or hide the input fault node in the mediation flow editor.
ref No Only applicable when the mediation flow is saved into multiple files.
portType No Only applicable when the mediation flow is saved into multiple files.
operation No Only applicable when the mediation flow is saved into multiple files.

Child elements of the requestFlow element

Child elements of requestFlow
Child Element Constraints Description
note minOccurs="0" maxOccurs="unbounded" An annotation on the request flow.
node minOccurs="0" maxOccurs="unbounded" A mediation node or primitive in the request flow.


responseFlow

Attributes of the responseFlow element

Attributes of the responseFlow element
Attribute Required Description
ref No Only applicable when the mediation flow is saved into multiple files.
portType No Only applicable when the mediation flow is saved into multiple files.
operation No Only applicable when the mediation flow is saved into multiple files.

Child elements of the responseFlow element

Child elements of responseFlow
Child Element Constraints Description
note minOccurs="0" maxOccurs="unbounded" An annotation on the request flow.
node minOccurs="0" maxOccurs="unbounded" A mediation node or primitive in the request flow.


errorFlow

Attributes of the errorFlow element

<errorFlow mfcex:showInputResponse="false">

Attributes of errorFlow
Attribute Required Description
name No The name that identifies the error flow to the main mediation flow. Only applicable when the mediation flow document is saved into multiple files.
description No A description of the error flow. Only applicable when the mediation flow document is saved into multiple files.
mfcex:showInputResponse No Show or hide the input response node in the mediation flow editor.
ref No Only applicable when the mediation flow document is saved into multiple files.

Child elements of the errorFlow element

Child elements of errorFlow
Child element Constraints Description
note minOccurs="0" maxOccurs="unbounded" An annotation on the error flow.
node minOccurs="0" maxOccurs="unbounded" A mediation node or primitive in the error flow.


subflow

<subflow>
    <node name="in" type="In">
      <outputTerminal type="XMLSchema:anyType">
        <wire targetNode="Fail1"/>
      </outputTerminal>
    </node>
    <node name="Fail1" type="Fail">
      <inputTerminal/>
    </node>
  </subflow>

Attributes of the subflow element

Attributes of the subflow element
Attribute Required Description
name No The name of the subflow.
description No A description of the subflow.

Child elements of the subflow element

Child elements of subflow
Child element Constraints Description
note minOccurs="0" maxOccurs="unbounded" An annotation on the subflow.
node minOccurs="0" maxOccurs="unbounded" A mediation node or primitive in the subflow.


note

Attributes of the note element

<note mfcex:x="64" mfcex:y="113">This is an annotation.</note>

Attributes of the note element
Attribute Required Description
mfcex:x No Optional x-coordinate of the note. Automatic layout is used if the attribute is not specified.
mfcex:y No Optional y-coordinate of the note. Automatic layout is used if the attribute is not specified.


property

Attributes of the property element

<property name="root" promotedPropertyGroup="HelloWorldMediation.HelloWorldMediation" promotedPropertyName="input_map.root" value="/body"/>
<property name="XSLTransform" value="xslt/input_map_req_1.xsl"/>
<property name="XMXMap" value="xslt/input_map_req_1.map"/>
<property name="validateInput" promotedPropertyGroup="HelloWorldMediation.HelloWorldMediation" promotedPropertyName="input_map.validateInput"/>
<property name="SMOVersion" value="SMO61"/>

Attributes of the property element
Attribute Required Description
name Yes The name of the property.
description No The description of the property.
value No The value of the property.
promotedPropertyName No Promotes this property to the parent, and use the specified value as the name of the promoted property.
promotedPropertyGroup No Optional attribute to help identify the promoted property name.


node

Attributes of the node element

<node displayName="callHello : HelloWorld" name="HelloWorld_callHello_InputResponse" type="InputResponse">

Attributes of the node element
Attribute Required Description
name Required The name of the mediation node.
type Required The mediation type.
displayName No The name that will be displayed in the user interface.
description No The description of the mediation node.
mfcex:x No Optional x-coordinate of the node or primitive. Automatic layout is used if the attribute is not specified.
mfcex:y No Optional y-coordinate of the node or primitive. Automatic layout is used if the attribute is not specified.

Child elements of the node element

Child elements of node
Child Element Constraints Description
note minOccurs="0" maxOccurs="unbounded" An annotation that attaches to the mediation node.
property minOccurs="0" maxOccurs="unbounded" A property of the mediation node.
inputTerminal minOccurs="0" maxOccurs="unbounded" An input terminal of the mediation node.
outputTerminal minOccurs="0" maxOccurs="unbounded" An output terminal of the mediation node.
failTerminal minOccurs="0" maxOccurs="1" A fail terminal of the mediation node.


inputTerminal

Attributes of the inputTerminal element

<inputTerminal type="HelloWorld:callHelloResponseMsg"/>

Attributes of the input terminal
Attribute Required Description
name No The identifier of the input terminal.
displayName No The name that will be displayed in the user interface.
description No The description of the terminal.
type No The message type of the input terminal. If not specified, the message type will be automatically deduced.

Child elements of the inputTerminal element

Child elements of inputTerminal
Child element Constraints Description
refinement minOccurs="0" maxOccurs="unbounded" A refinement of a weakly-typed field in the message type.


outputTerminal

<outputTerminal type="HelloService:getHelloRequestMsg">
            <wire targetNode="HelloServicePartner_getHello_Callout"/>
          </outputTerminal>

Attributes of the outputTerminal element

Attributes of the output terminal
Attribute Required Description
name No The identifier of the output terminal.
displayName No The name that will be displayed in the user interface.
description No The description of the terminal.
type No The message type of the output terminal. If not specified, the message type will be automatically deduced.

Child elements of the outputTerminal element

Child elements of outputTerminal
Child element Constraints Description
refinement minOccurs="0" maxOccurs="unbounded" A refinement of a weakly-typed field in the message type.
wire minOccurs="0" maxOccurs="unbounded" An outgoing connection to a mediation node or primitive.


failTerminal

Attributes of the failTerminal element

Attributes of the failTerminal element
Attribute Required Description
name No The identifier of the fail terminal.
displayName No The name that will be displayed in the user interface.
description No The description of the terminal.
type No The message type of the fail terminal. If not specified, the message type will be automatically deduced.

Child elements of the failTerminal element

Child elements of failTerminal
Child element Constraints Description
refinement minOccurs="0" maxOccurs="unbounded" A refinement of a weakly-typed field in the message type.
wire minOccurs="0" maxOccurs="unbounded" An outgoing connection to a mediation node or primitive.


refinement

Attributes of the refinement element

Attributes of the refinement element
Attribute Required Description
path Yes An XPath expression to a weakly-typed field.
type Yes The data type to use for the refinement.


wire

Attributes of the wire element

<wire targetNode="HelloServicePartner_getHello_Callout"/>

Attributes of the wire element
Attribute Required Description
targetNode Yes The name of the mediation node or primitive that this wire is connecting to.
targetTerminal No The input terminal name of the mediation node or primitive that this wire is connecting to.

Changing the format of mediation flows