Creating dashboard components
Who is this article for?
Users who want to use a dashboard component and Administrators who want to create a dashboard component
All Area Administrators Can Modify Custom Components
Dashboards consist of components and reports. Each user is able to create personalised dashboards by utilising reports, default components, or custom administrative components developed by authorised administrators.
Administrators possessing the Area Administrator role may create an unlimited number of custom dashboard components. Any component created by an Area Administrator may be modified and updated by other administrators holding the same role. It is essential that the creation of new components, as well as any updates or modifications, be approached with careful consideration and collaborative effort.
Components can contain various Element Types:
-
Reports: Display or link to standard reports, BI reports. Report component can be configured to be displayed in one of three views:
- Link: Only a link to the report will be shown
- Detail: A summary of the report, showing the number or Unread, Overdue, and Total items will be shown
- Full: Administrators can choose to show 3, 5, 10, or 25 rows of the report
- Dashboards: Links to other embedded dashboards
- External URLs (web pages): Links to internal, custom SSRS reports, or publicly available web pages
- Objects: Links to a specific record/object that are commonly used
- "Create New" Buttons: In addition to the main "Create New" Buttons button, a Module Templated "Create New" button that is unique to a specific application can be created and added to a dashboard component
-
Message: Messages can be added as a dashboard component element to display valuable information, warnings, notices, etc. Administrators who create components can customize a message with different icons and add multiple messages to each component.
- To enter URLs or links to a message use the following syntax:
[Search Google](http://www.google.com). Links must use 'https://' or 'http://' protocol. - To bold text, place two asterisks right before and after the text to bold for example,
**Bold Text**. Rich text editing is not currently available except for Bold*.
- To enter URLs or links to a message use the following syntax:
To create a dashboard component:
- Click "Add Dashboard Component" from the Dashboard Components menu of the main Administrative Components screen
- Enter a "Component Name" for the component
- Select the desired "Element Types" or "Available Reports"
- Select or enter any additional information that may be required "Element Types"
- Repeat steps 3 and 4 as many times as are needed
- Select the "Display Mode" option to adjust way the component or reports is displayed
- Click Save
After creating a custom dashboard component, it will appear in the list of available components on the dashboard edit screen, accessible to all users. These custom components are displayed alongside the default dashboard components.
All users can use any components saved by an administrator, but they won’t be able to change the contents of the custom components.
Access rights are always honored
All users will have access to view all components and the links contained within them. However, if a user lacks the necessary permissions to access certain data or an application/module, a notification will be displayed, restricting access to the protected information.
Test in UAT first
We suggest that admins create and test custom components in their UAT area before setting them up in production.