Managing Add-Ons for the NDE UI
In addition to loading a custom module, the NDE UI provides infrastructure to support the dynamic loading of add-ons developed by other stakeholders such as vendors, consortia, or community members. This allows institutions to integrate external functionality seamlessly and manage it through the Add-On Configuration page.
This infrastructure was developed to enable seamless integration with various stakeholders (such as Third Iron, StackMap, SpringShare and more), while allowing the community to share commonly used components. For more information, see NDE UI Customization - Best Practices.
To develop an add-on or guide a vendor in creating one, see Developing an Add-On for the NDE UI.
-
Open the Add-on Configuration page (Configuration > Discovery > Other > Add-on Configuration).
-
Select Add Row.
Add Row Dialog Box -
Specify the following fields to integrate an add-on with the NDE UI. Contact the add-on provider for help filling in the following information.
-
Add-on Name – The identifier of this add-on as specified in the custom module.
-
Add-on URL—The location where the add-on is hosted (a static folder to load the add-on at runtime). While saving the information, the URL is checked for access.
-
Configuration Parameters – JSON-based configuration parameters to be referenced at runtime by the add-on.
This configuration file has a 5 KB limitation, which is approximately 20 parameters.
-
View – Specify All or select a view on which to use the add-on.
-
-
Select Save and return to the list of configured add-ons.
-
Activate the add-on.