...
Out of the box, Parasoft provides useful component and parameter definitions for creating your own custom widgets:
Scroll Table Layout | ||
---|---|---|
|
Components | Description |
---|---|
Bubble Chart | This component renders concentrations of data points as bubbles along an x- and y-axis. The Modules - Bubble widget is an example of a bubble chart. |
Donut Chart | This component renders the data as proportioned segments and includes an overall value. The Policy Center Gate Summary Widget is an example of a donut chart. |
Percentage Chart | This component renders the data as an overall percentage. The Coverage - Percent widget is an example of a percentage chart. |
Pie Chart | This component renders the data as a pie chart with a legend. The Severities - Pie widget is an example of a pie chart. |
Summary Chart | This component renders the data as a single summary value. The Metrics - Summary widget is an example of a summary chart. |
Table Chart | This component renders the data as a table with five rows and an optional link to an additional report showing the complete data. The Authors - Top 5 Table widget is an example of the table chart. |
TreeMap Chart | This component renders the data into tiles with sizes proportional to the data point values. The Modules - Top 10 Tree Map widget is an example of the tree map chart. |
Scroll Table Layout | ||
---|---|---|
|
Parameters | Description |
---|---|
Build Delta - Report | This node specifies fields for a filter, time period, baseline build, and target build as parameters to be passed to a report. The node is useful for calculating the difference between two builds. It also allows you to resolve the build ID of the first or latest build within a time period for baseline builds, as well as resolve the build IDs of the latest build for target builds. |
Build Delta - Widget | This node specifies fields that can be configured in the widget creation edit dialog. This parameter node allows for filter, time period, baseline build, and target build to be configurable fields. This parameter node is useful for calculating the difference between two builds. It allows you to resolve the build ID of the first or latest build within a time period for baseline builds, as well as resolve the build IDs of the latest build for target builds. |
Build Delta with Profile - Report | This node is similar to the "Build Delta - Report" parameter node, but it also specifies a parameter for a profile that a report can use to access static data stored in Extension Designer. |
Build Delta with Profile - Widget | This node is similar to the "Build Delta - Widget" parameter node, but it also adds an input field for a profile that the widget can use to access static data stored in Extension Designer. |
...
- Choose Import> Library> Sample Widgets> Pie Chart example from the Extension Designer menu to import the example to a new flow tab in any service.
Double-click the Example Pie Chart endpoint node and review the configuration. This node defines the widget implementation.
You can change the following fields to configure the example widget:
Scroll Table Layout widths 30%,70% Name Name of the widget displayed in the DTP dashboard UUID Unique identifier for the endpoint that is automatically generated when you drop the endpoint node into the flow canvas. Type Choose an endpoint type from the Type drop-down menu:
- Widget: Specifies a DTP dashboard widget. Once this value is selected, the size, category, component, and parameter fields will be available. See About the Dashboard Grid for additional information about sizing widgets.
- Report: Specifies a custom report for the DTP dashboard. Once this value is selected, the component and parameter fields will be available
- Practice: Specifies a Policy Center practice (see Defining Policies). Once this value is selected, the component and parameter fields will be available.
- General: Specifies a general REST endpoint. Both GET and POST operations will be available for the endpoint. To get the endpoint URL, open the Service Category Page and copy the URL.
Category Defines the DTP dashboard widget category. In general, the value should be either "custom" or "process intelligence". You can enter a new name to create a new category. The widget header color will be gray if you create your own category name. Component: Specifies the component to provide. Any components deployed to the flow canvas should be available from the drop-down menu. Parameter Specifies the set of parameters to provide to the DTP dashboard. All parameters deployed to the flow canvas should be available from the drop-down menu. Description Specifies a description of the endpoint. This description will be used on DTP dashboards, the Add Widget page (see Adding Widgets), and the Extension Designer's category page as the endpoint description. - Click the refresh button at the UUID field. This will ensure that the new widget does not conflict with any other endpoint.
- Deploy the widget.
- Drop a new Endpoint node into the flow and configure it according the following image:
- Link new "My Own Widget" Endpoint node with "Sample Data" function node.
- Deploy the flow.
- In Report Center, refresh the dashboard (if already open) and click Add Widget. The Add Widget overlay will display your widget on its own category.
- Finish adding the widget to see it on the dashboard
...
You can configure the targetBuildDropdown
and baselineBuildDropdown
parameters with additional options that enable more refined filtering.
Scroll Table Layout | ||
---|---|---|
|
requiredRunTypes | This property accepts one comma-separated string. The string is a list of all run types contained in the build that you want to focus on. The following run types can be specified:
Example:
|
---|---|
detailedRunTypes | This property accepts one comma-separated string. The string is a list of all run types contained in the build that you want to focus on. The run types specified in the string must "have details," which refers to data that has not been pruned from the database as part of regular cleanup activities. You can archive builds to ensure that specific builds always have details (see Using Build Administration for additional information). By default, DTP stores details for the last two runs of a build. The following run types can be specified:
The runtype Example:
|
archived | Includes/excludes archived builds in the filter. Setting to true excludes unarchived builds, whereas setting to false excludes archived builds. |
locked | Includes/excludes locked builds in the filter. Setting to true excludes unlocked builds, whereas setting to false excludes locked builds. |
...