Using the Dashboard Designer

The purpose of the Dashboard Designer wizard is to provide a fully integrated tool to create dashboards in XMPro. The DevExpress Dashboard Designer are used to provide this functionality. Access the Dashboard Designer from the WorkFlow Designer, Design tab, Dashboard Designer.

Opening Dashboard Designer

This procedure describes how to open the XMPro Dashboard Designer using the WorkFlow Designer.

If the Dashboard Designer is grayed out, contact your Site Administrator.

Fig 1. Accessing Dashboard Designer
  1. On the ribbon, click the Design tab, click Dashboard Designer from the Reporting Group in WorkFlow Designer. The XMPro Dashboard Designer opens.

To use the Dashboard Designer please refer to Dashboard Designer | DevExpress End-User Documentation for more details.

Using the data source wizard in WorkFlow Designer

The data source wizard has been customized to work with the database configuration settings held under the DashboardConnections key in the application settings, shown below.

Fig 2. Dashboard Connections Settings

At runtime, when the report is loaded, it will use the Name of the tag, e.g. DataMasterDashboard to pick up the connection string value and set the connection properties for the report.

  1. Open the Dashboard Designer.

  2. Select the Data Source tab. Click on the New Data Source button. This will open the new Data Source Wizard. It will display a list of connection names configured under the DashboardConnections key.

Fig 3. Dashboard Data Source Wizard
  1. Select the connection from the list and follow the rest of the configuration settings in the wizard.

If the connection that you want to use is not available in the list OR if the data source in the list is on a remote server and not accessible and you will use a local copy to develop the dashboard :

  1. Use the option 'No, I'd like to specify the connection parameters myself'. This will open the Data Source Wizard as shown below. Continue to configure the data source.

Note: The wizard is limited to SQL Server only.

Fig 4. Configuring the data source for the Dashboard
  1. Click on the Rename button the the Data Source tab. Edit the name to be the same as the name configured in the DashboardConnections key.

Fig 5. Naming a Dashboard in Data Source tab

Deploy a Dashboard in WorkFlow Designer

Only users with the appropriate rights will be able to add, edit or delete Dashboards in WorkFlow. In WorkFlow Designer, if Dashboard are not showing in the explorer pane, check that the check box is checked for Dashboards in the Options Editor.

  1. Click Manage > Dashboard on the left side menu as shown below.

Fig 6. Accessing Dashboard in WorkFlow
  1. This will open the form the manage Dashboards as shown below.

Fig 7. Dashboard management in WorkFlow
  1. Click on the icon to add a new dashboard, shown below.

Fig 8. Adding Dashboard in WorkFlow
  1. Complete the form and upload a dashboard definition xml file designed in the Dashboard Designer. The fields are:

  • Name: The unique name for the dashboard. This is required field. This is the name that will be shown in the Dashboard menu item .

Fig 9. The newly added Dashboard is added to the Dashboard menu
  • Business Role: Users that are assigned to the Business Group can see the report in the left Menu, shown below.

  • Menu: When checked it will show up on the left side bar Menu

  • Refresh Rate: The duration after which the report will be refreshed. The default is 30 seconds.

  • Order: The sort order in which dashboards will be displayed in the left side bar Menu.

Display a Dashboard in WorkFlow Designer

There are two ways to display dashboards in WorkFlow. The first option is to enabled the Menu checkbox when the dashboard definition file is uploaded, as shown above. The second option is to make it an option that is shown under the New option in the task navigation page.

  1. Deploy a dashboard as shown above. In the grid note down the ID of the uploaded dashboard.

  2. Create an Activity from the WorkFlow Designer.

  3. Configure the properties using the Activity Configuration Wizard.

  4. In the Hyperlink property, add the following value: dashboardviewer.aspx?id=<id>. Replace the <id> with the ID shown in the

Fig 10. Configuring Dashboard in Activity Configuration Wizard to display in WorkFlow

Last updated

Was this helpful?