Partner services

A service is a B2Bi object that you use to specify the processing sequence for handling a message exchanged between two or more partners and communities. In B2Bi, there are two types of services. The partner services relate to agreements and is the type of service that is discussed here.

A partner service can contain one or more components.  Each component defines a step in the processing of a message. A service can also be reused in multiple agreements.

Partner service objects can be created and managed in the B2Bi user interface, on the Processing configuration > Manage services page.

For more information on services, please see the B2Bi Administrator Guide.

Service planning

A service is used when you want to specify the message handling processes for an exchange between endpoints. 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 service 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 DocumentServiceResource include:

  • Document services
  • Document service attributes
  • Document service outputs
  • Document service templates

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 partner service

A partner service is used to specify the processing sequence for handling a message exchanged between endpoints. Use the steps below to create and configure a new partner service definition through API requests. Note that this scenario assumes a completely new configuration without any existing pieces.

  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 service objects using GET: /rest/v1/services.
  3. Add a new service: POST: /rest/v1/services.
  4. Configure or update the service: PUT: /rest/v1/services.

Using the DocumentServiceResource, you can update the name of the service, change or add a new mapping component, and change or add a new post-detection component.

Configure the mapping component

  1. Retrieve the mapping component with GET: /rest/v1/services/component/<id>, where the "id" is the identifier of the service.
  2. Retrieve the list of configuration parameters (or parameter sets) for the mapping component: GET: /rest/v1/services/component/<id>/configurations, where "id" is the identifier of the service.
  3. Retrieve the list of arguments for a configuration parameter: GET: /rest/v1/services/component/configurations/<id>/arguments, where "id" is the configuration identifier.
  4. Set argument values with PUT: /rest/v1/services/component/configurations/arguments.

Configure the post-detection component

  1. Retrieve the post-detection component with GET: /rest/v1/services/postDetectionComponent/<id>, where "id" is the service identifier.
  2. Retrieve the list of configuration parameters (or parameter sets) for the post-detection component with GET: /rest/v1/services/postDetectionComponent/<id>/configurations, where "id" is the service identifier.
  3. Retrieve the list of arguments for a configuration parameter with GET: /rest/v1/services/postDetectionComponent/configurations/<id>/arguments, where "id" is the configuration identifier.
  4. Set argument values with PUT: /rest/v1/services/postDetectionComponent/configurations/arguments.

Configure an output

  1. Retrieve the list of outputs with GET: /rest/v1/<id>/outputs, where "id" is the unique identifier of the service.
  2. Get the definition of an output with GET: /rest/v1/outputs/<id>, where "id" is the output identifier.
  3. Configure an output by setting the delivery method with PUT: /rest/v1/service/outputs. A service can have one or more outputs.
  4. Retrieve the list of additional components with GET: /rest/v1/outputs/<id>/components, where "id" is the output identifier. Zero or more additional components can be added on an output.
  5. Add an additional component with POST: /rest/v1/outputs/<id>/components, where "id" is the output identifier.

Configure an additional component

  1. Get the definition of an additional component with GET: /rest/v1/outputs/component/<id>, where "id" is the identifier of the additional component.
  2. Retrieve the list of configuration parameters (or parameter sets) for an additional component with GET: /rest/v1/services/outputs/component/<id>/configurations, where "id" is the identifier of the additional component to be modified. The call is made on the ConfigurationResource.
  3. Retrieve the list of arguments for a parameter set that belongs to an additional component: GET: /rest/v1/services/outputs/component/configurations/<id>/arguments, where "id" is the identifier of the parameter set.
  4. Set argument values for a parameter set that belongs to an additional component with PUT: /rest/v1/services/outputs/component/configurations/arguments.

Related Links