OpenMessageBusEventPublisherOOB - Scoped

  • Release version: Xanadu
  • Updated August 1, 2024
  • 1 minute to read
  • The OpenMessageBusEventPublisherOOB script include provides a method for sending messages to the spoke selector, which sends the messages to the configured REST proxy.

    This script includes runs in the sn_api_notif_mgmt namespace. The admin role is required to access this script include.

    For additional information on how to configure your instance to use this script include, see Configure the Producer Event Notification Framework to use the Open Message Bus.

    OpenMessageBusEventPublisherOOB - publishMessageToComptibleRestProxy(Object tmfEventPayload, Array compatibleTopicArr)

    Sends the passed message to a custom message platform's REST proxy using the spoke selector.

    For additional information on this process, see Producing outbound API notifications using the open message bus. For information on how to implement this method, see Configure the Producer Event Notification Framework to use the Open Message Bus.

    Table 1. Parameters
    Name Type Description
    tmfEventPayload Object Event message to send. For additional information on the format, see TMF688 Event Management API User Guide v4.0.0.

    Format: TMF688

    compatibleTopicArr Array List of topic record sys_ids for which the passed event payload should be published. Located in the Topic [sn_api_notif_mgmt_topic] table.
    Table 2. Returns
    Type Description
    None

    The following code example shows how to call this method.

     publishEventToOpenMessageBus: function(tmfEventPayload) {
      // Fetch compatible topics
      var compatibleTopicArr = new TopicPickerUtils00B().fetchEventCompatibleTopic(tmfEventPayload);
      // Publish event in topic through REST proxy 
      new OpenMessageBusEventPublisherOOB().publishMessageToComptibleRestProxy(tmfEventPayload, compatibleTopicArr);
    },