Configuring Event Brokers in Event Portal

You can configure client application details, queues, and REST Delivery Points (RDPs) for Solace event brokers within applications in Designer and use the configuration to add, update, and delete client credentials, queues, ACL profiles, and RDPs on Solace event brokers.

This page includes the following information:

Setting Up Event Broker Configuration

To manage runtime event broker configuration from Event Portal, you must complete several setup steps.

  1. Make sure that your operational event brokers support configuration management from Event Portal.

    The event brokers must be Solace Cloud event broker services, Solace Appliance Event Brokers, or Solace Software Event Brokers running version 10.5 or later. For more information about creating an event broker service in Solace Cloud, see Creating Event Broker Services.

  2. Configure a connection between your operational event brokers in the runtime and Event Portal using one of the following options:

  3. Create modeled event meshes in Runtime Event Manager and add model event brokers that represent the operational event brokers you want to configure using Event Portal. If you want to configure event broker services in the same Solace Cloud account, we recommend putting the modeled event mesh and event broker services in the same environment.

  4. Set the appropriate runtime configuration option for the environments containing the modeled event meshes. For more information, see Setting Event Portal Runtime Configuration Options.

    Event Portal can send runtime configuration updates to operational event brokers automatically, or you can use Event Portal REST APIs to send runtime configuration updates on demand or using your organization's CI/CD pipeline to push configuration updates. For more information, see Pushing Runtime Configuration with Event Portal REST APIs.

  5. (Optional) Create Solace queue templates to define the queue configuration values you require on your event brokers. You can require using templates in an environment and specify which templates are allowed in each environment.

  6. (Optional) If client profiles are configured on the operational event broker, create client profile name templates so developers can select the correct client profile for the application in Designer. For more information about client profiles in Solace Cloud, see Creating a Client Profile. You can require using templates in an environment and specify which templates are allowed in each environment.

For more information about connecting Event Portal to your event brokers, see Connecting Event Portal to Runtime Event Brokers.

For a demonstration of setting up runtime configuration, watch this video:

Video illustrating the features described in the preceding text.

Application Settings on Event Brokers

The following diagram shows how the subscriptions, consumers, and client details you add to a standard application in Designer relate to your runtime environment when you set up Solace Cloud to configure event broker services from Event Portal.

Diagram showing the concepts described in the surrounding text.

  1. In an application in Event Portal, you specify events that the application publishes and consumers that subscribe to events published by other applications.

    • You can specify the name of the client profile that applies to the runtime application on the event broker. The client profile defines various settings that apply to the runtime client application when it connects to the event broker. For more information about client profiles, see Using Client Profiles and Client Usernames.

    • If the application subscribes to events, create a consumer in the application and specify one or more topic subscriptions to allow the client application to receive messages for the topic. Specifying a topic subscription creates a subscribe topic exception in an ACL profile to allow the client application to receive messages for the topic. For more information about ACL profiles, see Managing Client Access with ACL Profiles.

    • If the application publishes events, the event topic creates a publish topic exception in an ACL profile to allow the client application to publish messages to the topic.

  2. When you promote the application to an environment in Event Portal, you specify the client username and the authentication credentials that the runtime application uses to connect to the event broker. Optionally, you can download an AsyncAPI document from the application in Designer that includes the event broker connection and authentication details required by the runtime client application to help the developer configure the application.

  3. When the runtime configuration is deployed to the operational event broker, the following updates can occur on the event broker:

    • The event broker is configured to apply the specified client profile for the client application when it connects to the event broker using the specified username and credentials. If no client profile name is set, the application uses the default client profile on the event broker.

      Runtime configuration does not create or update client profiles; it only assigns an existing profile on an event broker to a client application.

    • A queue is created or updated on the event broker for each queue consumer with the properties and topic subscriptions specified by the queue configuration in Designer. If a queue with the same queue name already exists, the updates are applied to the existing queue.

    • ACL profiles with subscribe topic exceptions or publish topic subscriptions are created to allow the application to publish to the topic or receive messages for the topic.

  4. An application developer creates or updates a runtime client application to use the authentication credentials specified in Event Portal. When the client application authenticates with the operational event broker:

    • It is assigned the client profile specified in Designer.

    • It can bind to queues that were configured in Designer and consume any event messages attracted by the topic subscriptions for the queue.

    • It can subscribe to topics with a Direct messaging event flow if a Solace Direct Client consumer was configured for the application.

    • It can publish to topics that were configured in Designer.

JNDI Object Configuration

In Event Portal, you can define the Java Naming and Directory Interface (JNDI) objects that your JMS applications need, push them to event brokers when you promote the application, and include JMS connection details in AsyncAPI documents. This capability lets you onboard a JMS application without an administrator creating JNDI objects on the event broker manually.

Before you can use JNDI with Event Portal, check the following configuration settings for your event broker:

  • JNDI is enabled on the Message VPN of the event broker. In Broker Manager, select JMS JNDI on the navigation bar and make sure that JNDI Enabled is turned on.
  • The event broker service has the connection endpoints enabled for the protocols that your JMS applications use, such as Solace Message Format (SMF) or Advanced Message Queuing Protocol (AMQP). For more information, see Configuring Client and Management Ports.

If you don't have Mission Control Manager access, contact someone in your organization who does to perform these checks.

In Event Portal, ensure that your configuration meets these requirements:

  • The event broker in the modeled event mesh has the JMS protocol, the JMS over AMQP protocol, or both. For more information, see Adding an Event Broker to a Modeled Event Mesh.
  • If you use runtime configuration, the Event Management Agent for the event broker is a version that supports JNDI. If the agent is out of date, promotion fails with a message asking you to upgrade the agent. For more information, see Setting Up a Connected Event Management Agent.

Be aware of the following considerations when you configure JNDI objects:

  • You can't promote an application if its JNDI connection factory name or JNDI queue name is already used by another promoted application.

  • Two or more consumers in the same application cannot use the same JNDI queue name.

Setting JNDI Connection Factory Settings

JMS applications usually don't statically configure event broker connection details. Instead, they use JNDI to look up a connection factory and a destination by name. The connection factory tells the application how to connect to the event broker, and the destination tells it which queue to consume from. Each connection factory name must be unique within the application and must:

  • be a maximum of 256 characters

  • not include spaces, question marks (?), or asterisks (*)

After you enter a name in the required Connection Factory Name field, you can optionally configure JNDI Connection Factory settings:

  • Allow Duplicate Client ID — Allows new JMS connections to use the same client identifier (ID) as an existing connection.

  • Client Description — The description for the client or client ID.

  • Client ID — The client identifier (ID). If you don't specify a client ID, a unique value is generated.

  • Subscriber DTO Override — Allows overriding by the subscriber (consumer) of the Deliver-To-One (DTO) property on messages. When turned on, the subscriber can receive all DTO tagged messages.

  • Subscriber DTO Local Priority — The priority for receiving DTO messages by the subscriber (consumer) if the messages are published on the local event broker that the subscriber is directly connected to.

  • Subscriber DTO Network Priority — The priority for receiving DTO messages by the subscriber (consumer) if the messages are published on a remote event broker.

  • Publisher DTO — Allows the publisher (producer) to set the DTO property on the messages that it sends.

  • Dynamic Durable Endpoints — Allows the event broker to dynamically create a durable endpoint when the client calls Session.createDurableSubscriber() or Session.createQueue(). The created endpoint respects the message time-to-live (TTL) according to the Dynamic Endpoints Respect TTL option.

  • Dynamic Endpoints Respect TTL — Allows dynamically created durable and non-durable endpoints to respect the message time-to-live (TTL) property.

  • Subscriber Acknowledgment (ACK) Timeout (ms) — The timeout for sending the acknowledgment (ACK) for Guaranteed messages received by the subscriber (consumer), in milliseconds.

  • Subscriber Reconnect Retry Attempts — The maximum number of attempts to reconnect to the host or list of hosts after the Guaranteed messaging connection has been lost. The value -1 means to retry forever.

  • Subscriber Reconnect Retry Wait (ms) — The amount of time to wait before making another attempt to connect or reconnect to the host after the Guaranteed messaging connection has been lost, in milliseconds.

  • Subscriber Window Size (msgs) — The size of the window for Guaranteed messages received by the subscriber (consumer), in messages.

  • Subscriber Acknowledgment (ACK) Threshold (%) — The threshold for sending the acknowledgment (ACK) for Guaranteed messages received by the subscriber (consumer) as a percentage of the Subscriber Window Size value.

  • Publisher Acknowledgment (ACK) Timeout (ms) — The timeout for receiving the acknowledgment (ACK) for Guaranteed messages sent by the publisher (producer), in milliseconds.

  • Non-Persistent Message AD Window Size (msgs) — The size of the window for non-persistent Guaranteed messages sent by the publisher (producer), in messages. For persistent messages the window size is fixed at 1.

  • Publisher Messages Delivery Mode — The default delivery mode for messages sent by the publisher (producer).

    • Persistent — The event broker spools messages (persists in the message spool) as part of the send operation.

    • Non-Persistent — The event broker does not spool messages (does not persist in the message spool) as part of the send operation.

  • Publisher Messages DMQ Eligible — Allows messages sent by the publisher (producer) to be dead message queue (DMQ) eligible by default.

  • Publisher Messages Eliding Eligible — Allows messages sent by the publisher (producer) to be eliding eligible by default.

  • Publisher Messages JMSXUserID — Adds or replaces the JMSXUserID property in messages sent by the publisher (producer).

  • Publisher Message Payload Compression Level — The level of compression to apply to the message payload, from 1 (least compression) to 9 (most compression). A value of 0 means no compression.

  • Publisher Text Messages as XML Payload — Encodes JMS text messages in publisher (producer) messages as XML payload. When turned off, JMS text messages are encoded as a binary attachment.

  • Transport Compression Level — The zlib compression level for the connection to the event broker. The value 0 means no compression, and the value -1 means the compression level is specified in the JNDI Properties file.

  • Connect Retry Attempts — The maximum number of retry attempts to establish an initial connection to the host or list of hosts. The value 0 means a single attempt (no retries), and the value -1 means to retry forever.

  • Connect Retry Attempts per Host — The maximum number of retry attempts to establish an initial connection to each host on the list of hosts. The value 0 means a single attempt (no retries), and the value -1 means to retry forever.

  • Connect Timeout (ms) — The timeout for establishing an initial connection to the event broker, in milliseconds.

  • Direct Transport — Uses Direct transport mode. When turned on, non-persistent messages are sent as Direct messages and non-durable topic consumers and temporary queue consumers consume using direct subscriptions rather than from guaranteed endpoints. When turned off, all messaging uses guaranteed transport.

  • Keepalive Count — The maximum number of consecutive application-level keepalive messages sent without a response from the event broker before the connection is closed.

  • Keepalive Messages — Uses application-level keepalive messages to maintain a connection with the event broker.

  • Keepalive Interval (ms) — The interval between application-level keepalive messages, in milliseconds.

  • Deliver Messages Directly from I/O Thread — Delivers messages directly from the I/O thread.

  • Optimize for Direct Transport — Optimizes the client for the Direct transport delivery mode. When turned on, the client application is limited to one publisher (producer) and one non-durable subscriber (consumer).

  • Port — The connection port number on the event broker for Solace Message Format (SMF) clients. The value -1 means the port is specified in the JNDI Properties file.

  • Reply Timeout (ms) — The timeout for reading a reply from the event broker, in milliseconds.

  • Receive Socket Buffer Size (B) — The size of the receive socket buffer, in bytes. It corresponds to the SO_RCVBUF socket option.

  • Reconnect Retry Attempts — The maximum number of attempts to reconnect to the host or list of hosts after the connection has been lost. The value -1 means to retry forever.

  • Reconnect Retry Wait (ms) — The amount of time before making another attempt to connect or reconnect to the host after the connection has been lost, in milliseconds.

  • Send Socket Buffer Size (B) — The size of the send socket buffer, in bytes. It corresponds to the SO_SNDBUF socket option.

  • TCP No Delay — Sets the TCP_NODELAY option. When turned on, Nagle's algorithm for TCP/IP congestion control (RFC 896) is disabled.

  • XA — Makes the connection factory an XA connection factory. When turned on, the connection factory can be cast to XAConnectionFactory, XAQueueConnectionFactory, or XATopicConnectionFactory.

JMS Details in AsyncAPI Documents

AsyncAPI documents for Event API Product versions, and for applications that you download with an event broker context, include a server for each JMS protocol on the event broker. Each JMS server includes the protocol, the URL and port, and a protocol version of 1.1.0. The server bindings include a jms binding with the jmsConnectionFactory property. The following table shows the values for each transport type.

Transport Type Protocol in AsyncAPI Document jmsConnectionFactory

JMS

jms

com.solacesystems.jms.SolConnectionFactory

Secured JMS

jmss

com.solacesystems.jms.SolConnectionFactory

Compressed JMS

jmsc

com.solacesystems.jms.SolConnectionFactory

JMS over AMQP

jms-amqp

org.apache.qpid.jms.JmsConnectionFactory

JMS over Secured AMQP

jms-amqps

org.apache.qpid.jms.JmsConnectionFactory

The jmsConnectionFactory value is the connection factory class of the JMS client library, not the name of a JNDI connection factory that you create in Event Portal. For JMS, Secured JMS, and Compressed JMS servers, the bindings also include a solace binding with the Message VPN and client name.

AsyncAPI documents for Event API Product versions include server bindings for every protocol on the event broker, not only JMS.

Queue Configuration

If you intend to push application and queue configurations from Event Portal to your operational event brokers, you should be aware of the following considerations:

  • Each event queue consumer you create in an application configures a queue on the event broker.

  • You must provide the client username and authentication credentials for the event broker when you add the application to an environment.

  • You can specify the queue configuration in JSON format in the consumer. Users with the Event Portal Manager role can create Solace queue templates in Runtime Event Manager to help users quickly configure the appropriate queue settings.

Queue Configuration Properties

The JSON queue configuration for the consumer can include the following properties. Some of these properties are not supported by earlier event broker versions. For more information, see Solace Element Management Protocol (SEMP) API queue parameters.

Property Description

accessType

Access Type

(included in default configuration)

Specifies how messages are delivered when multiple consumer flows are bound to the queue. The default value is exclusive.

  • Exclusive specifies that only one consumer can receive a message at any one time, while additional consumers may be connected as standby. Only the first consumer to bind can receive messages. If the first consumer disconnects, the second consumer receives data, and so on. Exclusive queues always deliver messages in the order they are received.
  • Non-Exclusive specifies that multiple consumers can bind to the queue, which enables load balancing and consumer auto-scaling. A non-exclusive queue can be non-partitioned or partitioned.
    • For a non-partitioned queue (partitionCount is 0), each consumer is serviced in a round-robin fashion. If a connection fails, unacknowledged messages are delivered to another consumer with the re-delivered flag set. In this way, messages can be delivered to consumers out of order.
    • For a partitioned queue (partitionCount is greater than 0), each consumer is delivered messages from one or more partitions. Messages are mapped to partitions based on a hash of the partition key, which is set by the publishing application. Message order is maintained within a partition, but not between partitions.

consumerAckPropagationEnabled

Consumer Acknowledgment Propagation

Enables or disables the propagation of consumer acknowledgments (ACKs) received on the active replication Message VPN to the standby replication Message VPN. The default value is true.

deadMsgQueue

DMQ Name

Specifies the name of the dead message queue (DMQ) used by this queue. The default is #DEAD_MSG_QUEUE.

We recommend using a separate DMQ for each queue and topic endpoint that needs one and setting the DMQ name to the name of the queue, followed by "_dmq". For example if a queue named MyQueue needs a DMQ, the DMQ should be named MyQueue_dmq. For more information about configuring a DMQ, see Adding a Dead Message Queue to an Application.

A DMQ collects undelivered messages that would otherwise be discarded from the queue because the Maximum TTL or Maximum Redelivery Count has been reached.

deliveryCountEnabled

Enable Client Delivery Count

Enables or disables the ability for client applications to query the message delivery count of messages received from the queue. This setting is a Controlled Availability feature. To find out if this feature is supported for your use case, contact Solace. The default value is false.

deliveryDelay

Delivery Delay

Specifies the delay, in seconds, to apply to messages arriving on the queue before the messages are eligible for delivery. The default value is 0.

eventBindCountThreshold

Maximum Consumer Count Alert Thresholds

Specifies event bind count thresholds for the queue:

  • clearPercent — The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value triggers a corresponding event.
  • clearValue — The clear threshold for the absolute value of this counter. Falling below this value triggers a corresponding event.
  • setPercent — The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value triggers a corresponding event.
  • setValue — The set threshold for the absolute value of this counter. Exceeding this value triggers a corresponding event.

eventMsgSpoolUsageThreshold

Messages Queued Quota Alert Thresholds

Specifies message spool usage thresholds for the queue:

  • clearPercent — The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value triggers a corresponding event.
  • clearValue — The clear threshold for the absolute value of this counter. Falling below this value triggers a corresponding event.
  • setPercent — The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value triggers a corresponding event.
  • setValue — The set threshold for the absolute value of this counter. Exceeding this value triggers a corresponding event.

eventRejectLowPriorityMsgLimitThreshold

Reject Low Priority Messages Alert Thresholds

Specifies message spool usage thresholds for the queue:

  • clearPercent — The clear threshold for the value of this counter as a percentage of its maximum value. Falling below this value triggers a corresponding event.
  • clearValue — The clear threshold for the absolute value of this counter. Falling below this value triggers a corresponding event.
  • setPercent — The set threshold for the value of this counter as a percentage of its maximum value. Exceeding this value triggers a corresponding event.
  • setValue — The set threshold for the absolute value of this counter. Exceeding this value triggers a corresponding event.

maxBindCount

Maximum Consumer Count

Specifies the maximum number of consumer flows that can bind to the queue. The default value is 1000.

maxDeliveredUnackedMsgsPerFlow

Maximum Delivered Unacknowledged Messages per Flow

Specifies the maximum number of messages delivered but not acknowledged per flow for the queue. The default value is 10000.

maxMsgSize

Maximum Message Size

Specifies the maximum message size allowed in the queue, in bytes. The default value is 10000000.

maxMsgSpoolUsage

(included in default configuration)

Specifies the maximum message spool usage allowed by the queue, in megabytes. A value of 0 allows spooling of only the last message received and disables quota checking. The default value is 5000.

maxRedeliveryCount

Maximum Redelivery Count

Specifies the maximum number of times the queue attempts redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to try forever. The default value is 0.

maxTtl

Maximum TTL

Specifies the maximum time, in seconds, a message can stay in the queue when respectTtlEnabled is true. A message expires when the lesser of the sender-assigned time-to-live (TTL) in the message and the maxTtl configured for the queue, is exceeded. Expired messages are discarded or moved to a DMQ. A value of 0 disables expiry. The default value is 0.

msgVpnName

 

Specifies the name of the Message VPN hosting the queue. This property is not necessary for event broker services. Software event brokers and appliance event brokers can have multiple Message VPNs.

owner

Owner

Specifies the client username that owns the queue. Use this parameter to give ownership to the client application. The queue owner has full unlimited permissions to consume, delete, or modify topics in the queue.

partitionCount

Count

Specifies the count of partitions of the queue. This setting is relevant only for queues with an access type of non-exclusive. When set to 0, bound clients receive messages in a round-robin fashion. Otherwise, bound clients receive messages from individually assigned partitions. The default value is 0.

partitionRebalanceDelay

Rebalance Delay

Specifies the delay, in seconds, before a partition rebalance starts after a rebalance is needed. The default value is 5.

partitionRebalanceMaxHandoffTime

Rebalance Max Handoff Time

Specifies the maximum time, in seconds, to wait before handing off a partition while rebalancing. The default value is 3.

permission

Non-Owner Permission

Specifies the access level given to client applications other than the queue owner. The default value for queues created in Event Portal is no-access. This property can't be changed in Event Portal.

queueName

Queue Name

(included in default configuration)

Specifies the name of the queue. This property is required.

redeliveryDelayEnabled

Delayed Redelivery

Enables or disables message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount and undelivered messages are discarded or moved to the DMQ after the specified number of attempts is reached. When disabled, the queue never attempts message delivery more than once. The default value is true.

redeliveryDelayInitialInterval

Initial Delay

Specifies the delay to be used between the first two redelivery attempts, in milliseconds. The default value is 1000.

redeliveryDelayMaxInterval

Maximum Delay

Specifies the maximum delay to be used between any two redelivery attempts, in milliseconds. The default value is 64000.

redeliveryDelayMultiplier

Multiplier

Specifies the amount each delay interval is multiplied by after each failed delivery attempt. This number is in a fixed-point decimal format in which you must divide by 100 to get the floating point value. For example, a value of 125 causes the delay to be multiplied by 1.25. The default value is 200.

redeliveryEnabled

Redelivery

Enables or disables message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message is never delivered from the queue more than once. The default value is true.

rejectLowPriorityMsgEnabled

Reject Low Priority Messages

Enables or disables the checking of low priority messages against the rejectLowPriorityMsgLimit. This setting can be enabled only if rejectMsgToSenderOnDiscardBehavior does not have a value of never. The default value is false.

rejectLowPriorityMsgLimit

Reject Low Priority Messages Limit

Specifies the number of messages of any priority in the queue above which low priority messages are not admitted but higher priority messages are allowed. The default value is 0.

rejectMsgToSenderOnDiscardBehavior

Reject Messages to Sender on Discard

Specifies when to return negative acknowledgments (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. The default value is when-queue-enabled. Possible values are:

  • never — Silently discard messages
  • when-queue-enabled — NACK each message discard back to the client, except messages that are discarded because an endpoint is administratively disabled
  • always — NACK each message discard back to the client, including messages that are discarded because an endpoint is administratively disabled

respectDmqEligibleEnabled

Respect DMQ Eligible

Specifies whether the queue respects or ignores the publisher specified DMQ-eligible flags on messages.

  • When false, all messages are moved to the DMQ rather than discarded, regardless of the DMQ-eligible flag specified by the publisher.

  • When true, only messages flagged as DMQ-eligible by the publisher are moved to the DMQ rather than discarded.

The Message VPN must have the Allow DMQ Eligible Endpoint Override setting enabled for this setting to take effect. For more information, see Configuring Message VPN Settings.

This setting is available only for event broker versions 10.25.10 and later.

The default value is false for event brokers first deployed as version 10.25.10 or later. The default value is true for event brokers first deployed with a version earlier than 10.25.10 and later upgraded.

respectMsgPriorityEnabled

Respect Message Priority

Enables or disables the respecting of message priority. When enabled, messages contained in the queue are delivered in priority order. The default value is false.

respectTtlEnabled

Respect TTL

Enables or disables the respecting of the time-to-live (TTL) for messages in the queue. When enabled, expired messages are discarded or moved to the DMQ. The default value is false.

Queue Configuration Example

The following JSON queue configuration example creates a queue on the event broker named samplequeue with default values for all properties.

{
    "queueName" : "samplequeue",
    "accessType" : "exclusive",
    "consumerAckPropagationEnabled" : true,
    "deadMsgQueue" : "#DEAD_MSG_QUEUE",
    "deliveryCountEnabled" : false,
    "deliveryDelay" : 0,
    "eventBindCountThreshold": {
        "clearPercent": 60,    
        "setPercent": 80
    },
    "eventMsgSpoolUsageThreshold": {
        "clearPercent": 18,
        "setPercent": 25
    },
    "eventRejectLowPriorityMsgLimitThreshold": {
        "clearPercent": 60,
        "setPercent": 80
    },
    "maxBindCount": 1000,
    "maxDeliveredUnackedMsgsPerFlow": 10000,
    "maxMsgSize": 10000000,
    "maxMsgSpoolUsage": 5000,
    "maxRedeliveryCount": 0,
    "maxTtl": 0,
    "partitionCount": 0,
    "partitionRebalanceDelay": 5,
    "partitionRebalanceMaxHandoffTime": 3,
    "redeliveryDelayEnabled": false,
    "redeliveryDelayInitialInterval": 1000,
    "redeliveryDelayMaxInterval": 64000,
    "redeliveryDelayMultiplier": 200,
    "redeliveryEnabled": true,
    "rejectLowPriorityMsgEnabled": false,
    "rejectLowPriorityMsgLimit": 0,
    "rejectMsgToSenderOnDiscardBehavior": "when-queue-enabled",
    "respectDmqEligibleEnabled": false,
    "respectMsgPriorityEnabled": false,
    "respectTtlEnabled": false
}

Adding a Dead Message Queue to an Application

You can configure a dead message queue (DMQ) to receive messages that are discarded from a queue when they can't be delivered to the subscribing client. By default, messages are discarded from a queue in the following circumstances:

  • The maximum TTL value for the message has been reached and the queue is configured to respect message TTL expiry times.

  • The number of redelivery attempts to the consumer for a message has reached the max redelivery count value for the original endpoint.

You can configure an event queue in Designer to act as a DMQ for another event queue by setting the appropriate attribute values for both queues.

To configure a DMQ for another event queue, perform these steps:

  1. Configure an event queue according to the instructions for Updating Standard Solace Applications in the Component View.
  2. In the configuration for your queue, set the values using the following attributes.

    Attribute Description
    deadMsgQueue

    Specify the queueName for the DMQ to send expired messages to. You can have one DMQ shared by multiple queues; however, we recommend using a separate DMQ for each queue that requires one and setting the DMQ name to the name of the queue, followed by "_dmq", for example MyQueue_dmq.

    maxRedeliveryCount

    Set this value if you want to specify the maximum number of times the queue attempts to deliver the message before the message expires. If you want to specify the maximum redelivery count, you must also set redeliveryEnabled to true.

    respectDmqEligibleEnabled

    Specify whether the queue respects or ignores the publisher specified DMQ-eligible flags on messages.

    • When false, all messages are moved to the DMQ rather than discarded, regardless of the DMQ-eligible flag specified by the publisher.

    • When true, only messages flagged as DMQ-eligible by the publisher are moved to the DMQ rather than discarded.

    This setting is valid only for event broker versions 10.25.10 and later and requires the Allow DMQ Eligible Endpoint Override setting to be enabled for the Message VPN. For more information, see Configuring Message VPN Settings.

    maxTtl

    Set this value if you want to specify the TTL in seconds that the queue applies to messages when the message arrives in the queue. If you specify the maximum TTL, you must also set respectTtlEnabled to true.

    respectTtlEnabled

    Set this value to true if you want messages that have not been delivered to expire at the end of the message TTL. If a message is not consumed and its TTL time is reached, the message is discarded or moved to a DMQ.

  3. If it does not already exist, create a second Solace event queue to act as the DMQ for the first queue and set the queueName to match the deadMsgQueue value you set for the first queue.

    You don't need to add event subscriptions to the DMQ. It receives only the expired messages from the first queue.

For instructions to configure DMQs directly on the event broker, see Configuring Dead Message Queues.

REST Consumer and Queue Binding Configuration

When you configure an RDP (webhook) in Event Portal, in addition to configuring the queue that attracts the messages sent to the REST endpoint, you must also configure a REST consumer object on the event broker to specify the connection settings for the remote REST endpoint.

You need to configure queue bindings for RDPs to send messages to the REST endpoint. You can also configure the message request headers to add message topics and other metadata into the message header or configure the event broker to send specific headers that are required for cloud services such as Azure Storage and Amazon EventBridge.

For more information about configuring RDPs, see Creating and Managing RDPs (Webhooks).

RDP Destination Types

RDPs can have one of these destination types:

  • Generic
  • AWS S3
  • AWS API Gateway
  • Azure Data Lake Storage Gen2
  • Azure Event Hubs
  • Azure Functions
  • Azure Service Bus
  • Google Cloud Functions
  • Google Cloud Run
  • Google Cloud Storage

REST Endpoint Connection Settings

The available connection settings depend on the destination type.

Setting Description

Authentication Scheme

Specifies the authentication scheme that the event broker uses to connect to the remote REST endpoint. You can select any option for the Generic Destination Type. All other destination types support only one option.

  • AWS — The event broker logs in with AWS Signature Version 4 authentication. You can use this authentication mechanism to enable RDPs to communicate with most AWS services. If you select this option, you must specify the settings required by AWS. This option is automatically selected for the following destination type:

    • AWS S3
  • HTTP Basic — The event broker logs in with a username and optional password carried over HTTP. Credentials can be transmitted either as plain text or encrypted with SSL. If you select this option, you must specify the username and you can also specify the password.

  • Client Certificate — The event broker logs in with a client TLS certificate. If you select this option, you must upload the certificate file and you can also specify the password for the certificate.

  • HTTP Header — The event broker logs in with a specified HTTP header. If you select this option, you must specify the header name and value. This option is automatically selected for the following destination types:

    • AWS API Gateway
    • Azure Functions
  • None — The event broker logs in with no authentication. This option may be useful for anonymous connections or when a REST consumer does not require authentication.

  • OAuth Client — The event broker logs in with OAuth 2.0 client credentials. If you select this option, you must specify the settings required by your OAuth provider. This option is automatically selected for the following destination types:

    • Azure Data Lake Storage Gen2
    • Azure Event Hubs
    • Azure Service Bus
  • OAuth JWT — The event broker logs in with an OAuth JSON Web Token (JWT) profile. If you select this option, you must specify the settings required by your OAuth provider. This option is automatically selected for the following destination types:

    • Google Cloud Functions
    • Google Cloud Run
    • Google Cloud Storage
  • Transparent — The event broker logs in using the authorization header from the message properties, if present. Transparent authentication passes along existing authorization header metadata instead of discarding it.

Remote Host

Specifies the IP address or DNS name of the remote REST endpoint. A host value must be configured.

Remote Port

Specifies the port associated with the host for the remote REST endpoint.

This option is editable only for the Generic Destination type.

TLS Enabled

Enables TLS for connections to the remote REST endpoint.

This option can be disabled only for the Generic Destination type.

HTTP Method

Specifies the HTTP method to use when delivering messages to the remote REST endpoint. The default is Post. You can instead select Put to connect the event broker to remote endpoints that don't support the POST method, such as certain cloud native data lake products.

This option is editable only for the Generic Destination type.

Select Show Advanced Properties to display this setting.

Local Interface

This setting is valid only for Solace Appliance Event Brokers. If your environment requires a fixed IP interface, this setting specifies the IP interface to use for connections to the remote REST endpoint. For more information, see Creating an RDP Client.

Select Show Advanced Properties to display this setting.

Max Post Wait Time

Specifies the maximum amount of time, in seconds, that the event broker waits for a response from the remote REST endpoint. If an operation is outstanding for more than the configured maximum wait time, the event broker disconnects the HTTP connection and re-attempts message delivery. The timed-out attempt counts as a delivery attempt against the maximum delivery count on the queue. When the maximum delivery count is reached, the message is moved to the DMQ if it is eligible, otherwise it is discarded. The valid range is from 1 to 300 seconds. The default value is 30 seconds.

Select Show Advanced Properties to display this setting.

Outgoing Connection Count

Specifies the maximum number of concurrent outgoing connections to the remote REST endpoint that the event broker can initiate. The valid range is from 1 to 50 connections. The default is 3.

Select Show Advanced Properties to display this setting.

Proxy Name

Specifies the forward proxy to use if one is required for the connection to the remote REST endpoint. Select a proxy from the list of proxies that have been configured on the Message VPN. For more information, see Configuring a Forward Proxy.

Select Show Advanced Properties to display this setting.

Retry Delay

Specifies the amount of time, in seconds, to wait before retrying a connection attempt. The valid range is from 1 to 300 seconds. The default value is 3 seconds.

Select Show Advanced Properties to display this setting.

Queue Binding Request Targets

When you configure queue bindings for RDPs, you enter the POST request target resource for message delivery on the REST endpoint. The following table shows the expected path format for each destination type.

Destination Type Format

Generic

/<path>

AWS S3

[/<optional-folder>]/<filename>

AWS API Gateway

/<stage>/<path-to-resource>

Azure Data Lake Storage Gen2

/<container-name>[/<optional-folders>]/<filename>

Azure Event Hubs

/<instance-name>/messages

Azure Functions

/api/<function-name>

Azure Service Bus

/<service-bus-entity-name>/messages

Google Cloud Functions

/<function-name>[/<optional-path>]

Google Cloud Run

/

Google Cloud Storage

/upload/storage/v1/b/<bucket-name>/o?uploadType=media&name=<filename>

REST Gateway Mode

If you have gateway mode configured on the Message VPN, the event broker acts as a Microgateway and forwards REST requests from clients to service providers and returns the responses. When this setting is enabled, the event broker sends forwarded requests in absolute form, using the REST consumer's remote host and port as the request-target authority. When it's disabled, the request-target is left unchanged to preserve the original request.

For more information, see Microgateways and Viewing and Managing the Message VPN.