Vitria (Businessware) Adapter

The Vitria (Businessware) adapter connects Sterling B2B Integrator to the Vitria® BusinessWare® Server v3.x, which is the message path for Vitria BusinessWare.

The following table provides an overview of the Vitria® BusinessWare® 3.x adapter:

Category Description
System name Vitria
Graphical Process Modeler (GPM) category None
Description Connects Sterling B2B Integrator to the Vitria® BusinessWare® Server v3.x, which is the message path for Vitria BusinessWare.
Preconfigured? No
Requires third-party files? Vitria 3.x. For additional requirements, see Requirements.
Platform availability Sun Solaris
Related services No
Application requirements No
Initiates business processes? Yes
Invocation Runs as part of a business process.
Restrictions The Vitria (Businessware) adapter works only in the Solaris environment.

Requirements

The following table identifies files that are required for the Vitria (Businessware) adapter. These files must be located on the server where the Vitria BusinessWare applications reside.

Path Requirement
CLASSPATH Include the BW30.jar file, which contains the Vitria API class files.
VTNAME Environment variable that sets the location of the Vitria BusinessWare server in the network. VTNAME must have the following syntax:

[hostname|ip-address]: ip-port-number/credential-typeexample: 127.0.0.1:6000/tcp:
LD_LIBRARY_PATH Include the following library (*.so) files (provided by Vitria):
  • libiconv3_o3gri.so
  • libnpjavanative3.so
  • libnpjavanative3_g.so
  • libnplogger3.so
  • libnplogger3_g.so
  • libvFlowBridge.so
  • libvtlocale3_o3gri.so
  • libvtlogfil3_o3gri.so
  • libvtmeta3_o3gri.so
  • libvtorb3_o3gri.so
  • libvtORBServLocale3_o3gri.so
  • libvtTransformerLocale3_o3gri.so
  • libvtValidatorLocale3_o3gri.so

How the Vitria (Businessware) Adapter Works

The Vitria adapter supports publish (send) and subscribe (receive) transactions. These transactions are linked using the subject, which is a Vitria BusinessWare server location where publisher applications can publish messages and subscriber applications can subscribe to messages. Publishers are decoupled from subscribers: that is, they do not coordinate data transmission with each other, except by using the subject.

When used as an outbound adapter, the Vitria adapter publishes transactions to the subject that the Vitria BusinessWare applications use for subscribe transactions.

When used as an inbound adapter, the Vitria adapter subscribes to transactions for the subject that the Vitria BusinessWare applications use for publish transactions.

The Vitria BusinessWare daemon supports efficient network communications by acting as the pathway for the Vitria BusinessWare business processes running across the network. The Vitria BusinessWare daemon arranges the details of data transport, packet ordering, receipt acknowledgment, retransmission requests, and data dispatching for the appropriate business processes.

Data Flow of an Outbound Adapter

Following is the data flow for the Vitria (Businessware) adapter when it functions as an outbound adapter:
  1. The Vitria adapter outputs data in XML format which is encoded in an XML wire format. A wire format is a universal format independent of hardware, operating system, and programming language architecture that provides a common language to connect diverse programs.
  2. After the data is encoded in an XML wire format, it is sent to the Vitria BusinessWare server and processed by the Vitria API.
  3. The Vitria API provides the XML object, which accepts the XML message as a byte array and compresses it, reducing the number of bytes sent over the network.
  4. The XML object is stored in the message field data field object.
  5. The message field data field object is added to the message object, which is transmitted to the Vitria BusinessWare server.

Data Flow of an Inbound Adapter

Following is the data flow for the Vitria (Businessware) adapter when it functions as an inbound adapter:
  1. The Vitria (Businessware) adapter continuously receives Vitria BusinessWare objects. The objects contain the message fields, which contain the compressed XML data.
  2. The Vitria (Businessware) adapter converts the incoming XML data into a byte array and passes the data to the business process context, which passes the data to Sterling B2B Integrator.
    1. If the object is a synchronous request, it contains the data and business process that must run in response to the request.
    2. The adapter spawns a separate worker thread and passes the data to this thread.
    3. The worker thread runs the started business process, which polls the business process engine until the business process completes.

Implementing the Vitria (Businessware) Adapter

To implement the Vitria (Businessware) adapter, complete the following tasks:
  1. Activate your license for the Vitria (Businessware) adapter. See An Overview of Implementing Services.
  2. Create a Vitria (Businessware) adapter configuration. See Creating a Service Configuration.
  3. Configure the Vitria (Businessware) adapter. See Configuring the Vitria (Businessware) Adapter.
  4. Use the Vitria (Businessware) adapter in a business process.

Configuring the Vitria (Businessware) Adapter

To configure the Vitria (Businessware) adapter, you must specify settings for the following fields in Sterling B2B Integrator:

Field Description
Name Unique and meaningful name for the adapter configuration. Required.
Description Meaningful description for the adapter configuration, for reference purposes. Required.
Select a Group Select one of the options:
  • None – You do not want to include this configuration in a group at this time.
  • Create New Group – You can enter a name for a new group in this field, which will then be created along with this configuration.
  • Select Group – If you have already created one or more groups for this service type, they are displayed in the list. Select a group from the list.
HostName IP address of the server running the Vitria BusinessWare applications.
PortNumber Port number of the server running the Vitria BusinessWare applications.
Event Specification ID or signature with which an event is registered in the Vitria BusinessWare repository. This information must be provided by the Vitria BusinessWare administrator or business analyst.
Action One of the following modes of EAI communications:
  • Asynchronous Publish (Outbound) – Outbound communication
  • Asynchronous Subscribe with BootStrap – Inbound receiver of events
  • Synchronous Publish (Outbound) – Outbound request/response

Vitria BusinessWare Publisher Transaction

To publish messages to the Vitria BusinessWare server, the adapter must be configured to the appropriate event specification.

Publisher Configuration

The following table describes the configuration that is required to run a Vitria BusinessWare publisher transaction.

Field Description
Name Unique and meaningful name for the service configuration. Required.
Description Meaningful description for the service configuration, for reference purposes. Required.
HostName IP address of the server running the Vitria BusinessWare applications.
PortNumber Port number of the server running the Vitria BusinessWare applications.
Event Specification ID or signature with which an event is registered in the Vitria BusinessWare repository. This information must be provided by the Vitria BusinessWare administrator or business analyst.
Action Of the modes of EAI communications listed, select either:
  • Asynchronous Publish (Outbound) – Outbound communication
  • Synchronous Publish (Outbound) – Outbound request/response
TimeOut in milliseconds Field displays when you select Synchronous Publish from the Action field. This is the time designated for a response to the transmission. Optional.

Publisher Transaction Process

Following is the publisher transaction process for the Vitria (Businessware) adapter:
  1. When it runs as part of a business process, the Vitria BusinessWare publisher extracts the document from the business process context and converts it into a message.
  2. The publisher uses the adapter to publish (send) the message to the specified Vitria BusinessWare server.
  3. If the transmission is synchronous, the adapter waits for a returned document from the Vitria BusinessWare server. This document is returned as the primary document. If the transmission is asynchronous, the Vitria adapter does not wait for a document but does receive a status indicating the success or failure of the transmission.
  4. The publisher returns the status of the Vitria BusinessWare message generation to the business process.

Vitria BusinessWare Subscriber Transaction

To subscribe to messages from the Vitria BusinessWare server, the adapter must be configured to the appropriate event specification.

Subscriber Configuration

The following table describes the fields used to configure the Vitria BusinessWare server for a subscriber transaction.

Field Description
Name Unique and meaningful name for the service configuration. Required.
Description Meaningful description for the service configuration, for reference purposes. Required.
Select a Group Select one of the options:
  • None – You do not want to include this configuration in a group at this time.
  • Create New Group – You can enter a name for a new group in this field, which will then be created along with this configuration.
  • Select Group – If you have already created one or more groups for this service type, they are displayed in the list. Select a group from the list.
HostName IP address of the server running the Vitria BusinessWare applications.
PortNumber Port number of the server running the Vitria BusinessWare applications.
ChannelPath File system path for the Vitria channel.
Event Specification ID or signature with which an event is registered in the Vitria BusinessWare repository. This information must be provided by the Vitria BusinessWare administrator or business analyst.
Action Of the modes of EAI communications listed, select Asynchronous Subscribe with BootStrap (Inbound receiver of events).
Document Filename File name of the incoming XML document.
BusinessProcess Poll Interval Interval at which to poll. Valid value is the number of seconds. Optional.
Business Process Name of the business process you want to enable or disable. Sterling B2B Integrator displays a list of business processes.

Subscriber Transaction Process

Following is the subscriber transaction process for the Vitria (Businessware) adapter:
  1. The subscriber subscribes to a particular Vitria BusinessWare message.
  2. When the subscription operation is complete, the Vitria BusinessWare server sends the subscriber an instance of the message.
  3. The subscriber passes the incoming XML document to the initial business process context and runs the specified business process.
  4. In the case of an asynchronous subscriber, the subscriber sends an acknowledgment to the Vitria BusinessWare application that sent the response.
  5. The subscriber listens for additional Vitria Businessware messages.