Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DTPDEVEL and version 2024.1

...

Component nodes include a custom widget and a report's structure and definition. Import the a custom widget from the Sample Widgets library and click a component to view  its its parts.

  1. Choose Import from the ellipses menu.
  2. Choose an example widget from the Library > Sample Widgets folder.

...

Out of the box, Parasoft provides useful component and parameter definitions for creating your own custom widgets. All definitions are provided under Import> Library> Import > Library > Sample Widgets

Scroll Table Layout
widths30%,70%

ComponentsDescription
Bubble ChartThis 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 ChartThis component renders the data as proportioned segments and includes an overall value.
Percentage ChartThis 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 ChartThis component renders the data as a single summary value. The Metrics - Summary widget is an example of a summary chart.
Table ChartThis 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 ChartThis 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.

...

This section explains how to create new chart widget in DTP using the Pie chart sample widget. 

  1. Choose Import> Library> Sample Widgets> Import > Library > Sample Widgets > Pie Chart example from the Extension Designer menu to import the example to a new flow tab in any service.
  2. 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
    widths30%,70%

    NameName of the widget displayed in the DTP dashboard.
    UUIDUnique 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.
    • 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.
    CategoryDefines 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.
    ParameterSpecifies the set 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.
    DescriptionSpecifies 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.
  3. Click the refresh button at the UUID field. This will ensure that the new widget does not conflict with any other endpoint.
  4. Deploy the widget.
  5. Drop a new Endpoint node into the flow and configure the following settings:
    1. Specify a name.
    2. Choose Widget from the Type menu.
    3. Choose Pie Chart Component from the Component menu.
    4. Choose Pie Chart - Widget Parameters from the Parameters menu.
    5. (Optional) Enter a description.
  6. Click the output handle and on the new component to the input handle on the "Sample Data" function node.
     
  7. Deploy the flow.
  8. 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.
  9. Finish adding the widget to see it on the dashboard.

...

The nodes provide a structured msg.payload as the output to the endpoint. The DTP dashboard will use the response as data for the widget. In every sample widget, we provide a Sample Data function node (with actual data) and a No Data function node for possible payload schema. The No Data node demonstrate how to send an error message back to the widget so the widget can display the message properly.

Click on the connector from the custom widget to the Sample Data node and press the Delete keyDELETE.

 

Make a new connection to the No Data node. 

...