How-to: Defining custom widgets in widgets catalog
Introduction
Currently the widgets in the widgets catalog are
loaded from the Webparts.Home.xml file. To support extensions on widgets, you
have to create an XML file called “Webparts.Ext.xml”. In this XML file, you can
define the extended widgets. This new file is a subset of Webparts.Home.xml.
Once the file is created, it should be placed in the XML folder of the Exact Synergy Enterprise installation directory. After that, it will be necessary to either perform an IISReset or close all open browsers and reopen the browsers again in order for the extension to take effect.
The following is an example of the Webparts.Ext.xml file:
Similar to the standard Webparts.Home.xml file, the
structure of the Webparts.Ext.xml file is divided into two sections: Widgets
and Categories. However, for the Webparts.Ext.xml
file, it should begin with "<dashboardExtension>".
See the following table for more information:
|
Parent
node
|
Child
node
|
Description
|
Remarks
|
|
Widgets
> Widget
|
Title
|
The
title of the widget.
|
If the
widget defined has the same widget ID as the one available in the standard,
then the standard widget will be overwritten with this extended widget.
|
|
Description
|
The
description of the widget.
|
|
Image
|
The
image of the widget.
|
|
Applications
|
The
ascx file.
|
|
Param
|
Additional
param needed by the widget.
The
‘data-sizex’ and ‘data-sizey’ are used to determine the default size of the
widget (number of grids).
|
|
Constraints
|
To
determine the security level and user license type .
|
|
|
|
Categories
> Category
|
Title
|
The
title of the category.
|
If the
category ID is the same as the one available in the standard, then the title
in the standard category will be overwritten with this title.
|
|
Position
|
The
position this category should appear. The position of the first standard
category is 1.
|
The position
node is only applicable for the extended xml and not available in the
standard xml. This is an optional node.
When it
is not defined, then the new category will be added after the last standard
category.
When a
value is defined, then the category will be inserted at the defined position.
If the same position is defined more than once in the extended xml, the
category with the same position number will be added after the last standard
category.
|
|
Widgets
> widget
|
List of
widgets to be available under the parent category.
|
The
widgets defined here can be any standard widget or newly-created custom
widgets.
If the defined category is a
standard category:
·
If the widget defined, either
standard or custom widget, does not exist in the category, it will be added
after the last standard widget in the category (based on the sequence the
widget nodes are defined in the xml).
·
If the widget defined already exists
in the category, it
will not be added again.
If the
defined category is a new custom category:
· The widgets will be added based on
the sequence that the widget nodes are defined in the xml.
|
Related documents
| Main Category: |
Support Product Know How |
Document Type: |
Online help main |
| Category: |
On-line help files |
Security level: |
All - 0 |
| Sub category: |
General |
Document ID: |
27.393.891 |
| Assortment: |
Exact Synergy Enterprise
|
Date: |
09-11-2018 |
| Release: |
|
Attachment: |
|
| Disclaimer |