Third party gadgets can be added to the one-X Portal for IP Office using an XML file. You can upload a maximum of 50 gadgets at a time. The file size must not exceed 2MB.
For each gadget, the following parameters need to be specified:
•URL of the gadget, that is, the source of gadget and its content
•Name of the gadget displayed on the gadget title bar
•Toolbar icons for the gadget. It is recommended to provide toolbar icons for all gadgets specified in gadgets.xml.
•Gadget toolbar texts (the tool tip text and the text that appears below the toolbar icon).
An example of a gadgets XML file format:
<GadgetsConfigurationImpl>
<gadgetRecords>
<entry>
<key>1</key>
<value>
<categorys>1</categorys>
<categorys>2</categorys>
<created>2012-08-10</created>
<defaultToolbarIcon />
<downToolbarIcon />
<deleted />
<enable>true</enable><external>true</external><height>300</height><id>1</id>
<localizedName><?xml version="1.0" encoding="UTF-8" standalone="no"?><names><en_US>Angry Birds</en_US><en_GB>Angry Birds</en_GB></names></localizedName>
<name>Angry Birds</name>
<toolbarText><?xml version="1.0" encoding="UTF-8" standalone="no"?><names><en_US>Angry Birds</en_US><en_GB>Angry Birds</en_GB></names></toolbarText>
<tooltip><?xml version="1.0" encoding="UTF-8" standalone="no"?><names><en_US>Angry Birds</en_US><en_GB>Angry Birds</en_GB></names></tooltip>
<url>http://www.gmodules.com/ig/ifr?url=http://www.forumforyou.it/google_gadget_angry_birds.xml&synd=open&w=820&h=680&title=Angry+Birds&border=%23ffffff%7C3px%2C1px+solid+%23999999&output=js</url>
</value>
</entry>
</gadgetRecords>
</GadgetsConfigurationImpl>
Note: Ensure the following in the .xml file:
1. Place each of the gadget within the <entry></entry> element.
2.The element <key></key> should be unique and it should match with <id></id>. This is a unique gadget id used for internal purpose.
3.The element <value></value> should contain gadget information.
4.The element <categorys></categorys> indicates the category of the gadget. The IDs and codes for the categories are as follows:
Code |
Category |
1 |
ALL |
2 |
COMMUNICATION |
3 |
TOOLS |
4 |
PRODUCTIVITY |
5 |
FINANCE |
6 |
TECHNOLOGY |
7 |
ZOHO |
5.Details of other elements:
Element |
Description |
<created> |
The date you created the file. |
<defaultToolbarIcon> |
Specify the default toolbar icon that the system displays when you minimize the gadget is minimized. The system displays the icon in the toolbar of the user. |
<downToolbarIcon> |
Specify the toolbar that system displays when the user clicks the gadgets icon. |
<enable> |
Specify the value to true if you want the user to view the gadget. |
<external> |
Set the value as true for all external gadgets. |
<height> |
Set the height of the gadget in pixel. |
<id> |
ID of the gadget. |
<localizedName> |
Specify the localized name for each locale. |
<name> |
Specify a unique name for the gadget. |
<toolbarText> |
The text that the system displays in the gadget toolbar. |
<tooltip> |
The text that the system displays in the gadget tool tip. |
<url> |
The URL of the gadget. For more information see, Fetching the URL of an external gadget - Example |
Note: Appropriate error messages are displayed if the configuration file does not support any of the aforementioned criteria.
To import a gadgets file:
1. Click Gadget Configuration, in the left navigation pane.
2. Click Import external gadgets.
3. Click Choose File to browse for the configuration file.
4. Click Upload. The system uploads the XML file on the one-X Portal for IP Office.
5. Click Import to add the third party gadget to the Gadgets List.
6.The next time the user logs into the one-X Portal for IP Office, the third party gadget is available to user to add to their portal.
