Page History

...

The following table describes the file attributes within the structure of the schema.

Attribute		Description	Type	Required
`name`		The name of the widget also serves as the ID for adding widgets to custom dashboard templates. Only text (a-z) is allowed. Spaces are not allowed. See Custom Dashboard Templates.	string	Required
`attributes`		An object that contains the following attributes:	array	Required
	`title`	Title of the widget that appears in the widget UI	string	Required
	`description`	Description of the widget that appears in the widget UI	string	Optional
	`widgetCategory`	Specifies a category that the widget should belong to.

There are three options for specifying the widget category:

Existing category: You can view the JSON file of an existing widget in the DTP_HOME/grs/widget/builtin directory and copy its widgetCategory value (e.g., projectCenter).

Custom category:

If the attribute is not specified, the default custom category is used.

New category: The new category value can not match the value of an existing category. Spaces are not allowed. Set the widgetCategoryLabel attribute to specify a new category that appears in the Add Widget dialog.

string	Optional
	`widgetCategoryLabel`	Specifies the name of the category that appears in the Add Widget dialog when adding a new category as defined in the `widgetCategory` attribute.	string	Optional
	`reportLocation`	Specifies the relative path from

DTP

<DTP_

HOME

INSTALL>/tomcat/webapps/grs/custom directory to the report data used to populate the widget. Report files (HTML, JSP, etc.) should be placed in the custom folder to ensure that the files are backed up and restored when those processes occur. Do not include the beginning slash (/) when specifying the path.	string	Required
	`size_x`				Specifies the width o the widget (see About the Dashboard Grid)	integer	Required
	`size_y`				Specifies the height of the widget (see About the Dashboard Grid)	integer	Required
	`parameters`				Contains an array of objects that represent the widgets parameters. Each object contains the following attributes:		Required
		`type`			Specifies the input type of the parameter. The following values are valid: `text` `checkbox` `date` `dropdown` When the value is set to `dropdown`, the following attributes can be set:	string	Required
			`dropdownOptions`		Contains an array of objects that represent the drop-down menu UI	array	Optional
				`key`	Parameter for the drop-down item.	string	Required
				`value`	Parameter for the drop-down item.	string	Required
		`name`			Specifies the label for the parameter input. Text-only strings are allowed. Spaces are not allowed. When type is set to `dropdown`, the following special values can also be used: `filter`: Enables the user to select a DTP filter. `project`: Enables the user to select a DTP project. `period`: Enables the user to select a date range.	string	Required
		`required`			Specifies if the parameter is required to configure the widget. Default is `false`.	Boolean	Optional
		`title`			Specifies the label for the parameter in the UI. The value of the `name` attribute will be used if not specified.	string	Optional
		`inheritable`			Specifies if the filter, project, and period settings from the dashboard can be inherited.	Boolean	Optional
	`widgetLabels`				Contains an array of objects that represent the widget labels that will appear in the UI	array	Required
		`title`			Label that displays when the widget is added to the dashboard	string	Required
		`name`			Name of the selected parameter when the widget is added to the dashboard. The name should match the name of the parameter unless `filter` is used. You can also use `filterName` to display the name of the filter or `filterId` to show the ID.	string	Required

Page tree

Versions Compared

Old Version 3

New Version Current

Key