Installing Document Service

Procedure

  1. Sterling B2B Integrator and Document Service integration:
    1. Ensure the Sterling B2B Integrator helm charts contains the Document Service sub-charts in the following location: ibm-document-service-prod.
    2. Enable Document Service by setting the property in values.yaml: documentService.enabled=true.
    3. Enable license agreement by setting the property in values.yaml: documentService.license=true.
    For more information on configuring other properties, see Document Services Properties for Sterling B2B Integrator Integration.
  2. Configure the Document Service Pod: This configuration ensures that the pod is ready for communicating with Sterling B2B Integrator.

    Configure the pod using one of the following two methods.

    1. Partial Configuration

      In this approach, only the required properties are specified in the Sterling B2B Integrator values.yaml file. Other properties are automatically set using the default values from the Document Service sub-charts' values.yaml. Once configured, the Document Service pod will be up and running. For more information on configuring the properties, see Document Service Properties for Partial Configuration.

    2. Manual Configuration: Alternatively, you can manually configure all the properties in the Document Service sub-charts' values.yaml. This allows for a more customized setup, where you can configure all the properties to your specific requirements. For more information on configuring the properties, see Document Service Properties for Manual Configuration.
      The following is a list of possible values required for manual configuration of certain parameters:
      Parameter Possible values
      application.logging.level DEBUG, ERROR, INFO, FATAL, OFF, TRACE WARN
      objectstore.name AWS, Azure, MinIO, IBM Cloud, GoogleCloud
      objectstore.threadPoolType direct, single, fixed, workstealing, cached
      Note: In Sterling B2B Integrator v6200, auto-scaling is not supported. As a result, the replica count must be specified appropriately based on the server load.
      Note: In Sterling B2B Integrator v6201 and above, auto-scaling is supported. The communication between Sterling B2B Integrator and Document microservice can happen over REST or gRPC as per the following two configurations:
      • if the parameter useGrpc = false, i.e. REST is used between Sterling B2B Integrator and Document microservice, auto-scaling of Document Service pods will happen based on the configuration of the parameter targetCPUUtilizationPercentage.
      • if the parameter useGrpc = true, i.e. gRPC is used between Sterling B2B Integrator and Document microservice which is the default configuration, auto-scaling of Document Service pods will happen based on the configuration of the parameters targetCPUUtilizationPercentage and application.server.grpcMaxConnectionAge. The request will be load-balanced with the new Document Service pods as per the value in the parameter application.server.grpcMaxConnectionAge. However, you can change the value of the parameter. Make sure you choose the value carefully as Document Service will force Sterling B2B Integrator to form a new connection.
    3. Configure the purge pod for Object Store:

      If External Purge is enabled, it will delete the document payload from the object store. To enable deleting document payloads from object store through external purge, configure following properties in the Sterling B2B Integrator values.yaml file in setup.cfg section:

      Parameter Default value Description
      PROPERTY_archivethread_purge_disableInternalPurge false Internal purge should be disabled or not. Values are true or false
      PROPERTY_archivethread_purge_docsOnObjectStore false Documents that are stored on object store should be deleted. Valid values are true or false.
      Note: If PROPERTY_archivethread_purge_docsOnObjectStore is set to true, then PROPERTY_archivethread_purge_disableInternalPurge must also be set to true. Document payload on object store will not be deleted by Internal Purge. It will be only deleted by external Purge. Hence internal purge must be disabled.