Skip to main content
Version: 8.3

Dashboards basics

Level: beginner

Dashboards let you group analytics widgets easier as well as connect them to data source and apply filter by page data (Fig. 1). Certain apps as well as the list page of the Records and business processes app template have dashboards included out of the box.

Fig. 1 Dashboard
Fig. 1 Dashboard
note

In Creatio 8.3 Twin, list page template of the Records and business processes app template was enhanced with the Dashboards component. If you have an existing app that uses this template, you can update the page to include the component as well. Learn more: Update list page template to include dashboards.

Dashboard types​

The ability to transfer dashboards between environments depends on dashboard type. The dashboard type is determined by how the dashboard is added. Creatio provides the following dashboard types:

  • Configuration dashboard. A dashboard that is added by no-code creators at design-time using the Dashboards component in Freedom UI Designer. Learn more: Set up dashboards in Freedom UI Designer.
  • Environment dashboard. A dashboard that is added by end users at runtime using UI in the Dashboards view of Creatio sections. Learn more: View and manage dashboards.

When you add a configuration dashboard, Creatio performs the following actions:

  • Stores the configuration dashboard as a configuration schema (a client module schema of the Freedom UI page) in the app package automatically. Learn more: Freedom UI page schema (developer documentation).
  • Displays configuration schemas in the working area of the app package (the Package settings tab in the No-Code Designer), the main workspace of the app package (the Configuration section), and the Dashboards parameter block in the Freedom UI Designer setup area.
  • Displays the configuration dashboard in the dashboard list in the Dashboards view of Creatio sections if a dashboard is added to a section list page.
  • Binds access rights for the configuration dashboard to the app package using a Data schema type whose Object property is set to "SysSchemaAdminUnitRight" and Installation type property is set to "Initial data installation." Learn more: Configuration elements of the Data type (developer documentation).

When you add an environment dashboard, Creatio performs the following actions:

  • Stores the environment dashboard as a new Environment schema schema type and alerts end users who have access rights to the "Can manage configuration elements" (CanManageSolution code) system operation that the environment dashboard is available in the current environment only and cannot be transferred between environments. Those messages are enabled only for environments whose "Environment type" (EnvironmentType code) system setting includes a value other than "Production." This ensures that environment dashboard is implemented without package binding and is stored as an environment schema, reducing confusion for system administrators expecting package-level edits. Permissions to read, edit, and delete environment dashboards can be granted using access rights. Learn more: Share records.
  • Stores environment schemas in the database independently of packages, so they are not included in the working area of the app package (the Package settings tab in the No-Code Designer), the main workspace of the app package (the Configuration section), and the Dashboards parameter block in the Freedom UI Designer setup area.
  • Displays the environment dashboard in the dashboard list in the Dashboards view of Creatio sections.

Transfer dashboard customizations​

The ability to transfer dashboard customizations between environments also depends on dashboard type:

  • Edit the configuration dashboard using Freedom UI Designer if you need to transfer dashboard customizations between environments. Creatio stores dashboard customizations in the Replacing view model schema type that can be transferred between environments as part of package.
  • Edit the configuration or environment dashboard using UI if you do not need to transfer dashboard customizations between environments. Regardless of dashboard type, Creatio stores dashboard customizations in the Environment schema that cannot be transferred between environments.
note

We recommend no-code creators choose dashboard type before adding the dashboard, since you can only change the dashboard type during the dashboard creation stage and only configuration dashboards can be transferred between environments.

If a no-code creator adds dashboard at runtime using UI in the Dashboards view of Creatio sections, i. e., an environment dashboard, the environment dashboard page includes the toolbar whose message alerts users who have access rights to the "Can manage configuration elements" (CanManageSolution code) system operation that the environment dashboard is available in current environment only and cannot be transferred between environments. Those messages are enabled only for environments whose "Environment type" (EnvironmentType code) system setting includes a value other than "Production." Creatio displays the same warning message for no-code creators who modify configuration dashboards using UI in the Dashboards view of Creatio sections.

If a no-code creator adds an environment dashboard and needs to change the dashboard type during the dashboard creation stage:

  1. Click Open in the package button in the Freedom UI Designer toolbar. This determines package to store configuration dashboard and creates a new blank configuration dashboard. Learn more about how Creatio determines the package to store configuration dashboard: Store app data.

    If you set up environment dashboard before clicking Open in the package button, Creatio does not transfer customizations of the environment dashboard to configuration dashboard.

  2. Set up the configuration dashboard from scratch. Instructions: Set up dashboards in Freedom UI Designer.

Permissions for dashboard management​

Managing dashboards requires the following permission levels:

  • By license. External users, i. e., users that have "studio creatio self-service portal cloud," "studio creatio external b2b portal cloud," and "studio creatio external b2c portal cloud" licenses, can only view dashboards regardless of their permissions.
  • By system operation. You need to have permissions to the "Analytics setup" (CanManageAnalytics code) system operation. Learn more: Set up system operation permissions. Out of the box, the permission is granted to users that have the "All employees" role.
  • By dashboard record. Available only for environment dashboards. Learn more: Share records.

The list of environment dashboards you can view depends on your current access rights and the following rules:

  • You can view and manage dashboards you created.
  • You can view dashboards someone shared with you.
  • Users that have management roles cannot view dashboards of users that have employee roles and vice versa out of the box.

Out of the box, "All employees" organizational role has permissions to read the configuration dashboard. To change the out-of-the-box access rights to transfer them together with transferring configuration dashboard between environments:

  1. Set up access rights for a dashboard. Instructions: View and manage dashboards.
  2. Open the Data schema type whose Object property is set to "SysSchemaAdminUnitRight."
  3. Select new "System administration object" to bind to the package. Instructions: Configuration elements of the Data type, step 6 (developer documentation).

See also​

Set up widgets

Set up dashboards in Freedom UI Designer

View and manage dashboards

Update list page template to include dashboards

Store app data

Tech Hour: UI/ UX Building pages in Freedom UI Designer

Tech Hour: UI/ UX Best practices in Creatio

E-learning courses​

Analytics in Creatio. Working with dashboards