Skip to main content
Skip table of contents

Azure Service Bus configuration

This section describes how to configure Azure Service Bus for use with RPI. Please follow the steps below:

  1. Set up your service bus namespace in Azure and obtain the connection string.

    1. Log onto the Windows Azure portal (https://manage.windowsazure.com).

    2. Once you have successfully logged into the portal, go to the Service Bus tab and click CREATE as shown below:

      image-20250912-151453.png
    3. Provide a NAMESPACE NAME, leave the default TYPE of MESSAGING, and choose your REGION and SUBSCRIPTION:

      image-20250912-151504.png
    4. Once the namespace is created it will appear in the list of service bus namespaces. Select the record and then click on the CONNECTION INFORMATION icon from the taskbar at the bottom of the page:

      image-20250912-151517.png
    5. From the Access connection information dialog that pops up, copy and record the entire CONNECTION STRING property value. This will be used when configuring the queue provider in RPI:

      image-20250912-151530.png
  2. Setup RPI queue configuration elements to use your newly created Azure message bus as the queue provider.

    1. Log in to the RPI Client as an Admin user and navigate to Configuration -> Queue Providers

    2. Select the icon with the plus sign to create a new queue provider then select the option ‘Add new Azure Service Bus provider’.

      image-20250912-151548.png
    3. Give your queue entry a name, select the option to ‘Use this queue provider’ and then paste in the Connection String harvested in the section above. 

      image-20250912-151604.png
    4. Save the record and once saved, click on the ‘Connectivity test:’ button to verify connectivity to the service bus. 

    5. Once successful connectivity has been verified, click on the ‘Copy XML configuration to clipboard’ button and record the XML configuration details. This will be used in the web.config file for the RPI Realtime API site:

      image-20250912-151620.png
    6. Navigate to Configuration -> System Configuration and set the value for following 3 queue related parameters. Please note that the queues need not already exist within the Azure service bus namespace as RPI will create the queues automatically if they do not exist:

      • FormSubmissionQueuePath

      • WebCacheQueuePath

      • WebEventQueuePath

    7. Make a note of the names entered for the 3 queues as they will be entered in on the web.config file within the RPI Realtime API site in the next section. 

  1. Configure your Realtime API web.config file to reference the new queue provider and queues created in the sections above.

    1. Open up the web.config file at the root of the Realtime API web site directory in a text editor.

    2. Locate the webQueue XML tags within the web.config file:

      image-20250912-151640.png
    3. Within these two tags, paste in the contents of the queue XML configuration details harvested in section 2e above.

    4. Locate the following three settings within the <applicationSettings> section of the web.config file and set respectively to match exactly the three system configuration values defined above in section 2f:

      1. In this section, enter in the same value from RPI system configuration parameter FormSubmissionQueuePath:

        XML
        <setting name="ProcessQueuePath" serializeAs="String">
          <value>value from FormSubmissionQueuePath</value>
        </setting>
      2. In this section, enter in the same value from RPI system configuration parameter WebCacheQueuePath:

        XML
        <setting name="WebCacheQueuePath" serializeAs="String">
          <value>value from WebCacheQueuePath</value>
        </setting>
      3. In this section, enter in the same value from RPI system configuration parameter WebEventQueuePath:

        XML
        <setting name="TrackingEventsQueuePath" serializeAs="String">
          <value>value from WebEventQueuePath</value>
        </setting>

This completes the steps necessary to configure RPI to use Azure Service Bus message queues. You can validate that the queues have been created successfully from the Windows Azure portal. They will be listed under QUEUES within the namespace created in the first section above:

image-20250912-152212.png

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.