Configuring Message Broker

To configure an embedded or external message broker for Data Extract, navigate to gear > Global Settings > Messaging Configuration and select the checkbox to Enable Messaging.

There are sections for:

  • Broker Type

    • Embedded – the embedded ActiveMQ broker that is included with IdentityIQ.

    • External – an external ActiveMQ broker that you maintain.

  • Embedded Broker Settings

    • Lock Keep Alive Period (required) – the amount of time in milliseconds that the lock should be kept alive.

    • Lock Acquire Sleep Interval (required) – duration in milliseconds for how long the broker will wait before trying to retry acquiring a lock. For Lease Database Locker, this value should be larger than the Lock Keep Alive Period.

    • Max Page Size (required) – the maximum number of messages to page in from the store at one time.

    • DLQ Message Expiration in Days (required) – duration in days that messages in the dead letter queue (DLQ) will be expired and removed.

  • Connection Settings

    • Client Connection String (required) – a string that defines how clients connect to the broker, in the format of 'failover:(tcp://<host>:<port>)?<options>'

    • Enable Failover Optimization – if enabled, the system will use the last known broker url first when connecting to the broker.

    • Consumer Username (required) – username for read-only connections. For the embedded broker, it may take a few minutes for the change to take effect.

    • Consumer Password (required) – password for read-only connections. For the embedded broker, it may take a few minutes for the change to take effect.

    • Producer Username (required) – username of the connection that will write messages onto the queues. For the embedded broker, it may take a few minutes for the change to take effect.

    • Producer Password (required) – password of the connection that will write messages onto the queues. For the embedded broker, it may take a few minutes for the change to take effect.

    • Admin Username (optional for external brokers, required for embedded brokers) – username of the connection that creates queues if a queue is not available. This setting is required for Embedded Brokers. For the Embedded Broker, it may take a few minutes for the change to take effect.

    • Admin Password (optional for external brokers, required for embedded brokers) – password of the connection that creates queues if a queue is not available. This setting is required for Embedded Brokers. For the Embedded Broker, it may take a few minutes for the change to take effect.

  • Statistics Settings

    • Broker Statistics Queue Name (optional for external brokers unless you are using the Debug > ActiveMQ Monitoring page, required for embedded) – name of the ActiveMQ queue on which overall statistics are stored.

    • Destinations Statistics Queue Name (optional for external brokers unless you are using the Debug > ActiveMQ Monitoring page, required for embedded) – name of the ActiveMQ queue on which destination statistics are stored.

    • Subscriptions Statistics Queue Name (optional for external brokers unless you are using the Debug > ActiveMQ Monitoring page, required for embedded) – name of the ActiveMQ queue on which subscription statistics are stored.

Note: Selecting an external broker disables the embedded broker settings.