Versions Compared

Key

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

...

  1. 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.
  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:
     

    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.
    If you want to regenerate UUID, delete the value and click Done. A new UUID will be regenerated when the flow is saved.
    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.
    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 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 it according the following image:
  6. Link new "My Own Widget" Endpoint node with "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

...

You can configure the targetBuildDropdown and baselineBuildDropdown parameters with additional options that enable more refined filtering.

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:

  • dynamicAnalysis
  • coverage
  • staticAnalysis
  • metrics

Example:

"requiredRunTypes":"metrics, coverage"

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:

  • dynamicAnalysis
  • coverage
  • metrics

The runtype staticAnalysis is not supported as a detailedRunType option because all staticAnalysis runs always have details.

Example:

"detailedRunTypes":"metrics, coverage"

archivedIncludes/excludes archived builds in the filter. Setting to true excludes unarchived builds, whereas setting to false excludes archived builds.
lockedIncludes/excludes locked builds in the filter. Setting to true excludes unlocked builds, whereas setting to false excludes locked builds.

Using the Filter Builds Parameter Example

...