Configuring BPaaS in Certified Containers

About this task

Procedure

  1. Ensure at least one ASI and one API pod is running.
    Note: You must ensure Sterling B2B Integrator values.yaml has the replicaCount property set to at least one for ASI and API before the helm install/upgrade.
  2. Define a business process (BP) which adheres to the following rules:
    1. The BP should be defined with the option Use BP Queuing unchecked.
    2. BP should be enabled.
  3. Optional: Download the file bpaas.properties. Configure the properties in the file and save it to the config folder in Sterling B2B Integrator helm charts. For more information, see BPaaS Configuration File Properties.
  4. Download the file bpaasmapping.properties. Configure the APIs in the file and save it to the config folder in Sterling B2B Integrator helm charts.
    The configuration involves specifying the BP name and version (optional). Example:
    sampleprocessingapi.mapping=HelloWorldSync 

sampleprocessingapi.disablehttpmethods=DELETE,PUT 

sampleprocessingapi.skiprequestheaders=Authorization 

sampleprocessingapi.bpexecutiontimeout=30000
    You can also modify other API configuration parameters if required. For more information, see BPaaS Mapping Configuration File Properties.
    Note: Alternatively, you can add the properties to customer_overrides.properties and move it to the config folder in Sterling B2B Integrator helm charts.
    Restriction: You cannot add these properties through the customization UI page.
  5. Perform a helm install/upgrade. For more information, see Helm.
  6. 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 method:
    • GET → paymentprocesssing/VIEW
    • POST → paymentprocesssing/CREATE
    • DELETE → paymentprocesssing/DELETE
    • PUT → paymentprocesssing/UPDATE
  7. A new route now will be available for BPaaS: 
    https://myapi.apps.openshift.test.com/bpaas/v1

    Use the above URL along with the API name to invoke the BPaaS APIs.

    Example:
    https://myapi.apps.openshift.test.com/bpaas/v1/payamentprocessing
  8. Add a basic authorization header in the request: 
    Authorization: Basic YXBpdXNlcjpwYXNzd29yZA==
  9. Optional: Pass any custom request headers.
  10. Optional: 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.