The License Usage Pack provides a collection of DTP widgets and reports that present information regarding license usage of Parasoft tools whose licenses are being managed in DTP. It allows you to monitor how many Parasoft tools are being used in your organization, who is using these tools, and show if there were any license shortages or if license requests were close to your token limit.
Requirements
- DTP and DTP Enterprise Pack with Enterprise license.
Process Overview
- Download and install the License Usage Pack (license-usage-pack-<version>.zip) into your DTP environment. Installing the package adds several files that configure DTP to report license usage.
- Configure and deploy the new flows included with the pack.
- Add the license usage widgets to a new or existing DTP dashboard. A dashboard template including all the widgets is available.
- Interact with the widgets and reports to track license usage and token requests.
Installation
Parasoft provides the license usage pack as a compressed folder (.zip) which you can download from the Parasoft Marketplace. Extension Designer will expand the .zip file and move the contents to the appropriate location when uploaded. The following process is also described in the Downloading and Installing Artifacts section:
- Choose Extension Designer from the DTP settings menu (gear icon).
- Click the Configuration tab and click Upload Artifact.
- Browse for the .zip file when prompted and click Install.
Importing and Configuring License Usage Flows
- Choose Extension Designer from the DTP settings menu (gear icon).
- Click the Services tab, click Add Service and add a new service called something memorable (for example, "License Usage") to the category of your choice.
- Two new flows are included with the pack. Import them to this new service, but do not deploy them yet. See Working with Flows for more information about importing flows. The flows can be found under Local > Flows > Workflows > License Server.
- Once the flows are imported, click the tab to which you imported the "Update License Data Cache" flow and double-click the Set Rest Api Configuration node to open its properties.
- Click the edit icon for the License Server API and enter the username and password for your DTP installation to provide the flow access to the DTP License Server API.
- Click Update, then Done.
- Click Deploy.
Usage
After installing the license usage pack and configuring then deploying its flows, you can set up a dashboard and start using its widgets and reports.
Dashboard
The License Usage pack includes a dashboard template called "License Server Usage Dashboard" that contains all the license usage widgets and reports in one, convenient dashboard. See Adding Dashboards for more information about adding dashboards to DTP, including from a template.
Widgets
There are several license usage widgets available for you to use in a new category "License Server" that was added with this pack. If you added a new dashboard from the License Server Usage Dashboard template as described above, all of these widgets are shown there. You can also add any or all of these widgets to an existing dashboard. See Adding Widgets for more information about adding widgets to a dashboard. A brief overview of these widgets can found below.
Upon adding widgets, you might find that some of them have no data. This can be because no licenses have actually been used yet, or it could be because the cache file the widgets use is empty. This cache file is automatically updated every day at midnight and license usage is shown from that data. You can manually update this cache file by clicking Update Data on the "Update Data" widget with current data.
Period Chart - Token Usage
This chart provides the total tokens used for all Licensed Parasoft tools. The data is presented for the specified period of time.
Period Table - Features Denied
This table widget shows information about requests that were rejected by the License Server because the specific feature requested by Parasoft tool from License Server was not available in the license. Note that this data concerns specific features of license, not the entire license token. For that data, see the “Period Table - No More Tokens” widget. The data is presented for specified period of time.
Period Table - No More Tokens
This table widget shows information about the requests that were rejected by the License Server because the license token requested was not available on License Server. This generally happens when a specific license is not present in License Server or it is present but all available tokens for the license are already taken by other Parasoft tools. The data is presented for specified period of time.
Period Table - Users Denied
This table widget shows information about requests that were rejected by the License Server because the user making the request has had their permissions removed. The data is presented for specified period of time.
Trend - Daily Rejections (Last 7 Days)
This chart graphs three rejection types–No More Tokens, Users Denials, and License Feature Denials–over the preceding seven days. This period is fixed and cannot be changed.
Trend - Daily Hours (Last 7 Days)
This chart graphs daily tool usage, by hour, for each Parasoft tool over the preceding seven days. This period is fixed and cannot be changed.
Trend - Daily Tokens (Last 7 Days)
This chart graphs daily token usage for each Parasoft tool over the preceding seven days. This period is fixed and cannot be changed.
Period Table - License Usage Hours
This table widget shows information about the total usage hours for Parasoft tools over a specified period of time. Click the more... link to show all tools and their usage hours in the period.
Upgrading
Although Parasoft extensions are designed to be forward compatible, they are not guaranteed to work in newer versions of DTP or Extension Designer. We strongly recommend installing the latest version of the artifact and removing the previous version.
- Make a backup of the model/profiles associated with your license usage artifacts. See Working with Model Profiles for instructions on how to export copies of your models and profiles.
- Delete the existing models/profiles and install the newer artifact as described in Installation.
- Un-deploy older artifact from Extension Designer by deleting its nodes and clicking Deploy.
- Deploy the newer version.
- New models and profiles are installed as part of the upgrade. Refer to your backed up models/profiles and apply any modifications you may have implemented in the previous version to the newly installed models/profiles.