Activities

Activity Area Description

Configure Connectivity monitor app

Connectivity monitor setup

Configure the Connectivity monitor app.

To configure the app:

  • Connect to the database.
  • Sign in to the Connectivity monitor app.
  • Share with users.

 

Create application user in Power Platform

Connectivity monitor setup

Create an application user that is used for the connection with Connectivity studio. This user is used to get the logged connectivity data from Connectivity studio and store it in Dataverse.

On creation of the application user:

  • Add the previously registered Azure Active Directory app to access Dataverse from Connectivity studio.
  • Assign the System Administrator security role.

For more information, refer to Create an application user.

Create Dataverse instance

Connectivity monitor setup

Before you can install the Connectivity monitoring app, you must have a Dataverse database available.

Make sure you have administrator rights on this Dataverse database.

If you don't have a Dataverse database, you can create it. For more information, refer to Add a Microsoft Dataverse database.

Create Power BI user in Dataverse

Connectivity monitor setup

To use Power BI reports, a licensed user is required for the Dataverse environment.

Make sure to assign these roles to the licensed user:

  • Basic User: This the standard role that is required for each Power BI user.
  • Log Reader: The role that is needed to read the Connectivity monitor logs.

For more information, refer to Add users to an environment that has a Dataverse database.

Define system settings

Connectivity monitor setup

In the system settings, you can enable or disable alerts.

If a Connectivity studio message run fails, an alert is sent to the owner of the message. The alert is sent to Microsoft Teams and contains a hyperlink to more details about the error.

Import the BisHistoryExport project for Connectivity studio

Connectivity monitor setup

To get the Connectivity studio history data exported to the Dataverse database that is used by the Connectivity monitor, you need a special Connectivity studio project: BisHistoryExport.

In the D365 FO environment from which connectivity history must be exported, in Connectivity studio, import the BisHistoryExport project XML file. For more information on how to import the project file, refer to Import project from file.

The BisHistoryExport project contains the predefined setup (messages, web service, connectors, and documents) that is required to export Connectivity studio history data.

Install Connectivity monitor app on Microsoft Dataverse

Connectivity monitor setup To use the Connectivity monitor app, install it on the desired Dataverse environment.

Install Connectivity monitor Power BI reports

Connectivity monitor setup

Install the Power BI reports for the Connectivity monitor app.

To install the Power BI reports, click this link: Connectivity monitor Power BI reports.

Click Install when asked.

Monitor connectivity - Connectivity Dashboard ,,

Using Connectivity monitor

In the Connectivity monitor app, the Connectivity Dashboard page shows the integration performance, expressed in several key performance indicators and several charts.

These KPIs are shown:

KPI Description
Number of runs The total number of logged message runs in the Connectivity monitor app.
Number of applications The total number of applications for which message runs are logged in the Connectivity monitor app.
Successful runs The number of successful message runs.
Failed runs The number of fully failed message runs. So, for each run, all records were processed with errors.
Runs with errors The number of message runs with at least one record that is processed with an error.
Runs per hour Shows when message are run during the day.
Runs per day

Shows, for each day in the selected period, the number of message runs by status: Success or Error.

Runs by status Shows the total number of message runs. Also shows the percentage and number of runs by status: Success or Error.
Errors per application and company Shows, by company and application, the number of logged message runs with status Error.
Top 10 slow performers Shows the ten messages which runs take the most time. For each message, the chart shows the average number of records that is processed per minute.
Runs per application Shows, by application, the number of message runs split by status: Success or Error.

Monitor connectivity - Run History

Using Connectivity monitor

In the Connectivity monitor app, the Run History page shows all logged message runs from all related applications.

On the Run History page, you can use several filter and grouping options to define which runs are shown:

  • System views:
    • Today's Performance
    • All runs
    • Failed runs
    • Successful runs
  • Group by: You can group the logged runs by any of the fields of the grid.
  • Field sorting and filtering: You can sort or filter the logged runs by any of the fields.

Monitor connectivity - Todays Connectivity Performance

Using Connectivity monitor

In the Connectivity monitor app, the Today's Connectivity Performance page shows today's performance of the integrations you have, focused on KPIs related to connectivity errors.

These error-related KPIs are shown:

KPI Description
Integrations health

Shows an overview of all import message runs and export message runs for all applicable connections.

It shows the:

  • Number of successful import and export runs.
  • Number of failed import and export runs.
  • The percentage of successful import and export runs compared to the failed import and export runs.
Companies with failing runs Shows the companies for which import message runs or export message runs failed. It also shows the number of failed import runs and export runs for each company.
Applications with failing runs Shows the applications for which import message runs or export message runs failed. It also shows the number of failed import runs and export runs for each company.
Runs with errors

Shows a list of connections with failed import message runs and export message runs. For each of these connections, these figures are shown:

  • Number: The number of failed import runs and export runs.
  • Percentage: The percentage of failed import runs and export runs compared to the succeeded import runs and export runs.

Register application with Azure Active Directory

Connectivity monitor setup

Register an application in Azure Active Directory to access Dataverse from Connectivity studio. For more information, refer to Register an application with the Microsoft identity platform.

Make sure to:

Copy these values to a safe place:

  • Application (client) ID: Needed to set up an application user in Power Platform and to set the Client ID of the web service application in Connectivity studio.
  • Directory (tenant) ID: Needed to set the Token authorization endpoint of the web service application in Connectivity studio.
  • Client secret - Value: Needed to set the Client secret of the web service application in Connectivity studio. Note: Copy and save the secret before you leave the Client secrets page in Azure.

Set up applications with related status mapping

Connectivity monitor setup

Define to which applications the Connectivity monitor app is linked.

When connectivity data is received by the Connectivity monitor app, based on the application definition, to each received record the relevant application is added. This application is used to distinguish connectivity data from different applications.

For each application:

  • Set up the status mapping. Use the status mapping to define which Dataverse status is related to which status from the application.
  • You can define starred connections. You can do so, for example, for connections that need extra attention. Note: On the Logs page, you can mark a connection as starred. If you do so, it is added to the application mapping as well.

Set up Power Automate connection references

Connectivity monitor setup

On installation of the Connectivity monitor app, several cloud flows are installed.

For each of these cloud flows, you must:

  • Change the owner to the earlier created Power Platform application user.
  • Set the applicable connection references.
  • Turn it on.

Set up Power BI Dashboard connection

Connectivity monitor setup

To make the Dashboard (BI) available in the Connectivity monitor app, connect the Dashboard (BI) to the 'Performance details cockpit' report.

Set up web service application for BisHistoryExport project

Connectivity monitor setup

To get the Connectivity studio history data exported to the Dataverse database that is used by the Connectivity monitor, you need a special Connectivity studio project: BisHistoryExport. This project exports the Connectivity studio history data using a web service.

Set up the used web service application on the project to connect to the earlier registered Azure Active Directory app. For more information, refer to Set up web service application for project.

For the web service application, use these settings:

Field Description
Base URL

The Service Root URL of your Connectivity monitor app instance extended with 'tibis_createrecords'. For example: https://[Dataverse database].api.crm4.dynamics.com/api/data/v9.2/tibis_createrecords

To find the Service Root URL:

  1. In the Power Apps, open the Connectivity Monitor app.
  2. Click Settings -> Advanced settings.
  3. On the Business management page, expand settings, and click Customizations.
  4. On the Customization page, click Developer resources.
Authentication OAuth2
Grand type Client credentials
Client ID The Application (client) ID of the Azure Active Directory application that you registered to access Dataverse from Connectivity studio.
Resource The root of the Service Root URL of your Connectivity monitor app instance. For example: https://[Dataverse database].api.crm4.dynamics.com/
Token authentication endpoint

Use this URL: https://login.microsoftonline.com/[your-tenant]/oauth2/token

Replace '[your-tenant]' with the Directory (tenant) ID of the Azure Active Directory application that you registered to access Dataverse from Connectivity studio.

Provide feedback