Data import from Azure service Bus queue or topic subscription
Concept
You can use a connector of type 'Service Bus queue' to import data from an Azure Service bus queue or topic subscription.
Supported Service Bus entities
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.
Service Bus search definitions
To import data received from a Service Bus queue or topic subscription, you need an import message. Define dead-letter-specific Service Bus search definitions that are used to assign messages to the received data records. You can use these messages to import the received data into D365 FO.Data import from Service Bus queue
You can use the 'Service Bus queue' connector to import data from a Service Bus queue. Make sure that for the connector the:
- Service Bus type is 'Queue'.
- Entity field is filled with the name of the applicable Service Bus queue.
To import data:
- Run 'Receive data' to receive data from a Service Bus queue. The received data is added to the 'Received data' table in Connectivity studio. On receiving data from the Service Bus queue, based on the Service Bus search definitions and settings on the received data, import messages are automatically assigned to the received data records.
- Run import messages to read data from the 'Received data' table and import this data into D365 FO. The import messages must have the 'Service Bus queue' connector as source connector.
Data import from Service Bus topic subscription
You can use the 'Service Bus queue' connector to import data from a Service Bus topic subscription. Make sure that for the connector, the:- Service Bus type is 'Topic'
- Entity field is filled with the name of the applicable Service Bus topic.
- Subscription field is filled with the name of the applicable Service Bus topic subscription.
To import data:
- Run 'Receive data' to receive data from a Service Bus topic subscription. The received data is added to the 'Received data' table in Connectivity studio. On receiving data from the Service Bus topic subscription, based on the Service Bus search definitions and settings on the received data, import messages are automatically assigned to the received data records.
- Run the assigned import messages to read data from the 'Received data' table and import this data into D365 FO. The import messages must have the 'Service Bus queue' connector as source connector.
Document
The source document of the import message defines which data is imported from the 'Received data' table and in which format and structure.
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.
Receive modes
On receiving data from an Azure Service Bus queue or topic subscription, these receive modes are supported:
- Receive and delete
- Peek lock
If you use 'Peek lock' when you run 'Receive data', the received messages are temporarily locked in the Service Bus queue or topic subscription.
When the Connectivity studio message that imports the data from the 'Received data' table has run:
- Successfully, the message is deleted from the queue or topic subscription.
- With errors, the message is moved to the applicable Service Bus dead letter queue.