Configuring Widget JSON File

The Avaya Workspaces Widget Manager allows you to import external custom widgets. You can import a widget uploading a widget JSON file with the relevant properties. The structure of a widget JSON file is independent of the framework that you choose to create your widget. A widget JSON file contains several keys. The following table shows a type of value, a description and possible limitations for each key:

Property	Type of value	Description	Limitations
name	string	The widget name	No limit on characters. If long name is used, UX uses ellipsis to show more text
description	string	The widget description	No limit on characters. If long name is used, UX uses ellipsis to show more text
tags	string[]	Tags for the widget by which it can be found	Limited to 10. Otherwise, admin fails to import and shows an error message
version	string	The widget version	No limit
element	string	The custom element rendered in Avaya Workspaces
icon	string	The NEO icon
files	string[]	A directory with the web component build file that contains dependencies and relevant files to render the web component	Only one file location is supported
override_url	string	The URL of a remote server. You can use it if you want to have multiple widgets hosted at different locations. Alternatively, you can leave out this property and use the Widget Library URL, which you can set on a Profile in the Administration app.

The keys name, description, icon, element, and version are mandatory. If your JSON is missing any of these keys, it is rejected with an error message.

note

The id key is no longer used. Every widget is given an id by backend on save.

A correct example of a widget JSON file looks as follows:

{

"name": "My Angular Web Component",

"description": "Basic web component",

"tags": ["widget", "demo", "api"],

"version": "1.0.0",

"id": "1",

"element": "<my-web-component></my-web-component>",

"icon": "neo-icon-sort",

"files": ["/elements/my-web-component.js"],

"override_url": "http://123.23.12.56:8007"

}

If you upload a correct widget JSON file, your can see your widget appeared in the Widget Manager. If the import failed, ensure that:

• The widget is not missing mandatory fields.
• The widget has a unique name.
• The widget has a unique element property.
• The widget has less than 11 tags.
• The JSON file is valid.