Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Dashboard Items Type

 

A new item on the JSA dashboard. These items are available to users, who must manually add the items to their dashboard.

The contents of the item come from the response of the REST method execution. The expected format of the response is outlined in the following way:

{ id:"Unique ID of item" title:"Title text to display in the item", HTML:"Contents of dashboard item, including any HTML and JavaScript you want to use." }

Each time the dashboard item is refreshed, the REST method runs, so methods have a short response time. The current default refresh rate for dashboard items in JSA is 60 seconds.

The following table describes the dashboard_items block fields in the manifest.json file.

Table 1: Dashboard_items Block Fields

Field

Required

Type

Description

text

Yes

String

A unique ID for this area.

description

Yes

String

Concise text to display that describes the area. Can optionally point at a resource bundle key if the application is globalized.

rest_method

Yes

String

Name of the REST method to load this item. Must be declared in the rest_methods section of the manifest.

required_capabilities

No

Array of String

A set of capabilities that a user must affiliate with their user role to have access to this item.

The following code is a sample dashboard_items block from the manifest.json file:

... "dashboard_items": [ { "text":"Sample Item", "description":"Sample dashboard item that is a copy of most recent offenses", "rest_method":"sampleDashboardItem", "rest_arguments":null, "required_capabilities":["ADMIN"] } ], ...