1. Data Management
  2. Connectivity Studio
  3. Design
  4. Set up messages

Set up business event for message

You can set up a business event that is triggered by a message.

Business events provide a mechanism that lets external systems receive notifications from D365 F&SCM. In this way, the external systems can perform business actions in response to the business events.
For more information on business events, refer to Business events overview .
Note:
  • Only use business events to send small sets of data. So, do not use business events to export data.
  • You can export a project to transfer the Connectivity configuration to another environment, for example, from Test to Production. The message business events are included in the export. So after importing into the new environment, you do not need to recreate them. However, due to the environment change, you must redo the other activities in this flow.


Application Consultant Application Consultant Start Start Create message business event Create message business event If you want to create a business event to be triggered by a message, first create and set up a message business event. A message business event is a business event definition that is used to create a business event in D365 F&SCM. For each message, you can only create one message business event. The business event is triggered when the message run is done, taking into account the 'Send business event' setting. Procedure 1. Click Connectivity studio Integration Design. 2. On the Message tab, in the list, find and select the desired message. 3. Click Edit. 4. On the Action Pane, click Design. 5. Click Message business event. 6. Click New. 7. The business event ID is composed by a prefix and the target connector type: [prefix]_[target connector type]. You can use the same prefix for several message business events. In this way you can link an existing business event to the message business event. In this field define the prefix. In the Prefix field, type a value. Note: The target connector type as used in the business event ID can be: - D365 F&SCM: If the target connector is of type 'D365 F&SCM'. - File: If the target connector is of type 'Windows folder' or 'Azure Blob Storage'. - Database: If the target connector is of type 'Database'. - Staging: If the target connector is of type 'Staging journal'. Business events are not supported for target connectors of type 'Web service' and 'Upload and download'. 8. In the Event name field, type a value. 9. In the Description field, type a value. 10. In the Send business event field, select an option. 11. Sub-task: Define additional content from target document. 12. Expand the Target field section. 13. Click Add line. 14. In the Response field field, enter or select a value. 15. Sub-task: Define additional content from source document. 16. Expand the Source field section. 17. Click Add line. 18. In the Response field field, enter or select a value. 19. Sub-task: Create Connectivity business event in Business events catalog. 20. If the message business event definition is set up, create a business event in the Business events catalog. The business event is created based on the message business event definition and gets the category 'Connectivity'. Click Create connectivity events. Note: - If for the message business event the 'Send business event' field is set to 'Never', no business event is created. - You can view a created 'Connectivity' business event in the Business events catalog. To do so, on the Action Pane, click Business events catalog. 21. Close the page. Notes You can also view message business events in these ways: View all message business events for a specific project: On the Project page, on the Action Pane, on the Design tab, click Message business events. View all message business events in a D365 F&SCM environment: On the Connectivity studio menu, click Inquiries, Message business events.   Set up endpoint Set up endpoint Set up the endpoint that manages the destination the business event is sent to. Business events in D365 F&SCM support several endpoint types. For more information, refer to Manage business event endpoints. Configure business events endpoint Configure business events endpoint For several endpoint types, you configure the business event endpoints: In the Business events catalog in D365 F&SCM. This, for example, applies to endpoints of type 'HTTP' or 'Azure Event Grid'. From the endpoint. This, for example, applies to endpoints of type 'Microsoft Power Automate' or 'Dataverse'. For more information, refer to Manage business event endpoints. The tutorials, as referred to in this topic, give more detailed information. Activate business event Activate business event For several business events, you activate the business event: In the Business events catalog in D365 F&SCM. This, for example, applies to endpoints of type 'HTTP' or 'Azure Event Grid'. From the endpoint. This, for example, applies to endpoints of type 'Microsoft Power Automate' or 'Dataverse'. For more information, refer to: Activating business events Manage business event endpoints . The tutorials, as referred to in this topic, give more detailed information. Are message business  events or environment  changed? Are message business  events or environment  changed? (Re)build Connectivity business events (Re)build Connectivity business events You can rebuild the business events of category 'Connectivity'. You can do so, for example, if:Changes are made to the message business events. Changes can be, for example, when message business events are deleted or the 'Send business event' field is changed to 'Never'.The connectivity setup, including the message business events are moved from a Test environment to a Production environment.As a result:All existing business events of category 'Connectivity' are deleted from the business events catalog.Based on the message business events, business events are created. So, a business event is created for message business events that:Had a related business event.Didn't have a related business event.Note:If a message business event is deleted while a related business event exists, on rebuild, the related business event is deleted and not rebuilt.A business event is not (re)built if for the message business event the 'Send business event' field is set to 'Never'.If a 'Connectivity' business event is activated before rebuild, the activation stays after rebuild is done. However, if for a message business event the 'Business event ID' is changed, the activation is undone.If Connectivity setup is moved from Test to Production, the endpoints must be set up, activated, and configured again. Procedure 1. Click Connectivity studio Integration Design. 2. Click Projects. Note: Your currently active project is opened. This is the project as shown in the Project field on the Integration design workspace. 3. On the Action Pane, click Design. 4. Click Message business event. 5. Click Rebuild connectivity events. 6. Close the page. 7. Close the page. End End Yes No 

Activities

Name Responsible Description

Create message business event

Application Consultant

If you want to create a business event to be triggered by a message, first create and set up a message business event. A message business event is a business event definition that is used to create a business event in D365 F&SCM.

For each message, you can only create one message business event.
The business event is triggered when the message run is done, taking into account the 'Send business event' setting.

Set up endpoint

Application Consultant

Set up the endpoint that manages the destination the business event is sent to. Business events in D365 F&SCM support several endpoint types.

For more information, refer to Manage business event endpoints.

Configure business events endpoint

Application Consultant

For several endpoint types, you configure the business event endpoints:

  • In the Business events catalog in D365 F&SCM. This, for example, applies to endpoints of type 'HTTP' or 'Azure Event Grid'.
  • From the endpoint. This, for example, applies to endpoints of type 'Microsoft Power Automate' or 'Dataverse'.
For more information, refer to Manage business event endpoints. The tutorials, as referred to in this topic, give more detailed information.

Activate business event

Application Consultant
For several business events, you activate the business event:
  • In the Business events catalog in D365 F&SCM. This, for example, applies to endpoints of type 'HTTP' or 'Azure Event Grid'.
  • From the endpoint. This, for example, applies to endpoints of type 'Microsoft Power Automate' or 'Dataverse'.
For more information, refer to:

(Re)build Connectivity business events

Application Consultant

 		You can rebuild the business events of category 'Connectivity'. You can do so, for example, if:
  • Changes are made to the message business events. Changes can be, for example, when message business events are deleted or the 'Send business event' field is changed to 'Never'.
  • The connectivity setup, including the message business events are moved from a Test environment to a Production environment.
As a result:
  • All existing business events of category 'Connectivity' are deleted from the business events catalog.
  • Based on the message business events, business events are created. So, a business event is created for message business events that:
    • Had a related business event.
    • Didn't have a related business event.
Note:
  • If a message business event is deleted while a related business event exists, on rebuild, the related business event is deleted and not rebuilt.
  • A business event is not (re)built if for the message business event the 'Send business event' field is set to 'Never'.
  • If a 'Connectivity' business event is activated before rebuild, the activation stays after rebuild is done. However, if for a message business event the 'Business event ID' is changed, the activation is undone.
  • If Connectivity setup is moved from Test to Production, the endpoints must be set up, activated, and configured again.

See also

Provide feedback