Using the AquaLogic Service Bus Plug-in for WorkSpace Studio

     Previous  Next    Open TOC in new window    View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

User Interface Reference

This section describes all the views, dialogs, wizards, and other user interface objects in the ALSB plug-in.

Alerts

The following pages are provided for managing alerts:

Alert Destination editor

An alert destination is a destination address for alert notifications in ALSB. Use this page to configure an alert destination resource. For more information, see Alert Destinations in Using the AquaLogic Service Bus Console.

Option
Description
Description
Enter a description for this alert destination.
SNMP Trap
If you specify SNMP Trap, alerts are sent as SNMP traps, and can be processed by any third-party enterprise monitoring systems (ESM).
Reporting
If you specify Reporting, alerts are sent to the ALSB Reporting module and can be captured using a custom reporting provider that can developed using the reporting APIs provider by AquaLogic Service Bus. This allows third-parties to receive and process alerts in custom Java code.

Continue in the Edit Alert Destination page. Click Add to add e-mail and JMS recipients to an alert destination. See:

For more information, see Adding E-Mail and JMS Recipients in Using the AquaLogic Service Bus Console.

Edit E-mail Recipient page

Use this page to configure the destination target for an alert sent via e-mail (that is, using the e-mail transport). For more information, see Adding E-Mail Recipients in Using the AquaLogic Service Bus Console.

Option
Description
Mail Recipients
Enter an e-mail recipient in the format: mailto:username@hostname
You can specify multiple e-mail recipients by entering the user names and hostnames in a comma-separated list. For example, mailto:username@hostname
[,username_1@hostname_1]...[,username_n@hostname_n]
Only the first mail recipient needs to be prefixed with the text “mailto:”. However doing so is optional; the code will add it if it is missing.
SMTP Server
Select the name of the SMTP server for the outgoing e-mail. This field is not required if Mail Session is selected in the next field. These fields are mutually exclusive; it is an error to configure both.
Mail Session
Select an available mail session. This field is not required if an SMTP Server is selected in the previous field. These fields are mutually exclusive; it is an error to configure both.
From Name
Provide a sender’s name for the alert notification. This field is optional.
From Address
Provide a valid e-mail address. This field is required if a value for the From Name field is specified.
Reply To Name
Provide a name to which a reply may be addressed. This field is optional.
Reply To Address
Provide an e-mail address to which a reply may be sent. This field is required if a value for the Reply To Name field is specified.
Connection Timeout
Enter the number of seconds a connection must wait for a response from the server before timing out. The default value is 0.
Request Encoding
Enter a character set encoding value. The default encoding value is iso-8859-1.

Edit JMS Destination page

Use this page to configure the destination target for an alert sent via JMS (that is, using the JMS transport). For more information, see Adding JMS Recipients in Using the AquaLogic Service Bus Console.

Option
Description
Destination URI
Enter a JMS destination URI in the format: jms://host:port/factoryJndiName/destJndiName
Destination Type
Select Queue or Topic.
Message Type
Select Bytes or Text.
Request Encoding
Enter a character set encoding value. The default encoding value is iso-8859-1.

AquaLogic Business Service Configuration

You configure new business services while creating them in the New AquaLogic Business Service wizard. You can view and modify those settings in the AquaLogic Business Service editor: With a few exceptions, configuration options are identical in the wizard and the editor and are therefore documented in one place. The wizard and editor business service configuration pages are:

Business Service General Configuration page

Use the AquaLogic Business Service General Configuration page to specify general configuration settings for a business service. This page appears both in the New AquaLogic Business Service wizard and in the AquaLogic Business Service editor. Options vary, depending on whether you are using the wizard or the editor, as described below.

New AquaLogic Business Service Wizard Options

The following table describes the options in the wizard:

Option
Description
Description
Enter a description for this service.
Service Type - Create a New Service (wizard only)
A service type defines the types and packaging of the messages exchanged by the service. Select the type of business service to create:
WSDL Web Service
Select this option to create a business service based on a WSDL. Then, enter the WSDL name, qualified by its path (for example, myProject/myFolder/myWSDL). Alternatively, click Browse to select a WSDL resource.
(port or binding) - Enter the name of a port (defined in the WSDL) to describe an actual transport address, or enter the name of a binding (defined in the WSDL) to map to a transport address. If you use Browse to select a WSDL, as described above, the Select a WSDL Definition dialog lists any ports and bindings defined in the WSDL. When you choose a port or a binding on that page, the (port or binding) field is filled with the selected name.
Transport Typed Service
Select this option to create a service that uses EJB transport.
Messaging Service
Select this option to create a service that exchanges messages of different content-types. These exchanges can be either request/response or one-way. They can also have a response with no request when used with the HTTP ‘GET’ option for the HTTP transport. Unlike Web Services, the content-type of the request and response need not be the same.
Any SOAP Service
Select this option to create a SOAP service that does not have an explicitly defined, concrete interface.
Select SOAP 1.1 or SOAP 1.2 from the drop-down list to specify the SOAP version to be used.
Any XML Service
Select this option to create an XML service that does not have an explicitly defined, concrete interface.
HTTP GET is only supported for messaging services and this service type.
Service Type - Create From Existing Service
Choose one of these options to create a service based on another service.
Business Service
Select this option to clone an existing business service.
Enter the path (project/folder) and the name of the business service; or click Browse to select a service.
Since ALSB does not accept the same URI for multiple services, you must change the URI for the cloned service.
Proxy Service
Select this option to create a business service based on an existing proxy service.
Enter the path (project/folder) and the name of the proxy service; or click Browse to select a service.
Since ALSB does not accept the same URI for multiple services, you must change the URI for the cloned service.

AquaLogic Business Service Editor Options

The following table describes the options in the editor:

Option
Description
Description
Enter or modify a description for this service.
Service Type (editor only)
This option shows the service type of the business service. You can change only some of the properties of some of the service types:
  • WSDL Web Service - You can enter (or click Browse to select) a different port or binding from the same WSDL. You can also specify a different WSDL, but by doing so, you are effectively creating a new service and you will have to configure it as if it were a new service.
  • Transport Typed Service - This option cannot be modified.
  • Messaging Service - This option cannot be modified.
  • Any SOAP Service - You can change the SOAP version (SOAP 1.1 or SOAP 1.2)
  • Any XML Service - This option cannot be modified.

Business Service Message Type Configuration page

Use the AquaLogic Business Service Message Type Configuration page to configure message types for a business service whose type is Messaging Service. This page appears both in the New AquaLogic Business Service wizard and in the AquaLogic Business Service editor:

The binding definition for messaging services consists of configuring the content-types of the messages that are exchanged. The content-type for the response does not need to be the same as for the request; therefore, the response is configured separately (for example, the service could accept an MFL message and return an XML acknowledgment receipt).

Note: E-mail, File, FTP, or SFTP transport business services whose type is Messaging Service support one-way messaging only; the Response Message Type should be None. If you select an option other than None, the file, ftp, or sftp protocol will not be available on the Transport Configuration page.

Option
Description
Request Message Type
Select a message type for the request message:
  • None - Select this option if there is no request message (HTTP GET example)
  • Binary - Select this option if the content-type of the message is unknown or not important.
  • Text - Select this option if the message can be restricted to text.
  • MFL - Select this option if the message is a binary document conforming to an MFL definition. Enter the MFL file name (qualified by its path), or click Browse to select a file.
  • You can configure only one MFL file.

    Note: To support multiple MFL files, define the content as binary or text and use the MFL action in the message flow to convert to XML.

  • XML - Select this option if the message is an XML document. Enter the XML file name (qualified by its path), or click Browse to select a file.
  • Optionally provide some type information by declaring (in the element or type field) the XML schema type of the XML document exchanged.

Response Message Type
Select a message type for the response message:
  • None - Select this option if there is no response message.
  • Binary - Select this option if the content-type of the message is unknown or not important.
  • Text - Select this option if the message can be restricted to text.
  • MFL - Select this option if the message is a binary document conforming to an MFL definition. Enter the MFL file name (qualified by its path), or click Browse to select a file.
  • You can configure only one MFL file.

    Note: To support multiple MFL files, define the content as binary or text and use the MFL action in the message flow to convert to XML.

  • XML - Select this option if the message is an XML document. Enter the XML file name (qualified by its path), or click Browse to select a file.
  • Optionally provide some type information by declaring (in the element or type field) the XML schema type of the XML document exchanged.

Business Service Service Policy Configuration page

Use the AquaLogic Business Service Service Policy Configuration page to configure service policy settings for a proxy service. This page appears both in the New AquaLogic Business Service wizard and in the AquaLogic Business Service editor.

Option
Description
WSDL-Based Policy
Select this option if the service policy is associated with the WSDL upon which the service is based.
Custom Policy Bindings
Select this option to add service-level policies, operation-level policies (in which case the policy applies to both the request and response messages), request policies, and response policies directly.
For more information about configuring service policies, see Configuring Message Level Security for Web Services in the AquaLogic Service Bus Security Guide.

Business Service SOAP Binding Configuration page

Use AquaLogic Business Service SOAP Binding Configuration page to configure the SOAP Binding for a business service based on a WSDL. This page appears both in the New AquaLogic Business Service wizard and in the AquaLogic Business Service editor:

Select or deselect Enforce WS-I Compliance to specify whether or not the service is to conform to the Basic Profile defined by the Web Services Interoperability Organization. This option is available for or SOAP 1.1 services only

When a service is marked WS-I compliant, checks are performed against the messages sent to and from that service.

Business Service Transport Configuration page

Use the AquaLogic Business Service Transport Configuration page to select, review, or change the service’s transport protocol and to set, review, or change general transport configuration settings. This page appears both in the New AquaLogic Business Service wizard and in the AquaLogic Business Service editor:

Outbound transport-level security applies to the connections between ALSB proxy services and business services. For more information about transport-level security, see Configuring Transport-Level Security in the AquaLogic Service Bus Security Guide.

Option
Description
Protocol
Select a transport protocol from the list. The protocols available differ, depending on the service type:
  • WSDL Web Service: DSP, HTTP, JMS, JPD, SB, WS
  • Transport-Typed Service: EJB, Flow
  • Messaging Service: E-mail, File, FTP, HTTP, JMS, MQ (if available), SFTP, Tuxedo
  • Any SOAP Service: DSP, HTTP, JMS, JPD, SB
  • Any XML Service: DSP, E-mail, File, FTP, HTTP, JMS, JPD, MQ (if available), SB, SFTP, Tuxedo
Load Balancing Algorithm
Select one of these load-balancing algorithms:
  • Round-robin - This algorithm dynamically orders the URLs that you enter in the Endpoint URI field for this business service. If the first one fails, it tries the next one, and so on until the retry count is exhausted.
  • For every new message, there is a new order of URLs.

  • Random - This algorithm randomly orders the list of URLs that you enter in the Endpoint URI field for this business service. If the first one fails, it tries the next one, and so on until the retry count is exhausted.
  • Random-weighted - This algorithm randomly orders the list of URLs that you enter in the Endpoint URI field for this business service, but some are retried more than others based on the value you enter in the Weight field.
  • None - This algorithm orders the list of URLs that you enter in the Endpoint URI field for this business service from top to bottom.
Endpoint URI
Enter an endpoint URL in the format based on the transport protocol you selected in the Protocol field, above: The formats are:
  • DSP - t3://dsp-ip-address:port/dsp-app-name
  • EJB - ejb:provider:jndiname
  • In the URI, provider is the name of the JNDI provider resource, and JNDIname is the JNDI name in the JNDI server for the EJB.

    If the JNDI provider is located on the same server, the JNDI provider need not be specified. The URI then would be ejb::jndiname

  • E-mail - mailto:foo@bar.com
  • File - file:///root-dir/dir1
  • FTP - ftp://hostname:port/directory
  • HTTP - http://host:port/someService
  • The HTTP transport supports both HTTP and HTTPS endpoints.

  • JMS - jms://host:port[,host:port]*/factoryJndiName/destJndiName
  • To target a JMS destination to multiple servers, use the following URI format:
    jms://host1:port,host2:port/QueueConnectionFactory/DestName

  • JPD - jpd:[<provider>]:<jpd_uri>
  • provider (optional) is the name of the JNDI provider which corresponds to the WLI JNDI provider resource. When omitted, the JNDI provider on the local server is used.

    <jpd uri> is the relative URL of the JPD on the WLI server. For example, if processes.Process.jpd is in the SampleApp Web project, then the relative URL of the JPD is /SampleApp/processes/Process.jpd.

  • MQ - mq://local-queue-name?conn=mq-connection-resource-ref
  • local-queue-name is the name of the MQ queue from which the business service reads messages.

    mq-connection-resource-ref is the path (project/folder) and name of the MQ connection resource; for example, default/my_MQconnection.

    To make the MQ transport available in ALSB, see MQ Connections in Using the AquaLogic Service Bus Console.

  • SB - sb://<jndi_provider_name/>service_name
  • jndi_provider_name (optional) is the name of the ALSB JNDI provider resource. When omitted, the default context is used.

    service_name is a target service and corresponds to the remote proxy service URI.

  • SFTP - sftp://hostname:port/directory
Endpoint URI (continued)
  • Tuxedo - tuxedo:resourcename/remotename
  • tuxedo-queue:sendQSpace/sendQName[/[rcvQspace:]rvcQname][/failureQname]

    In the URI, resourcename corresponds to a WTC Import name and remotename corresponds to the service name exported by the remote Tuxedo domain. The URI resourcename is required, and the remotename is optional.

    If more than one URI is specified, you must have unique resource names for the endpoints. If no remote name is specified, its value is the value of the resource name. If no remote name is entered or if remote and resource name are the same, only one URI is allowed. In this case resource name and remote name have the same value. This allows already defined WTC Imports to make use of WTC load-balancing and failover. For more information, see AquaLogic Service Bus Interoperability Solution for Tuxedo.

  • WS - http://host:port/someService

Note: ALSB no longer supports duplicate endpoint URIs within the same business service.

Click Add to add one or more additional URIs. At run time, the URLs are selected based on the load balancing algorithm you selected in the Load Balancing Algorithm field.
If you selected Random-weighted in the Load Balancing Algorithm field, you can also enter a weight in the Endpoint URI field. The default is 1.
If you have multiple endpoint defined, and you selected None in the Load Balancing Algorithm field, the order of endpoints is significant. You can reorder the endpoints using the Up and Down buttons.
ALSB does not support duplicate endpoint URIs within the same business service.
Retry count
In case of delivery failure when sending outbound requests, specify the number of times to retry individual URL endpoints; in other words, the number of failover attempts.
For example, a business service has one configured URI (U1) and the number of retries is set to 3. If U1 fails on the first attempt, the system retries the U1 endpoint 3 more times.
If a business service has 2 configured URIs (U1 and U2) and a retry count of 3, if the first attempt (for example, to U1) fails, the system tries (fails over to) the next URI (U2). If that also fails, the system makes two more attempts, once to U1 and once to U2.
Retry Iteration Interval
Specify the number of seconds the system pauses before iterating over all the endpoint URIs in the list again.
For example, a business service has two configured URIs (U1 and U2) and a retry count of 2 with a retry iteration interval of 5 seconds. If the first attempt (to U1) fails, the system tries U2 right away. But if U2 also fails, the system waits for 5 seconds and retries U1 once more.
Retry Application Errors
Select Yes or No.
In case of delivery failure when sending outbound requests, specify whether or not to retry endpoint URIs based on application errors (for example, a SOAP fault).

AquaLogic Proxy Service Configuration

You configure new proxy services while creating them in the New AquaLogic Proxy Service wizard. You can view and modify those settings in the AquaLogic Proxy Service editor: With a few exceptions, configuration options are identical in the wizard and the editor and are therefore documented in one place. The wizard and editor business service configuration pages are:

Proxy Service General Configuration page

Use the AquaLogic Proxy Service General Configuration page to set or modify general configuration properties for a proxy service. This page appears both in the New AquaLogic Proxy Service wizard and in the AquaLogic Proxy Service editor: Options vary, depending on whether you are using the wizard or the editor, as described below.

New AquaLogic Proxy Service Wizard Options

The following table describes the options in the wizard:

Option
Description
Description
Enter a description for this proxy service.
Service Type - Create a New Service
Select the type of proxy service to create, as described below.
WSDL Web Service
Select this option to create a proxy service based on a WSDL. Then enter the WSDL name, qualified by its path (for example, myProject/myFolder/myWSDL). Alternatively, click Browse to select a WSDL resource.
(port or binding) - Enter the name of a port (defined in the WSDL) to describe an actual transport address, or enter the name of a binding (defined in the WSDL) to map to a transport address. If you use Browse to select a WSDL, the Select a WSDL Definition dialog lists any defined ports and bindings.

Note: If you are going to use the SOAP Body Type for operations, ensure that the WSDL does not have two operations with the same input message. The SOAP Body Type operation cannot be uniquely identified by inspecting the input message.

Messaging Service
Select this option to create a service that can receive messages of one data type and respond with messages of a different data type. These exchanges can be either request/response or one-way.
(HTTP GET is supported only in the Any XML Service and Messaging Service service types.)
Any SOAP Service
Select this option to create a SOAP service that does not have an explicitly defined, concrete interface.
Select SOAP 1.1 or SOAP 1.2 from the drop-down list to specify the SOAP version to be used.
Any XML Service
Select this option to create an XML service that does not have an explicitly defined, concrete interface.
(HTTP GET is supported only in the Any XML Service and Messaging Service service types.)
Service Type - Create From Existing Service
Choose one of these options to create a service based on another service.

Note: When a proxy service is created from another service, alert rules are maintained in the following way:

    • When a proxy service is created from a business service or a business service is created from a proxy service, the alert rules, if any, are removed.
    • When a proxy service is created from another proxy service or a business service is created from another business service, the alert rules, if any, are retained.
Business Service
Select this option to create a proxy service with a route node that routes to the business service you select. You cannot create a proxy service from a transport typed business service. If you create a proxy service from a DSP transport business service, ALSB switches the transport type of the proxy service to HTTP, because the DSP transport cannot be used for proxy services. You can change the transport type of the proxy service to any other available transport.
Enter the path (project/folder) and the name of the business service; or click Browse to select a service.
Proxy Service
Select this option to clone an existing proxy service. Enter the path (project/folder) and the name of the proxy service, or click Browse to select a service.
Since ALSB does not accept the same URI for multiple services, you must change the URI for the cloned service.
Content Streaming
Select this option to stream message content rather than store it in memory.
Select the Enabled check box and whether to buffer the intermediate content in memory (Memory Buffer) or to a disk file (Disk Buffer).
For more information, see Streaming body Content in the AquaLogic Service Bus User Guide.

AquaLogic Proxy Service Editor Options

The following table describes the options in the editor:

Option
Description
Description
Enter a description for this proxy service.
Service Type (editor only)
This option shows the service type of the proxy service. You can change only some of the properties of some of the service types:
  • WSDL Web Service - You can enter (or click Browse to select) a different port or binding from the same WSDL. You can also specify a different WSDL, but by doing so, you are effectively creating a new service and you will have to configure it as if it were a new service.
  • Transport Typed Service - This option cannot be modified.
  • Messaging Service - This option cannot be modified.
  • Any SOAP Service - You can change the SOAP version (SOAP 1.1 or SOAP 1.2)
  • Any XML Service - This option cannot be modified.
Content Streaming
Select this option to stream message content rather than store it in memory.
Select the Enabled check box and whether to buffer the intermediate content in memory (Memory Buffer) or to a disk file (Disk Buffer).
For more information, see Streaming body Content in the AquaLogic Service Bus User Guide.

Proxy Service Message Level Security Configuration page

Use the AquaLogic Proxy Service Message Level Security Configuration page to configure message-level security for the proxy service. This page appears both in the New AquaLogic Proxy Service wizard and in the AquaLogic Proxy Service editor:

Message-level custom tokens and message-level user name and password are supported on proxy services of the following binding types:

The configuration for both custom user name/password and custom token is similar. In both cases, you specify XPath expressions that enable ALSB to locate the necessary information. The root of these XPath expressions is as follows:

All XPath expressions must be in a valid XPath 2.0 format. The XPath expressions must use the XPath "declare namespace" syntax to declare any namespaces used, as follows:

  declare namespace
  ns='http://webservices.mycompany.com/MyExampleService';)

Option
Description
Service Key Provider
The name of a service key provider to be used by the service.
You can enter the path (project/folder) and name of a service key provider, or click Browse to select one.
A service key provider is only required in certain cases:
  • Outbound two-way TLS/SSL, where the proxy service routes messages to HTTPS services that require client-certificate authentication.
  • In some Web Service security scenarios, for example, if the proxy service requires messages to be encrypted.
To add a Web service security-enabled proxy service, you must create the proxy service from a WSDL (port or binding) with WS-policy attachments.
Custom Authentication Settings
Select one of the following:
  • None - if the service will not use custom authentication.
  • Custom User Name and Password - if the service will use a custom name and password, specified as XPath expressions
  • Custom Token - if the service will use a custom token
Custom User Name and Password - User Name XPath
The user name, specified as an XPath expression.
The XPath expression is evaluated against the message headers or payload, as appropriate, which allows ALSB to obtain the user name and for custom authentication.
Custom User Name and Password - User Password XPath
The password, specified as an XPath expression.
The XPath expression is evaluated against the message headers or payload, as appropriate, which allows ALSB to obtain the password values for custom authentication.
Custom Token - Token Type
Enter the type for the custom token type. Only the active token types configured for a WebLogic Server Identity Assertion provider can be used.
Custom Token - Token XPath
An XPath expression that specifies a path to the custom token. ALSB evaluates the Token XPath expression against the message headers or payload, as appropriate, to obtain the token for custom authentication.
To create or edit an expression, click <XPath> (or the expression_fragment, if one is already defined) to display the XPath Expression Editor.
Custom User Name and Password - Context Properties
or
Custom Token - Context Properties
Optionally, specify one or more context properties to pass additional context information to the Authentication (Custom User Name and Password) or Identity Assertion (Custom Token) security provider.
Context Properties provide a way (the ContextHandler interface) to pass additional information to the WebLogic Security Framework so that a security provider can obtain contextual information. See Additional Context Properties for Message Level Authentication for more information.
Enter the Property Name as a literal string, and the Value Selector as a valid XPath expression. (XPath expressions can also be literal strings.)
The XPath expressions are evaluated against the same message-part that is used for the custom token or custom user name/password. That is, the Value Selector XPath expressions for SOAP-based proxy services evaluate against the header and against the payload for non-SOAP-based proxy services.
The XPath expression is evaluated at runtime to produce the property's value. A ContextHandler is essentially a name/value list and, as such, it requires that a security provider know what names to look for. Therefore, the XPath expressions are evaluated only if a security provider asks for the value of one of these user-defined properties.
Click Add Property to add this context property. You can add multiple context properties.

Proxy Service Message Type Configuration page

Use AquaLogic Proxy Service Message Type Configuration page to configure message types for a proxy service whose type is Messaging Service. This page appears both in the New AquaLogic Proxy Service wizard and in the AquaLogic Proxy Service editor:

The binding definition for messaging services consists of configuring the content-types of the messages that are exchanged. The content-type for the response does not have to be the same as for the request; therefore, the response is configured separately (for example, the service could accept an MFL message and return an XML acknowledgment receipt).

Note: E-mail, File, FTP, or SFTP transport proxy services whose type is Messaging Service support one-way messaging only; the Response Message Type should be None. If you select an option other than None, the E-mail, File, FTP, or SFTP protocols will not be available on the Transport Configuration page.

Option
Description
Request Message Type
Select a message type for the request message:
  • None - Select this option if there is no request message.
  • Binary - Select this option if the content-type of the message is unknown or not important.
  • Text - Select this option if the message can be restricted to text.
  • MFL - Select this option if the message is a binary document conforming to an MFL definition. Enter the MFL file name (qualified by its path), or click Browse to select a file.
  • You can configure only one MFL file.

    Note: To support multiple MFL files, define the content as binary or text and use the MFL action in the message flow to convert to XML.

  • XML - Select this option if the message is an XML document. Enter the XML file name (qualified by its path), or click Browse to select a file.
  • Optionally provide some type information by declaring (in the element or type field) the XML schema type of the XML document exchanged.

Response Message Type
Select a message type for the response message:
  • None - Select this option if there is no response message.
  • Binary - Select this option if the content-type of the message is unknown or not important.
  • Text - Select this option if the message can be restricted to text.
  • MFL - Select this option if the message is a binary document conforming to an MFL definition. Enter the MFL file name (qualified by its path), or click Browse to select a file.
  • You can configure only one MFL file.

    Note: To support multiple MFL files, define the content as binary or text and use the MFL action in the message flow to convert to XML.

  • XML - Select this option if the message is an XML document. Enter the XML file name (qualified by its path), or click Browse to select a file.
  • Optionally provide some type information by declaring (in the element or type field) the XML schema type of the XML document exchanged.

Proxy Service Operation Selection Configuration page

Use AquaLogic Proxy Service Operation Selection Configuration page to enforce WS-I compliance (for SOAP 1.1 services only) and select the selection algorithm to use to determine the operation called by this proxy service. This option is only available for SOAP or XML services defined from a WSDL.

The WSDL specification defines a default algorithm to compute which operation is called based on the type of the SOAP message received. However, there are cases (for example, performance issues, signature/encryption issues, or the default algorithm is not applicable) when you may need to select the operation based on other means.

ALSB provides additional algorithms. Each of them follows the same pattern and are based on the evaluation of an expression to get a value that is then used to lookup the corresponding operation in a static table.

ALSB is generally very forgiving if an inbound message is either missing data such that the operation cannot be determined, or has data that does not correspond to a valid operation. Both of these conditions result in $operation being empty. Rather than reject all such messages, ALSB does not initialize the operation variable in the context but otherwise continues to process the message.

However, security requirements are enforced if the proxy service is WSDL-based and at least one of the following conditions is true:

If these conditions are met, then there is a runtime check to make sure the operation selection algorithm returns a valid operation name. If the operation selection returns null or an operation that is not in the WSDL, then the message is rejected and an error is raised.

Option
Description
Enforce WS-I Compliance
Select or deselect this check box to specify whether or not the service is to conform to the Basic Profile defined by the Web Services Interoperability Organization. This option is available for or SOAP 1.1 services only
When a service is marked WS-I compliant, checks are performed against the messages sent to and from that service.
For proxies, checks are performed against request messages received by the proxy. For invoked services (i.e. services invoked by a proxy via service callout action or route node), checks are performed against the response messages received from those services. Note that it is the WS-I compliance property of the invoked service and not the proxy that determines whether or not checks are performed against messages received from the invoked service. If you specify WS-I compliance testing for an invoked service, the message flow generates a fault for response errors.
Selection Algorithm
Select one of the following and perform any required additional steps:
  • Transport Header - Select this algorithm to define the transport header that contains the lookup value. Then:
    • In the Header Name field, enter the transport header that extracts the value used as a key to select the operation being invoked.
    • Under the Operation Mapping field, specify the value for each operation in the Value field. The value is used as the key of the operation.
  • SOAPAction Header - Select this algorithm to specify that operation mapping be done automatically from the WSDL associated with this proxy service.
  • WS-Addressing - Select this algorithm to specify that the lookup value is contained by the WS-Addressing Action tag located in the SOAP headers of the SOAP message. Then, under the Operation Mapping field, specify the value for each operation in the Value field. The value is used as the key of the operation.
  • SOAP Header - Select this algorithm to define an XPath expression to be evaluated against the SOAP headers. This allows you to get the lookup value. Then:
    • In the XPath Expression field, specify the XPath expression that extracts the value used as a key to select the operation being invoked.
    • In the Operation Mapping field, specify the value for each operation in the Value field. The value is used as the key of the operation.
  • SOAP Body Type - This is the default algorithm defined by the WSDL specification to compute which operation is called based on the type of the SOAP message received.
  • If the proxy service is configured for a Web Service security pass-through scenario with an encrypted body, you cannot select this algorithm. A similar caveat applies to pass-through encrypted SOAP headers.

    If you have a WSDL that has two operations with the same input message, do not select this algorithm for operations, because the operation cannot be uniquely identified by inspecting the input message.

  • Payload Type - Available only for XML services based on a WSDL port or WSDL binding.
Header Name
This option is available only when the Selection Algorithm option is set to Transport Header.
Enter the transport header that extracts the value used as a key to select the operation being invoked.
XPath Expression
This option is available only when the Selection Algorithm option is set to SOAPHeader.
Specify the XPath expression that extracts the value used as a key to select the operation being invoked.
Operation Mapping
This option is available only when the Selection Algorithm option is set to Transport Header, WS-Addressing, or SOAP Body Type.
Specify the value for each operation in the Value field. The value is used as the key of the operation.

Proxy Service Service Policy Configuration page

Use AquaLogic Proxy Service Service Policy Configuration page to configure service policies for a proxy service. This page appears both in the New AquaLogic Proxy Service wizard and in the AquaLogic Proxy Service editor:

Option
Description
Option
Description
WSDL-Based Policy
Select this option if the service policy is associated with the WSDL upon which the service is based.
Custom Policy Bindings
Select this option to add service-level policies, operation-level policies (in which case the policy applies to both the request and response messages), request policies, and response policies directly.
For more information about configuring service policies, see Configuring Message Level Security for Web Services in the AquaLogic Service Bus Security Guide.

Proxy Service SOAP Binding Configuration page

This page is displayed only if the service you are creating has operations. This page appears both in the New AquaLogic Proxy Service wizard and in the AquaLogic Proxy Service editor:

Use the AquaLogic Proxy Service SOAP Binding Configuration page to enforce WS-I compliance (for SOAP 1.1 services only) and select the selection algorithm to use to determine the operation called by this proxy service. This option is only available for SOAP or XML services defined from a WSDL.

The WSDL specification defines a default algorithm to compute which operation is called based on the type of the SOAP message received. However, there are cases (for example, performance issues, signature/encryption issues, or the default algorithm is not applicable) when you may need to select the operation based on other means.

ALSB provides additional algorithms. Each of them follows the same pattern and are based on the evaluation of an expression to get a value that is then used to lookup the corresponding operation in a static table.

ALSB is generally very forgiving if an inbound message is either missing data such that the operation cannot be determined, or has data that does not correspond to a valid operation. Both of these conditions result in $operation being empty. Rather than reject all such messages, ALSB does not initialize the operation variable in the context but otherwise continues to process the message.

However, security requirements are enforced if the proxy service is WSDL-based and at least one of the following conditions is true:

If these conditions are met, then there is a runtime check to make sure the operation selection algorithm returns a valid operation name. If the operation selection returns null or an operation that is not in the WSDL, then the message is rejected and an error is raised.

Option
Description
Enforce WS-I Compliance
For SOAP 1.1 services only:
Select or deselect this check box if you want to specify whether or not the service is to conform to the Basic Profile defined by the Web Services Interoperability Organization.
When a service is marked WS-I compliant, checks are performed against the messages sent to and from that service. For proxies, checks are performed against request messages received by the proxy. For invoked services (i.e. services invoked by a proxy via service callout action or route node), checks are performed against the response messages received from those services. Note that it is the WS-I compliance property of the invoked service and not the proxy that determines whether or not checks are performed against messages received from the invoked service. If you specify WS-I compliance testing for an invoked service, the message flow generates a fault for response errors.

Proxy Service Transport Configuration page

Use the AquaLogic Proxy Service Transport Configuration page to select a transport protocol for the proxy service and to set other general transport configuration settings.

This page appears both in the New AquaLogic Proxy Service wizard and in the AquaLogic Proxy Service editor:

Note: Inbound transport-level security applies to the client applications and ALSB proxy services. Outbound transport-level security applies to the connections between ALSB proxy services and business services. To learn more about transport-level security, see Configuring Transport-Level Security in the AquaLogic Service Bus Security Guide.

Option
Description
Protocol
Select a transport protocol from the list. The protocols available differ, depending on the service type you are creating:
  • WSDL Web Service: HTTP, JMS, Local, SB, WS
  • Messaging Service: E-mail, File, FTP, HTTP, JMS, Local, MQ (if available), SFTP, Tuxedo
  • Any SOAP Service: HTTP, JMS, Local, SB
  • Any XML Service: E-mail, File, FTP, HTTP, JMS, Local, MQ (if available), SB, SFTP, Tuxedo
Endpoint URI
Enter an endpoint URI in the format based on the transport protocol you selected in the Protocol field, above: The formats are:
  • E-mail - mailfrom:mail-server-host:port
  • File - file:///root-dir/dir1
  • FTP - ftp://hostname:port/directory
  • HTTP - /someName
  • The HTTP transport supports both HTTP and HTTPS endpoints.

  • JMS - jms://host:port[,host:port]*/factoryJndiName/destJndiName
  • To target a target a JMS destination to multiple servers, use the following URI format:

      jms://host1:port,host2:port/QueueConnectionFactory/DestName

    Note that when you create a proxy service, you can configure a JMS endpoint URI even if the server at that endpoint if not available. However, in the case of JMS, when you activate the session, the endpoint must be available.

  • Local
  • This transport does not require an endpoint URI.

  • MQ - mq://local-queue-name?conn=mq-connection-resource-ref
  • local-queue-name is the name of the MQ queue from which the proxy service reads messages.

    mq-connection-resource-ref is the path (project/folder) and name of the MQ connection resource; for example, default/my_MQconnection.

    To make the MQ transport available in ALSB, see MQ Connections in Using the AquaLogic Service Bus Console.

  • SB - service_name
  • service_name is the unique identifier for the proxy service. By default, this name will be the proxy service name.

    service_name must only contain characters permitted in URIs (as described in RFC2396), except it cannot contain forward slash (/) or colon (:) characters.

  • SFTP - sftp://hostname:port/directory
Endpoint URI (continued)
  • Tuxedo - servicename
  • The URI servicename corresponds to a WTC Export that the remote Tuxedo domain identifies as a Tuxedo service.

    If more than one URI is specified, you must have unique resource names for the endpoints. If no remote name is specified, its value is the value of the resource name. If no remote name is entered or if remote and resource name are the same, only one URI is allowed. In this case resource name and remote name will have the same value. This allows users using already defined WTC Imports to make use of WTC load-balancing and failover.

    Note: If you configure two identical URIs, an error indicates that the service name already exists.

  • WS - /contextPath
contextPath must be unique for proxy services that use either HTTP or WS transport.
Get All Headers
Select Yes to retrieve all the headers from the transport.
Select No to retrieve a defined set of headers. If you select No, enter a set of headers in the Header field, then click Add. (This step does not apply to Local transport.)

Note: ALSB does not pass the HTTP Authorization header from the request to the pipeline because it opens a security vulnerability. You could inadvertently create a log action that writes the user name and unencrypted password to a log file. If your design pattern requires the HTTP Authorization header to be in the pipeline, do the following:

a. In the startup command for ALSB, set the following system property to true: com.bea.wli.sb.transports.http.GetHttpAuthorizationHeaderAllowed

b. In Eclipse, on the Transport Configuration page, select Yes for Get All Headers or select No and specify Authorization.

c. Restart ALSB.

ALSB will pass the Authorization header to the pipeline.

ALSB Configurations and Projects

The following are provided for working with ALSB configurations and projects.

ALSB Configurations view

This view displays a hierarchical list of all your ALSB configurations and the projects they contain. See also New AquaLogic Service Bus Configuration Project wizard.

You can do the following in the Configurations view:

New AquaLogic Service Bus Configuration Project wizard

Use this wizard to create an ALSB configuration project. For configuration options, see ALSB Configuration page.

ALSB Configuration page

An ALSB configuration project is a grouping of ALSB projects and resources destined for a server, a location for system resources (SMTP, UDDI, and such), and a container for validation; for example, a resource in a project associated with one ALSB configuration cannot refer to a resource in a project associated to another ALSB configuration.

Use this page to create a new ALSB configuration project (in the New AquaLogic Service Bus Configuration Project wizard) or to to configure an existing one (in the Properties for ALSB Configuration editor).

The preserve, session, and customization file settings are used when publishing an ALSB configuration to the server, and used as defaults when configuring the Export wizard - Export to Server - Select Resources page.

Option
Description
Configuration name
Enter a name for this ALSB configuration or keep the default.
Advanced Options
Preserve environment variable values
Select this check box when you are re-importing a resource but want to preserve environment variable values in the existing resource.
Preserve security and policy settings
Select this check box to preserve the security configuration (excluding access control policies) and the references to the WS-policies bound directly to the service (instead of bound to the WSDL).
Preserve credentials
(user name and password)
Select this check box to preserve PKI credentials in service key providers, user name and passwords in service accounts, and user name and password credentials in SMTP servers, JNDI providers, and UDDI registries.
Discard session if activation fails
Select this check box to discard the session if the activation fails (for example, due to conflicts). For more information, see Activating Sessions in Using the AquaLogic Service Bus Console.
Session Name
The session name.
Description
The session description.
Deployment customization file
Specify a customization.xml file or click Browse, locate the file, then click Open. For information on customization, see Creating Customization Files in Using the AquaLogic Service Bus Console.
Keystore file
Specify a keystore.jks file or click Browse, locate the file, then click Open.
The key store settings are used when configuring a service key provider.
Password
Enter the password that you use to secure access to the key store.
Server
The name of the server associated with this ALSB configuration. This setting is automatically configured unless there is more than one server from which to choose. When multiple servers are associated with the same ALSB configuration, use the drop-down list to select the server you want to associate with this ALSB configuration.
The server setting is only used for transport specific configuration, when the transport benefits from being connected to a server (for example, when configuring the dispatch policy setting in the HTTP transport).

New AquaLogic Service Bus Project wizard

Use this page to create a new ALSB project.

Option
Description
Project name
Enter a unique name for the project. For more information, see Naming Projects and Folders in Using the AquaLogic Service Bus Console.
Project contents
Select the Use default check box to keep the project in the default location or click Browse and select a folder.
ALSB Configuration
Select an existing ALSB configuration or click New to open the New AquaLogic Service Bus Configuration Project wizard, where you can create a new configuration.

Custom Resources

You can define custom resources for use by ALSB using the New Custom Resource wizard and the Custom Resource editor, as described in the following topics:

New Custom Resource wizard

Use this wizard to create a new custom resource.

New Custom Resource Editor

Use this editor to modify the configuration of a custom resource. The General page identifies the type of custom resource. The Custom page provides options for editing the configuration for that type of custom resource.

New Custom Resource - Resource Type page

Use this page to select the type of custom resource to create. Select the type of custom resource to create from the list of available resource type.

Custom MQ Resource Configuration page

Use this page to configure a custom MQ connection resource. For information on MQ connection resources and MQ transports, see the following:

Export wizard

The Export wizard contains the following pages:

Export wizard - ALSB Configuration JAR Export page

Use this page to export ALSB resources to a configuration JAR file. For more information, see Exporting Resources in Using the AquaLogic Service Bus Console.

Option
Description
ALSB Configuration
Select an existing ALSB configuration and resources to export.
Export Level
Select whether to export projects or resources.

Note: A System project cannot be exported at the project level.

Note: Exporting projects might cause resource deletion when you import the full project JAR file. For more information, see Importing Resources in Using the AquaLogic Service Bus Console.

Include Dependencies
If you selected to export resources, select or clear this check box. Use the Include Dependencies option to export any other resources that this resource references
Export Destination
Enter the fully qualified name of a JAR file to export, or click Browse to select it.

Export wizard - Export to Server - Select Resources page

Use this page to select the projects or resources you want to export. Clear the check boxes next to any resources that you do not want to include in this export.

Option
Description
Resource
The name of the project and resource.
Operation
Create or update. The operation that will be performed on the resource.
Include Dependencies
Select this check box if you are exporting resources (not projects) and want to ensure that all the associated resources are exported.
Preserve Environment Settings
Preserve environment variable values
Select this check box when you want to preserve (protect against overwriting) the environment variables values in the resource you are exporting.
Preserve security and policy settings
Select this check box to preserve the security configuration (excluding access control policies) and the references to the WS-policies bound directly to the service (instead of bound to the WSDL).
Preserve credentials
(user name and password)
Select this check box to preserve PKI credentials in service key providers, user name and passwords in service accounts, and user name and password credentials in SMTP servers, JNDI providers, and UDDI registries.
Session Settings
Activate session after publish
Select this check box to create and activate a session in the ALSB console. For more information, see Activating Sessions in Using the AquaLogic Service Bus Console.
Discard session if activation fails
Select this check box to discard the session if the activation fails (for example, due to conflicts).
Description
The session description.
Customization File
Specify a customization file or click Browse, locate the file, then click Open. For information on customization, see Creating Customization Files in Using the AquaLogic Service Bus Console.

Export wizard - Export to Server - Review Resources page

Use this page to select the projects or resources you want to export.

Option
Description
ALSB Configuration
Select an existing ALSB configuration and resources to export.
Export Level
Select whether to export projects or resources.
Server
From the drop-down list, select an ALSB destination server.
Session
The session name.

Import wizard

The Import wizard has the following pages:

Import wizard - Config JAR Import - Load Resources page

Use this page to select a configuration JAR to import and an import destination. For more information, see Importing Resources in Using the AquaLogic Service Bus Console.

Option
Description
ALSB Configuration
Select an existing ALSB configuration or click New to open the New AquaLogic Service Bus Configuration Project wizard, where you can create a new configuration.
Jar
Select a full project JAR file or a resource JAR file that has been previously exported from another ALSB domain.

Import wizard - Config JAR Import - Review Resources page

Use this page to select the objects on which you want to operate (create, update, or delete). Resources are only scheduled for deletion when the JAR being imported is a full project JAR and there are project resources in the importing system that are not present in the imported JAR file. To prevent resources from being deleted, deselect them. For more information, see Importing Resources in Using the AquaLogic Service Bus Console.

Option
Description
Resources
The name of the project and resource.
Operation
Expand the Project folder to display the operations (create, update, delete) that will be performed on the resources.
To prevent resources from being deleted, deselect them. Resources are only scheduled for deletion when the JAR being imported is a full project JAR and there are project resources in the importing system that are not present in the imported JAR file.
Include Dependencies
Select this check box if you are importing a resource JAR file and want to ensure that all its associated resources are imported.
Passphrase
Enter the password that was used to encrypt the data.
Preserve Environment Settings
Preserve environment variable values
Select this check box when you are re-importing a resource but want to preserve environment variable values in the existing resource.
Preserve security and policy settings
Select this check box to preserve the security configuration (excluding access control policies) and the references to the WS-Policies bound directly to the service (instead of bound to the WSDL).
Preserve credentials
(user name and password)
Select this check box to preserve PKI credentials in service key providers, user name and passwords in service accounts, and user name and password credentials in SMTP servers, JNDI providers, and UDDI registries.

Import wizard - Config ZIP Import - Load Resources page

Use this page to select a ZIP file with resources to import and an import destination. For more information, see Loading Resources from a Zip File in Using the AquaLogic Service Bus Console.

Option
Description
ALSB Configuration
Select an existing ALSB configuration and an import destination (project or folder).
File Name
Enter the fully qualified name of a ZIP file to import, or click Browse to select it.

Import wizard - Config ZIP Import - Review Resources page

Use this page to select the objects you want to import. Clear the check boxes next to any resources that you do not want to include in this import. For more information, see Loading Resources from a Zip File in Using the AquaLogic Service Bus Console.

Option
Description
Resource
The name of the project and resource.
Operation
Create or update. The operation that will be performed on the resource.
File Name
The file name of the resource, including the file extension.

Import wizard - URL Import - Load Resources page

Use this page to import resources such as WSDLs or XML schemas that are available on the Web. You can import them, along with all their dependents, by specifying the URL of the root resource. For more information, see Loading Resources from a URL in Using the AquaLogic Service Bus Console.

Option
Description
ALSB Configuration
Select an existing ALSB configuration and an import destination (project or folder).
URL
Enter the URL where the file is located.
To specify a local resource, you can use the file protocol with a file name fully qualified by its path, for example, file:///c:/alsbresources/ForeachAction.jar.
Resource Name
Enter a name for the resource.
Resource Type
Select the type of resource from the list.

Import wizard - URL Import - Review Resources page

Use this page to select the objects you want to import. Clear the check boxes next to any resources that you do not want to include in this import. For more information, see Loading Resources from a URL in Using the AquaLogic Service Bus Console.

Option
Description
Resource
The name of the project and resource.
Operation
Create or update. The operation that will be performed on the resource.
URL
Enter the URL where the file is located.
To specify a local resource, you can use the file protocol with a file name fully qualified by its path, for example, file:///c:/alsbresources/ForeachAction.jar.

JNDI Providers

The following are provided for working with JNDI providers:

JNDI Provider Editor

Use this editor to modify an existing JNDI provider configuration. For descriptions of the fields, see the New JNDI Provider Resource wizard. For more information, see Editing JNDI Providers in Using the AquaLogic Service Bus Console.

New JNDI Provider Resource wizard

Use this page to configure a new JNDI provider resource. For more information, see Adding JNDI Providers in Using the AquaLogic Service Bus Console.

Option
Description
Description
Enter a description for the JNDI provider.
JNDI Cache
Keep the default Enabled option or select Disabled.
When enabled, the JNDI context and JNDI objects are cached locally which improves performance when doing an object lookup. BEA recommends that you keep the JNDI cache enabled.
Provider URL
Enter the URL for the JNDI provider in the format: protocol://host:port
You can use any protocol, for example, http, https, t3, t3s, iiop, iiops.
User Name
If access to the target JNDI provider requires a user name and password, enter a user name in the User Name field, and the associated password in the Password and Confirm Password fields.
These fields are optional, and required only if the JNDI tree is secured.
Password
Enter the associated password.
Confirm Password
Enter the same password you entered for the Password field.

Message Flow Design Palette

The Message Flow Design Palette lists all the nodes and actions you can use to construct a message flow for a proxy service. To insert a node or an action into a message flow, drag the item from the palette to the Message Flow Editor. When you drag an item to the palette, one or more targets appear () to indicate that you can drop the dragged item in that position on the palette. When you drag the item onto a target, the target is highlighted () to show that you can drop the item there.

You can also add nodes and actions to message flows by right-clicking an object in the Message Flow Editor and choosing a node or action from the Insert, Insert Into, or Insert After submenus. You can also add an error handler by selecting the Add Error Handler command. These submenus and commands are context sensitive. That is, they appear only when it is legal to add the item into the selected context in the message flow.

The Message Flow Design Palette is organized into the following categories:

Message Flow Nodes

The following table describes the nodes you can add to a message flow:

Node
Description
Conditional branch
A branch node allows processing to proceed down exactly one of several possible paths.
For configuration properties, see Conditional Branch Node Properties.
Operational branch
An operational branch node determines what branch to follow based on specified operations.
For configuration properties, see Operational Branch Node Properties.
Pipeline pair
A pipeline pair node consists of a request pipeline and a response pipeline.
For configuration properties, see Pipeline Pair Node Properties.
Route
Route node actions define the handling of messages as they flow through the route node.
For configuration properties, see Route Node Properties.
Stage
A stage node is a container of actions.
For configuration properties, see Stage Node Properties.
Error handler
An error handler provides the logic for resending errors in the message flow.
For configuration properties, see Error Handler Node Properties.

Message Flow Route Actions - Communication Actions

The following table describes the communication actions you can add to a route in a message flow:

Action
Description
Dynamic routing
A dynamic routing action assigns a route for a message based on routing information available in an XQuery resource.
For configuration properties, see Dynamic Routing Action Properties.
Routing
A routing action identifies a target service for the message and configures how the message is routed to that service:
For configuration properties, see Routing Action Properties.
Routing table
A routing table action assigns a set of routes wrapped in a switch-style condition table. Different routes are selected based upon the results of a single XQuery expression.
For configuration properties, see Routing Table Action Properties.

Message Flow Route Actions - Flow Control Actions

The following table describes the flow control action you can add to a route in a message flow:

Action
Description
If-then
An if-then action performs an action or a set of actions conditionally, based on the Boolean result of an XQuery expression.
For configuration properties, see If-Then Action Properties.

Message Flow Stage Actions - Communication Actions

The following table describes the communication actions you can add to a stage in a message flow:

Action
Description
Dynamic Publish
A dynamic publish action publishes a message to a service identified by an XQuery expression
For configuration properties, see Dynamic Publish Action Properties.
Publish
A publish action publishes a message to a statically specified service.
For configuration properties, see Publish Action Properties.
Publish Table
A publish table action publishes a message to zero or more statically specified services. Switch-style condition logic is used to determine at run time which services will be used for the publish.
For configuration properties, see Publish Table Action Properties.
Routing Options
A routing options action modifies any or all of the following properties in the outbound request: URI, Quality of Service, Mode, Retry parameters, Message Priority.
For configuration properties, see Routing Options Action Properties.
Service Callout
A service callout action configures a synchronous (blocking) callout to an ALSB-registered proxy or business service.
For configuration properties, see Service Callout Action Properties.
Transport Headers
A transport header action sets the transport header values in messages
For configuration properties, see Transport Headers Action Properties.

Message Flow Stage Actions - Flow Control Actions

The following table describes the flow control actions you can add to a stage in a message flow:

Action
Description
For-Each
A for-each action iterates over a sequence of values and executes a block of actions
For configuration properties, see For-Each Action Properties.
If-Then
An if-then action performs an action or set of actions conditionally, based on the Boolean result of an XQuery expression.
For configuration properties, see If Action and Else-If Action Properties.
Raise error
A raise-error action raises an exception with a specified error code (a string) and description.
For configuration properties, see Raise Error Action Properties.
Reply
A reply action specifies that an immediate reply be sent to the invoker.
For configuration properties, see Reply Action Properties.
Skip
A skip action specifies that at run time, the execution of the current stage is skipped and the processing proceeds to the next stage in the message flow.
For configuration properties, see Skip Action Properties.
Resume
A resume action resumes message flow after an error is handled by an error handler.
For configuration properties, see Resume Action Properties.

Message Flow Stage Actions - Message Processing Actions

The following table describes the message processing actions you can add to a stage in a message flow:

Action
Description
Assign
An assign action assigns the result of an XQuery expression to a context variable.
For configuration properties, see Assign Action Properties.
Delete
A delete action deletes a context variable or a set of nodes specified by an XPath expression.
For configuration properties, see Delete Action Properties.
Insert
An insert action inserts the result of an XQuery expression at an identified place relative to nodes selected by an XPath expression.
For configuration properties, see Insert Action Properties.
Java callout
A Java callout action invokes a Java method from the pipeline.
For configuration properties, see Java Callout Action Properties.
MFL transform
A MFL transform action converts non-XML to XML or XML to non-XML in the pipeline.
For configuration properties, see MFL Transform Action Properties.
Rename
A rename action renames elements selected by an XPath expression without modifying the contents of the element.
For configuration properties, see Rename Action Properties.
Replace
A replace action replaces a node or the contents of a node specified by an XPath expression.
For configuration properties, see Replace Action Properties.
Validate
A validate action validates elements selected by an XPath expression against an XML schema element or a WSDL resource.
For configuration properties, see Validate Action Properties.

Message Flow Stage Actions - Reporting Actions

The following table describes the reporting actions you can add to a stage in a message flow:

Action
Description
Alert
An alert action ends an alert notification based on pipeline message context.
For configuration properties, see Alert Action Properties.
Log
A log action constructs a message to be logged.
For configuration properties, see Log Action Properties.
Report
A report action enables message reporting for a proxy service.
For configuration properties, see Report Action Properties.

Message Flow Editor

Use this editor to construct a proxy service message flow. To insert a node or an action into a message flow, drag the item from the Message Flow Design Palette to the editor. When you drag an item to the editor, one or more targets appear () to indicate that you can drop the dragged item in that position on the palette. When you drag the item onto a target, the target is highlighted () to show that you can drop the item there.

You can also add nodes and actions to message flows by right-clicking an object in the Message Flow Editor and choosing a node or action from the Insert, Insert Into, or Insert After submenus. You can also add an error handler by selecting the Add Error Handler command. These submenus and commands are context sensitive. That is, they appear only when it is legal to add the item into the selected context in the message flow.

When you select a node or action in the editor, a configuration page for that item is displayed in the Properties view. You can add or modify configuration properties in those pages. The message flow node and action properties configuration pages are:

Alert Action Properties

In a message flow, use the alert action to generate alerts based on message context in a pipeline, to send to an alert destination. Unlike SLA alerts, notifications generated by the alert action are primarily intended for business purposes, or to report errors, and not for monitoring system health. Alert destinations should be configured and chosen with this in mind. To learn more about alert destinations, see Alert Destination editor.

If pipeline alerting is not enabled for the service or at the domain level, the configured alert action is bypassed during message processing.

In the Message Flow Editor, click an alert action to display its properties in the Properties view. Use these properties pages to configure the selected alert action. The pages are:

The Alert page has the following options:

Option
Description
Expression
An XQuery expression that specifies the message context to be added to the alert message.
To create or edit an expression, click <Expression> (or the expression_fragment, if one is already defined) to display the XQuery/XSLT Expression Editor.
Summary
A short description of the alert. This will be the subject line in the case of an e-mail notification and can contain no more than 80 characters. If no description is provided, a predefined subject line that reads, “ALSB Alert,” will be used instead.
Severity
The severity level for this alert. Select a level from the list.
Destination
The destination for the alert. To specify a destination, click Browse to select an appropriate resource.

Tip: To prevent exceptions from aborting the message being processed when generating a pipeline alert, it is recommended that an error handler for the alert action be defined to handle and contain such exceptions locally, rather than having them bubble up to a global error handler.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Assign Action Properties

In a message flow, use an assign action to assign the result of an XQuery expression to a context variable.

In the Message Flow Editor, click an assign action to display its properties in the Properties view. Use these properties pages to configure the selected assign action. The pages are:

The Assign page has the following options:

Option
Description
Expression
An expression that creates the data that is assigned to variable named in the Variable field, described below.
To create or edit an expression, click <Expression> (or the expression_fragment, if one is already defined) to display the XQuery/XSLT Expression Editor.
Variable
The variable to which the value created in the XQuery expression described above is assigned.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Conditional Branch Node Properties

In a message flow, use a conditional branch node to specify that message processing is to proceed along exactly one of several possible paths, based on a result returned by an XPath condition.

Conditional branching is driven by a lookup table with each branch tagged with a simple, but unique, string value. A variable in the message context is designated as the lookup variable for that node, and at run time, its value is used to determine which branch to follow. If no branch matches the value of the lookup variable, the default branch is followed. You should design the proxy service in such a way that the value of the lookup variable is set before reaching the branch node.

In the Message Flow Editor, click a conditional branch node to display its properties in the Properties view. Use these properties pages to configure the selected conditional branch node. The pages are:

The Flow page has the following options:

Option
Description
Name
Enter a name for the conditional branch node.
Description
Enter a description for the conditional branch node.

The Conditional Branch page has the following options:

Option
Description
XPath
The XPath expression that defines the condition to be evaluated for determining the branch to follow.
To create or edit the XPath expression, click <XPath> (or the XPath_fragment, if one is already defined) to display the XPath Expression Editor.
Variable
Enter a context variable.

A conditional branch node also always contains one or more branches, which are configured as part of the node.

Click a Branch icon in a conditional branch node to display the Branch properties page in the Properties view. Use these properties pages to configure the selected branch node in a message flow. This page has the following options.

Option
Description
Label
A label for the branch. This label appears as the label for the branch in the Message Flow Editor.
Operator
Select an operator from the list to be used with the value in the next field, for creating the condition on which the branch is based.
Value
Enter a value to be used with the operator in the previous field, for creating the condition

Delete Action Properties

In a message flow, use a delete action to delete a context variable or a set of nodes specified by an XPath expression.

In the Message Flow Editor, click a delete action to display its properties in the Properties view. Use these properties pages to configure the selected delete action. The pages are:

The Delete page has the following options. Select Variable to delete a variable, or select XPath to delete an XPath expression.

Option
Description
Variable
Select this radio button to delete a context variable. Enter the name of the context variable to delete in the adjacent text field.
XPath
Select this radio button to delete all nodes selected by an XPath expression. Then:
  • To create or edit the XPath expression, click <XPath> (or the XPath_fragment, if one is already defined) to display the XPath Expression Editor.
  • After saving the expression, in the In Variable field, enter the context variable containing the nodes specified in the XPath expression.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Dynamic Publish Action Properties

In a message flow, use a dynamic publish action to publish a message to a service specified by an XQuery expression.

In the Message Flow Editor, click a dynamic publish action to display its properties in the Properties view. Use these properties pages to configure the selected dynamic publish action. The pages are:

The Dynamic Publish page has the following options:

Option
Description
Service
An XQuery expression that defines the service to which a message is to be published.
To create or edit the expression, click <Expression> (or the expression_fragment, if one is already defined) to display the XQuery/XSLT Expression Editor.
In the editor, enter an Xquery expression or select an XQuery resource that provides a result similar to:

<ctx:route isProxy="false">

<ctx:service>project/folder/businessservicename</ctx:service>

<ctx:operation>foo</ctx:operation>

</ctx:route>

Note: The element operation is optional.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Dynamic Routing Action Properties

In a message flow, use a dynamic routing action to assign a route for a message based on routing information available in an XQuery resource.

This is a terminal action, which means you cannot add another action after this one. However, this action can contain request and response actions.

In the Message Flow Editor, click a dynamic routing action to display its properties in the Properties view. Use these properties pages to configure the selected dynamic routing action. The pages are:

The Dynamic Routing page has the following option:

Option
Description
Service
An XQuery expression that defines the route to be taken by a message.
To create or edit an expression, click <Expression> (or the expression_fragment, if one is already defined) to display the XQuery/XSLT Expression Editor.
In the XQuery/XSLT Expression editor, enter an Xquery expression, the result of which is similar to:

<ctx:route>

    <ctx:service isProxy='true'>{$service}</ctx:service>

    <ctx:operation>{$operation}</ctx:operation>

</ctx:route>

Note: If a proxy service is being invoked, isProxy attribute should be set to true.
– The service name is the fully qualified service name.
– The operation element is optional

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Error Handler Node Properties

Use an error handler to specify what should happen if an error occurs in a specific location in the message flow.

All configuration for an error handler is in one or more stages contained by the error handler. See Stage Node Properties.

For-Each Action Properties

In a message flow, use the for-each action to iterate over a sequence of values and execute a block of actions.

In the Message Flow Editor, click a for-each action to display its properties in the Properties view. Use these properties pages to configure the selected for-each action. The pages are:

The For Each page has the following options:

Option
Description
For Each Variable
Enter the name of the variable on whose contents the for-each action(s) will be executed.
XPath
An XPath expression that specifies where in the structure of the containing context variable the variable specified in the For Each Variable field is located.
To create or edit the XPath expression, click <XPath> (or the XPath_fragment, if one is already defined) to display the XPath Expression Editor.
In Variable
The context variable containing the variable on whose contents the for-each action(s) will be executed.
Index Variable
A variable containing the current number of iterations in the loop.
Count Variable
A variable containing the total number of iterations.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

If-Then Action Properties

In a message flow, use an if-then action to perform an action or a set of actions conditionally, based on the Boolean result of an XQuery expression.

In the Message Flow Editor, click an if-then action to display its properties in the Properties view. Use this page to review and configure general properties of the if-then action. The pages are:

An if-then action always contains an if condition plus zero or more else-if condition, where you define the conditions for the if-then action. An if-then action also always contains an else condition, which defines the default path when no other condition is met.

Click an If:condition icon or an Else-If:condition icon in an if-then action to display their properties in the Properties view. Use these properties pages to configure the selected condition. This If condition properties page has the following option.

If Action and Else-If Action Properties

If actions and else-if actions are always contained by an if-then action. The message follows the path associated with the first if action or else-id action that returns true.

Option
Description
Condition
A condition in an if action or an if-else action that contains one of the tests for following alternative paths in the flow.
To add or edit a condition,
  1. Click <Condition> (or condition_fragment, if one is already defined) to display the Condition Editor. Define a condition to be evaluated in the if-then action.
  2. When you finish editing the condition, add one or more action that will be executed when the condition evaluates to true. To add an action, drag it from the Design Palette to associate with the condition.
In the route node, you can select only the routing, dynamic routing, or routing table actions. However, these actions can contain request and response actions.
  1. To add an else-if condition, click add condition. Then add one or more actions to this else-if condition, as described above for the If condition. Continue with as many else-if conditions as your logic requires.
Condition actions can be nested.

Else Action Properties

The else action does not have associate properties. When all if and else-if conditions return false, the message proceeds down the path associated with the else action.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Insert Action Properties

In a message flow, use an insert action to insert the result of an XQuery expression at an identified place relative to nodes selected by an XPath expression.

In the Message Flow Editor, click an insert action to display its properties in the Properties view. Use these properties pages to configure the selected insert action. The pages are:

The Insert page has the following options:

Option
Description
Expression
The XQuery expression used to create the data that will be inserted at a specified location in a named variable.
To create or edit an expression, click <Expression> (or the expression_fragment, if one is already defined) to display the XQuery/XSLT Expression Editor.
Location
The location where the insert is performed, relative to the result of the XPath expression: Options are:
  • Before—as sibling before each element or attribute selected by the XPath expression
  • After—as sibling after each element or attribute selected by the XPath expression
  • As first child of—as first child of each element identified by the XPath expression. An error occurs if the result of the XPath returns attributes.
  • As last child of—as last child of each element identified by the XPath expression. An error occurs if the XPath returns attributes.
XPath
Valid configurations include those in which:
  • XQuery and XPath expressions both return elements.
  • The XQuery and XPath expressions both return attributes—in which case, the XQuery expression must return attributes.
To create or edit the XPath expression, click <XPath> (or the XPath_fragment, if one is already defined) to display the XPath Expression Editor.
Variable
The context variable whose contents are evaluated by the XPath variable defined above. Enter the name of the variable in the text field.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Java Callout Action Properties

In a message flow, use a Java callout action to invoke a Java method or an EJB business service from within the message flow.

In the Message Flow Editor, click a Java callout action to display its properties in the Properties view. Use these properties pages to configure the selected Java callout action. The pages are:

The Java Callout page has the following options:

Option
Description
Method
An external Java method to be called from the message flow.
Click Browse to select a class and a static method from an archived resource. Once you have selected the class and method, a table appears on the Java Callout Properties page:
The Name column lists all the method’s arguments.
The Action column provides an <Expression> or expression_fragment link to the XQuery/XSLT Expression Editor, where you can create an expression to retrieve a value for the argument.
Data types for the arguments must be one of the following:
  • Java.lang.String
  • Primitive types, and their corresponding class types (e.g., int vs. java.lang.Integer)
  • java.lang.BigDecimal, and java.lang.BigInteger (these types are used in financial calculations where round-off errors or overflows are not tolerable)
  • only org.apache.xbeans.XmlObject and no typed xml beans.
  • byte[]
  • java.lang.String[] (INPUT ONLY)
  • XmlObject [ ] (INPUT ONLY)
If the type of the input value you enter does not match the declared input argument type, ALSB tries to automatically typecast input values to the declared type of the input argument. For example a string value of "123" will be converted to integer 123 if the declared type of the input argument is java primitive int.
Result Type
The variable to which the result is assigned. The label for the field indicates the data type of the result.
If the result is a byte array (the only possible array returned), the binary-content XML element is returned.
Service Account
An optional Service Account, which can be specified if there is a security context for this Java method.
Click Browse to select a service account.
In the case of fixed and mapped service accounts, the userid/password from the service account is authenticated in the local system and the security context propagated to the Java callout. In the case of passthru, the security context is propagated to the Java callout. This context is the message level context if defined (with WS-Security). Otherwise, it is the transport level context.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Log Action Properties

In a message flow, use the log action to construct a message to be logged and to define a set of attributes with which it will be logged.

In the Message Flow Editor, click a log action to display its properties in the Properties view. Use these properties pages to configure the selected log action. The pages are:

The Log page has the following options:

Option
Description
Expression
The message context to be logged through XQuery expressions on context variables.
To create or edit an expression, click <Expression> (or the expression_fragment, if one is already defined) to display the XQuery/XSLT Expression Editor.

Note: The Log action may remove blank spaces in an expression when the message is output to the console or a file. Log action output may be parser dependent.

Annotation
Notes for this log action. These notes are logged along with the result of the previously defined expression.
Severity
The severity of the log message. Options are:
Debug - While your application is under development, you might find it useful to create and use messages that provide verbose descriptions of low-level activity within the application.
Info -Used for reporting normal operations; a low-level informational message.
Warning - A suspicious operation or configuration has occurred but it might not affect normal operation.
Error - A user error has occurred. The system or application can handle the error with no interruption and limited degradation of service.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Message Flow Properties- Comment

In the Message Flow Editor, click a node or an action to display its properties in the Properties view. For most nodes and actions, one of the properties pages displayed (as a tab) is the Comment page. Use this page to add an optional comment about the item selected in the message flow.

Message Flow Properties - Namespaces

In the Message Flow Editor, click a node or an action to display its properties in the Properties view. For most nodes and actions, one of the properties pages displayed (as a tab) is the Namespaces page. Use this page to see a list of defined namespaces or to create a new namespace.

Message Flow Properties - Variables

In the Message Flow Editor, click a node or an action to display its properties in the Properties view. For many nodes and actions, one of the properties pages displayed (as a tab) is the Variables page. Use this page to see a list of all the predefined and user-defined context variables. Click Add to define a new variable.

For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

MFL Transform Action Properties

In a message flow, use a MFL (Message Format Language) transform action to convert message content from XML to non-XML, or vice versa, in the message pipeline. An MFL is a specialized XML document used to describe the layout of binary data. It is a BEA proprietary language used to define rules to transform formatted binary data into XML data, or vice versa.

In the Message Flow Editor, click a MFL transform action to display its properties in the Properties view. Use these properties pages to configure the selected MFL transform action. The pages are:

The MFL Transform page has the following options:

Option
Description
Apply Transform
The type of transform to be applied.
Select XML to Non-XML or Non-XML to XML, according to your requirement.
on <Expression>
The variable on which the MFL transformation action is to be performed.
Click <Expression> (or the expression_fragment, if one is already defined) to display the XQuery/XSLT Expression Editor, where you can specify the variable.
This input must be text or binary when transforming to XML, and must be XML when transforming to non-XML. Binary content in the message context is represented by the binary-content XML element. This XML should be the result of the Xquery expression when the input needs to be binary.
Resource
Select this option to perform an MFL transform action using a static MFL resource. Click Browse to select the resource.
Resource From
Select this option to specify an MFL resource that will perform the transform action.
Click <Expression> (or the expression_fragment, if one is already defined) to display the XQuery/XSLT Expression Editor, where you can specify the MFL resource that will perform the action, in the format project/folder/MFLresourcename.
Variable
The name of the variable to which the result of this transform action is to be assigned. The result will be a binary-content XML element.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Operational Branch Node Properties

In a message flow, use an operational branch node to configure branching based on operations defined in a WSDL.

When message flows define WSDL-based proxy services, operation-specific processing is required. Instead of configuring a branching node based on operations manually, ALSB provides a branching node that automatically branches based on operations. In other words, when you create an operational branch node in a message flow, you can quickly build your branching logic based on the operations defined in the WSDL, because the ALSB plug-in presents those operations in the operational branch node configuration page.

A branch node allows processing to proceed along exactly one of several possible paths. Branching is driven by an XPath-based switch table. Each branch in the table specifies a condition (for example, <500) that is evaluated in order down the message flow against a single XPath expression (for example, ./ns: PurchaseOrder/ns:totalCost on $body). Whichever condition is satisfied first determines which branch is followed. If no branch condition is satisfied, then the default branch is followed. A branch node may have several descendants in the message flow: one for each branch, including the default branch.

When you add an operational branch node to a message flow in the Message Flow Editor, the node contains an initial conditional branches based on the first operation defined in the WSDL, as shown below, plus a default branch:

Click the node itself (the Operational Branch Node icon or the bounding box connected to the icon) to display the Flow properties page in the Properties view. You can provide a name and a description for the node on that page.

Click an operational branch icon to display the properties for that operational branch on the Operational Branch page. That page contains a drop-down list of all the operations defined in the WSDL. You can select a different operation for that branch. You can also click the plus sign in the operational branch node, in the Message Flow Editor, to add another operation branch.

After you have added all the branches, add nodes and stages to them to define the processing for each branch.

Pipeline Pair Node Properties

In a message flow, use a pipeline pair node to define request and response processing.

Message flows can include zero or more pipeline pair nodes: request and response pipelines for the proxy service (or for the operations on the service), and error handler pipelines that can be defined for stages, pipelines, and proxy services. Pipelines can include one or more stages, which in turn include actions.

A pipeline pair always contains a request pipeline and a response pipeline. Add stages and actions to those pipelines, as needed.

In the Message Flow Editor, click a pipeline pair node to display its properties in the Properties view. Use this properties page to configure the selected pipeline pair node. The options are:

Option
Description
Name
Enter a name for the pipeline pair node.
Description
Enter a description for the pipeline pair node.

Publish Action Properties

In a message flow, use a publish action to identify a statically specified target service for a message and to configure how the message is packaged and sent to that service.

In the Message Flow Editor, click a publish action to display its properties in the Properties view. Use these properties pages to configure the selected publish action. The pages are:

The Publish page has the following options:

Option
Description
Service
The target service for the publish action. Click Browse to select a proxy service or business service from a list.
Invoking
The operation to be invoked on the target service.
This option appears only if the selected service defines any operations.
To configure how the message is packaged and sent to the service, in the Request Actions field, click Add an Action. Then select an action to associate with the service. You can add more than one action.
Use inbound operation for outbound
Select this option to make the outbound operation the same as the inbound operation.
This option appears only if the selected service defines any operations.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Publish Table Action Properties

In a message flow, use a publish table action to publish a message to zero or more statically specified services. Switch-style condition logic is used to determine at run time which services will be used for the publish. A publish table action contains one or more case actions to define conditions for following alternative paths (by default, via publish actions), as well as a default path to a default publish action. To fully define a publish table action, you must configure the publish table action, its case actions, and its publish actions (and any other actions you may add).

When you add a publish table action to a message flow in the Message Flow Editor, the publish table action contains a case action with a path to a publish action plus a default case action with a path to a default publish action, as shown below. Click add condition to add another condition to the publish table.

Publish Table Properties

In the Message Flow Editor, click the publish table action itself (the Publish Table icon or the bounding box connected to the icon) to display the Publish Tables properties page in the Properties view. Use these properties pages to configure the selected publish table action. The pages are:

The Publish Table properties page has the following option:

Option
Description
Expression
An XQuery expression, which at run time returns the value upon which the routing decision will be made.
To create or edit an XQuery expression, click <Expression> (or the expression_fragment, if one is already defined) to display the XQuery/XSLT Expression Editor.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Case Action Properties

In the Message Flow Editor, click a case action to display its properties in the Properties view. Use this properties page to configure the selected case action, as described below:

Option
Description
  • Operator
  • Value
Select a comparison operator from the list. Then enter a value against which the value returned from the XQuery expression defined for the publish table action will be evaluate

Publish Action Properties

See Publish Action Properties.

Raise Error Action Properties

In a message flow, use the raise error action to raise an exception with a specified error code (a string) and description.

In the Message Flow Editor, click a raise error action to display its properties in the Properties view. Use these properties pages to configure the selected raise error action. The pages are:

The Raise Error page has the following options:

Option
Description
Code
The error code to be raised.
Message
Description of the error code

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Rename Action Properties

In a message flow, use the rename action to rename elements selected by an XPath expression without modifying the contents of the element.

In the Message Flow Editor, click a rename action to display its properties in the Properties view. Use these properties pages to configure the selected rename action. The pages are:

The Rename page has the following options:

Option
Description
XPath
An XPath expression used to specify the data (in the named variable) that will be renamed.
To create or edit the XPath expression, click <XPath> (or the XPath_fragment, if one is already defined) to display the XPath Expression Editor.
In Variable
The context variable that holds the element you want to rename.
Enter the name of the variable in this field.
Localname
A local name to use to rename the selected elements.
Enter the local name in this field.
Namespace
A namespace to use when renaming the selected elements.
Enter the namespace in this field.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Replace Action Properties

In a message flow, use a replace action to replace a node or the contents of a node specified by an XPath expression. The node or its contents are replaced with the value returned by an XQuery expression.

A replace action can be used to replace simple values, elements and even attributes. An XQuery expression that returns nothing is equivalent to deleting the identified nodes or making them empty, depending upon whether the action is replacing entire nodes or just node contents.

In the Message Flow Editor, click a replace action to display its properties in the Properties view. Use these properties pages to configure the selected replace action. The pages are:

The Replace page has the following options:

Option
Description
XPath
The XPath expression used to specify the data (in the named variable) that will be replaced.
To create or edit the XPath expression, click <XPath> (or the XPath_fragment, if one is already defined) to display the XPath Expression Editor.
Variable
Enter a context variable.
Expression
The XQuery expression used to create the data that replaces the data specified by the XPath in the named variable.
To create or edit an expression, click <Expression> (or the expression_fragment, if one is already defined) to display the XQuery/XSLT Expression Editor.
Replace entire node
or
Replace node contents
When you finish editing the XQuery expression, select one of the options:
  • Replace entire node—to specify that the nodes selected by the XPath expression you defined are replaced along with all of its contents
  • Replace node contents—to specify that the node is not replaced; only the contents are replaced.

Note: Selecting the Replace node contents option and leaving the XPath field blank is more efficient than selecting the Replace entire node option and setting the XPath to ./*

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Reply Action Properties

In a message flow, use the reply action to specify that an immediate reply be sent to the invoker.

The reply action can be used in the request, response or error pipeline. You can configure it to result in a reply with success or failure. In the case of reply with failure where the inbound transport is HTTP, the reply action specifies that an immediate reply is sent to the invoker.

In the Message Flow Editor, click a reply action to display its properties in the Properties view. Use these properties pages to configure the selected reply action. The pages are:

The Reply page has the following options:

Option
Description
With Success
or
With Failure
Select With Success to reply that the message was successful, or select With Failure to reply that the message has a fault.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Report Action Properties

In a message flow, use the report action to enable message reporting for a proxy service.

In the Message Flow Editor, click a report action to display its properties in the Properties view. Use these properties pages to configure the selected report action. The pages are:

The Report page has the following option:

Option
Description
Expression
The XQuery expression used to create the data that will be reported.
To create or edit an expression, click <Expression> (or the expression_fragment, if one is already defined) to display the XQuery/XSLT Expression Editor.
Search Keys
When you finish editing the XQuery expression, click Add a Key to add one or more key value pairs to be used to extract key identifiers from any message context variable or message payload. (The rest of the message is ignored.) The keys are a convenient way to identify a message.
  1. In the Key Name: Name field enter a name for the key.
  2. In the Key Value column, click <XPath> to create the XPath expression in the XPath Expression Editor.
  3. In the In variable field, enter the name of the variable on which the expression will be executed.

For example, consider a report action configured on an error handler in a stage. The action reports the contents of the fault context variable in the event of an error. The report action is configured as follows:

Each time this action is executed at run time, a message is reported via the Reporting Data Stream. The following table shows the results after the report action is executed twice.

Report Index
DB TimeStamp
Inbound Service
Error Code
errorCode=BEA-382505
04/26/07 9:45 AM
MortgageBroker/ProxySvcs/loanGateway3
BEA-382505
errorCode=BEA-382505
04/26/07 9:45 AM
 
BEA-382505

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Resume Action Properties

In a message flow, use the resume action to resume message flow after an error is handled by an error handler. This action has no parameters and can only be used in error pipelines.

In the Message Flow Editor, click a resume action to display its properties in the Properties view. Use these properties pages to configure the selected resume action. The pages are:

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Route Node Properties

In a message flow, use the route node to handle request and response dispatching of messages to and from business services. No other nodes can follow a route node.

In the Message Flow Editor, click a route node to display its properties in the Properties view. Use these properties pages to configure the selected route node. The pages are:

The Route page has the following option:

Option
Description
Name
Enter a name for the route node.
Description
Enter a description for the route node.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Routing Action Properties

In a message flow, use a routing action to identify a target service for the message and configure how the message is routed to that service.

This is a terminal action, which means you cannot add another action after this one. However, this action can contain request and response actions.

In the Message Flow Editor, click a routing action to display its properties in the Properties view. Use these properties pages to configure the selected routing action. The pages are:

The Routing page has the following option:

Option
Description
Service
The target service for the routing action. Click Browse to select a proxy service or business service from a list.
Invoking
The operation to be invoked on the target service.
This option appears only if the selected service defines any operations.
To configure how the message is packaged and sent to the service, in the Request Actions field, click Add an Action. Then select an action to associate with the service. You can add more than one action.
Use inbound operation for outbound
Select this option to make the outbound operation the same as the inbound operation.
This option appears only if the selected service defines any operations.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Routing Options Action Properties

In a message flow, use a routing options action to modify any or all of the following properties in the outbound request: URI, Quality of Service, Mode, Retry parameters, Message Priority.

In the Message Flow Editor, click a routing options action to display its properties in the Properties view. Use these properties pages to configure the selected routing options action. The pages are:

The Routing Options page has the following option:

Option
Description
URI
Select this option to set the URI for the outbound message:
To create or edit an expression, click <Expression> (or the expression_fragment, if one is already defined) to display the XQuery/XSLT Expression Editor.
Enter an expression that returns a URI. This overrides the URI for the invoked service.
QoS
Select this option to set the Quality of Service element:
Select a QoS option from the drop-down list. This overrides the default.
Mode
Select this option to set the mode to Request or Request-Response.
Select the mode from the drop-down list.

Note: This is normally already automatically set, based on the interface of the service invoked. However, in some cases like Any Soap or Any XML services, this is not so.

Retry Interval
Select this option to set the retry interval.
Specify the number of seconds between retries. This overrides the default configured with the invoked service.
Retry Count
Select this option to set the retry count.
Specify the number of retries the system must attempt before discontinuing the action. This overrides the default configured with the invoked service.
Priority
Select this option to set the message priority:
To create or edit an expression, click <Expression> (or the expression_fragment, if one is already defined) to display the XQuery/XSLT Expression Editor.
Enter an expression that returns a positive integer.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Routing Table Action Properties

In a message flow, use a routing table to select different routes based upon the results of a single XQuery expression. A routing table action contains a set of routes wrapped in a switch-style condition table.

This is a terminal action, which means you cannot add another action after this one. However, this action can contain request and response actions.

When you add a routing table action to a message flow in the Message Flow Editor, the routing table action contains a case action with a path to a routing action plus a default case action with a path to a default routing action, as shown below. Click add condition to add another condition to the routing table.

Routing Table Properties

In the Message Flow Editor, click the publish table action itself (the Publish Table icon or the bounding box connected to the icon) to display the Publish Tables properties page in the Properties view. Use these properties pages to configure the selected publish table action. The pages are:

The Routing Table properties page has the following option:

Option
Description
Expression
An XQuery expression, which at run time returns the value upon which the routing decision will be made.
To create or edit an XQuery expression, click <Expression> (or the expression_fragment, if one is already defined) to display the XQuery/XSLT Expression Editor.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Case Action Properties

In the Message Flow Editor, click a case action to display its properties in the Properties view. Use this properties page to configure the selected case action, as described below:

Option
Description
  • Operator
  • Value
Select a comparison operator from the list. Then enter a value against which the value returned from the XQuery expression defined for the routing table action will be evaluate

Routing Action Properties

See Routing Action Properties.

Service Callout Action Properties

In a message flow, use a service callout action to configure a synchronous (blocking) callout to an ALSB-registered proxy or business service.

In the Message Flow Editor, click a service callout action to display its properties in the Properties view. Use these properties pages to configure the selected service callout action. The pages are:

The Service Callout page has the following options:

Option
Description
Service
The target service for the service callout action. Click Browse to select a proxy service or business service from a list.
Invoking
The operation to be invoked on the target service.
This option appears only if the selected service is WSDL-based and has operations that can be invoked on the service.
Configure Soap Body
or
Configure Payload Document
Specify how you want to configure the request and response messages by selecting one of the following options:
  • Select Configure SOAP Body to configure the SOAP Body. Selecting this option allows you to use $body directly.
  • This option supports SOAP-RPC encoded, which is not supported when configuring payload parameters or document.

  • Select Configure Payload Parameters or Configure Payload Document to configure the payload.

Subsequent configuration options depend on the kind of service you selected in step 3 and on the kind of configuration options you chose for that service in step 5. Table 3-1 shows the options available for each service type.

Selected Service Type
Configure SOAP Body” Options
“Configure Payload Parameters” Options or
“Configure Payload Document” Options
  • SOAP RPC
  • SOAP Document
  • Any SOAP
  • XML
  • Any XML
  • Messaging

The following table provides instructions for each of the options listed in the table above.

For These Options...
Follow These Steps...
SOAP Request Body and
SOAP Response Body
To configure these options,
  • In the SOAP Request Body field, enter the name of a variable to hold the XML of the SOAP Body element for the callout request.
  • In the SOAP Response Body field, enter the name of a variable to which the XML of the SOAP Body element on the response will be bound.
SOAP Request Header and
SOAP Response Header
To configure these options,
  • In the SOAP Request Header field, enter the name of a variable to hold the XML of the SOAP Header element for the callout request
  • You must wrap the input document for the SOAP Request Header with <soap-env:Header>...</soap-env:Header>.

  • In the SOAP Response Header field, enter the name of a variable to which the XML of the SOAP Headers on the response, if any, will be bound.
Request Parameters and
Response Parameters
To configure options,
  • In the Request Parameters fields, enter names for the variables that will be evaluated at run time to provide values for the request parameters.
  • You must provide only the core payload documents in the input variable—the SOAP package is created for you by AquaLogic Service Bus. In other words, do not wrap the input document with <soap-env:Body>...</soap-env:Body>.

    For example, when creating a body input variable that is used for this request parameter, you would define that variable’s contents using the XPath statement body/* (to remove the wrapper soap-env:Body), not $body (which results in keeping the soap-env:Body wrapper).

  • In the Response Parameters fields, enter the names of the variables to which the responses will be assigned at run time.
Request Document and
Response Document
To configure these options,
  • In the Request Document Variable field, enter the name of a variable to assign a request document to.
  • For SOAP Document-type services, the variable is evaluated at runtime to form the body of the SOAP message sent to the service. For Any XML services, the variable is evaluated at runtime to form the body of the XML message sent to the service.

    For SOAP Document-type services and for Any XML services, you provide only the core payload documents in the input variable—the SOAP package is created for you by AquaLogic Service Bus. In other words, do not wrap the input document with <soap-env:Body>...</soap-env:Body>.

    For example, when creating a body input variable that is used for this request parameter, you would define that variable’s contents using the XPath statement body/* (to remove the wrapper soap-env:Body), not $body (which results in keeping the soap-env:Body wrapper).

    For Messaging services, the variable is evaluated to form the body of the message, based on the type of data expected by the service. The following restrictions apply to variables used with Messaging services:

    • For services that expect binary data, the variables must have a ctx:binary-content element.
    • For services that expect MFL data, the variable must have the XML equivalent.
    • For services that expect text data, the variable is a string.
  • In the Response Document Variable field, enter the name of the variable to which a response document will be assigned at run time.

Optionally, add one or more transport header actions. For more information about transport header actions, see Transport Headers Action Properties

Note: In addition to the transport headers you specify, headers are added by the ALSB binding layer.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Skip Action Properties

In a message flow, use the skip action to specify that at run time, the execution of the current stage is skipped and the processing proceeds to the next stage in the message flow. This action has no parameters and can be used in the request, response or error pipelines.

In the Message Flow Editor, click a skip action to display its properties in the Properties view. Use these properties pages to configure the selected skip action. The pages are:

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Stage Node Properties

In a message flow, use a stage node as a container for actions in a message flow. You can string multiple stages together, to compartmentalize processing logic.

In the Message Flow Editor, click a stage node to display its properties in the Properties view. Use these properties pages to configure the selected stage node. The pages are:

The Stage page has the following options:

Option
Description
Name
Enter a name for the stage node.
Description
Enter a description of the stage node.

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Transport Headers Action Properties

In a message flow, use a transport header action to set header values in messages.

In the Message Flow Editor, click a transport headers action to display its properties in the Properties view. Use these properties pages to configure the selected transport headers action. The pages are:

The Transport Header page has the following options:

Option
Description
Direction
  1. From the Set Transport Headers for list, select one of the following, to specify to the run time which of the message context locations are to be modified:
    • Outbound Request - Select this option to set header values for outbound requests (the messages sent out by a proxy service in route, publish, or service callout actions). This header element is located in the message context as follows:
    • $outbound/ctx:transport/ctx:request/tp:headers

    • Inbound Response - Select this option to set header values for inbound responses (the response messages a proxy service sends back to clients). This header element is located in the message context as follows:
    • $inbound/ctx:transport/ctx:response/tp:headers

Pass All Headers
Select this option to pass all headers through from the inbound message to the outbound message or vice versa. Every header in the source set of headers will be copied to the target header set, overwriting any existing values in the target header set.
Headers
Click Add Header to add a header to the Headers table. Then configure each header as described in the following rows.
You can add as many headers as necessary to this table. You do not have to order the headers in the table, because the run time declares namespaces and places header elements in their proper order when generating the corresponding XML.
Headers: Name:
Specify a header by doing either of the following:
  • From the drop-down list in the Name column, select a header name. The list contains all of the predefined header names for the target transport (for example, Content-Type for HTTP transports, JMSCorrelationID for JMS transports, etc.).
  • Enter a header name in the Other field. If that header name is not one of the predefined headers for this service’s transport, it becomes a user-header, as defined by the transport specification.
Headers: Action
Select one of the options in this column to specify how to set the header’s value:
  • Set Header to Expression
  • Selecting this option allows you to use an XQuery or XSLT expression to set the value of the header. The expression can be simple (for example, “text/xml”) or a complex XQuery or XSLT expression.

    Because the ALSB transport layer defines the XML representation of all headers as string values, the result of any expression is converted to a string before the header value is set. Expressions that return nothing result in the header value being set to the empty string. You cannot delete a header using an expression.

    Warning: Not all of the header settings you can specify in this action are honored at run time.

  • Delete Header
  • Specifies that the header is removed from the request or response metadata.

    Copy Header from Inbound Request (if you are setting transport headers for the Outbound Request)
          or
    Copy Header from Outbound Response (if you are setting transport headers for the Inbound Response)

    Specifies that this header is copied directly from the corresponding header of the same name from the inbound message to the outbound message and vice versa. For example, if you want to set the SOAPAction header for an outbound request, selecting Copy Header from Inbound Request causes the run time to copy the value from the SOAPAction request header of $inbound. In the case of inbound response headers, the source of the header to copy is the response headers of $outbound.

    If the Copy Header... option is selected for a header that does not exist in the source, this option is ignored and no action is performed on the target for this header.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Validate Action Properties

In a message flow, use a validate action to validate elements selected by an XPath expression against an XML schema element or a WSDL resource. You can validate global elements only; ALSB does not support validation against local elements.

In the Message Flow Editor, click a validate action to display its properties in the Properties view. Use these properties pages to configure the selected validate action. The pages are:

The Validate page has the following options:

Option
Description
XPath
An XPath expression that specifies the elements to be validated.
To create or edit the XPath expression, click <XPath> (or the XPath_fragment, if one is already defined) to display the XPath Expression Editor.
In Variable
The name of the variable to hold the element to be validated. Enter the name of the variable, or, if Content Assist is on, press Ctrl-Space to display a list of declared variables.
Against Resource
An XML schema element or a WSDL resource against which the elements selected by the XPath expression (in the XPath field described above) are validated.
Save Variable
or
Raise Error
To save the result of this validation (a boolean result), select Save Variable and enter the name of the variable in which you want to save the result.
Alternatively, to raise an error if the element fails validation against the WSDL or XML schema element, select Raise Error.

Use the Comment page to add a comment, if desired:

Use the Namespaces page to see a list of defined namespaces or to create a new one.

Use the Variables page to see a list of defined context variables or to create a new one. For more information about context variables, see Message Context in the AquaLogic Service Bus User Guide.

Modify JAR Dependencies dialog

In ALSB, JAR resources can contain classes that depend on other classes in different JARs. Use the Modify JAR Dependencies page to add or remove referenced JAR resources. Use the Up and Down buttons to reorder the hierarchy (order of precedence) of referenced JARs. For more information, see JARs in Using the AquaLogic Service Bus Console.

Option
Description
Available JARs
The project name and the name of the folder, if applicable, in which the JAR resources reside. This column shows all available JARs in the current workspace.
JAR references
The name and path of the referenced JAR resources. This column shows all the JARs currently configured as dependencies.

SMTP Servers

The following editor and wizard are provided for working with SMTP servers:

Edit SMTP Server page

Use this page to view the details of an SMTP server and edit the configuration, if required. For descriptions of the fields, see the New SMTP Server Resource wizard. For more information, see Editing SMTP Servers in Using the AquaLogic Service Bus Console.

New SMTP Server Resource wizard

Use this page to configure a new SMTP server resource. For more information, see Adding SMTP Servers in Using the AquaLogic Service Bus Console.

Option
Description
Description
Enter a description for this SMTP server resource.
Server URL
Enter the URL that points to the SMTP server. This is a required field.
Port Number
Enter a port number for the SMTP server (the default port is 25). This is a required field.
User Name
If access to the target SMTP server requires a user name and password, enter a user name in the User Name field, and the associated password in the Password and Confirm Password fields.
These fields are optional, and required only if the SMTP server is secured.
Password
Enter the associated password.
Confirm Password
Enter the same password you entered for the Password field.

UDDI Registry Configuration page

Use this page to configure a UDDI registry resource. This page is displayed in the New UDDI Registry Resource wizard and in the UDDI Configuration editor.

For more information, see UDDI in Using the AquaLogic Service Bus Console and UDDI in the AquaLogic Service Bus User Guide.

Option
Description
Description
Enter a description of the registry.
Inquiry URL
The URL of the Inquiry API endpoint used for locating and importing services. Enter an inquiry URL in the format: http://host:port/APPLICATION_SERVER_CONTEXT/uddi/inquiry
Publish URL
The URL of the Publish API endpoint used for publishing services. Enter a publish URL in the format: http://host:port/APPLICATION_SERVER_CONTEXT/uddi/publishing
Security URL
The URL of the Security API endpoint used for getting an authentication token so that you can publish to the registry. Enter a security URL in the format: http://host:port/APPLICATION_SERVER_CONTEXT/uddi/security
Subscription URL
The URL of the Subscription API endpoint used for subscribing to registry changes, creating a registry subscription, and listening for changes to imported services. Enter a subscription URL in the format:
http://host:port/APPLICATION_SERVER_CONTEXT/uddi/subscription
By default, the value for APPLICATION_SERVER_CONTEXT in the installer is registry.
User Name
Enter the user name to log into the registry console.
Password (Confirm Password)
Enter the password to log into the registry console.
Validate
Click Validate to validate that a connection can be made to the configured registry.

Outline view - AquaLogic Service Bus

This view displays a hierarchical view, or outline, of a structured file that is currently open in the editor area. The contents of this view are editor-specific.

In ALSB, when the proxy service is editor is open and the Message Flow Editor is selected, the Outline view displays a hierarchical view of the nodes and actions in the message flow. When the Message Flow Editor is displayed, you can switch between the hierarchical view and a thumbnail view of the service, as described in the table below:

Button
Description

Click this button to display a hierarchical view of the contents of the current editor.

Click this button to display a graphical thumbnail view of the contents of the Message Flow Editor. When the entire message flow does not fit in the editor, a blue mask appears in the outline view to show what portion of the flow is visible in the editor. To display a different portion of the flow, you can drag the mask to the portion of the flow you want to display in the editor.

Resource Management

The following are provided for managing resources:

Preferences dialog - AquaLogic Service Bus - Type Associations page

Use this page to associate one or more file extensions with an ALSB resource type.

Option
Description
Resource Types
This pane lists all the available types of ALSB resources. Select a type to display its assigned file extension associated with the type.

References view

Use this page to view resource dependencies. This view shows your current selection whether it is in the Project Explorer or the active editor.

Option
Description
Referenced By
A list of the resources outside of this project, folder, or resource that are dependent on resources inside this project or folder, or this resource.
References
A list of the resources outside of this project, folder, or resource on which resources inside this project or folder, or this resource depends.

Select Clone Target dialog

Use this dialog to specify where to clone a project, as a new project or as a folder under a different project.

Option
Description
Name
Enter a name for the new (cloned) project.
As project
or
As folder in location
Select As project to clone the project as another project, that is, as a peer to the other projects.
Select As folder in location to convert a project (and its contents) into a folder under a project. When you select this option, you must also select the new location.

Select a Resource dialog

Use this dialog to select a resource, appropriate to the context, that has been created in or imported into the ALSB plug-in. When you click Browse from an editor or a wizard, this dialog displays the available resources that are appropriate for the context. The dialog has different names, depending on the type of resource displayed, for example, Select a WSDL, Select a MFL, Select an XML Schema, etc. In some cases, the dialog displays a hierarchical list of items contained in each resource. For example, the Select an XML Schema dialog lists elements and types defined in the schemas. The Select a WSDL dialog displays ports and bindings defined in the WSDLs.

In some cases, for example, the Select a WSDL dialog, you can click the Consume button to open the Service Consumption dialog, where you can consume services from the following resource types: AquaLogic Enterprise Repository, file system, UDDI, URI, workspace: consume a service residing in the current workspace.

New Service Key Provider Resource wizard

Use this page to configure a service key provider resource. For more information, see Service Key Providers in Using the AquaLogic Service Bus Console.

Option
Description
Description
Enter a description for the service key provider.
Encryption Key
  1. Next to Encryption Key, select the Key check box.
  2. Enter a key alias that maps to an X.509 certificate and that supports encryption, or click Browse to display the key aliases from the key store that your realm’s PKI credential mapper is using.
  3. Enter the password that you use to secure access to the key store. (You set the password when you create the key store.)
When you associate this service key provider with a proxy service, ALSB embeds the X.509 certificate into the proxy service’s WSDL. The proxy service then uses this certificate to encrypt the messages that it sends to its endpoint. The proxy service uses the private key in the PKI credential to decrypt the messages that the endpoint returns.
Digital Signature Key
  1. Next to Digital Signature Key, select the Key check box.
  2. Enter a key alias, or click Browse to display the key aliases from the key store that your realm’s PKI credential mapper is using.
  3. Enter the password that you use to secure access to the key store. (You set the password when you create the key store.)
SSL Client Authentication Key
  1. Next to SSL Client Authentication Key, select the Key check box.
  2. Enter a key alias, or click Browse to display the key aliases from the key store that your realm’s PKI credential mapper is using.
  3. Enter the password that you use to secure access to the key store. (You set the password when you create the key store.)

New WS-Policy wizard

Web Services Policy Framework (WS-policy) is an extensible XML-based framework that extends the configuration of a Web Service with domain specific security assertions and specifies the security requirements, expectations, and capabilities of the Web Service. In ALSB, one of the primary uses of WS-policy is configuring message-level security in proxy services and business services. For more information, see Custom WS-Policies in Using the AquaLogic Service Bus Console.

Use this page to select a name and location for a new WS-policy resource.

Option
Description
Enter or select the parent folder
Enter or select the name of the project or folder in which to locate a new WS-policy resource.
File Name
Enter a name for this WS-policy.

Service Accounts

The following are provided for working with service accounts:

New Service Account Resource wizard

Use this wizard to create a new service account resource, as described in the following table.

Option
Description
Description
Enter a description for the service account.
Resource Type
  • To create a service account that provides the user names and passwords that it receives from incoming client requests, select Pass Through and click Finish.
  • To create a service account that provides a user name and password that you save with the service account configuration, select Static. Continue as described in Service Account editor - Static User Configuration page.
  • To create a service account that maps the user name from one or more authenticated clients to user names and passwords that you specify, select Mapping. Continue as described in Service Account editor - User Mappings Configuration page.

For more information, see Service Accounts in Using the AquaLogic Service Bus Console.

Service Account editor - General Configuration page

Use this page to configure a service account resource, as described in the following table.

Option
Description
Description
Enter a description for the service account.
Resource Type
Leave the resource type as is, or select a different resource type:

For more information, see Service Accounts in Using the AquaLogic Service Bus Console.

Service Account editor - Static User Configuration page

Use this to page to save a user name and password with the service account configuration. The service account encodes this user name and password in the outbound request. For more information, see Service Accounts in Using the AquaLogic Service Bus Console.

Option
Description
User Name
Enter a user name for this service account.
Password
Enter the associated password.
Confirm Password
Enter the same password you entered for the Password field.

Service Account editor - User Mappings Configuration page

Use this to page to create a service account that maps the user name from one or more clients to user names and passwords that you specify. For more information, see Service Accounts in Using the AquaLogic Service Bus Console.

Option
Description
Remote Users
In the Remote User Name and Remote Password fields, enter the user name and password that you want to send in outbound requests.
(Optional) Add additional remote users in the Remote Users table.
Local User Mappings
To map authorized clients to remote user names and passwords, in the Local User Name field, enter the name that identifies a client that has been authenticated on its inbound request.
If you have not already added this user in the Security Configuration module of the ALSB Console, do so before you use this mapping in a runtime environment. See Adding Users in Using the AquaLogic Service Bus Console. ALSB lets you create a mapping for a non-existent local user, but the mapping will never match an authenticated user and will never be used.
From the Remote User Name list, select the user name that you want to send in outbound requests for the authenticated user you specified in the Local User Name field.
Map Anonymous Requests
To map anonymous clients to remote user names, select the Map Anonymous Requests check box.
From the Select Remote User list, select the user name that you want to send in outbound requests for all anonymous users.

Expression Editors

The following editors help you to write expressions for use in services.

XQuery/XSLT Expression Editor

Use the XQuery/XSLT Expression editor to create variable structures, define user namespaces, use predefined message context variables to build inline XQuery expressions, build inline XQuery expressions manually, and select XQuery or XSLT resources for execution as inline XQueries.

For more information about using XQueries, see Working with Variable Structures in the AquaLogic Service Bus User Guide

The XQuery/XSLT Expression editor contains two panels, each containing three tabs.

Use the panel on the left to write or construct the expression. The panel contains these pages (tabs):

Use the tabs in the panel on the right to manage the variables, namespaces, and XQuery functions you can use to construct an XQuery or XSLT. The panel contains these pages (tabs):

XPath Expression Editor

Use the XPath Expression Editor to create an XPath expression, which is then inserted into the location from which you launched the editor.

The XPath Expression Editor contains these pages:

You can write an expression directly in the Expression text field, or you can drag variables from the Variable Structure page and drag XQuery functions from the XQuery Functions page to construct a valid XPath expression.

When you are finished constructing the expression, you can click Test to test the expression on a running server. Or click OK to insert the expression without testing it.

Condition Editor

Use the Condition Editor to create an inline XQuery condition.

Use the panel on the left to write or construct the condition. The panel contains these tabs, each of which is described below:

Use the tabs in the panel on the right to manage the variables, namespaces, and XQuery functions you can use to construct a condition. The panel contains the following tabs. They are the same as the tabs in the right-hand panel of the XQuery/XSLT Expression Editor, and the following links display the help for those tabs in the XQuery/XSLT Expression Editor.

Condition Builder page

Use the Condition Builder page to build an inline condition. This page appears only in the Condition Editor.

Build an expression in the Condition Builder as follows:

  1. Select Comparison Expression to build a comparison expression or select Unary Expression to build a unary expression.
  2. If you chose Comparison Expression, do the following:
    1. In the Operand field, enter the name of the operand you want to compare to a value. Alternatively, drag an item from the Variable Structures tab on the right to the Operand field.
    2. In the Value field, enter the value against which to compare the operand. Alternatively, drag item from the Variable Structures tab on the right to the Value field.
    3. Select a comparison operator from the Operator list.
    4. Go to step 4.
  3. If you chose Unary Expression, do the following:
    1. Select or deselect the Not check box to indicate whether to evaluate the expression as true or not true, that is, to specify whether the expression should be enclosed by not().
    2. Enter an expression in the text field, or construct it by dragging items from the Variable Structures tab on the right.
  4. Do either of the following:
    • Click Add to add a new statement to the expression in the Condition Expression field.
    • Select a statement in the Condition Expression field, then click Update to modify the statement.
  5. Click Test to test the expression in a running server, or click OK to insert the condition in the message flow.

Expression page

This page appears on the XQuery/XSLT Expression Editor, the XPath Expression Editor, and the Condition Editor.

The Expression page contains a text field where you can build expressions by typing directly into the field or by dragging items from the Variable Structures page or the XQuery Functions page on the right side of the editor.

Click Test to test the expression in an ALSB domain on a running server. WebLogic Server is packaged with ALSB, so an installation of ALSB includes an embedded server you can use for testing purposes.

XQuery Resource page

This page appears in the XQuery/XSLT Expression Editor only.

In the message flow of a proxy service, you can assign XQuery expressions to message context variables, assign if-then-else actions based on the Boolean result of an XQuery expression, insert the result of an XQuery expression at an identified place relative to an XPath expression, specify the message context that you want to log through XQuery expressions on context variables, and so on.

Use the XQuery Resource page to configure an XQuery transformation to be executed in the message flow of a proxy service.

Field
Description
XQuery
The XQuery resource to be executed. Click Browse to find and open an XQuery resource that has been registered in ALSB.
Bind Variables
When you select a resource, each input parameter of the transformation is displayed. Each label corresponds to the name of a parameter, and each text box is for defining an XQuery expression to be mapped to the parameter. You must define a mapping for each parameter. Enter the expression directly, or drag variables and structures from the right panel.

XSLT Resource page

This page appears in the XQuery/XSLT Expression Editor only.

Use the XSLT Resource tab to configure an XSLT transformation to be executed in the message flow of a proxy service.

Field
Description
XSLT
The XSLT resource to execute. Click Browse to find and open a resource registered with ALSB.
Input Document
An XQuery expression for the input document to the transformation, for example $body.
Bind Variables
A label and a corresponding text box is displayed for each input parameter of the transformation. Each label corresponds to the name of a parameter, and each text box is for defining an XQuery expression to be bound to the parameter. You must define a binding for each parameter. For example, if an XSL transformation has two input parameters named one and two, the Variable Name field has two labels one and two— with a text box associated with each into which the XQuery expression is entered.

Enter the expression directly, or drag variables and structures from the right panel.

The following XQuery expressions are examples of valid input to this field:
$body/*[1]
$body/po:PurchaseOrder
Note: The following variable name is not a valid entry for this field and results in an exception:

body

Variable Structures page

This page appears in the XQuery/XSLT Expression Editor, the XPath Expression Editor, and the Condition Editor.

The Variable Structures page displays variables and their contents as trees. It includes the built-in message context variables attachments, body, header, outbound, and inbound, as well as any user-defined variables. It includes fault if the context of the expression is appropriate (htat is, in an error handler). The outbound variable is always listed; even though it is not valid in every context. If outbound is used in invalid contexts, it will be reported when validating.

Each variable structure mapping entry has a label and maps a variable or variable path to one or more structures. The scope of these mappings is a stage or a route node.

You can drag items from this page to the editor’s Expression page to insert them into the current expression. They are inserted as XPath expressions.

To define a new variable and add it to the variable structure tree, click Add to open the Add Variable Structure dialog.

For more information about working with variable structures, see Working with Variable Structures in the AquaLogic Service Bus User Guide

Namespace Definitions page

This page appears in the XQuery/XSLT Expression Editor, the XPath Expression Editor, and the Condition Editor.

The Namespace Definitions page lists default ALSB namespaces, variable namespaces, and user-defined namespaces. Click Add to define a new namespace, which is then added to the list of user-defined namespaces. To modify a user-defined namespace, select it in the list, then click Edit.

XQuery Functions page

This page appears in the XQuery/XSLT Expression Editor, the XPath Expression Editor, and the Condition Editor.

The XQuery Functions page lists a set of standard XQuery functions, organized alphabetically and by type. You can drag functions from this page to the editor’s Expression page to insert them into the current expression. When you insert a function into an expression, placeholders are used for parameter values you must supply.

Add Variable Structure dialog

Use this dialog to define a variable and add it to the tree of variable structures in the Variable Structures page of the Expression Editors.

You create variable structures in this dialog to define the structure of a variable for design purposes. For example, it is easier to browse the XPath variable in the structure view rather than viewing the XML schema of the XPath variable. Variable structures do not create variables. Variables are created at runtime as the target of the assign action in the stage.

You can declare your own variable structures based on:

You can use this feature directly for all user-defined variables, as well as $inbound, $outbound, and $fault. However, you cannot use it directly to access XML attachments in $attachments, headers in $header, or documents and RPC parameters in $body, with one exception— you can use it directly to access documents and parameters in $body for request messages received by a WSDL proxy service.

When you create a variable structure based on XML types, MFLs, or service interfaces, you must enter the following information into the fields at the top of the page:

Option
Description
Structure Label
A display name for the variable you want to create. This display name enables you to give a meaningful name to the structure so you can recognize it at design time but it has no impact at run time.
Structure Path
The path of the variable structure at run time

For more information about working with variable structures, see Working with Variable Structures in the AquaLogic Service Bus User Guide

New XSL Transformation wizard

Transformation maps describe the mapping between two data types. eXtensible Stylesheet Language Transformation (XSLT) maps describe XML-to-XML mappings. For more information, see XSL Transformations in Using the AquaLogic Service Bus Console.

Use this page to select a name and location for a new XSL transformation. This wizard creates a skeleton for the XSLT. Add details in the XSLT editor.

Option
Description
Enter or select the parent folder
Enter or select the name of the project or folder in which to locate a new XSL transformation.
File Name
Enter a name for this new XSL transformation.

Split-Join User Interface Reference

The following sections describe the fields and user interface components involved with creating and configuring Split-Joins in ALSB.

Split-Join Design Palette

The Split-Join Design Palette lists all the controls you can use to construct a Split-Join. To insert a control into a Split-Join, drag the icon from the palette to the Split-Join editor. When you drag an item to the editor, one or more circles (drag-points) appear () to indicate that you can drop the dragged item in that position on the editor. When you drag the item into such a circle, it is highlighted () to show that you can drop the item there.

Controls

The Split-Join Design palette is organized into the following categories:

The following table describes the controls you can add to a Split-Join:

Control
Description
Communication
Invoke Service
Invoke Service invokes a WSDL-based, non-transport-typed Business Service or a WSDL-based Proxy Service.
For configuration properties, see Split-Join Properties View - Invoke External Service.
Reply
Reply sends a response or fault back to the ALSB Message Flow.
For configuration properties, see Split-Join Properties View - Reply Page.
Flow Control
Parallel
Parallel creates a fixed number of configured parallel branches.
For configuration properties, see Split-Join Properties View - Parallel.
For Each
For Each executes logic configured within its Scope a specified number of times.
For configuration properties, see Split-Join Properties View - For Each.
If
If provides conditional behavior within a Split-Join.
For configuration properties, see Split-Join Properties View - If Activity.
Raise Error
Raise Error generates an error that causes the Split-Join to stop normal processing. If the error is not handled using an Error Handler, the Split-Join will terminate and a Fault will be sent to the ALSB Message Flow.
For configuration properties, see Split-Join Properties View - Raise Error Page.
Message Processing
Assign
Use Assign for data manipulation, including initializing and updating a Variable.
For configuration properties, see Split-Join Properties View - Assign.

Split-Join Properties View - Error Handler

Use this properties page to review and configure the selected Error Handler in a Split-Join.

The Error Handler receives and handles all of the errors that are raised in a Split-Join.

The catchAll tab has the following options.

Option
Description
SOAP Fault Variable Name
Defines a variable to contain SOAP (1.1 or 1.2) faults. If the Error Handler is executed due to a SOAP fault received from invoked external services, this variable is populated with the received SOAP fault.

Split-Join Properties View - External Services

Use this properties page to review and configure the selected External Services (business and proxy services) invoked from the Split-Join.

Use External Services to call Services outside of the context of the Split-Join.

When you select External Service, a dashed blue line appears pointing to the Invoke Service associated with the service.

Option
Description
Service Location
Shows the location of the External Service within the ALSB Configuration.
The location path is a link that opens the service file.

Split-Join Properties View - Assign

Use this properties page to review and configure the selected Assign in an Split-Join.

Use Assign for data manipulation, including initializing and updating a Variable.

This page has two tabs:

The Assign tab has the following options:

Option
Description
Add
Provides the following options for adding operations to the Assign:
Edit
Launches the appropriate dialog for the selected item (as listed for Add, above)
Delete
Deletes the currently selected operation(s)
Up and Down Arrows
Click the up arrow or down arrow to change the position of the currently selected operation. This option is only enabled when more than one operation exists.
Assign Operations
  • Assign the result of an XQuery expression to a Variable.
  • To create an Assign operation, select Assign from the Add Button to launch the Assign Operation Dialog.

  • Copy the information specified by an XPath expression from a source document to a destination document.
  • To create a Copy operation, select Copy from the Add Button to launch the Copy Literal/XPath 1.0 Expression Dialog.

  • Delete a set of nodes specified by an XPath Expression.
  • To create a Delete operation, select Delete from the Add Button to launch the Delete Action Dialog.

  • Insert the result of an XQuery expression at an identified place relative to nodes selected by an XPath Expression.
  • To create an Insert operation, select Insert from the Add Button to launch the Insert Action Dialog.

  • Replace a node or the contents of a node specified by an XPath Expression.
  • To create a Replace operation, select Replace from the Add Button to launch the Replace Action Dialog

The General tab has the following options:

Option
Description
Label
Enter a label for the file defining the External Service.
Documentation
Enter a description and/or comments.

Split-Join Properties View - Global Properties

Use this properties page to review and configure the Global Properties of the selected Split-Join.

The initial node in a Split-Join specifies its Global Properties. Among these properties, Global Variables and associated External Services can be reviewed and configured by expanding the left-side arrow. The global Error Handler can be reviewed and configured by expanding the right-side arrow.

This page has two tabs:

The Imports tab has the following options:

Option
Description
WSDL Imports
Displays WSDL Imports used by the Split-Join.
Select a WSDL in the list and right-click to delete it.
Schema Imports
Displays Schema Imports used by the Split-Join.
Select a Schema in the list and right-click to delete it.

The General tab has the following options:

Option
Description
Label
Enter a label for the file defining the Process Node.
Documentation
Enter a description and/or comments.

Split-Join Properties View - For Each

Use this properties page to review and configure the selected For Each in a Split-Join.

For Each executes logic configured within its Scope a specified number of times.

This page has two tabs:

The For Each tab has the following options:

Option
Description

Parallel

Select one of the following options:
  • If yes is selected, each iteration of For Each is executed in parallel.
  • If no, each iteration of For Each is executed sequentially.

Counter Variable Name

Defines an implicit variable within the Scope of the For Each. Each iteration of the For Each contains an isolated instance of this variable. In turn, every instance is set to an iteration number; for example, the first iteration has its value set to Start Counter Value, the second iteration to Start Counter Value+1, etc.

Start Counter Value

The value of the Counter Variable for the first iteration of For Each. Determined as the result of an XPath 1.0 expression. The result must be “1” or more. (“0” is not a valid Start Counter Value.)

The browse button launches the Copy Literal/XPath 1.0 Expression Dialog. The built Expression should generate an integer for the initial Start Count Value.

Final Counter Value

The value of the Counter Variable for the final iteration of For Each. Determined as the result of an XPath 1.0 expression. The result must be “1” or more. (“0” is not a valid Start Counter Value.)

The browse button launches the Copy Literal/XPath 1.0 Expression Dialog. The built expression should generate an integer for the Final Count Value.

The General tab has the following options:

Option
Description
Label
Enter a label for the file defining the For Each condition.
Documentation
Enter a description and/or comments.

Split-Join Properties View - If Activity

Use this properties page to review and configure the selected If in a Split-Join.

Use If to provide conditional behavior within an Split-Join.

Option
Description
Label
Enter a label for the file defining the If Condition.
Documentation
Enter a description and/or comments.

Split-Join Process Properties View - If and Else If

Use this properties page to review and configure the selected If or Else If in an Split-Join.

The If and Else If controls provide conditional behavior within an Split-Join.

Option
Description
Condition
Define an XPath 1.0 expression that evaluates to true or false. If the condition evaluates to true, the associated If/Else If branch is executed.
Click the browse button to launch the Copy Literal/XPath 1.0 Expression Dialog.

Split-Join Properties View - Invoke External Service

Use this properties page to review and configure the selected Invoke External Service in a Split-Join.

Use Invoke External Service to invoke a WSDL-based, non-transport-typed Business Service or a WSDL-based Proxy Service.

This page has four tabs:

The Operation tab has the following options:

Option
Description
Operation
The operation to be invoked by the Service
Browse to select an operation from the Service Browser.
Service Location
The location of the invoked Service.
Click the location path to open the service file.

The Input Variable tab has the following options:

Option
Description
Message Variable
A list of message type variables with the type matching the operation’s input message type.
Select Create New Variable to define a new message variable.

Note: If message type variables with the type matching the operation’s input message type do not exist, you must define a new message type variable with the required type.

Message Type Namespace
The namespace of the operation’s input message type.
Message Type
The operation’s input message type.

The Output Variable tab has the following options:

Option
Description
Message Variable
A list of message type variables with the type matching the operation’s output message type.

Note: If message type variables with the type matching the operation’s output message type do not exist, you must define a new message type variable with the required type.

Message Type Namespace
The namespace of the operation’s output message type.
Message Type
The operation’s output message type.

The General tab has the following options:

Option
Description
Label
Enter a label for the file defining the Invoke Service
Documentation
Enter a description and/or comments

Split-Join Properties View - Parallel

Use this properties page to review and configure the selected Parallel in a Split-Join.

Parallel creates a fixed number of configured parallel branches.

Option
Description
Label
Enter a label for the file defining the Parallel.
Documentation
Enter a description and/or comments.

Split-Join Properties View - Raise Error Page

Use this properties page to review and configure the selected Raise Error in an Split-Join.

Raise Error establishes an error condition under which the execution of the process will halt.

Option
Description
Label
Enter a label for the file defining the Raise Error.
Documentation
Enter a description and/or comments.

Split-Join Properties View - Receive Page

Use this properties page to review and configure the selected Receive in a Split-Join.

This page has three tabs:

The Operation tab has the following options:

Option
Description
Operation
The operation to be invoked by the Receive.
Browse to select an operation from the WSDL Browser.

The Variable tab has the following options:

Option
Description
Message Variable
A list of the message variables whose type matches the operation’s output message type
Select Create New Variable to define a new message variable.

Note: If message type variables with the type matching the operation’s output message-type do not exist, you must define a new message type variable with the required type.

Message Type Namespace
The namespace of the operation’s output message type.
Message Type
The operation’s output message type.

The General tab has the following options:

Option
Description
Label
Enter a label for the file defining the Reply
Documentation
Enter a description and/or comments

Split-Join Properties View - Reply Page

Use this properties page to review and configure the selected Reply in a Split-Join.

Reply sends a response or fault back to the ALSB message flow.

This page has three tabs:

The Operation tab has the following options:

Option
Description
Operation
The operation to be invoked by the Reply.
Binding
 
WSDL Ref
 

The Variable tab has the following Select options:

Option
Description
Message Variable
A list of the message variables whose type matches the operation’s output message type.
Select Create New Variable to define a new message variable.

Note: If message type variables with the type matching the operation’s output message-type do not exist, you must define a new message type variable with the required type.

Message Type Namespace
The namespace of the operation’s output message type.
Message Type
The operation’s output message type.
Fault Options
Pick WSDL Fault/SOAP Fault
Determine whether the fault reply is a fault message defined in the operation of the WSDL or an explicit SOAP fault message.
Fault Name
Select a fault name from the list of faults defined in the operation of the WSDL.
Message Variable
A list of the Message Variables whose type matches the operation’s output message type.
Select Create New Variable to define a new message variable.

Note: If message type variables with the type matching the operation’s output message-type do not exist, you must define a new message type variable with the required type.

Message Type Namespace
The namespace of the operation’s output message type.
Message Type
The operation’s output message type.
SOAP Fault
Select SOAP Fault
Propagate SOAP Fault
Propagate the SOAP fault in the SOAP fault variable defined in the Error Handler.

The General tab has the following options:

Option
Description
Label
Enter a label for the file defining the Reply
Documentation
Enter a description and/or comments

Split-Join Properties View - Scope

Use this properties page to review and configure the selected Scope in a Split-Join.

The Scope creates a context which influences the behavior of its enclosed controls. Local variables and the Error Handler defined within the Scope are restricted to this context.

Option
Description
Label
Enter a label for the file defining the Scope.
Documentation
Enter a description and/or comments.

Split-Join Properties View - Start Node

Use this properties page to review and configure the Start Node in a Split-Join.

The Start Node contains global variables and imports introspected from the WSDL Operation. It can also have an associated global Error Handler.

This page has two tabs:

The Imports tab has the following options:

Option
Description
WSDL Imports
WSDLs imported by the Split-Join
Schema Imports
Schemas imported by the Split-Join

Option
Description
Label
Enter a label for the file defining the Scope.
Documentation
Enter a description and/or comments.

The General tab has the following options:

Split-Join Properties View - Variable

Use this properties page to review and configure Variables in the selected Split-Join.

Option
Description
(tree)
Depicts the hierarchical structure of the Variable’s type.
Edit
Click to display the Create/Edit Variable Dialog, where you can modify the Variable’s name and type.

Assign Operation Dialog

Use this dialog to create an Assign Operation for use in an Assign.

Option
Description
Expression
An XQuery expression used to create the data that will be assigned to the Variable.
Clicking the expression launches the XQuery editor.
Variable

A variable to which the result of the XQuery expression is assigned.

Only previously defined Variables, the Counter Variable, and SOAP Fault Variables (for Error Handlers) are available.

Copy Literal/XPath 1.0 Expression Dialog

Use this dialog to create a Copy Operation for use in an Assign.

Option
Description
Choose Type
Allows the user to select the desired type: Variable, Expression, Literal, or XML Fragment. Literals and XML fragments are available only in the Select From menu.
Choose Type - Variable
Select an XPath on a Variable. Use this option when simple node selection on a Variable is required.
When a node is selected by expanding the Variable tree, and Xpath 1.0 expression is automatically generated.
Choose Type - Expression

Create an Xpath 1.0 expression to select a node from a Variable.Use this option when more complex Xpaths (potentially with predicates) are required to select a node on a Variable.

Click the browse button to use the Copy Literal/XPath 1.0 Expression dialog.

Note: The entered Xpath 1.0 expression should only copy to one XML node/element, or there will be runtime errors.

Choose Type - Literal
A Literal string entered by the user
Choose Type - XML Fragment
An XML fragment entered by the user.

Counter Variable Dialog

Use this dialog to create a Counter Variable.

Option
Description
Counter Variable Name
The name of the Counter Variable

Create/Edit Variable Dialog

Use this dialog to review and/or configure Variables in the Split-Join.

Option
Description
Name
Enter a unique name for the Variable.
Select Variable Type
Select one of the following Variable Types:
  • Built-in Types
  • Schema Types
  • Message Types
Select Variable Type - Basic Types
When selected, only Basic Type Variables are displayed.
Select Variable Type- Schema Types
When selected, all Schema Types in the current ALSB Configuration are displayed.
If “Show only applicable schema types/elements for this Split-Join” is selected, only Schema Types directly applicable to the current Split-Join are displayed. This is checked by default.

Select Variable Type - Message Types

When selected, only message types are displayed.
If “Show only applicable schema types/elements for this Split-Join” is selected, only Schema Types directly applicable to the current Split-Join are displayed. This is checked by default.
Type
The Variable type.
Namespace
The namespace of the Variable’s type.

Create Message Variable Dialog

Use this dialog to create a new Variable.

Option
Description
Name
Enter a unique name for the Variable.
Type
One of the following Variable types: WSDL message, XSD element, or XSD type (simple, complex, built-in).
Namespace
The namespace of the Variable’s type.

Delete Action Dialog

Use this dialog to create a Delete Action for use in an Assign.

Option
Description
XPath
An XPath Expression that selects the nodes to be deleted.
Click on the XPath to launch the XPath Editor.
In Variable
Variable on which the XPath expression is executed to select the nodes to be deleted.

Insert Action Dialog

Use this dialog to create an Insert Action for use in an Assign.

Option
Description
Expression
An XQuery 1.0 expression used to create the data that will be inserted at a specified location in a Variable.
Click on the Expression to launch the XQuery editor.

Location

The location used to control where the Insert Action is performed relative to the result of the XPath 1.0 Expression. Options include:
  • Before: Immediately before the element specified by the result of the Xpath 1.0 Expression.
  • After: Immediately after the element specified by the result of the Xpath 1.0 Expression.
  • as first child of: The first child element of the element specified by the result of the Xpath 1.0 Expression.
  • as last child of: The last child element belonging to the element specified by the result of the Xpath 1.0 Expression.
XPath
An XPath that determines the nodes to be selected.
Click on the Xpath to launch the XPath Expression Editor.
Variable
A Variable to be evaluated by the XPath.

Replace Action Dialog

Use this dialog to create a Replace Action for use in an Assign.

Option
Description
XPath
An XPath 1.0 Expression used to specify the data (in the Variable) that will be replaced.
Click on the XPath to launch the XPath Expression Editor.
Variable
The Variable that contains the data to be replaced
Expression
An XQuery 1.0 expression used to create the data that replaces the data specified by the XPath in the named Variable.
Click on the Expression to launch the XQuery 1.0 editor.

Replace entire node

Specifies that the nodes selected by the XPath 1.0 expression defined above are replaced along with all of its contents.

Replace node contents
Specifies that the node is not replaced. Only the contents are replaced.

Split-Join Wizard - New Split-Join

Use this page to locate and name the new Split-Join

Option
Description
Enter or select the parent folder
Enter the name of the folder to contain this Split-Join, or select a folder from the list.
File Name
Enter a name for the file defining the Split-Join.

Split-Join Wizard - Specify Operations

Use this page to select an operation for the new Split-Join.

Option
Description
Select Operation
Select the operation from those available in the tree.
Consume
Click this button to import WSDLs from outside your current ALSB configuration that can subsequently be used to select an operation.

Service Browser

Use this dialog to browse for and select an operation from a Business or Proxy Service in the depicted tree.

SOAP Fault Variable Dialog

Use this dialog to create a SOAP fault variable.

Option
Description
SOAP Fault Variable Name
The name of the SOAP fault variable.

WSDL Browser

Use this dialog to browse for and select an operation from a WSDL in the depicted tree.


  Back to Top       Previous  Next