Skip to content

Dashboards

What is dashboards ?

Dashboards are used to create new screen layouts with system-defined or process-developer-defined lists of widgets.

The dashboard uses a 12-column grid layout to organize its panels. This layout is based on dividing the width of the screen into 12 equal parts (columns). Each panel can span multiple columns, depending on its size and importance. By assigning different widths to panels (e.g., 3, 6, or 12 columns), the layout remains flexible and responsive. This structure allows the content to rearrange itself dynamically on different screen sizes, ensuring optimal viewing on both large and small devices.

grid_layout.png

After panels are added to the list, you can define their width to adjust the layout according to the screen width.

dashboard_panels.png

Panels

System Defined Panels

Emakin defines the following panels as standard. Some panels may have additional configuration settings.

Worklist Counts

Displays the user’s worklist items by Critical, High Priority, Inbox, and Outbox categories.

Case List

Displays the list of cases that the user has permission to view.

Configuration

When no configuration is set displays the recently updated top 10 cases. Configuration data can be set as a plain text or JSON object.

Plain text

Lists all cases containing the “search” keyword.

1
search
JSON Data

JSON configuration provides more detailed control on the case list.

1
2
3
4
5
6
7
{
    "query": "search",
    "start": 0,
    "length": 50,
    "showFilter": true,
    "preferenceKey": "mydashboard"
}
Field Description
query Specifies the query to be performed
start List start offset
length Maximum list length
showFilter Specifies whether or not to display the filter toolbar.
preferenceKey Key to store filter preferences. Leave empty if persistence is not required.

Work List

Displays the tasks that are assigned to a user.

Configuration

When no configuration is set displays the top 10 tasks assigned to the user. Configuration data can be set as a plain text or JSON object.

Plain text

Lists all cases containing the “search” keyword.

1
search
JSON Data

JSON configuration provides more detailed control on the case list.

1
2
3
4
5
6
7
{
    "query": "search",
    "start": 0,
    "length": 50,
    "showFilter": true,
    "preferenceKey": "mydashboard"
}
Field Description
query Specifies the query to be performed
start List start offset
length Maximum list length
showFilter Specifies whether or not to display the filter toolbar.
preferenceKey Key to store filter preferences. Leave empty if persistence is not required.

Favorite Tasks

Displays a user's most frequently used processes for quick access.

favorite_tasks.png

Top Processes

Displays a chart showing a user's most frequently used processes.

top_processes.png

Average Task Duration

Displays the overall task completion duration for the user.

average_task_duration.png

Displays the list of links for quick access.

link_list.png

Link configuration can be defined as a list.

Title
Specifies the title to be displayed to the user.

Link
URL of the link to be opened when clicked.

Process Start

Displays the processes in one or more folders.

Configuration

Configuration data can be set as a plain text or JSON array of folders or processes.

Plain text

List of folder or process id that are separated with commas.

1
[folder_id],[process_id]
JSON Data

JSON data is expected as an array of strings or objects, specifying a folder or processes.

An array item can also be an object that contains the name of the process if you prefer to use the process name instead of the ID.

1
2
3
4
5
6
7
[
  'folder_id',
  'process_id',
  {
    'process' : 'myprocess'
  }
]

Process Defined Panels

In addition to system-defined panels, custom workflow screen definitions marked as dashboards can also be used as panels.

process_defined_panels.png