User Tools

Site Tools


replicator_snc_subscribed_queues

Subscribed Queues

Subscribed queues are a way to specify message queues a ServiceNow instance should read messages from. By default, ServiceNow instances subscribe to a queue named after its instance name (i.e. psp.out.servicenow.instancename) so this can be useful in cases where the agent should read messages from another queue in additional to its default one.

Please ensure you have the proper credentials to create the message queue or the queue has been created by the Perspectium team (support@perspectium.com) on the Perspectium server before creating it here inside ServiceNow.

1) To create a subscribed queue, go to the Replicator > Subscribed Queues option in the Perspectium app:

2) Click the “New” button at the top to create a new subscribed queue:

3) The Subscribed Queue form will appear with the following fields:

  • Name : This is the name of the message queue itself. This will generally be in the format of
    psp.out.servicenow.<name>

    where <name> is a name that is only letters and numbers with no spaces. For any questions about the proper queue name for your subscribing instance, please contact support@perspectium.com.

  • Endpoint URL : Click on the lock icon to edit the field and enter the server URL as provided by Perspectium (this will usually be the same URL as found in the Configuration > Properties page such as https://server6.perspectium.com/ or https://server6.perspectium.net). Note the value here should be entered starting with “https:” and with an ending slash “/” such as
  • Queue user : The message queue username as provided by Perspectium.
  • Queue user password : The message queue password as provided by Perspectium.
  • Direction : The field will default with the value “Subscribe” and should be left as is.
  • Active : A checkbox to indicate if this subscribed queue is active and available to be used.

4) When finished, click “Submit” to save this new subscribed queue.

Once a subscribed queue is created, the ServiceNow instance will automatically start listening for messages on the subscribed queue along with its default subscribed queue each time the Perspectium Replicator Subscriber scheduled job runs in the background (which by default is every 30 seconds).

For example, if your instance is named “dev” and you create a subscribed queue name “psp.out.servicenow.dev1”, every 30 seconds the Perspectium Replicator Subscriber job will first read form the default queue “psp.out.servicenow.dev” and then read from the subscribed queue “psp.out.servicenow.dev1”.

Separate encryption and decryption keys per queue

v3.10

Normally, within the same company implementation of Replicator the use of one universal encryption key for both outbound and inbound messages is sufficient and convenient.

There comes a time when an external integration with another company such as a service provider is required but giving out the universal encryption key is both insecure and unmanageable. This feature allows separate encryption and decryption keys to be defined for both outbound messages and received message symmetrically so that a pre-agreed key can be shared with an external consumer of integration data without risk.

Shared Queue Record Encryption Key

By specifying a 24 or more character encryption key in the following Shared Queue definition, ensures that all data flowing through this queue will be encrypted using only this key.

Subscribed Queue Record Encryption Key

By specifying a 24 or more character encryption key in the following Subscribed Queue definition, ensures that all data coming in through this queue will be decrypted using only this key.

2016/06/02 16:09 · David Loo

Get Queue Status

In v3.13.0, a “Get Queue Status” UI action has been added that will allow you to test the connection of the queue and display the current number of messages in the queue.

When clicked, “Get Queue Status” will use attempt to connect to the endpoint URL using the queue user and password to query the queue name for the number of messages it currently contains. The result of trying to connect and query the queue will be displayed in the “Status” field:

In v3.18.0 of both the update set and MBS, the message will display if the queue does not exist instead of displaying an error as in previous versions.

Purge Queue

v3.19.0

Purging queues is only supported in you have been provisioned in a vhost. Please contact support@perspectium.com to set this up and for more information.



The “Purge Queue” UI action allows you to purge a queue of all messages in it. This is useful if you ran a large bulk share and no longer want or need a subscriber to consume these messages.

When clicked, “Purge Queue” will attempt to connect to the endpoint URL using the queue user and password to purge the queue of all the messages it currently contains. The result of trying to purge the queue will be displayed in the “Status” field.

Proceed with caution when purging a queue as the messages cannot be recovered.

In v3.24.0 the user can no longer purge a queue that contains over 1 million records. The user must contact support to purge the queue.

2017/03/07 13:47 · Paul Nguyen

Default Subscribe Queue

In v3.19.0 each instance's default subscribe queue will appear in the Subscribed Queues list. The Finish Install module will create the queue record in the list. This record can not be modified and will only update when Perspectium Replicator Properties is configured. Updating the properties will set the Endpoint URL, Queue Username and Password in the default subscribe queue automatically.

Instance Created On field

In v3.25.0 each record of the subscribe queues table will have a field referencing the instance the record was created on. This field will auto populate once a new record is created on the subscribe queues table.

This feature provides protection against cloned instances. The background job that subscribes to records from MBS for each queue will automatically check the instance created on field and deactivate any queues that were created on a different instance.

Update To Current Instance UI actions

Form View

Users can update their subscribed queues that were cloned to be configured for the current instance. This UI action will also be available in the list view of the subscribed queues table.

List View

Users can also select multiple records in the list view and perform the Update Queues to Current Instance

replicator_snc_subscribed_queues.txt · Last modified: 2018/10/08 21:27 by paul