User's Guide > About the User's Guide > Codebeamer: Common Concepts > Wiki > Dashboard > External Widget Development > Enabling Pure Variants Widget in Codebeamer
Enabling Pure Variants Widget in Codebeamer
To enable the Pure Variants widget in the Codebeamer instance, add the following code to the Codebeamer Application Configuration:
"pvWidgetConfig" : {
"enabled" : true,
"settings" : {
"PV_HUB" : "webhub",
"PV_HUB_EDITABLE" : true,
"PV_HUB_URL": "https://webhub.server/pvweb",
"PV_HUB_URL_EDITABLE" : true
}
}
The following table lists the "pvWidgetConfig" settings and the related descriptions.
"pvWidgetConfig" Setting
Description
"enabled"
If set to true, the Pure Variants widget is enabled in Codebeamer.
If set to false, the Pure Variants widget is disabled in Codebeamer.
"settings"
If the "enabled" property is set to true, further settings can be specified under the "settings" property.
"PV_HUB"
The "PV_HUB" property defines the hub to be used. Possible values:
• WebHub ("webhub")
• DesktopHub ("desktophub").
"PV_HUB_EDITABLE"
The "PV_HUB_EDITABLE" property defines if the hub should still be editable by the user.
• If set to true, the hub is editable by the user.
• If set to false, the hub is not editable by the user.
If not defined, the hub is still editable by the user in the widget.
"PV_HUB_URL"
The "PV_HUB_URL" property defines the URL for the WebHub.
Example value: "https://webhub.server/pvweb".
"PV_HUB_URL_EDITABLE"
The "PV_HUB_URL_EDITABLE" property defines if the webhub URL should still be editable by the user.
• If set to true, the webhub URL is editable by the user.
• If set to false, the webhub URL is not editable by the user.
If not defined, the webhub URL is still editable by user in widget.
By default, the Pure Variants widget configuration is empty and disabled. To enable this widget, add the Pure Variants widget's setting.json configuration under the settings of the pvWidgetConfig. You do not need to mention the Pure Variants widget's extension.json path under externalWidgetExtensions.
The following steps should be performed by the system administrator if the deployment of Pure Variants widget is done manually in an older Codebeamer release:
• Remove the previously deployed Pure Variants widget folder from the webapp along with the related Pure Variants jars.
• Move settings.json from Pure Variants widget to Codebeamer application configuration.
• Remove the configuration of Pure Variants widget's extension.json from externalWidgetExtensions.
For more information on how to facilitate the Pure variants connector for Codebeamer, see Using the Integration
Was this helpful?