Components

Components are used in B2Bi to provide specific types of processing to a message handling flow. A component associates a resource (a piece of message-processing code) residing on the integration engine with a set of specific parameters and message formats. The processing can then be used in one or more service objects to specify how a particular message type is handled between two or more exchange points.

In the B2Bi user interface, you can create and edit components on the Processing configuration > Manage components page.

A component can use any one of the following resource types:

  • Custom delivery - Used with an application delivery to deliver messages to a database or an external application.
  • Detector - Detects characteristics of messages that transit in B2Bi.
  • Document - Provides regular processing of a document, including pre-processing and post-processing. This processing step is executed after a map, but before enveloping.
  • Enveloper - Adds an envelope to a document or group of documents for outbound messages.  The envelope provides information such as sender and receiver IDs and control numbers.
  • Map - Performs message transformations, data mining, and routing based on message body, header or metadata content.
  • Post detection - Performs processing of a message after detection but before any splitting, mapping or other message processing. This component type is not applicable to metadata services.
  • Post enveloping - Provides processing after an enveloping process on outbound messages.
  • Post transfer failed - Provides specific post-processing after an unsuccessful transfer attempt.
  • Post transfer success - Provides specific post-processing after a successful transfer.

To view the parameters and arguments available for each component type on the B2Bi user interface, click Add a component to open the wizard and scroll through the pages and options. Alternatively, click on a current component in the list on the Manage components page to view the available parameters and arguments for that component resource type. For more information about each of the available components, see B2Bi Administrator Guide.

Component planning

Components are used when you want to use the functionality provided by a resource to process a message exchanged between endpoints. The standard process for use with components includes logging in, getting a list of available components, and adding a new or updating an existing component along with its configuration parameters.

The trading engine service APIs support a Representational State Transfer (REST) model for accessing a set of resources through a fixed set of operations. For detailed documentation on each resource and its parameters, see the dynamically generated API documentation available on your host: http://<host>:<port>/apidocs.

As you develop your component project plan, be sure to:

  • Read the dynamic API documentation thoroughly. Note that different methods (GET, POST, UPDATE/PUT, DELETE) apply for each sub-resource.
  • Evaluate all resources and sub-resources carefully and test in a sandbox environment.
  • Consider consulting with Axway Professional Services.

The B2Bi objects currently supported by the ComponentResource include:

  • Components
  • Registered components
  • Configurations
  • Arguments
Note   You must log in to B2Bi using a valid username and password before calling other resources.

RESTQL queries

B2Bi trading engine support for RESTQL (REST Query Language) is modeled after Apigee’s query syntax. For more information, see http://apigee.com/docs/app-services/content/querying-your-data and RESTQL.

Add and configure a component

  1. Login. Authenticate yourself with a valid username and password combination. This will allow you to interact with the system and continue with the next steps. Depending on the tool used, authentication might be needed only once per session.
  2. Retrieve a list of available component objects with GET: /rest/v1/components.
  3. Add a new component with POST: /rest/v1/components. To create a new component, you must specify a resource that resides on the integration engine. The resource name and type can be identified by accessing a different API resource. The component definition is returned with a unique identifier.
  4. Configure or update the component with PUT: /rest/v1/components. Update the component definition by setting a different name or a different resource type. Some parameters, like the component type, cannot be changed. Depending on the component type, the configuration might contain parameters that are used to specify the characteristics of the component. Those parameters can be configured by accessing a different resource.
  5. Retrieve a list of configuration parameter sets for a specific component with GET: /rest/v1/components/<id>/configurations, where "id" is the component identifier. These parameters can be configured to specify the characteristics of the component.
  6. Retrieve a list of arguments for a configuration parameter with GET: /rest/v1/components/configurations/<id>/arguments, where "id" is the configuration identifier. The configuration parameters are grouped into different parameter sets. To configure these parameters, you have to access the list of arguments specific to a parameter set. You can specify the input or output formats of the document and provide values for specific parameters used to describe component object characteristics. The identifier is returned within the configuration bean.
  7. Set argument values for a specific configuration parameter with rest/v1/components/configurations/<id>/arguments, where "id" is the configuration identifier.

Related Links