Dashboards - user guide

Dashboards - introduction

Dashboards convert data into clear information, enables you to follow KPI, to evaluate the quality of service, and rapidly identify improvements, to optimiser the client experience.

Syfadis has integrated the Dashboard editor to display and analyse data via interactive dashboard. A specific layer has been developed to adapt Stimulsoft to our specific needs, simplifying its use and maintaining advanced features.

With this guide, you should be able to autonomously create and adapt your Dashboards. Don’t hesitate to explore the different Stimulsoft features and apply best practices to optimise your dashboards.

Prerequisites

Before you begin, ensure your development environment is configured correctly. For this you need to:

• Activate the configuration parameter Enable Dashboard V2: ensure that this parameter is activated to access the dashboard features.

Create the role of Dashboard editor

• In the Directory menu, create a role called Dashboard Editor.

The purpose of this role is to precisely define editing rights and ensure that they are not granted to an uninformed user.

• Create a new user and assign the role of Dashboard Editor.

Manage dashboard privileges

• Have dashboard privileges: activate necessary authorisations to design/consult dashboards (Design a dashboard, View a dashboard etc.).

Create a simple dashboard

We can create a single dashboard with a single component, an indicator that will display the number of users who are active on the platform, those who are not cancelled.

Open the Analysis menu, click on the button NEW DASHBOARD to view the design phase.

Add a component

You can now insert the components of your choice using the drag and drop function, in our case, we will use an indicator:

Add the data source

The data required to feed into the dashboards comes from pre-existent cubes, meticulously filtered per domain.

1. Right click on Cube [StiCubeDataConnector] and select the cube to exploit.

2. Choose New Data Source…

3. A window opens. Click on Cube. The cubes window appears.

4. Choose the one you want to use.

5. In our example, select the cube Analysis_Users.

6. Click OK.

Configure a component

1. After choosing the corresponding cube, select the column Id in the Users cube and move the column on the component, by hovering over the indicator.

2. Click on pencil icon situated on the right. A small window appears, displaying the column recently added in the section Value.

3. In the section Expression, choose the function Count (Distinct) which enables the ID to be counted.

Personalise the component

1. To personalise the indicator, click on it then access the Properties tab in the top right.

2. In the section Behavior/Title on the left, modify the text, the colour, the font and the alignment.

3. Adjust the background colour, the style, and the font in the section Appearence.

Add filters

1. To add filters, click on the indicator, then select the filter icon under the pencil icon.

2. Drag the column DeletedOn in the Users cube and drop the column in the filter zone.

3. Configure the condition for it to be "is null".

Best practices

• Do not list all table data in order to reduce volumes and improve performances.

• Use filters judiciously to target pertinent information and not overload the Dashboard.

Create a complex dashboard

Dashboard with 2 cubes, a relation and a drill-down

We will design a complex dashboard with a graph showing the sum of active users per establishment. For this, we will use 2 cubes: Users and establishments creating a relation between both cubes. A drill-down on the graph components will display a table that details the users affiliated to the selected establishment.

Add components

You can now insert components of your choice using the drag and drop function. In our case, we will use a graph.

Add a data source

1. As in the previous example, select the cubes Analysis_Users [Users] and Analysis_Etablishments [Establishments].

2. Once the cubes are added, create a relation between them. To do this, right-click on the cube Establishments which has already been added.

3. In the menu window that opens, select New Relation… allowing you to name the relation.

4. Select Establishments as a parent cube, click on the column Members_Id. Define Users as a child cube and select the column Id.

5. Ensure the relation is active by clicking the box Active Relation.

6. Click OK in the data sources section to add the relation.

Configure a component

1. Select the column Members_Id in the cube Establishment.

2. Drop it onto the component by hovering over the graph, click on the pencil icon situated to the right. A small window appears displaying the recently added column in the section Value.

3. In the section Expression, choose the function DistinctCount that enables member ID counts.

4. In the section arguments, add the column name of the establishment.

Add filters

1. To add filters, click on the component.

2. Select the filter icon under the pencil icon.

3. Drag and drop the column DeletedOn, from the previously added relation and place this column in the filter zone.

4. Configure the condition to "is null".

Add a second Dashboard

1. To add a second Dashboard which represents a table detailing information on establishment members, click on the icon and choose New dashboard.

2. Add the Table component then integrate these columns: Full name, Sex, Entry date in the establishment and any other pertinent information.

3. Save this Dashboard with the name Dashboard2.

Configure the drill-down

1. Select the Graph component, then click on the button Interaction in the Welcome tab. A window opens.

2. In the section On Click, modify the mode to Show Dashboard.

3. In the section Page, enter the name of the dashboard recently created. Here Dashboard2.

4. To configure the transition parameter between the first and the second dashboard, click on New parameter and provide the name.

5. In the section Value, select Argument to transfer the name of the establishment as a parameter.

6. Open the second dashboard, then in the recently created table filter, add the column Establishments_Id of the Users cube with a simple drag and drop.

7. Adjust the condition to equal and activate the utilisation of an expression by checking the box Expression.

8. Click on the pencil icon to enter the expression that will retrieve the establishment ID from the parameter name.

9. Use the personalised Syfadis function that allows you to obtain the ID of an element from another column.

10. Enter this expression: GetElementId("Analysis_Establishments.Name", this["Nom"]). Here, Analysis_Establishments.Name represents the column, and this["Nom"] corresponds to the value of the parameter, or the name of the selected establishment.

Personalise the component

By following the previous example, personalise the graph by selecting the colours and the style that you need.

Best practices

Avoid combining excessively large volumes of data in a single element to ensure performance levels are not impacted. Use the drill-down to explore data without overloading the initial Dashboard.

Create a Dashboard with GetEnumValueByCode

Before starting, please noter that the function GetEnumValueByCode is designed to manage enumerations, by translating codes stored in the base of values that can be read for the user.

We will design a dashboard, with a graph representing the sum of active users depending on their gender. For this we will use the User’s cube.

Add a component

You can now insert components of your choice using drag-drop, in our case, we will use a graph.

Add the data source

As with the previous example, we will select the Users cube.

Configure the component

1. Select the Id column in the Users cube and drag it onto the component, hovering over the graphic, click on the pencil icon to its right. A small window will appear, displaying the newly added column in the Value section.

2. In the Expression section, select the DistinctCount function, which will count user IDs.

3. In the arguments section, add the Gender column and click on the pencil icon to add the GetEnumValueByCode function, as shown in the screenshot below.

Here's what the function looks: GetEnumValueByCode ("Analysis_Users","Gender", [Analysis_Users.Gender]).

Personnalize the component

• Following the previous example, customize the graphic by selecting the colors and style that suit you best.

Best practices

We recommend avoiding the use of this function in an array-type component displaying a large volume of data, as this could lead to too many successive calls to the function, with a risk of performance degradation that could even impact the platform.