B2B Advanced Communications Storage Adapter

The B2B Advanced Communications Storage adapter gives IBM® Transformation Extender the ability to read and write payloads that were stored in the IBM Sterling B2B Integrator storage subsystem.

Overview

Table 1. B2B Advanced Communications Storage adapter overview. The following table provides an overview of the B2B Advanced Communications Storage adapter:
Characteristic Definition
Adapter Name

B2B Advanced Communications Storage

Adapter specifics are as follows:
<M4Adapter name="IBM B2B Storage" alias="BSTR" id="194" type="app" class="
      com/ibm/itx/dtx/m4storage"/>
Description

This adapter integrates IBM Transformation Extender with IBM B2B Advanced Communications. This adapter enables communication between the two products and allows IBM Transformation Extender to get data from and put information to B2B Advanced Communications storage.
Business usage IBM Transformation Extender uses this adapter to retrieve data from B2B Advanced Communications storage and persist data to B2B Advanced Communications storage.
Inbound
The inbound integration steps are as follows:
  1. B2B Advanced Communications sends a business document object to IBM MQ.
  2. The IBM Transformation Extender reads the business document object from IBM MQ using the IBM MQ adapter.
  3. The IBM Transformation Extender map uses a B2B Advanced Communications schema on the input card to read and parse the business document object.
  4. The IBM Transformation Extender map reads the B2B Advanced Communications storage of the input document (if the data is not sent inline)
Outbound
The outbound integration steps are as follows:
  1. IBM Transformation Extender adds the message to B2B Advanced Communications storage.
  2. The IBM Transformation Extender map creates a business document object.
  3. The IBM Transformation Extender map writes the message to IBM MQ.
Preconfigured? No. The storage-required .jar files and business document object schemas are installed with IBM Transformation Extender. However, you must perform the following steps before using the adapter:
  1. Create a folder called com/ibm/itx/dtx/m4storage under the tx_install_dir/Jars folder.
  2. Copy the following .jar files under the com/ibm/itx/dtx/m4storage folder:
    • m4storage.jar
    • ibm-b2b-meg-core-apiint-common*.jar
    • ibm-b2b-meg-core-apiint-common-api*.jar
    • ibm-b2b-meg-core-components-utils*.jar
    • ibm-b2b-meg-core-storage-core*.jar
    • ibm-b2b-meg-core-storage-fs*.jar
    • ibm-b2b-meg-core-storage-service*.jar
  3. Create a Schemas folder under the com/ibm/itx/dtx/m4storage folder.
  4. Copy the business document object related schemas into the new Schemas folder:
    • BaseMessages.xsd
    • BaseTypeDefinitions.xsd
    • BusinessDocument.xsd
    • ExchangeVisibilityEvent.xsd
    • NotificationMessage.xsd
  5. Add the following two properties to the tx_install_dir/dtx.ini file:
    [B2B STORAGE]
BASE_FILE_PATH=location_of_root_storage
DATA_DOMAIN=data_domain_for_B2B_Advanced Communications_storage
Requires third-party files? No. All required components are shipped with the product.
Platform availability
  • Windows
  • Linux®
Related services None
Application requirements This adapter requires that you install B2B Advanced Communications version 1.0.0.5 or higher. If you do not install the full B2B Advanced Communications product, at a minimum you must deploy the Proof of Concept installation. Additionally, you must install IBM Transformation Extender V9.0.0.1 or later.
Initiates business processes? No
Invocation This adapter can be invoked through the command line.
Business process context considerations None
Returned status values None
Restrictions
  • Data ID, which is provided when data is written to B2B Advanced Communications storage, is required for inbound process flows to read the data from storage.
  • PUT is not supported for this function.
Persistence level

None
Testing considerations There are two levels of testing, depending on whether you installed the B2B Advanced Communications Proof of Concept installation or the full version of the product:
  1. Install B2B Advanced Communications (Proof of Concept) version 1.0.0.5 or higher and perform storage adapter testing.
  2. Install B2B Advanced Communications (production) version 1.0.0.5 or higher and test the Launcher with the MQ adapter.

Command line options

Use the following command line options with this adapter:
-BUCKET (-B)
The name of the bucket.
-ID (-ID)
This is the unique identifier for the message or business document object.
-NOW (-NOW)
Indicates that the adapter is writing data to B2B Advanced Communications storage.
-SERVICE (-S)
This is the name of the adapter.
-ADDDOC (-A)
Adds a business document object to B2B Advanced Communications storage.

Implementing the B2B Advanced Communications Storage adapter

To implement this adapter, follow this procedure:
  1. From the command line, go to B2B_Advanced_Communications_install_dir/members/bin
  2. Invoke execute member start all
  3. Invoke execute storage –provision

Inbound parameters passed from business process to adapter

Field Description
Action The inbound storage action.
  • GET - get payload from storage as primary document
For example:
=VALID(GET("BSTR", "-B 1st_provisioned -S 1st_provisioned_var01 -ID " + Output2), LASTERRORMSG())
DataId

The unique identifier for the business document object to be retrieved from B2B Advanced Communications storage.

Outbound parameters passed from adapter to business process schema

Field Description
Action The outbound storage action.
  • GET - write payload from message to B2B Advanced Communications storage
For example:
=VALID(GET("BSTR", "-B 1st_provisioned -S 1st_provisioned_var01 –NOW -ADDDOC", "THIS IS A TEST"), LASTERRORMSG())
DataId

The unique identifier for the business document object to be added to B2B Advanced Communications storage. This value is provided by the adapter.

PrimaryDocument The business document object. This value is returned by the GET action from B2B Advanced Communications storage.