Enable Widget Extensions in DNG

You can enhance the Requirements Management (RM) application by authoring extensions for it. The extensions can enhance productivity and are useful for analysis. You can add the extensions to your mini dashboard and remove them as needed. Extensions are authored by using a combination of JavaScript, HTML, and CSS files. The extensions access data within the RM application by using an RM API.

This article aims to help you with enabling and uploading the widget extensions in Engineering Requirements Management DOORS Next.

Widget Extensions

You can enhance the Requirements Management (RM) application by authoring extensions for it. The extensions can enhance productivity and are useful for analysis. You can add the extensions to your mini dashboard and remove them as needed. Extensions are authored by using a combination of JavaScript, HTML, and CSS files. The extensions access data within the RM application by using an RM API.

Enabling Extensions via Widget Catalog

This procedure describes how to enable scripts in DNG:

  • Open the file: C:\.....\I...\JazzTeamServer\server\liberty\servers\clm\server.xml
  • Change the false to true in following line: <applicationMonitor dropinsEnabled="true" pollingRate="10s" updateTrigger="mbean"/>
  • Save
  • A restart of the server is not needed.
  • Go to servername/rm/admin -> Advanced Properties
  • Find and edit the line that begins with (use Ctrl+F to search in Windows Browser) com.ibm.rdm.widgetcatalog.internal.WidgetCatalog
  • User Extension Catalog URL: https://servername:port/extensions/WidgetCatalog.xml
  • Save
  • Add extension files to following folder .\JazzTeamServer\server\liberty\servers\clm\dropins\war\extensions 
    (if repository \war\extensions doesn't exist in \dropins, you must create it!)
  • You must have there: WidgetCatalog.xml, Several Folders containing the scripts and conf files
  • If you are using IBM HTTP Proxy server in your topology then make sure plugin-cfg.xml file is configured with /extensions context or alternatively put extensions into the following directory: .\Apache\htdocs\extensions

Widget Catalog

Widget Catalog is the .xml file that is used by the server to recognize which extensions you want to run on it. It contains the following information:

  • Description - description of widget that is shown in DNG UI
  • Title - the name of the widget that you want to see in the DNG UI
  • Resource - paths to the Widget files and pictures that will be shown in DNG UI
  • Category - Name of the category where the widget will be placed in DNG UI

DNG UI

Example of WidgetCatalog with one entry:

<?xml version="1.0" encoding="UTF-8"?>

<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
     xmlns:ju="http://jazz.net/ns/ui#"
     xmlns:dc="http://purl.org/dc/terms/">     
     <ju:catalog-entry>
          <dc:description>This extension shows a hierarchical tree view of the module, which you can click to explore. You can search for artifacts, collapse or expand the hierarchy to a particular level, and toggle to show only headings or all of the artifacts in the module.</dc:description>
          <dc:title>Module Explorer</dc:title>
          <ju:gadget rdf:resource='./module_explorer/moduleexplorer.xml'/>
          <ju:icon rdf:resource="./module_explorer/moduleexplorer.gif"/>
          <ju:preview rdf:resource="./module_explorer/moduleexpl_pre.png"/>
          <ju:thumbnail rdf:resource=".module_explorer/moduleexpl_thumb.png"/>
          <ju:category>Sample Extensions</ju:category>
     </ju:catalog-entry>
</rdf:RDF>

Enabling External Widgets

In Engineering Requirements Management DOORS Next you have also the possibility to use widgets that are not hosted on your server. Add OpenSocial Gadget option gives you the possibility to use any of the provider's widgets in case you know the full URL of the widget. URL has the following format:

http://[servername] + /gadgetlocation

OpenSocialGAdgets

 

In newer ifixes start from versions ELM 7.0.2 iFix004, ELM 7.0.1 iFix009, CLM 6.0.6.1 iFix018, and CLM 6.0.6 iFix022 an additional action has to be performed in order to enable loading of widgets.
Find more information here: https://www.softacus.de/blog/articles/dng/extensionsnotworkingifix

 

 

 

 

Image

Softacus AG

Löwenstrasse 20
8001 Zürich
Switzerland
E-Mail: info@softacus.com
Tel.: +41 43 5087081
Fax: +41 43 344 6075 

VAT: CHE-108.817.809 MWST
D-U-N-S® Number 486800618

Image

Softacus GmbH

Westendstrasse 28
60325 Frankfurt am Main
Germany
E-Mail: info@softacus.com
Tel.: +49 69 34876544
Fax: +49 69 5830 35709

VAT: DE301903892
D-U-N-S® Number 313482703

Image

Softacus s.r.o.

Křídlovická 351/47A
603 00 Brno
Czech Republic
E-Mail: info@softacus.com
Tel.: +420 530333482
Fax: +41 43 344 6075

VAT: CZ07286333
D-U-N-S® Number 496165108

Image

Softacus s.r.o.

Tatranské nám. 3
058 01 Poprad
Slovakia
E-Mail: info@softacus.com
Tel: +421 911 083 612
Fax: +41 43 344 6075

VAT: SK53507070
D-U-N-S® Number  2121388148