Configuring Endpoint Templates

Endpoint templates are configurable objects that administrators can use to specify custom attributes and parameters for any new client-created endpoints. When client-created endpoints are created, the endpoint name can be matched to the endpoint template. All custom attributes that are configured in the endpoint template are copied to the client-created endpoint. For more information. see Endpoint Templates.

Client profiles have an optional copy-from-template-on-create command for both queues and topic endpoint templates. You can use the copy-from-template-on-create command to specify a CLI-provisioned endpoint template, and those template values are applied to any new client-created endpoints. For more information, see Configuring Initial Values for Client-Created Endpoints.

You can configure endpoint templates using PubSub+ Broker Manager or Solace CLI. This section describes how to configure endpoint templates using PubSub+ Broker Manager. For information about configuring endpoint templates using the Solace CLI, see Configuring Endpoint Templates.

Creating an Endpoint Template

To create a template using PubSub+ Broker Manager, perform these steps:

  1. Open Broker Manager. For instructions, see Using PubSub+ Broker Manager.
  2. Select Queues in the left navigation bar.
  3. Select theTemplates tab.
  4. Select Queue Templates or Topic Endpoints Templates for the type of endpoint template you want to create.


  5. Click +Queue Template or +Topic Endpoint Template.
  6. Enter a name for the template and click Create.

  7. Set the following options for the template:

    Setting Description

    Queue Name Filter/Topic Endpoint Name Filter

    Specifies the pattern used to determine which queues and topic endpoints copy their settings from this template. Only the > and * wildcards are supported for this filter:

    • > matches anything, but only when it's placed at the end after a slash /.
    • * matches zero or more characters but never a slash /. It can be present only at the end, after a slash /.

    Access Type

    Specifies how messages are delivered when multiple consumer flows are bound to the endpoint.

    • 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 endpoint, which enables load balancing and consumer auto-scaling. A non-exclusive endpoint can be non-partitioned or partitioned.
      • For a non-partitioned endpoint (partition count is zero), 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 endpoint (partition count is greater than zero), 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.

    Messages Queued Quota

    Specifies the maximum amount of message spool, in megabytes, that the endpoint may use. Setting the messages queued quota to 0 enables the last value queue feature for queues and disables endpoint quota checking. A value of 0 only allows spooling of the last message received by deleting older messages from the endpoint upon receiving new messages. If the endpoint is partitioned, each of its partitions holds the last message spooled to that partition. For more information, see Last Value Queues.

    Non-Owner Permission

    Specifies the access level given to client applications other than the endpoint owner:

    • No Access—Disallows all access.

    • Read Only—Clients have read-only access to messages spooled to the endpoint.

    • Consume—Clients can consume and delete messages from the endpoint.

    • Modify Topic—Clients can consume and delete messages and modify the topic or selector assigned to the endpoint.

    • Delete—Clients can consume and delete messages, modify the topic or selector assigned to the endpoint, and delete the endpoint.

    Maximum Consumer Count

    Specifies the maximum number of consumer flows that can bind to the endpoint.

  8. (Optional) Click Show Advanced Settings, and set any additional options for your queue.

    9. Setting Description

    Messages Queued Quota

    Specifies the maximum amount of message spool, in megabytes, that the endpoint may use. Setting the messages queued quota to 0 enables the last value queue feature for queues and disables endpoint quota checking. Global quota checking and Message VPN quota checking are unaffected. A value of 0 only allows spooling of the last message received by deleting older messages from the endpoint upon receiving new messages. If the endpoint is partitioned, each of its partitions holds the last message spooled to that partition. For more information, see Last Value Queues.

    • Alert Thresholds—Specifies the thresholds that control when message spool-related events are generated for the endpoint.

    Durability Override (Queues Only)

    Specifies the durability of queues created from this template. Durability override has two settings:

    • None—The durability of the queue will be as requested on creation.

    • Non-Durable—The durability of the queue will be non-durable, regardless of what was requested on creation.

    Maximum Consumer Count

    Specifies the maximum amount of consumer flows that can bind to the endpoint.

    • Alert Thresholds—Specifies the thresholds that control when consumer flow alerts are generated for the endpoint.

    Maximum Message Size

    Specifies the maximum message size, in bytes, for the endpoint.

    Maximum Delivered Unacknowledged Messages per Flow

    Specifies the maximum number of messages delivered but not acknowledged per flow for the endpoint. After this maximum number of delivered unacknowledged messages is exceeded, the event broker stops delivering messages to the client on the flow until the client acknowledges messages that are already delivered.

    DMQ Name

    The name of the dead message queue (DMQ) used by this endpoint. The default is #DEAD_MSG_QUEUE. Solace recommends using a separate DMQ for each queue and topic endpoint that requires one and setting the DMQ name to the name of the endpoint, followed by "_dmq", for example MyQueue_dmq.

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

    Messages are sent to a DMQ only if the publisher specifies that the message is DMQ-eligible and if an endpoint with the specified DMQ name exists on the same event broker service. For more information, see Configuring Dead Message Queues.

    Delivery Delay

    Specifies the number of seconds of delay between the message arriving in the endpoint and being sent to the consumer. For more information, see Delayed Delivery. The default is 0, or no delay.

    Respect Message Priority

    Specifies whether the endpoint supports priority message delivery and delivers higher priority messages first. For more information, see Message Priority.

    Message Expiry

    Specifies whether messages that have not been delivered to the consumer expire at the end of the message time-to-live (TTL). If a message is not consumed and its TTL time is reached, the message is discarded or moved to a dead message queue (DMQ). Message expiry has two settings:

    • Respect TTL—Specifies whether the endpoint acts on TTL values set for either the endpoint or by the message publisher.

    • Maximum TTL—Specifies the TTL that the endpoint applies to messages when the message arrives in the endpoint. A value of 0 means that the endpoint does not impose a limit.

    Messages can also have a publisher-supplied TTL, which indicates how long the publisher considers a message to be valid. This differs from the maximum TTL for the endpoint in that the publisher TTL expiration starts when a message is published and counts down as the message passes through the network. If a message has both a publisher-assigned TTL and an endpoint-assigned maximum TTL, the event broker uses the minimum of the two TTL values when the message is in the endpoint.

    Redelivery

    Specifies the options for message redelivery attempts if the message is not delivered to the consumer on the first attempt.

    Disabling message redelivery and enabling delayed redelivery are Controlled Availability (CA) features. Please contact Solace to find out if those feature are supported for your use case.

    Redelivery has the following settings:

    • Try Forever—Specifies that the endpoint attempts to deliver the message to the consumer until delivery is successful. This is the default.

    • Maximum Redelivery Count—Specifies the maximum number of times the endpoint attempts to deliver the message to the consumer. This value is respected only if Try Forever is not selected. If the message is not delivered successfully after the specified number of attempts, the message is discarded or is moved to a dead message queue (DMQ).

    • Delayed Redelivery—Specifies whether the endpoints waits between message redelivery attempts. This option is disabled by default.

    • Multiplier—If Delayed Redelivery is selected, specifies the multiplier for each subsequent delay. For example, if the Initial Delay is 1000 milliseconds (one second), and the multiplier is 2.00, the endpoint waits for two second before the second redelivery attempt, four seconds, before the following attempt, and so on until the Maximum Delay is reached. You can set a value between 1.00 and 5.00.

    • Initial Delay—If Delayed Redelivery is selected, specifies the delay in milliseconds before the first redelivery attempt. The default is 1000 milliseconds (one second).

    • Maximum Delay—If Delayed Redelivery is selected and the Multiplier is set to a value greater than 1.00, specifies the maximum delay in milliseconds.

    Reject Messages to Sender on Discard

    Specifies when and how negative acknowledgments are returned to the sending client on message discards.

    • Silent—Silently discards messages.

    • Notify-Sender—Negatively acknowledge the message discard back to the client, except for messages that are discarded because an endpoint is disabled.

    • Notify-Sender-Include-Shutdown—Negatively acknowledge the message discard back to the client, including messages that are discarded because an endpoint is disabled.

    Reject Low Priority Messages

    Specifies whether low priority messages are discarded to protect against congestion scenarios. When enabled, low priority messages are checked against the reject low priority messages limit. The endpoint can selectively discard low priority messages only after the total number of spooled low priority and high priority messages exceed the value set for the reject low priority messages limit . Before enabling it is recommended that the reject low priority messages limit has a non-zero value to avoid inadvertently discarding all low priority messages.

    Reject Low Priority Messages Limit

    Specifies the limit above which low priority messages are not admitted but higher priority messages are allowed. Before enabling it is recommended that the reject low priority messages limit has a non-zero value to avoid inadvertently discarding all low priority messages.

    • Alert Thresholds—Specifies the thresholds that control when the maximum allowed number of priority messages queued alerts are generated for the endpoint.

    Consumer Acknowledgment Propagation

    Specifies whether consumer acknowledgments received on the active replication Message VPN propagate to the standby replication Message VPN. Bridges cannot bind to endpoints configured with consumer acknowledgment propagation.

  9. Click Apply.