1. To-Increase Dynamics 365 for Finance & Operations
  2. Connectivity studio
  3. Design
  4. Set up connectors

Set up Service Bus queue connector

Set up a connector of type 'Service Bus queue' to exchange information via an Azure Service bus queue or topic.

The 'Service Bus queue' connector supports these Service Bus entities:

  • Queue: Queues provide First In, First Out (FIFO) message delivery to one or more competing consumers. That is, receivers typically receive and process messages in the order in which they were added to the queue. And only one message consumer receives and processes each message.
  • Topic and subscriptions: Topics and subscriptions provide a one-to-many form of communication in a publish and subscribe pattern. It's useful for scaling to large numbers of recipients. Each published message is made available to each subscription registered with the topic. Publisher sends a message to a topic and one or more subscribers receive a copy of the message, depending on filter rules set on these subscriptions.
For more information, refer to Service Bus queues, topics, and subscriptions.


Application Consultant Application Consultant Start Start Which Service Bus type  do you need? Which Service Bus type  do you need? Set up Azure Service Bus namespace - Queue Set up Azure Service Bus namespace - Queue You can use a connector of type 'Service Bus queue' to exchange information via an Azure Service bus queue. A Service Bus queue provides First In, First Out (FIFO) message delivery to one or more competing consumers. That is, receivers typically receive and process messages in the order in which they were added to the queue. And only one message consumer receives and processes each message. To set up an Azure Service Bus queue: Create a namespace in the Azure portal You need the Service Bus namespace name to fill in the Service Bus namespace field of the connector. Create a queue in the Azure portal You need the Service Bus queue name to fill in the Entity name field of the connector. Create Shared access signature (SAS) policy You can create and use a SAS policy on these levels: Service Bus queue or Service Bus namespace. You need the: SAS policy name to fill in the Policy name field of the connector. Primary key of the SAS policy to fill in the Policy key field of the connector. For more information, refer to: Service Bus queues, topics, and subscriptions Use Azure portal to create a Service Bus namespace and a queue Service Bus access control with Shared Access Signatures Set up Azure Service Bus namespace - Topic and subscriptions Set up Azure Service Bus namespace - Topic and subscriptions You can use a connector of type 'Service Bus queue' to exchange information via an Azure Service bus topic and subscriptions. A topic and subscriptions provide a one-to-many form of communication in a publish and subscribe pattern. It's useful for scaling to large numbers of recipients. Each published message is made available to each subscription registered with the topic. Publisher sends a message to a topic and one or more subscribers receive a copy of the message, depending on filter rules set on these subscriptions. To set up an Azure Service Bus queue: Create a namespace in the Azure portal You need the Service Bus namespace name to fill in the Service Bus namespace field of the connector. Create a topic in the Azure portal You need the Service Bus topic name to fill in the Entity name field of the connector. Create subscriptions to the topic You need the Service Bus subscription name to fill in the Subscription field of the connector. Create Shared access signature (SAS) policy You can create and use a SAS policy on these levels: Service Bus topic (advised) or Service Bus namespace. You need the: SAS policy name to fill in the Policy name field of the connector. Primary key of the SAS policy to fill in the Policy key field of the connector. For more information, refer to: Service Bus queues, topics, and subscriptions Use the Azure portal to create a Service Bus topic and subscriptions to the topic Service Bus access control with Shared Access Signatures Set up Service Bus queue connector Set up Service Bus queue connector Set up a connector of type 'Service Bus queue'. Use this connector type to exchange information via an Azure Service bus queue or topic.You can use the 'Service Bus queue' connector to:Export data:Use a Connectivity studio export message to send messages to the applicable Service Bus queue or Service Bus topic. The export message must have the 'Service Bus queue' connector as target connector.On export, each message that is sent to a queue or topic is logged in the 'Data sent to queue' history table.Import data:Run 'Receive queue data' to receive messages from a Service Bus queue or a Service Bus topic subscription. The received messages are added to the 'Received data from queue' table in Connectivity studio.These receive modes are supported: 'Receive and delete' and 'Peek lock'.Run import messages to read data from the 'Received data from queue' table and import this data into D365 FO. The import message must have the 'Service Bus queue' connector as source connector.The related document defines which data is sent to or received from a queue or topic and in which format and structure. So, the document does not result in a file.With the 'Service Bus queue' connector, you can use these external file-based documents: EDI, Fixed text, Text, XML, JSON. You can only use this connector in combination with a document for which the version 3 (V3) handler class is selected. Procedure 1. Click Connectivity studio Integration Design. 2. Click the Connectors tab. 3. Click New. 4. In the Connector field, type a value. Note: You are advised to not include, in the connector name, the name of the application to which you connect. Use the Application field to define the applicable application for the connector. 5. In the Project field, enter or select a value. 6. Define the applicable application for the connector. For a web service connector, for example, select a 'Service Bus' application. In the Application field, enter or select a value. Note: - You can only select an application that is defined for the applicable project. You can define project applications on the Projects page. - You can type any existing application name, whether it is defined as project application or not. If the typed application is not defined as project application, it is automatically added to the project applications. 7. In the Connector type field, select 'Service bus queue'. 8. Sub-task: Set properties. 9. You can export connectivity setup and import it in another D365 FO environment. For example, you first set up and test the connectivity setup in a development environment. When finished, you deploy the setup in your production environment. To prevent messing up your production data, use different Service Bus queues or topics for your development or testing environment and for your production environment. To strictly distinguish between different environments, you can define unique connector properties for each of your environment types. Which properties apply to the current environment is defined in the Environment type field on the Connectivity studio parameters. Example: If set to Development, the connector properties as defined for environment type Development are applicable. In the Environment types field, select an option. Note: The environment types only apply to connectors of type Database, Azure file storage, Blob storage, SharePoint, or Service Bus queue. 10. Expand the Properties section. 11. In the Service Bus namespace field, enter the name of the Service Bus namespace as created in the Azure portal. 12. The 'Service Bus queue' connector supports these Service Bus entity types: - Queue: Queues provide First In, First Out (FIFO) message delivery to one or more competing consumers. That is, receivers typically receive and process messages in the order in which they were added to the queue. And only one message consumer receives and processes each message. - Topic and subscriptions: Topics and subscriptions provide a one-to-many form of communication in a publish and subscribe pattern. It's useful for scaling to large numbers of recipients. Each published message is made available to each subscription registered with the topic. Publisher sends a message to a topic and one or more subscribers receive a copy of the message, depending on filter rules set on these subscriptions. In the Service bus type field, select an option. Note: If you use a Service Bus: - Queue, only fill in the Entity name field. - Topic, fill in both the Entity name field and the Subscription field. 13. In the Entity name field, enter the name of the Service Bus queue or Service Bus topic as created for the applicable Service Bus in the Azure portal. 14. In the Subscription field, enter the name of the Service bus topic subscription as created in the Azure portal. 15. In the Policy name field, enter the name of the Shared access signature (SAS) policy that is used to access the Service Bus queue or topic. 16. In the Policy key field, or in the Policy key reference field, type a value. 17. Sub-task: Set write options. 18. Expand the Write section. 19. In the Content info field, select an option. 20. In the Subject info field, select an option. 21. Sub-task: Select custom handler. 22. Expand the Custom section. 23. In the Handler field, enter or select a value. 24. Sub-task: Set advanced options. 25. Expand the Advanced options section. 26. Select Yes in the Cross company disabled field. 27. Close the page. Notes You can test the connection. To do so, on the Connectors page, in the Action Pane, on the Development tab, click Test connection. Import data from  Service Bus? Import data from  Service Bus? Set up Service Bus search definitions Set up Service Bus search definitions You can use Service Bus search definitions to automatically assign Connectivity studio messages to received data records from a Service Bus. Procedure 1. Go to Service Bus search definitions. Note: You can open this page from the Connectivity studio menu or from the Connector page. 2. Click New. 3. In the Dead letter field, select the applicable option. 4. In the Service Bus namespace field, enter the name of the applicable Service Bus namespace. 5. In the Entity name field, enter the name of the applicable Service Bus queue or Service Bus topic. 6. In the Subscription field, if the entity is a topic, enter the name of the applicable Service Bus topic subscription. 7. In the Priority field, enter the desired priority number. 8. In the Content info field, enter the value based on which to filter the search definition. 9. In the Subject filter field, select an option. 10. In the Subject info field, enter the value based on which to filter the search definition. 11. Define the message to be assigned to the received data records that match the search definition. In the Message field, enter or select a value. Note: The defined message must have the 'Service Bus queue' connector as source connector. 12. In the Company field, enter or select a value. 13. Close the page. End End Queue Topic Yes No

Activities

Name Responsible Description

Set up Azure Service Bus namespace - Queue

Application Consultant

You can use a connector of type 'Service Bus queue' to exchange information via an Azure Service bus queue. A Service Bus queue provides First In, First Out (FIFO) message delivery to one or more competing consumers. That is, receivers typically receive and process messages in the order in which they were added to the queue. And only one message consumer receives and processes each message.

To set up an Azure Service Bus queue:
  • Create a namespace in the Azure portal
    You need the Service Bus namespace name to fill in the Service Bus namespace field of the connector.
  • Create a queue in the Azure portal
    You need the Service Bus queue name to fill in the Entity name field of the connector.
  • Create Shared access signature (SAS) policy
    You can create and use a SAS policy on these levels: Service Bus queue or Service Bus namespace. You need the:
    • SAS policy name to fill in the Policy name field of the connector.
    • Primary key of the SAS policy to fill in the Policy key field of the connector.
For more information, refer to:

Set up Azure Service Bus namespace - Topic and subscriptions

Application Consultant
You can use a connector of type 'Service Bus queue' to exchange information via an Azure Service bus topic and subscriptions. A topic and subscriptions provide a one-to-many form of communication in a publish and subscribe pattern. It's useful for scaling to large numbers of recipients. Each published message is made available to each subscription registered with the topic. Publisher sends a message to a topic and one or more subscribers receive a copy of the message, depending on filter rules set on these subscriptions.
To set up an Azure Service Bus queue:
  • Create a namespace in the Azure portal
    You need the Service Bus namespace name to fill in the Service Bus namespace field of the connector.
  • Create a topic in the Azure portal
    You need the Service Bus topic name to fill in the Entity name field of the connector.
  • Create subscriptions to the topic
    You need the Service Bus subscription name to fill in the Subscription field of the connector.
  • Create Shared access signature (SAS) policy
    You can create and use a SAS policy on these levels: Service Bus topic (advised) or Service Bus namespace. You need the:
    • SAS policy name to fill in the Policy name field of the connector.
    • Primary key of the SAS policy to fill in the Policy key field of the connector.
For more information, refer to:

Set up Service Bus queue connector

Application Consultant

 		Set up a connector of type 'Service Bus queue'. Use this connector type to exchange information via an Azure Service bus queue or topic.
You can use the 'Service Bus queue' connector to:
  • Export data:
    Use a Connectivity studio export message to send messages to the applicable Service Bus queue or Service Bus topic. The export message must have the 'Service Bus queue' connector as target connector.
    On export, each message that is sent to a queue or topic is logged in the 'Data sent to queue' history table.
  • Import data:
    1. Run 'Receive queue data' to receive messages from a Service Bus queue or a Service Bus topic subscription. The received messages are added to the 'Received data from queue' table in Connectivity studio.
      These receive modes are supported: 'Receive and delete' and 'Peek lock'.
    2. Run import messages to read data from the 'Received data from queue' table and import this data into D365 FO. The import message must have the 'Service Bus queue' connector as source connector.

The related document defines which data is sent to or received from a queue or topic and in which format and structure. So, the document does not result in a file.

With the 'Service Bus queue' connector, you can use these external file-based documents: EDI, Fixed text, Text, XML, JSON. You can only use this connector in combination with a document for which the version 3 (V3) handler class is selected.

Set up Service Bus search definitions

Application Consultant
You can use Service Bus search definitions to automatically assign Connectivity studio messages to received data records from a Service Bus.

See also

Provide feedback