Configuring the endpoints for publishing events

In Sterling Intelligent Promising to activate event publishing, you must configure your cloud storage provider endpoint.

Before you begin

For webhooks, review the webhook concept documentation and ensure that you have provisioned a web server that uses OAuth 2.0 authentication and they have the details of webhook and OAuth server. The server must be online during provisioning. For Google Cloud storage, Azure Blob storage, and Amazon Web service, follow the concept documentation resources that are provided.

For IBM Cloud® Object Storage, following steps 1 and 2.
  1. Provision your IBM Cloud Object Storage bucket. For more information, see Getting started with IBM Cloud Object Storage.

    Assign only one data type to a IBM Cloud Object Storage bucket.

  2. Gather the following provisioning information about your IBM Cloud Object Storage bucket to provide to the file transfer adapter:

About this task

The event publish rule guides the system to process events and determines where to publish them. The Publish endpoint configuration now supports multiple storage providers. When you select a specific storage provider, you must provide the configuration details for that storage provider.

Procedure

  1. Log in to Order Hub.
  2. From the menu, click Endpoints.
  3. Select the Publish tab.
    The Endpoints page opens with the following information:
    Table 1. Endpoints page
    Field name Description
    Entity The event type for which you configure a publish event rule.
    • Click any Entity link to view the endpoint details. An Entity link is available only when you configure a rule. To sort the entities, hover over the Entity column and select the Sort icon.
    Description A description of the event type.
    File type The type of file that is supported by the endpoint, for example, a Events file.
    Status The status of the endpoint and whether it is configured. An entity stays in an unconfigured state until you activate or configure it.
    • Valid options are Configured or Unconfigured.
    Actions Edit an endpoint that is configured or configure an endpoint. Delete an endpoint that is configured.
    You can select any column heading to sort the information.
  4. Complete one of the following steps.
    • To configure an endpoint, click the Edit icon for an endpoint that is in the Unconfigured status.
    • Select an entity for which you want to configure a publish event rule.
  5. On the Endpoints page, view the following endpoint configuration information that is provided:
    Endpoint ID
    The ID that is associated with the endpoint to configure.
    Entity
    The event type for which you configure a publish event rule.
    Description
    A description of the event type.
    File type
    The type of file that is supported by the endpoint, for example, a Events file.
    Status
    The status of the endpoint and whether it is active or inactive.
    To activate the endpoint, slide the Status toggle to Active.
    Skip failed events (optional)
    Optional: When the application is unable to complete a transaction within the defined endpoint, the events fail. Retrieve the failed events anytime within the retention period.
    To skip the failed events, slide the toggle to On.
  6. In the storage provider setup section, to configure the cloud storage provider or to configure the webhook to publish the allocation data from the Storage provider drop-down list, select one of the following options.
    • Amazon S3
    • Microsoft Azure Blob Storage
    • Google Cloud Storage
    • Webhook
    • Amazon S3
      Table 2. Amazon S3 Hash-based message authentication (HMAC) credentials
      Credentials Description
      HMAC Access key The access key that is used to access the bucket.
      HMAC Secret key The secret key that is used to access the bucket.
      Region The region that is associated with the S3 service instance.
      Endpoint URL The endpoint URL of the IBM Cloud Object Storage instance. The endpoint URL depends on your bucket's location and resiliency. For more information, see Amazon Simple Storage Service endpoints and quotas.
      Table 3. Amazon S3 export location details
      Export location Description
      Bucket name The name of the bucket.
      Optional: Prefix Optional: The prefix value of the storage location in the bucket for input publish data.
    • IBM Cloud Object Storage
      Table 4. IBM Cloud Object Storage HMAC credentials
      HMAC Credentials Description
      Access key The access key that is used to access the bucket.
      Secret key The secret key that is used to access the bucket.
      Region The region that is associated with the IBM Cloud Object Storage instance.
      Endpoint URL The endpoint URL of the IBM Cloud Object Storage instance. The endpoint URL depends on your bucket's location and resiliency. For more information, see Endpoints and storage locations.
      Alternatively, instead of the HMAC credentials, provide the following IBM Cloud Object Storage API credentials:
      Table 5. IBM Cloud Object Storage API credentials
      Credentials Description
      API Key The IAM API key that has Writer access to the bucket.
      Endpoint URL The endpoint URL of the IBM Cloud Object Storage instance. The endpoint URL depends on your bucket's location and resiliency. For more information, see Endpoints and storage locations.
      Table 6. IBM Cloud Object Storage export location details
      Export location Description
      Bucket name The name of the bucket.
      Prefix The prefix value of the storage location in the bucket for input publish data.
    • Microsoft Azure Blob Storage
      Table 7. Microsoft Azure Blob Storage authentication details
      Authentication Description
      Authentication type Select one of the following options and provide the details that are required:
      • Shared key (access keys)
        • Account Name: The name of the Azure Storage account that is used to access the azure blob container.
        • Account Key: The access key for the Azure Storage account that is used to access the azure blob container.
      • Azure SAS Credential
        • Signature: The shared access signature that is used to access the azure blob container.
      Endpoint URL The endpoint URL of the Microsoft Azure Blob Storage instance.
      Table 8. Microsoft Azure Blob Storage export location details
      Export location Description
      Container name The azure blob container name.
      Optional: Blob prefix The prefix value of the storage location in the bucket for input publish data.
    • Google Cloud Storage
      Table 9. Google Cloud Storage configuration details
      Google cloud credentials Description
      Service account key (JSON) The private key that is used to access the bucket.
      Endpoint URL The endpoint URL of the Google Cloud Storage instance.
      Table 10. Google Cloud Storage export location details
      Export location Description
      Bucket name The name of the bucket.
      Optional: Prefix The prefix value of the storage location in the bucket for export publish data.
    • Webhook
      Table 11. Webhook configuration details
      Webhook configuration Description
      Authentication type The security protocol used to authenticate the webhook connection. Currently, OAuth 2.0 is supported, which ensures secure token-based authentication.
      Grant type The method used to obtain an access token for the selected authentication type. For OAuth 2.0, the Client Credentials grant type is used.
      Table 12. Webhook export location details
      Export location Description
      Webhook URL The HTTPS type of URL where the webhook events are posted.
      Event formatter The format in which the events are delivered, including JSON Array or Object. The default format is Array. For more information, see New event delivery format
      Table 13. Client credentials
      Credentials Description
      Token URL The HTTPS type of URL where OAuth 2.0 tokens are available.
      Client ID The client ID for the OAuth 2.0 token server.
      Client secret The client secret for the OAuth 2.0 token server.
  7. Click Save.
  8. To view the endpoint details for an existing configuration, select the Publish tab and click any of the entity links that have a Configured status.
    The Endpoints page displays the configuration details.
  9. Edit or delete a configuration.
    • To edit the configuration information, on the Endpoints page, click the Edit icon. Edit the endpoint configuration details and click Save.

    There is a toggle button to change the active toggle to inactive. This change stops the event publishing but the endpoint configuration can be saved.

    • To delete a configuration, on the Endpoints page, click the Delete icon. In the Confirm delete dialog, click Delete.