Aras Dashboards
Copy
The purpose of this section is to describe how dashboards work on the Aras Innovator platform.
Aras Dashboards provide configurable views that can be populated with interactive widgets for displaying and navigating data. Dashboards are a low-code feature, meaning that users are not required to have coding skills or admin experience to build or use dashboards.
This section describes the important ItemTypes and properties that define Aras Dashboards.
Dashboards
Dashboard settings for name, description, and columns A Dashboard item defines the name, description, and column configuration of a Dashboard. All Widgets shown in a Dashboard are related to this root item.
A dashboard in view mode Users can configure dashboard settings, view the dashboard content, and edit widget settings all from the dashboard item.
Widget Templates
Custom Widget Template to display a user’s InBasket Tasks A Widget Template is a reusable template that describes details like a widget’s name, label, type, and icon. The template also defines the properties that control a widget’s content and behavior. These properties can be preset by a dashboard administrator, or they can be entered by a dashboard’s user.
Widget Types
Widget Types determine how the content of a widget is displayed. Different Widget Types will require different properties to correctly render the UI controls. Here is a list of the default Widget Types provided with the Aras Innovator platform, as well as their required or optional properties.
Grid Widget Type
Widget Properties for a custom Grid Widget Template
- ItemType
- Specifies the type of items in the widget grid
- Required property
- Default Value: id of the ItemType to be displayed
- Search
- Specifies the favorite search used to populate the widget grid
- Optional property
- Default Value: id of a favorite search item (optional)
- Results per Page
- Specifies the number of rows that will be displayed per page in the grid
- Optional property
- Default Value: integer (optional)
- Maximum Results
- Specifies the maximum number of items that will be loaded into the widget grid (across all pages)
- Optional property
- Default Value: integer (optional)
- Search Criteria
- Specifies the search criteria used to populate the widget grid
- Required if the Widget Template has a default value for Search
- Default Value: AML contents of the Saved Search that corresponds to the default favorite search
Tree Grid Widget Type
Widget Properties for a custom Tree Grid Widget Template
- Tree Grid View
- Specifies the Tree Grid View Definition that will be displayed in the widget
- Required property
- Default Value: id of the TGV to be displayed
- Context Item
- Specifies the root item that will be displayed in the Tree Grid View
- Required property
- Default Value: id of an item – same type as the TGV’s root ItemType
Report Widget Type
Widget Properties for a custom Report Widget Template
- Report
- Specifies the Report that will be displayed in the widget
- Required property
- Default Value: id of the Report to be displayed
- ItemType
- Specifies the ItemType parameter for the Report
- Optional property – provide if required by the Report
- Default Value: ItemType id
- Context Item
- Specifies the context item parameter for the Report
- Optional property – provide if required by the Report
- Default Value: item id
Widgets
The red box highlights one of many Widgets in this Dashboard A Widget is an instance of a Widget Template that defines and renders an interactive control for displaying and navigating data in a Dashboard. Each Widget displays live data and has settings that can be configured by the end user. These settings are based on the properties defined on the Widget Template.
The default permissions for Aras Dashboards include three out of the box group identities. To easily configure permissions, simply add identities of individuals or groups to these identities.
Default permissions for Dashboard items
Dashboard Administrators
Dashboard Administrators have the broadest permissions. Not only can they view and create Dashboards, but they can also edit, delete, and change the permissions of Dashboards created by any user. Dashboard Admins are also the only group that can create and edit Widget Templates for other users.
Dashboard Authors
Dashboard Authors have the next broadest permissions. They can view and create Dashboards, but they can only edit or delete the Dashboards they created themselves. Dashboard Authors have permission to view Widget Templates, but they aren’t able to create or edit templates.
Dashboard Viewers
Dashboard Viewers have the narrowest permissions. They can view Dashboards, but they cannot create, edit, or delete them. They cannot view, create, or edit Widget Templates.
Sharing Dashboards using Private Permissions A Private Permission is a Permission set specifically for a given Item, overriding its current Item Permission. The configured Permission is unique to the given Item and is not shared with any other Items. Private Permissions can be set for confidential Items to prevent viewing by other Identities. Once set, the Private Permission controls access to the Item by imposing a new set of access rights. It is possible to roll back to the default Item Permission. Once the default permission is reapplied, the Private Permission is deleted. The Can Change Access grant in an Item Permission defines who can create Private Permissions. By default, the Item Creator and Assigned Creator have this grant. Aras Administrators can define who can change access rights for Items.
Dashboards Creators and Administrators are granted Change Access right and can assign and control access rights of the created Dashboards.