> Using the AquaLogic Service Bus Plug-in for WorkSpace Studio > Tasks

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

Tasks

This section tells how to perform tasks in the AquaLogic Service Bus Plug-in for WorkSpace Studio:

Working with Projects, Folders, Resources, and Configurations

This section tells how to perform the following tasks:

See also the following information about working with other kinds of resources:

Editing Resources

Edit resources using the built-in editors. For example, edit a proxy service by double-clicking its name in the Project Explorer.

Do not manually edit resource files as text or XML files. This can result in unpredictable behavior. Do not manually edit these resource types:

Cloning ALSB Projects and Folders

  1. In the Project Explorer, right-click the ALSB project or folder you want to clone.
  2. From the menu, select AquaLogic Service Bus > Clone to display the Select Clone Target dialog. Enter information as appropriate.

Creating ALSB Configuration Projects

In the ALSB perspective, select File > New > ALSB Configuration Project to display the New AquaLogic Service Bus Configuration Project wizard. Enter information as appropriate.

Creating ALSB Projects

In the ALSB perspective, select File > New > ALSB Project to display the New AquaLogic Service Bus Project wizard. Enter information as appropriate.

Note: You can create an ALSB project in an ALSB configuration project only.

Creating Custom Resources

In the ALSB perspective, select File > New > Custom Resource to display New Custom Resource wizard. Enter information as appropriate.

Note: You can create a custom resource in an ALSB project only.

Creating JNDI Provider Resources

In the ALSB perspective, select File > New > JNDI Provider to display the New JNDI Provider Resource wizard. Enter information as appropriate.

Note: You can create a JNDI provider resource in an ALSB configuration project only.

Creating Message Format Files

In the ALSB perspective, select File > New > MFL to display the New Message Format File wizard. Enter information as appropriate.

Note: You can create a message format file in an ALSB project only.

Editing JNDI Provider Resources

  1. In the Project Explorer, find the ALSB configuration project containing the JNDI provider resource you want to edit.
  2. Double-click the name of the JNDI provider to display the JNDI Provider Editor. Edit as appropriate.

Exporting Resources

In the ALSB perspective, select File > Export to display the Export wizard. See:

Generating an Effective WSDL

  1. In the Project Explorer, find the proxy service or business service from which you want to generate the effective WSDL.
  2. Right-click the name of the service and select AquaLogic Service Bus > Generate Effective WSDL from the menu.
  3. Select a location and save the file.

Modifying JAR Dependencies

  1. In the Project Explorer, find the JAR file whose dependencies you want to modify.
  2. Right-click the name of the file and select AquaLogic Service Bus > Modify JAR Dependencies from the menu.
  3. Make modifications in the Modify JAR Dependencies dialog.

Importing Resources

In the ALSB perspective, select File > Import to display the Import wizard. See:

Creating Servers

In the ALSB perspective, select File > New > Server to display the New Server wizard.

Creating Service Account Resources

In the ALSB perspective, select File > New > Service Account to display the New Service Account Resource wizard.

Note: You can create a service account resource in an ALSB project only.

Creating Service Key Provider Resources

In the ALSB perspective, select File > New > Service Key Provider to display the New Service Key Provider Resource wizard.

Note: You can create a service key provider resource in an ALSB project only.

Creating SMTP Server Resources

  1. In the ALSB perspective, select File > New > SMTP Server to display the New SMTP Server Resource wizard. Enter information as appropriate.
Note: You can create an SMTP server resource in an ALSB configuration project only.

Creating XQuery Transformations

In the ALSB perspective, select File > New > XQuery Transformation to display the XQuery/XSLT Expression Editor. Enter information as appropriate.

Note: You can create an XQuery transformation resource in an ALSB project only.

Creating XSL Transformations

In the ALSB perspective, select File > New > XSL Transformation to display the XPath Expression Editor.

Note: You can create an XSL transformation resource in an ALSB project only.

Working with Business Services

The following topics describe how to create and work with business services in the ALSB plug-in.

Creating Business Services

In the ALSB perspective, select File > New > Business Service to display the New AquaLogic Business Service wizard. See:

Note: You can create a business service in an ALSB project only.

Editing Business Services

  1. In the Project Explorer, find the business service you want to edit.
  2. Double-click the name of the service.
  3. Select the page containing the options you want to edit, and make changes as appropriate. See:

Working with Proxy Services

The following topics describe how to create and work with proxy services in the ALSB plug-in.

Creating Proxy Services

In the ALSB perspective, select File > New > Proxy Service to display the New AquaLogic Proxy Service wizard. See:

Note: You can create a proxy service in an ALSB project only.

Editing Proxy Services

  1. In the Project Explorer, find the proxy service you want to edit.
  2. Double-click the name of the service.
  3. Select the page containing the options you want to edit, and make changes as appropriate. See:

Working with Alert Destinations

The following topics describe how to create and work with alert destinations in the ALSB plug-in.

Creating Alert Destinations

  1. In the Project Explorer in the ALSB perspective, right-click a project or folder in which you want to create an alert destination.
  2. From the menu, select File > New > Alert Destination to display the New Alert Destination Resource wizard. Enter information as appropriate. See Alert Destination editor.
Note: You can create an alert destination in an ALSB project only.

Editing Alert Destinations

  1. In the Project Explorer, find the project folder containing the alert destination you want to edit.
  2. Double-click the name of the alert destination to display the Alert Destination editor. Edit information, as desired.

Adding E-mail Recipients to Alert Destinations

  1. Create or edit an alert destination, as described in Creating Alert Destinations and Editing Alert Destinations.
  2. In the E-mail Recipients field of the Alert Destination editor, click Add to display the Edit E-mail Recipient page. Add information, as appropriate.

Adding JMS Destinations to Alert Destinations

  1. Create or edit an alert destination, as described in Creating Alert Destinations and Editing Alert Destinations.
  2. In the JMS Destinations field of the Alert Destination editor, click Add to display the Edit JMS Destination page. Add information, as appropriate.

Working with Proxy Service Message Flows

The following topics describe how to add and configure nodes and actions to proxy service message flows.

Constructing Proxy Service Message Flows

When you create a proxy service, a message flow is created by default, with an empty starting node. The process for constructing the message flow follows this general pattern:

  1. Open the Message Flow Editor for the proxy service. To open the proxy service, double-click its name in Project Explorer. The Message Flow Editor appears as a tab in the proxy service view.
  2. Open the Message Flow Design Palette. To open the palette, in the ALSB perspective, select Window > Show View > Design Palette.
  3. Open the Properties view, if it is not already open:
    1. In the ALSB perspective, select Window > Show View > Other.
    2. In the Show View dialog, select General > Properties.
  4. Drag nodes and actions from the Message Flow Design Palette to the Message Flow Editor.

    5. Alternatively, you can right-click a node or action in the Message Flow Editor to display menus of nodes and actions that can be inserted in that location. The menu contains one or more the following:

    • Insert > (list of nodes and actions)
    • Insert Into > (list of nodes and actions)
    • Insert After > (list of nodes and actions)
    • Add Error Handler
  5. Configure nodes and actions:
    1. In the Proxy Service Editor, select the node or action by clicking it.

      2. Alternatively, you can select a node or an action from the Outline view. To open the Outline view, in the ALSB perspective, select Window > Show View > Outline.

    2. In the Properties view, set the properties, as appropriate for the selected node or action. For instructions on how to configure the nodes and actions, click the Properties view for a node or action, and press F1 for help.

Adding and Configuring Alert Actions in Message Flows

Use the alert action to generate alerts based on message context in a pipeline, to send to an alert destination.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add an alert action

  1. In the Message Flow Design Palette, open the Stage Actions > Reporting list, if it is not already open.
  2. Drag the alert action to the desired location in the message flow.

To configure the alert action

  1. In the Message Flow Editor, click the alert action, if it is not already selected.
  2. On the Alert Action Properties page, edit properties as appropriate.

Adding and Configuring Assign Actions in Message Flows

Use an assign action to assign the result of an XQuery expression to a context variable.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add an assign action

  1. In the Message Flow Design Palette, open the Stage Actions > Message Processing list, if it is not already open.
  2. Drag the assign action to the desired location in the message flow.

To configure the assign action

  1. In the Message Flow Editor, click the assign action, if it is not already selected.
  2. On the Assign Action Properties page, edit properties as appropriate.

Adding and Configuring Conditional Branch Nodes in Message Flows

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.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a conditional branch node

  1. In the Message Flow Design Palette, open the ALSB Message Flow > Nodes list, if it is not already open.
  2. Drag the conditional branch node to the desired location in the message flow.

To configure the conditional branch node

  1. In the Message Flow Editor, click the conditional branch node, if it is not already selected.
  2. On the Conditional Branch Node Properties page, edit properties as appropriate.x

Adding and Configuring Delete Actions in Message Flows

Use a delete action to delete a context variable or a set of nodes specified by an XPath expression.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a delete action

  1. In the Message Flow Design Palette, open the Stage Actions > Message Processing list, if it is not already open.
  2. Drag the delete action to the desired location in a stage action in the message flow.

To configure the delete action

  1. In the Message Flow Editor, click the delete action, if it is not already selected.
  2. On the Delete Action Properties page, edit properties as appropriate.

Adding and Configuring Dynamic Publish Actions in Message Flows

Use a dynamic publish action to publish a message to a service specified by an XQuery expression.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a dynamic publish action

  1. In the Message Flow Design Palette, open the Stage Actions > Communication list, if it is not already open.
  2. Drag the dynamic publish action to the desired location in the message flow.

To configure the dynamic publish action

  1. In the Message Flow Editor, click the dynamic publish action, if it is not already selected.
  2. On the Dynamic Publish Action Properties page, edit properties as appropriate.

Adding and Configuring Dynamic Routing Actions in Message Flows

Use a dynamic routing action to assign a route for a message based on routing information available in an XQuery resource.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a dynamic routing action

  1. In the Message Flow Design Palette, open the Route Actions > Communication list, if it is not already open.
  2. Drag the dynamic routing action to the route action in the message flow.

To configure the dynamic routing action

  1. In the Message Flow Editor, click the dynamic routing action, if it is not already selected.
  2. On the Dynamic Routing Action Properties page, edit properties as appropriate.

Adding and Configuring Error Handlers in Message Flows

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

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add an error handler

  1. In the Message Flow Design Palette, open the ALSB Message Flow > Nodes list, if it is not already open.
  2. Drag the error handler to the desired location in the message flow.
  3. Drag a stage node to the error handler.
  4. Add actions to the stage, as appropriate, to define the error handler.

To configure the error handler

  1. In the Message Flow Editor, click the error handler, if it is not already selected.
  2. On the Error Handler Node Properties page, edit the properties.
  3. Click the stage node, if it is not already selected.
  4. On the Stage Node Properties page, edit the properties.
  5. Select and edit any actions contained by the stage, as appropriate.

Adding and Configuring For-Each Actions in Message Flows

Use the for-each action to iterate over a sequence of values and execute a block of actions.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a for-each action

  1. In the Message Flow Design Palette, open the Stage Actions > Flow Control list, if it is not already open.
  2. Drag the for-each action to the desired stage action in the message flow.

To configure the for-each action

  1. In the Message Flow Editor, click the for-each action, if it is not already selected.
  2. On the For-Each Action Properties page, edit properties as appropriate.

Adding and Configuring If-Then Actions in Message Flows

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

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add an if-then action

  1. In the Message Flow Design Palette, do one of the following:
    • For an if-then action in a route node, open the Route Actions > Flow Control list, if it is not already open.
    • For an if-then action in a stage node, open the Stage Actions > Flow Control list, if it is not already open.
  2. Drag the if-then action to the route node or to the desired stage action in the message flow.

To configure the if-then action

  1. In the Message Flow Editor, click each if condition and else-if condition contained by the if-then action, and define the conditions in the Condition Editor, as described in If-Then Action Properties.

Adding and Configuring Insert Actions in Message Flows

Use an insert action to insert the result of an XQuery expression at an identified place relative to nodes selected by an XPath expression.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add an insert action

  1. In the Message Flow Design Palette, open the Stage Actions > Message Processing list, if it is not already open.
  2. Drag the insert action to the desired location in the message flow.

To configure the insert action

  1. In the Message Flow Editor, click the insert action, if it is not already selected.
  2. On the Insert Action Properties page, edit properties as appropriate.

Adding and Configuring Java Callout Actions in Message Flows

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

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add an Java callout action

  1. In the Message Flow Design Palette, open the Stage Actions > Message Processing list, if it is not already open.
  2. Drag the Java callout action to the desired location in the message flow.

To configure the Java callout action

  1. In the Message Flow Editor, click the Java callout action, if it is not already selected.
  2. On the Java Callout Action Properties page, edit properties as appropriate.

Adding and Configuring Log Actions in Message Flows

Use the log action to construct a message to be logged and to define a set of attributes with which it will be logged.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a log action

  1. In the Message Flow Design Palette, open the Stage Actions > Reporting list, if it is not already open.
  2. Drag the log action to the desired location in the message flow.

To configure the log action

  1. In the Message Flow Editor, click the log action, if it is not already selected.
  2. On the Log Action Properties page, edit properties as appropriate.

Adding and Configuring MFL Transform Actions in Message Flows

Use a MFL (Message Format Language) transform action to convert message content from XML to non-XML, or vice versa, in the message pipeline.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a MFL transform action

  1. In the Message Flow Design Palette, open the Stage Actions > Message Processing list, if it is not already open.
  2. Drag the MFL transform action to the desired location in the message flow.

To configure the MFL transform action

  1. In the Message Flow Editor, click the MFL transform action, if it is not already selected.
  2. On the MFL Transform Action Properties page, edit properties as appropriate.

Adding and Configuring Operational Branch Nodes in Message Flows

Use an operational branch node to configure branching based on operations defined in a WSDL.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add an operational branch node

  1. In the Message Flow Design Palette, open the ALSB Message Flow > Nodes list, if it is not already open.
  2. Drag the operational branch node to the desired location in the message flow.

To configure the operational branch node

  1. In the Message Flow Editor, click the operational branch node, if it is not already selected.
  2. On the Operational Branch Node Properties page, edit properties as appropriate.

Adding and Configuring Pipeline Pair Nodes in Message Flows

Use a pipeline pair node to define request and response processing.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a pipeline pair node

  1. In the Message Flow Design Palette, open the ALSB Message Flow > Nodes list, if it is not already open.
  2. Drag the pipeline pair node to the desired location in the message flow.

To configure the pipeline pair node

  1. In the Message Flow Editor, click the pipeline pair node, if it is not already selected.
  2. On the Pipeline Pair Node Properties page, edit properties as appropriate.

Adding and Configuring Publish Actions in Message Flows

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.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a publish action

  1. In the Message Flow Design Palette, open the Stage Actions > Communication list, if it is not already open.
  2. Drag the publish action to the desired location in the message flow.

To configure the publish action

  1. In the Message Flow Editor, click the publish action, if it is not already selected.
  2. On the Publish Action Properties page, edit properties as appropriate.

Adding and Configuring Publish Table Actions in Message Flows

Use a publish table action to publish a message to zero or more statically specified services.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a publish table action

  1. In the Message Flow Design Palette, open the Stage Actions > Communication list, if it is not already open.
  2. Drag the publish table action to the desired location in the message flow.

To configure the publish table action

  1. In the Message Flow Editor, click the publish table action, if it is not already selected.
  2. On the Publish Table Action Properties page, click <Expression> to display the XQuery/XSLT Expression Editor. Create an XQuery expression, which at run time returns the value upon which the routing decision will be made.
  3. In the Message Flow Editor, select a case action.
  4. From the Operator list on the Publish Table Action Properties page, select a comparison operator. Then, in the Value field, enter a value against which the value returned from the XQuery expression will be evaluated.
  5. In the Message Flow Editor, click one of the publish table’s publish actions to select it.
  6. On the Publish Action Properties page, click Browse to select a service. Select the service to which messages are to be published if the expression evaluates true for the value you specified. The Select a Service Resource dialog is displayed.
  7. Select a service from the list, then click OK. This is the target service for the message.
  8. If the service has operations defined, you can specify the operation to be invoked by selecting it from the invoking list.
  9. If you want the outbound operation to be the same as the inbound operation, select the Use inbound operation for outbound check box.
  10. In the Request Actions field, to configure how the message is packaged and sent to the service, click Add an Action, then select one or more actions that you want to associate with the service. To learn more about the type of action you want to add, see “Adding and Editing Actions in Message Flows” on page 18-1.
Note: There is a nesting limit of four cumulative levels in the stage editor. If you attempt to add a fifth level, nesting action is not displayed. Cumulative levels include all branching actions: if... then... conditions, publish tables, and route tables. For example, you can have 2 levels of conditionals, then a publish table with a route table inside of it, bringing the total to 4 levels. If you attempt to add another conditional (to the last publish table), the conditional is not displayed.
  1. To insert a new case, click the  Case icon, then select Insert New Case.
  2. Repeat steps 4-8 for the new case.
  3. Add additional cases as dictated by your business logic.
  4. Click the  Case icon of the last case you define in the sequence, then select Insert Default Case to add a default case at the end.
  5. Configure the default case—the configuration of this case specifies the routing behavior in the event that none of the preceding cases is satisfied.

Adding and Configuring Raise Error Actions in Message Flows

Use the raise error action to raise an exception with a specified error code (a string) and description.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a raise error action

  1. In the Message Flow Design Palette, open the Stage Actions > Flow Control list, if it is not already open.
  2. Drag the raise error action to the desired location in the message flow.

To configure the raise error action

  1. In the Message Flow Editor, click the raise error action, if it is not already selected.
  2. On the Raise Error Action Properties page, edit properties as appropriate.

Adding and Configuring Rename Actions in Message Flows

Use the rename action to rename elements selected by an XPath expression without modifying the contents of the element.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add an rename action

  1. In the Message Flow Design Palette, open the Stage Actions > Message Processing list, if it is not already open.
  2. Drag the rename action to the desired location in the message flow.

To configure the rename action

  1. In the Message Flow Editor, click the rename action, if it is not already selected.
  2. On the Rename Action Properties page, edit properties as appropriate.

Adding and Configuring Replace Actions in Message Flows

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.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a replace action

  1. In the Message Flow Design Palette, open the Stage Actions > Message Processing list, if it is not already open.
  2. Drag the replace action to the desired location in the message flow.

To configure the replace action

  1. In the Message Flow Editor, click the replace action, if it is not already selected.
  2. On the Replace Action Properties page, edit properties as appropriate.

Adding and Configuring Reply Actions in Message Flows

Use the reply action to specify that an immediate reply be sent to the invoker.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a reply action

  1. In the Message Flow Design Palette, open the Stage Actions > Flow Control list, if it is not already open.
  2. Drag the reply action to the desired location in the message flow.

To configure the reply action

  1. In the Message Flow Editor, click the reply action, if it is not already selected.
  2. On the Reply Action Properties page, edit properties as appropriate.

Adding and Configuring Report Actions in Message Flows

Use the report action to enable message reporting for a proxy service.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a report action

  1. In the Message Flow Design Palette, open the Stage Actions > Reporting list, if it is not already open.
  2. Drag the report action to the desired location in the message flow.

To configure the report action

  1. In the Message Flow Editor, click the report action, if it is not already selected.
  2. On the Report Action Properties page, edit properties as appropriate.

Adding and Configuring Resume Actions in Message Flows

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.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a resume action

  1. In the Message Flow Design Palette, open the Stage Actions > Flow Control list, if it is not already open.
  2. Drag the resume action to the desired location in the message flow.

To configure the resume action

  1. In the Message Flow Editor, click the resume action, if it is not already selected.
  2. On the Resume Action Properties page, edit properties as appropriate.

Adding and Configuring Route Nodes in Message Flows

Use the route node to handle request and response dispatching of messages to and from business services.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a route node

  1. In the Message Flow Design Palette, open the ALSB Message Flow > Nodes list, if it is not already open.
  2. Drag the route node to the desired location in the message flow.

To configure the route node

  1. In the Message Flow Editor, click the route node action, if it is not already selected.
  2. On the Route Node Properties page, edit properties as appropriate.

Adding and Configuring Routing Actions in Message Flows

Use a routing action to identify a target service for the message and configure how the message is routed to that service.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a routing action

  1. In the Message Flow Design Palette, open the Route Actions > Communication list, if it is not already open.
  2. Drag the routing action to the desired location in the message flow.

To configure the routing action

  1. In the Message Flow Editor, click the routing action, if it is not already selected.
  2. On the Routing Action Properties page, edit properties as appropriate.

Adding and Configuring Routing Options Actions in Message Flows

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.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a routing options action

  1. In the Message Flow Design Palette, open the Stage Actions > Communication list, if it is not already open.
  2. Drag the routing options action to the desired location in the message flow.

To configure the routing options action

  1. In the Message Flow Editor, click the routing options action, if it is not already selected.
  2. On the Routing Options Action Properties page, edit properties as appropriate.

Adding and Configuring Routing Table Actions in Message Flows

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.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a routing table action

  1. In the Message Flow Design Palette, open the Route Actions > Communication list, if it is not already open.
  2. Drag the routing table action to the desired location in the message flow.

To configure the routing table action

  1. In the Message Flow Editor, click the routing table action, if it is not already selected.
  2. On the Routing Table Action Properties page, edit properties as appropriate.

Adding and Configuring Service Callout Actions in Message Flows

Use a service callout action to configure a synchronous (blocking) callout to an ALSB-registered proxy or business service.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a service callout action

  1. In the Message Flow Design Palette, open the Stage Actions > Communication list, if it is not already open.
  2. Drag the service callout action to the desired location in the message flow.

To configure the service callout action

  1. In the Message Flow Editor, click the service callout action, if it is not already selected.
  2. On the Service Callout Action Properties page, edit properties as appropriate.

Adding and Configuring Skip Actions in Message Flows

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.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a skip action

  1. In the Message Flow Design Palette, open the Stage Actions > Flow Control list, if it is not already open.
  2. Drag the skip action to the desired location in the message flow.

To configure the skip action

  1. In the Message Flow Editor, click the skip action, if it is not already selected.
  2. On the Skip Action Properties page, edit properties as appropriate.

Adding and Configuring Stages in Message Flows

Use a stage node as a container for actions in a message flow.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a stage

  1. In the Message Flow Design Palette, open the ALSB Message Flow > Nodes list, if it is not already open.
  2. Drag the stage to the desired location in the message flow.
  3. Add actions to the stage, as appropriate for your configuration.

To configure the stage

  1. In the Message Flow Editor, click the stage, if it is not already selected.
  2. On the Stage Node Properties page, edit properties as appropriate.

Adding and Configuring Transport Headers Actions in Message Flows

Use a transport header action to set header values in messages.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a transport headers action

  1. In the Message Flow Design Palette, open the Stage Actions > Communication list, if it is not already open.
  2. Drag the transport headers action to the desired location in the message flow.

To configure the transport headers action

  1. In the Message Flow Editor, click the transport headers action, if it is not already selected.
  2. On the Transport Headers Action Properties page, edit properties as appropriate.

Adding and Configuring Validate Actions in Message Flows

Use a validate action to validate elements selected by an XPath expression against an XML schema element or a WSDL resource.

Before you begin

Display the message flow for the desired proxy service. See Constructing Proxy Service Message Flows.

To add a validate action

  1. In the Message Flow Design Palette, open the Stage Actions > Message Processing list, if it is not already open.
  2. Drag the validate action to the desired location in the message flow.

To configure the validate action

  1. In the Message Flow Editor, click the validate action, if it is not already selected.
  2. On the Validate Action Properties page, edit properties as appropriate.

Working with MQ Connections

MQ connections are sharable resources that can be reused across multiple MQ proxy and business services. MQ proxy and business services must connect to a MQ queue manager before accessing an MQ queue. MQ Connection resources provide the connection required for connecting to an MQ queue manager.

Each MQ Connection resource has a connection pool. Every business or proxy service using a given MQ Connection resource to get a connection to a given queue manager uses the same connection pool that was created for that resource. Thus, multiple business services and proxy services using the same queue manager share a connection pool.

To learn more about ALSB MQ Connection resources and native MQ transports, see the Native MQ Transport User Guide.

To learn more about WebSphere MQ Fundamentals, see http://www.redbooks.ibm.com/redbooks/SG247128/wwhelp/wwhimpl/java/html/wwhelp.htm.

Adding MQ Connections

In ALSB, MQ connections are created as custom resources. Therefore, to add an MQ connection, you must create it as a custom resource, as follows:

  1. In the ALSB perspective, select File > New > Custom Resource to display New Custom Resource wizard.
  2. On the Create a New Custom Resource page, in the Resource Type field, select MQ Connection.
  3. Enter configuration information, as appropriate, on the Custom MQ Resource Configuration page.

Editing MQ Connections

  1. In the Project Explorer, find the ALSB configuration folder containing the MQ connection resource you want to edit.
  2. Double-click the name of the MQ connection to display the Custom MQ Resource Configuration page. Edit as appropriate.

Working with UDDI Registries

Universal Description, Discovery and Integration (UDDI) registries are used in an enterprise to share Web Services. UDDI provides a framework in which to classify your business, its services, and the technical details about the services you want to expose.

Publishing a service to a registry requires knowledge of the service type and the data structure representing that service in the registry. A registry entry has certain properties associated with it and these property types are defined when the registry is created. You can publish your service to a registry and make it available for other organizations to discover and use. Proxy services developed in ALSB can be published to a UDDI registry. ALSB can interact with any UDDI version 3.0-compliant registry.

See also UDDI in the AquaLogic Service Bus User Guide.

Adding UDDI Registries

  1. In the ALSB perspective, select File > New > UDDI Registry. to display the New UDDI Resource wizard.
    2. Note: You can add a UDDI registry only to an ALSB configuration project only.
  2. After choosing a location and entering a name, configure the registry on the UDDI Registry Configuration page.
Note: You can add a UDDI registry in an ALSB configuration project only.

Configuring UDDI Registries

  1. In the Project Explorer, find the UDDI registry you want to configure.
  2. Double-click the name of the registry.
  3. Set configure options on the UDDI Registry Configuration page.

Importing Business Services From a UDDI Registry

  1. Create a business service, as described in Creating Business Services.
  2. In the New AquaLogic Business Service wizard Business Service General Configuration page, select WSDL Web Service. then click Browse.
  3. In the Select a WSDL dialog, click Consume.
  4. In the Service Consumption dialog, select UDDI.

    5. For help using UDDI Register Access in the Service Consumption dialog, press F1, or search in the help system for “Service Consumption dialog.“

Working with Split-Join

This section provides instructions for creating and configuring Split-Joins. Following are the primary topics in this section:

Introduction to Split-Join

The Split-Join is a mediation pattern that can be used by a transport typed business service in an ALSB message flow. Split-Join allows you to send message requests to multiple services concurrently, thus enhancing performance in comparison to sending them sequentially. Split-Join achieves this task by splitting an input message into individual messages, routing them concurrently to their destinations, and then aggregating the responses into one overall message.

You design a Split-Join in the WorkSpace Studio Split-Join editor, then export it to the ALSB console for testing and production.

Note: In the ALSB console, a Split-Join is associated with a business service using the Flow transport protocol. Therefore, the Split-Join has a .flow file name extension in WorkSpace Studio even though it is always referred to simply as a “Split-Join” in this document.

There are two types of Split-Join pattern: static Split-Join and dynamic Split-Join, as described in Designing a Split-Join.

For more information on invoking a business service from an ALSB message flow, see Proxy Services: Message Flow in the ALSB console help system.

Designing a Split-Join

There are two Split-Join patterns, the Static Split-Join and the Dynamic Split Join.

The Static Split-Join can be used to create a fixed number of message requests (as opposed to an unknown number). For instance, a customer places an order for a cable package that includes three separate services: internet service, TV service, and telephone service. In the Static use case, you could execute all three requests in separate parallel branches to improve performance time over the standard sequential execution.

The Dynamic Split-Join can be used to create a variable number of message requests. For instance, a retailer places a batch order containing a variable number of individual purchase orders. In the Dynamic use case, you could parse the batch order and create a separate message request for each purchase. Like the Static use case, these messages can then be executed in parallel for improved performance.

Initial Setup

Split-Joins potentially include the following tasks as part of their initial setup:

Creating/Importing a WSDL Containing the Base Operation

Every Split-Join is based upon a WSDL operation. When you first create a Split-Join, you will be asked to browse to the appropriate WSDL file and to select this operation as part of the creation process. You can create this WSDL file in WorkSpace Studio.

Creating/Importing a Business Service to Use the Split-Join

Every Split-Join will be used by a transport typed business service, which, in turn, is invoked by a proxy service. You cannot export or test your Split-Join until you have created this business service. If it already exists, you can import it into WorkSpace Studio, or, if it does not exist, you can create it in WorkSpace Studio or the ALSB console. If you want to get started on your Split-Join before you create the business service, you can generate the business service automatically after you create the Split-Join.

Designing a Static Split-Join

Suppose you want to design a new Split-Join called Service Availability that handles orders for a telco’s cable service package including TV, phone, and internet service. The idea is for the Split-Join to receive an incoming package order and to reply with an order acknowledgement for each type of service. In this case, Service Availability is designed as a Static Split-Join because there are three message requests per order, one for each type of service. In this particular example the customer requests only TV and DSL service.

Creating the Service Availability Split-Join may include the following tasks:

1. Creating a New Split-Join

2. Adding an Assign

3. Adding a Parallel Node

4. Adding an Assign for Each Branch

5. Adding an Invoke External Service

6. Adding an Assign for Each Branch

7. Exporting and Testing the Split-Join

1. Creating a New Split-Join

Create a new Split Join based on the WSDL operation you want to use for placing the order. In this case the WSDL operation we want is called “telecom.”

After you select the WSDL operation, a skeleton of the newly created Split-Join appears in the Split-Join editor, as shown in the following figure. It consists of a Start Node, a Receive, a Reply. The labels are then edited in the general properties tab to better reflect the specific function of each node in this particular Split-Join.

The Start Node contains both a Request Variable and a Response Variable that have been determined by the WSDL operation initially selected. The Receive receives the incoming request message (in this case for the three or fewer different kinds of cable service), and the Reply generates a response message and sends it back to the client.

Note: The Receive node requires no further configuration. Similarly the Reply requires no further configuration, unless to generate an error fault--which is not the case in this scenario (see Configuring a Reply for more information on generating faults).

2. Adding an Assign

The first Assign, Prepare Output Message, contains an Assign operation that prepares the Response Variable in a form such that the later nodes can work on the data within it (that is, Copy/Insert/Assign/Replace/Delete the data). This output message is relayed to the final Reply node in the Split-Join and, in turn, returned to the original client.

3. Adding a Parallel Node

The Parallel Node contains two main branches, one to check cable TV availability and one to check DSL availability. Each branch is composed of a number of actions, the sequence and general configuration being the same for both branches.

4. Adding an Assign for Each Branch

The first Assign in each Parallel Branch, Prepare Input Address, copies the incoming customer address data into a Variable that is referenced to check the availability of the service at that location. The Assigns are the same for each branch and would be for additional branches as well.

5. Adding an Invoke External Service

An External Service is then invoked to check whether the requested service type is available at the customer’s location. Each branch contains one Invoke External Service, Check Cable TV Availability and Check DSL Availability. Each invocation calls an External Service, which compares the customer’s address (stored in the Variable initialized in the previous step) to the availability of the service at that location. The result is then stored in an output Variable that is passed on to the final Assign in the Branch below.

6. Adding an Assign for Each Branch

The final two Assigns, Update Cable TV Status in Output Message and Update DSL Status in Output Message, take the results of the external service invocations and put them into the output message using a Replace operation. The aggregated response are then sent to the original client in the final Reply node, which requires no further configuration.

7. Exporting and Testing the Split-Join

After you design the Split-Join, you can export it to the ALSB console for testing and production.

Related Topics

Designing a Dynamic Split-Join

Suppose that you want to design a Split-Join that handles a batch order from a retailer containing a variable number of individual purchase orders (as opposed to a fixed number of orders). The idea is for the Split-Join to receive the batch order and to reply with an order acknowledgement for each order within. This would be a Dynamic Split-Join because the number of individual purchase order requests is variable and unknown at design time.

Creating this Split-Join may include the following tasks:

1. Creating a New Split-Join

2. Adding an Assign

3. Adding a For Each

4. Adding an Assign

5. Adding an Invoke External Service

6. Adding an Assign

7. Adding an Error Handler

8. Exporting and Testing the Split-Join

1. Creating a New Split-Join

Create a new Split Join based off of the WSDL operation you want to use for placing the order. In this case the WSDL operation we want is called “batchOrders.”

After the operation is selected, a skeleton of the newly created Split-Join appears in the Split-Join editor consisting of a Start Node, a Receive, a Reply. The labels are then edited in the general properties tab to better reflect the specific function of each node in this particular Split-Join.

The Start Node, Order Placement, contains both a request variable, inputVar, and an response variable, outputVar. The Receive, Receive Batch Order Request, will initialize the contents of the Request Variable (in this case purchase orders), and the Reply, Reply Order Placement, will send a response, based on the order acknowledgements aggregated into the Response Variable, back to the client. In this example Order Placement also contains a callout to an External Service, “Order” that will be invoked to approve individual orders.

Note: The Receive node requires no further configuration. Similarly, the Reply requires no further configuration, unless you would like to generate an error fault—which is not the case in this scenario (see Configuring a Reply for more information on generating faults).

2. Adding an Assign

The first Assign, Prepare Output Message, contains an Assign operation that prepares the response variable (here labeled an “Output Message” for readability) in a form such that the later nodes can work on the data captured within it (that is, Copy/Insert/Assign/Replace/Delete into the Variable). In this case, that data would consist of order acknowledgments and/or errors.This Output Message is relayed to the final Reply node in the Split-Join and, in turn, returned to the original client.

3. Adding a For Each

The For Each, Iterate Through Orders, contains logic that will parse through each order in the batch, send it to an external proxy for approval, and capture an order acknowledgment in response. If there is a problem with an order, an error is sent from the invoked proxy and captured in the Error Handler. The following figure depicts the entire scope of the For Each logic.

4. Adding an Assign

The Assign, Prepare Purchase Order, copies the incoming purchase order requests into a variable that is referenced to check approval of the order in the next step.

5. Adding an Invoke External Service

An external service, Check Order Availability, is then invoked to approve each individual purchase order. If the order is accepted, the service responds with an order acknowledgment. If the order is not accepted, the service responds with an error.The result is then stored in an output variable that is passed on to the final Assign in the next step.

6. Adding an Assign

The final Assign, Update Order Status in Output Message, takes the results of the external service invocation and copies them into the output message using an Insert operation. The aggregated response is then sent to the original client in the final Reply node, which requires no further configuration.

7. Adding an Error Handler

The Error Handler captures any Errors returned by the invoked service. It takes these errors and inserts them into the output message using an Assign operation.

8. Exporting and Testing the Split-Join

After you design the Split-Join, you can export it to the ALSB console for testing and production.

Related Topics

Creating a New Split-Join

In order to create a new Split/Join, you must have access to a WSDL containing the operation upon which to base the Split-Join. The Split Join must be created in an existing ALSB project within an existing ALSB configuration project.

To create a new Split-Join:

  1. In the ALSB perspective, select File > New > Split-Join. This opens the New Split-Join Wizard.
  2. In the New Split-Join Wizard, type or select an ALSB project location and enter a file name for the new Split-Join. When you have finished, click Next.
  3. In the next screen, you must select a binding and then an operation on which to implement the Split-Join. There are two ways to make your selection:
    1. Choose your operation from one of the WSDLs displayed in the Select Operation tree. All of the WSDLs in your current ALSB configuration project are available.
    2. Import your WSDL into the ALSB configuration project using the Consume button. Consumption imports a new WSDL into your configuration from an outside source, as described in the following step.
  4. If you choose to consume the base WSDL, go through the following steps:
    1. Click Consume.
    2. Browse for the location, or “Artifact Folder,” wherein you wish to generate the consumed WSDL. The default artifact folder is your current ALSB project.
    3. If you want to overwrite existing local files, select the checkbox.
    4. Choose the service resource in which the WSDL to be consumed resides: Enterprise Repository, File System, UDDI, URI, or Workspace.
    5. Select The WSDL that you want to consume from that Service Resource. After you have made your selection the workspace will rebuild momentarily and the Service Consumption Status dialog will appear depicting the status of your consume. If it was successful, click OK to close the dialog.
    6. The consumed WSDL is now in your ALSB configuration project, and you can select an operation from it upon which to base your Split-Join.
  5. Click Finish.

A basic Split-Join is created and visually represented as a diagram in the Design View. By default, it consists of a Start Node, a Receive, and a Reply. The Start Node contains the Request and Response Variables introspected from the WSDL operation. The Receive is used to receive incoming request messages. The Reply is used to send response messages.

Related Topics

Configuring the Start Node

The Start Node is generated automatically whenever you create a new Split-Join. It is the starting point from which all the other nodes proceed. Configuring a Start Node can include the following tasks:

Related Topics

Adding General Information

General information is useful for making a node more legible. It includes the ability to add a unique identifier, or Label, to the node and to supplement it with notes, or Documentation. General information is optional.

  1. To add a Label to a node, open the Properties view and enter a unique, identifying string in the Label field. The label that you enter appears underneath the node in the Canvas Area. Alternatively, you can simply double-click the string under the icon and edit.
  2. To add Documentation to a node, open the Properties view and enter any notes that you think are important in the Documentation field.

Defining Global Variables

Variables in the Start Node store data that can be referenced globally, that is by any node in the Split-Join. By default, every Start Node is assigned both a request and a response variable when the Split-Join is initially created. From the Start Node, you can either create a new global variable or edit an existing global variable.

To create a new global variable:

  1. Right-click the Start Node and select Create Variable to open the Create Variable Dialog.
  2. Enter a name for the variable.
  3. Select the Variable Type (Builtin, Schema, or Message).
  4. Choose a Variable.
    5. Note: You may need to drill down into the hierarchy to select a Schema or Message Type variable.
  5. Click OK.

If it is not already open, expand the content area to the left by clicking the arrow to the left of the Start Node icon. The newly created variable appears in the Variables field along with any other global variables. To view the details of any variable, simply select it and its structure will appear in the Properties view.

To edit an existing global Variable:

  1. Open the Edit Variable Dialog in one of the following ways:
    • Right-click the selected variable and select Edit Variable from the context menu.
    • Select a variable and click Edit in the variable Properties view.
  2. Enter a name for the Variable.
  3. Select the Variable Type: Builtin, Schema, or Message.
  4. Choose a variable.
    5. Note: You may need to drill down into the hierarchy to select a Schema or Message Type variable.
  5. Click OK.

If it is not already open, expand the content area to the left of the Start Node icon. The newly created variable appears in the Variables field along with any other global variables. To view the details of any variable, simply select it and its structure will appear in the Properties view.

Viewing External Services

The External Services listed in the Start Node are those invoked outside of the context of the Split-Join. They are specified in an Invoke External Service but listed here for convenience.

To view External Services, expand the content area to the left of the Start Node by clicking the arrow to the left of the Start Node icon. When an External Service is selected, a dashed blue arrow appears pointing to the Invoke External Service associated with the service, and the service’s location appears in the Properties view.

Configuring a Receive

A Receive is generated automatically whenever you create a new Split-Join. The purpose of the Receive is to place incoming request data in a variable and make the contents available for later nodes to use. Configuring a Receive can include the following tasks:

Related Topics

Viewing the Operation

The Operation is based upon the initial WSDL selection for the overall Split-Join. It is displayed in the Properties View for reference.

Defining the Receive Variable

You must define the Incoming Message Variable the Receive will initialize. This can be done in two ways:

  1. Select a pre-existing variable from the Message Variable menu.
  2. Create a new Message Variable (following steps).
    3. Note: If there are no available Message Variables associated with the previously chosen Operation, you must create a new Message Variable.

To create a new Message Variable, select Create Message Variable from the Message Variable menu. The Create Message Variable Dialog appears:

  1. Provide a name for the variable.
  2. Click OK.

Note that Message Type Namespace and Message Type are displayed automatically on the Properties page once the variable is defined.

Adding General Information

General information is useful for making a node more legible. It includes the ability to add a unique identifier, or Label, to the node and to supplement it with notes, or Documentation. General information is optional.

  1. To add a Label to a node, open the Properties view and enter a unique, identifying string in the Label field. The label that you enter appears underneath the node in the Canvas area. Alternatively, you can simply double-click the string under the icon and edit.
  2. To add Documentation to a node, open the Properties view and enter any notes that you think are important in the Documentation field.

Creating an Assign

The Assign is used for data-manipulation including initializing and updating a variable. It is composed of a set of one or more operations that can be added and/or edited in the Assign toolbar. Configuring an Assign can include the following tasks:

Related Topics

Adding and Configuring Assign Operations

Assign operations include Assign, Copy, Delete, Insert, and Replace. Every Assign is composed of one or more of these operations, which you can add to the Assign using the Assign toolbar.

In addition, each operation has its own configuration dialog/editor.

Note: The Assign operations in the Split-Join editor are essentially the same as the corresponding actions in the WorkSpace Studio Message Flow editor. However, one important difference is that when you are using the XQuery\XSLT or XPath Editors to edit expressions in the Split-Join context, only variables and namespaces internal to the Split-Join are available.

A brief explanation of each operation follows:

Adding an operation to the Assign involves the following steps:

  1. Select an operation from the Add Operation menu. The configuration dialog box for that expression appears.
  2. Configure the operation.
  3. Click OK.
  4. Add and configure the next expression, if necessary.

Note that you can edit a configured operation by double-clicking the operation in the Assign Operations table or selecting an operation and clicking the Edit button in the toolbar.

Adding a Copy Operation

The Copy operation allows you to copy the information specified by an XPath 1.0 expression from a source document to a destination document. It is an operation unique to the Split-Join editor. Adding a Copy operation to the Assign involves the following steps:

  1. Select Copy from the Add operation menu. The Copy dialog box opens.
  2. Select a Copy From type and a Copy To type.
  3. If the type is an expression, enter the expression manually or click browse to launch the XQuery Expression Builder.
  4. In the type is a variable, drill down to and select the desired element. The resulting query will be displayed in the Query field below.
  5. If the Copy From type is a Literal, enter the literal in the text field.
  6. If the Copy From type is an XML fragment, enter [or paste] the fragment in the text field.
  7. Click OK.

Adding General Information

General information is useful for making a node more legible. It includes the ability to add a unique identifier, or Label, to the node and to supplement it with notes, or Documentation. General information is optional.

  1. To add a Label to a node, open the Properties view and enter a unique, identifying string in the Label field. The label that you enter appears underneath the node in the Canvas area. Alternatively, you can simply double-click the string under the icon and edit.
  2. To add Documentation to a node, open the Properties view and enter any notes that you think are important in the Documentation field.

Creating an Invoking External Service

The Invoke External Service is used to invoke external, WSDL-based business or proxy services. Configuring an Invoke Service can include the following tasks:

Related Topics

Selecting an Operation

An operation must be selected upon which to base the Invoke External Service. You must select this operation before you can configure Input and Output variables. To select an operation:

  1. Select the Invoke External Service for which you wish to select an operation and open the Properties view.
  2. From the Operations tab in the Properties view, select Browse to launch the Service Browser.
  3. In the Service Browser, drill down to the desired service and select a Binding and then an operation.
  4. Click OK. The selected operation and its Service Location appear in the operation page.
    5. Note: Clicking a selected Service Location will open the file.

Defining Input and Output Variables

An Invoke External Service requires both an Input Variable and an Output Variable, unless it is a one-way invocation. The procedure to configure these variables is essentially the same. Either type of variable can be global (that is, available within the entire Split-Join) or local (that is, available within a particular context Scope.) To define either an Input or Output variable:

  1. Define the Message Variable. This can be done in two ways:
    1. Select a pre-existing variable from the Message Variable menu.
    2. Create a new Message Variable (following steps).
      3. Note: If there are no available Message Variables associated with the previously chosen operation, you must create a new Message Variable.

To create a new Message Variable:

  1. Select Create Message Variable from the Message Variable menu. The Create Message Variable Dialog appears.
  2. Provide a name for the variable.
  3. Make the variable either global or local. Global variables are accessible within the entire Split-Join, whereas local variables are restricted to the current Scope.
  4. Click OK.

Note that Message Type Namespace and Message Type are displayed automatically on the properties page once a variable is defined.

Adding General Information

General information is useful for making a node more legible. It includes the ability to add a unique identifier, or Label, to the node and to supplement it with notes, or Documentation. General information is optional.

  1. To add a Label to a node, open the Properties view and enter a unique, identifying string in the Label field. The Label that you enter appears underneath the node in the Canvas Area. Alternatively, you can simply double-click the string under the icon and edit.
  2. To add Documentation to a node, open the Properties view and enter any notes that you think are important in the Documentation field.

Creating a Parallel

The Parallel creates a fixed number of configured parallel branches. Each branch has its own Scope which in turn can contain any number of nodes. Configuring a Parallel can include the following tasks:

Related Topics

Adding Nodes

The Parallel is essentially a placeholder for a fixed number of processing branches, each with its own scope. Two branches are automatically generated by default. An individual scope may contain unique processing logic according to your construction; simply drag the appropriate nodes into the Scope. You may add additional branches with the Add Scope button.

Adding General Information

General information is useful for making a node more legible. It includes the ability to add a unique identifier, or Label, to the node and to supplement it with notes, or Documentation. General information is optional.

  1. To add a Label to a node, open the Properties view and enter a unique, identifying string in the Label field. The Label that you enter appears underneath the node in the Canvas area. Alternatively, you can simply double-click the string under the icon and edit.
  2. To add Documentation to a node, open the Properties view and enter any notes that you think are important in the Documentation field.

Creating a For Each

The For Each is used to create conditional logic for iterating through a variable number of requests. It is primarily used to create dynamic Split-Joins. Configuring a For Each can include the following tasks:

Related Topics

Defining the For Each Logic

To define the For Each logic:

  1. Set the Parallel property to yes or no. If you choose yes, individual branches will be processed in parallel. If you select no, they are processed sequentially.
  2. Define the Counter Variable Name by clicking on the counter string.
  3. Enter the Start Counter Value. If necessary, use the Browse button to create a new value in the XPath Expression Builder.
    4. Note: The lowest possible starting counter value is “1.”
  4. Enter the Final Counter Value. If necessary, use the Browse button to create a new value in the XPath Expression Builder.
    5. Note: The lowest possible starting counter value is “1.”

Adding General Information

General information is useful for making a node more legible. It includes the ability to add a unique identifier, or Label, to the node and to supplement it with notes, or Documentation. General information is optional.

  1. To add a Label to a node, open the Properties view and enter a unique, identifying string in the Label field. The Label that you enter appears underneath the node in the Canvas area. Alternatively, you can simply double-click the string under the icon and edit.
  2. To add Documentation to a node, open the Properties view and enter any notes that you think are important in the Documentation field.

Creating an If Activity

The If Activity is used to provide conditional logic within a Split-Join. It is composed of a number of nodes that determine the behavior for the overall If activity. Each node must be individually configured. When you create an If activity, an If and an Else are automatically generated within it. You can add an unlimited number of Else If nodes with the Add Else If button.

Configuring an If Activity can include the following tasks:

Related Topics

Configuring the If

The If provides a unit of conditional logic within the overall If activity. It is automatically generated when you create an If activity. Configuring an If can include the following tasks:

Related Topics

Writing the logic of the condition

The If Activity executes conditional logic defined by an XPath 1.0 expression. Enter this condition in the Condition text field of the Condition tab, or click the browse button to launch and write the expression in the Xpath 1.0 Expression Builder.

Adding resulting nodes

If the condition in the If logic is met, a subsequent node or string of nodes will result. Add and configure any resulting nodes by dragging them in sequential order to a drop point beneath the If icon.

Adding General Information

General information is useful for making a node more legible. It includes the ability to add a unique identifier, or Label, to the node and to supplement it with notes, or Documentation. General information is optional.

  1. To add a Label to a node, open the Properties view and enter a unique, identifying string in the Label field. The Label that you enter appears underneath the node in the Canvas area. Alternatively, you can simply double-click the string under the icon and edit.
  2. To add Documentation to a node, open the Properties view and enter any notes that you think are important in the Documentation field.

Adding and Configuring Else If

The Else If is used to provide additional logic within the context of an overall If. You can add an Else If every time you press the “Add Else If” button.

Configuring an Else If can include the following tasks:

Related Topics

Writing the Logic of the Condition

The Else If uses conditional logic defined by an XPath 1.0 expression. Enter this condition in the Condition text field of the Condition tab or click the browse button to launch and write the expression in the Xpath 1.0 Expression Builder.

Adding Resulting Nodes

If the condition in the Else If logic is met, a subsequent node or string of nodes will result. Add and configure any resulting nodes by dragging them in sequential order to a drop point beneath the Else If icon.

Adding General Information

General information is useful for making a node more legible. It includes the ability to add a unique identifier, or Label, to the node and to supplement it with notes, or Documentation. General information is optional.

  1. To add a Label to a node, open the Properties view and enter a unique, identifying string in the Label field. The Label that you enter appears underneath the node icon in the Canvas area. Alternatively, you can simply double-click the string under the icon and edit.
  2. To add Documentation to a node, open the Properties view and enter any notes that you think are important in the Documentation field.

Configuring the Else

The Else provides a final case of logic within the context of an overall If. It is automatically generated when an If is created. Configuring an Else can include the following tasks:

Related Topics

Adding Resulting Nodes

As the final case in the If’s logic, the Else requires no conditions to be met in order to execute. It will automatically execute resulting activities when invoked. Add and configure any resulting nodes by dragging them in sequential order to a drop point beneath the Else icon.

Adding General Information

General information is useful for making a node more legible. It includes the ability to add a unique identifier, or Label, to the node and to supplement it with notes, or Documentation. General information is optional.

  1. To add a Label to a node, open the Properties view and enter a unique, identifying string in the Label field. The Label that you enter appears underneath the node in the Canvas area. Alternatively, you can simply double-click the string under the icon and edit.
  2. To add Documentation to a node, open the Properties view and enter any notes that you think are important in the Documentation field.

Creating an Error Handler

The Error Handler receives and handles errors. If it is attached to a Start Node, it is a “global” Error Handler and serves as a catch-all for the output of all local Raise Error nodes. If it is attached to a Scope, it only handles errors raised locally. To create an Error Handler:

  1. Select the node to which the Error Handler will be added.
    2. Note: It must be a Start Node or a Scope.
  2. Right-click the selected icon and select Add Error Handler.
  3. If you are invoking a SOAP Fault, in the Catch All tab of the Properties View, select SOAP Fault Variable Name to define a SOAP Fault variable associated with the Error Handler.

The basic Error Handler is now configured, but you may need to add additional Assign, If, and/or Reply nodes to it depending on whether you wish to execute logic upon the received faults before sending a response.

Related Topics

Creating a Raise Error

The 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. Configuring a Raise Error can optionally include documenting the nature of the error in the General Information tab.

Related Topics

General information is useful for making a node more legible. It includes the ability to add a unique identifier, or Label, to the node and to supplement it with developer notes, or Documentation. General information is optional.

  1. To add a Label to an node, open the Properties view and enter a unique, identifying string in the Label field. The Label that you enter appears underneath the node Icon in the Canvas area.
  2. To add Documentation to an node, open the Properties view and enter any notes that you think are important in the Documentation field.

Configuring a Reply

A global Reply is generated automatically whenever you create a new Split-Join. The purpose of the global Reply is to send a response back to the invoking ALSB message flow. However, you may also create a local Reply to an Error Handler. Configuring the Reply can include the following tasks:

Related Topics

Viewing the Operation

The operation is based upon the initial WSDL selection for the overall Split-Join. It is displayed in the Properties view for reference.

Defining the Reply Variable

The Reply can either send a Response or a Fault back to the client depending on how you configure the variable. The Fault options available vary depending upon whether the Reply is global or local.

Note: Switching back and forth between the Response and Fault buttons will clear either configuration. For instance, if you have previously selected “Propagate SOAP Fault” for Fault configuration and you then switch to the “Response” configuration, “Propagate SOAP Fault” will be deselected.

Given the available options as outlined above, select either a Response or a Fault for your Reply Variable.

If you select Response, you must define the Message Variable the Response will be assigned to. This can be done in two ways:

  1. Select a pre-existing variable from the Message Variable menu.
  2. Create a new Message Variable (following steps).
    3. Note: If there are no available Message Variables associated with the previously chosen operation, you must create a new Message Variable.

To create a new Message Variable, select Create Message Variable from the Message Variable menu. The Create Message Variable Dialog appears:

  1. Provide a name for the variable.
  2. Click OK.

Note that Message Type Namespace and Message Type are displayed automatically in the Properties view once the variable is defined.

If you select Fault, you must specify either a WSDL Fault or propagate a SOAP Fault.

Note: In some circumstances, no Faults or only a SOAP Fault will be available. See previous notes.

If you select a WSDL Fault, you must specify the Fault by name and define the Message Variable that it will be assigned to.

  1. Select WSDL Fault Name and choose a name from those available.
    2. Note: There may only be one name available in which case no choice is necessary.
  2. Define a Message Variable. This can be done in two ways:
    1. Select a pre-existing variable from the Message Variable menu.
    2. Create a new Message Variable (following steps).
      3. Note: If there are no available Message Variables associated with the previously chosen operation, you must create a new Message Variable.

To create a new Message Variable, select “Create Message Variable” from the Message Variable menu. The Create Message Variable Dialog opens:

  1. Provide a name for the variable.
  2. Click OK.

Note that Message Type Namespace and Message Type are displayed automatically on the properties page once a variable is defined.

If you select Propagate SOAP Fault, the SOAP Fault specified in the parent Error Handler will automatically be propagated in the Reply. There is nothing else to be configured

Adding General Information

General information is useful for making a node more legible. It includes the ability to add a unique identifier, or Label, to the node and to supplement it with notes, or Documentation. General information is optional.

  1. To add a Label to a node, open the Properties view and enter a unique, identifying string in the Label field. The Label that you enter appears underneath the node in the Canvas area. Alternatively, you can simply double-click the string under the icon and edit.
  2. To add Documentation to a node, open the Properties view and enter any notes that you think are important in the Documentation field.

About Scope

A Scope is a container that groups various elements together. The container creates a context that influences the behavior of its enclosed elements. Local Variables and the Error Handler defined within the Scope are restricted to this context. However, some nodes within the scope may operate both locally (that is, within the Scope) and globally (that is, outside of the Scope.) For instance, an Invoke External Service within a certain Scope might call upon an service external to the Scope’s context.

Related Topics

Exporting and Testing a Split-Join

You can export and test a Split-Join on an ALSB server provided that it is associated with a transport typed business service. Exporting and testing a Split-Join can include the following tasks:

Creating a Transport Typed Business Service

A Split-Join is used by a particular transport typed business service. If you do not have an appropriate business service, you must create one before you can export or test your Split-Join. There are two ways to create a business service:

  1. Create the business service manually in WorkSpace Studio or the ALSB console.
  2. Generate the business service automatically from the Split-Join (.flow) menu:
    1. Right click on the Split-Join (.flow) file in the Project Explorer to open the Split-Join menu.
    2. Select AquaLogic Service Bus.
    3. Select Generate Business Service.
    4. Name and save the new service in a project.

After you create the business service, you can export the Split-Join provided that it has no errors.

Note: It is a helpful practice to place the associated business service in the same ALSB project as the Split-Join. It can also be useful to give the business service the same name as the Split-Join so that they are easily correlated.

Exporting the Split-Join Files

Split-Joins without errors can be exported to an ALSB server.

Note: Errors appear in the Problems view of the Split-Join editor. If you try to export a Split-Join with errors, the export fails.

There are three ways to export a Split-Join:

  1. Export from the Business Service Menu
  2. Auto-export
  3. Manual export
Exporting from the Business Service Menu

It is possible to export a Split-Join directly from the Business Service menu. However, because exporting by this method automatically launches the ALSB Test Console, it is useful if you want to both export and test. Exporting from the Business Service menu involves the following steps:

  1. In the Project Explorer, right click on the Business Service (.biz file) to be exported/tested.
  2. Select Run as.
  3. Select Run on server. The Run on Server Dialog opens.
  4. Select an existing server or define a new one and go to the next step.
  5. In the Add and Remove Projects window, the ALSB project containing the business service and any other dependent files have been pre-selected for configuration/export. They can not be removed because the business service can not be tested without its dependent files. The entire Split-Join will therefore be exported.
  6. Select Finish, and the ALSB Test Console will launch. You can now test the business service.
Auto-export

A Split-Join can be auto-exported to an ALSB server. If you use this method, you must manually launch the ALSB console in order to test the exported files. Auto-exporting involves the following steps:

  1. Select File > Export.
  2. Select AquaLogic Service Bus.
  3. Select Resources to ALSB Server. This will export the resources to the ALSB server, but it will not launch the ALSB Test Console. You must launch the Test Console manually within the ALSB console application.
Manual export

A Split-Join can be manually exported to an ALSB server. If you use this method, you must manually launch the ALSB console to test the exported files. Manually exporting involves the following steps:

  1. Select File > Export.
  2. Select AquaLogic Service Bus.
  3. Select Resources as Configuration JAR and go to the next step.
  4. In the ALSB Configuration JAR Export window, configure the following options:
    1. Select the ALSB Configuration file containing the files to be exported.
    2. Set the Export Level to Project or Resource depending upon whether you wish to export entire projects or individual files. The selection available in the tree below will change based upon the Export Level.
    3. Select the projects and/or resources to be exported in the configuration JAR.
    4. Select Include Dependencies if you want to export any file dependencies associated with the selected files.
    5. Browse to a destination for the exported JAR file.
    6. Click Finish to export the JAR file.
  5. Import the JAR file via the ALSB console.
Note: A quick way to access the ALSB console from the IDE is to select Launch ALSB Administration Console from the server menu. (Right-click the appropriate server in the Servers view.)

Testing the Split-Join in the Test Console

You can test a Split-Join by executing the business service that uses it in the ALSB Test Console. This can either be done within the Split-Join editor or by exporting the Split-Join to an ALSB server. To test the Split-Join within the IDE, you need to export the files using the menu for the business service that uses the Split-Join.

Exporting from the Business Service Menu

You can export and test a Split-Join directly from the Business Service menu. If you use this method, the export happens in the background while the ALSB Test Console launches. Exporting from the Business Service menu involves the following steps:

  1. In the Project Explorer, right click on the Business Service (.biz file) to be exported/tested.
  2. Select Run as.
  3. Select Run on server. The Run on Server Dialog appears.
  4. Select an existing server or define a new one and go to the next step.
  5. In the Add and Remove Projects window, the ALSB project containing the business service and any other dependent files have been pre-selected for configuration/export. The dependent files cannot be removed because the business service cannot be tested without its dependent files.

Click Finish, and the ALSB Test Console will launch. You can now test the business service.

Note: Although only the ALSB Test Console is displayed at this point, the entire Split-Join has been exported to the ALSB server.

  Back to Top       Previous  Next