DashboardMessageHandler
-
- UpdatedJan 30, 2025
- 2 minutes to read
- Yokohama
- Dashboards
Provides methods to define custom filtering logic for interactive filters.
For more information about interactive filters, see reporting and interactive filters.
DashboardMessageHandler - DashboardMessageHandler(String id)
Instantiate a DashboardMessageHandler object with a given unique ID.
Name | Type | Description |
---|---|---|
Id | String | A unique ID for the filter. This ID allows report widgets to track which filter applied each filter. The ID does not need to be unique across all dashboards, but each dashboard cannot have multiple filters with the same ID. |
Example
DashboardMessageHandler - publishFilter(String table, String encodedQuery)
Each DashboardMessageHandler object can publish a single filter.
Publishing a new filter from the same object overwrites the original filter. Use multiple DashboardMessageHandler objects to publish multiple filters.
Name | Type | Description |
---|---|---|
table | String | The table to filter, such as task. |
encodedQuery | String | An encoded query that specifies the filter to publish. |
Type | Description |
---|---|
void |
Example
DashboardMessageHandler - publishMessage(Array filters)
Apply a custom interactive filter to multiple tables.
Name | Type | Description |
---|---|---|
filters | Array | Array of filter objects that define the tables to filter and the filter criteria. |
filters.table | String | Name of the table to filter. |
filters.filter | String | Encoded query containing the filter criteria to apply to the table. |
Type | Description |
---|---|
None |
Example
This jelly script filters the Incident and Problem tables to return records where the assignment group is Problem solving.
DashboardMessageHandler - removeFilter()
Removes the current filter published by this DashboardMessageHandler object from all reports on the dashboard.
Name | Type | Description |
---|---|---|
None |
Type | Description |
---|---|
void |