Configuring BPaaS in Sterling B2B Integrator
About this task
- Install Sterling B2B Integrator REST APIs. For more information, see Installing B2B REST APIs.
Define a business process (BP) which adheres to the following rules:
- The BP should be defined with the option Use BP Queuing unchecked.
- BP should be enabled.
Configure the APIs in the bpaasmapping.properties file.
The configuration involves specifying the BP name and version (optional). Example:
You can also modify other API configuration parameters if required. For more information, see BPaaS Mapping Configuration File Properties.
sampleprocessingapi.mapping=HelloWorldSync sampleprocessingapi.disablehttpmethods=DELETE,PUT sampleprocessingapi.skiprequestheaders=Authorization sampleprocessingapi.bpexecutiontimeout=30000
Modify the bpaas.properties.in file to override the default configuration and run the following command:
setupfiles.shNote: You can add the properties to customer_overrides.properties to prevent them from being overwritten during upgrades.For most cases, the out of box configuration or the default settings in bpaas.properties.in will suffice. For more information, see BPaaS Configuration File Properties.
Define the permissions for each API and assign it to a user or user groups.
The following is an example of permissions defined for the paymentprocesssing API based on the supported HTTP methods:
- GET → paymentprocessing/VIEW
- POST → paymentprocessing/CREATE
- DELETE → paymentprocessing/DELETE
- PUT → paymentprocessing/UPDATE
Add a basic authorization header in the request:
Authorization: Basic YXBpdXNlcjpwYXNzd29yZA==
- Optional: Pass any custom request headers.
Pass a request body. This will be set as a Primary document in the BP.
Note: If no request body is sent, then no primary document is created for the BP.