Gadget Repository

WSO2 Gadget Repository is developed with two faces - the "administrator's view" and the "user's view" . In WSO2 Gadget Server, adding gadgets to the repository is only allowed for the server administrators. Therefore, an interface for the administrators to govern gadgets comes integrated to the Management Console. It enables Gadget Server administrators to manage gadgets from a single place, through a simplified user-interface.

Through the Gadget Repository, gadgets can also be made "default" to new users that sign-in to the Gadget Portal. Default gadgets are used to pre-populate the portal of a new user.

The Gadget Repository provides the following functionality.

Add New Gadgets

Follow the instructions below to add gadgets to the gadget repository.

1. Log on to the Gadget Server Management Console and select "Gadgets -> Gadget Repository" under the "Main" menu.

2. The Gadget Repository opens. Click the "Add New Gadget" link.

3. The "Add/Modify Gadget" window opens.

Gadget Server administrators can add gadgets in four ways as follows.

Using Gadget URL

This option is used to add from a http gadget repository location where the gadget is stored. If the Gadget xml is hosted in another Web Server, you can add that to the repository by simply adding its HTTP:// URL as the gadget URL. Also, if you are a user who just wants to test your gadget, the Gadget XML can be hosted in a public location and its HTTP URL can be provided (the xml file should be accessible via HTTP).

4. Enter the gadget details and click "Add Gadget". For example,

Using Gadget File Path

This option can be used to add a gadget by uploading its xml file.

5. Enter the gadget details and click "Add Gadget". For example,

Using Gadget Registry Path

This option can be used to add a gadget by browsing the registry and selecting the required gadget. You can click the "Browse Registry" link to open the resource tree of the enterprise Gadget Portal. From there, a gadget can be selected.

5. Enter the gadget details and click "Add Gadget". For example,

Using Gadget Zip File Path

This option can be used to add a gadget by uploading it as a zip file. The zip file typically contains gadget-related Java scripts and UI features in css files, gadget thumbnails etc. that can be deployed with the gadget.

5. Enter the gadget details and click "Add Gadget". For example,

In all four ways of adding gadgets, the newly added gadgets will be listed in the Gadget Repository as shown below. From here you can, your gadget, make default or available to anonymous users.

All newly created gadgets, except the ones added via a URL, are stored in the Gadget Repository. Users can find these gadgets simply by browsing the repository, according to their permission levels. Usually, the Repository is searched and browsed when gadgets are  added to the Gadget Portal by signed-in users.

Modify/Delete Gadgets

Follow the instructions below to modify or delete gadgets in the gadget repository.

Modify Gadgets

1. Log on to the Gadget Server Management Console and pen the Gadget Repository.

2. In the Gadget Repository, select the gadget you want to modify and click the "Modify" link associated with it.

3. The "Add/Modify Gadget" window opens. Users can modify the gadget xml file directly by clicking on the "Modify Gadget Source" link or browse the registry and change the resource path by clicking the "Browse Registry" link.

Change the gadget information as required and click the "Modify Gadget" button.

Delete Gadgets

4. In the Gadget Repository window, select the gadget you want to delete and click the "Delete" link associated with it.

5. Confirm your request.

Gadget Availability

Follow the instructions below to set gadget availability.

1. Log on to the Gadget Server Management Console, and open the Gadget Repository. Click on the relevant check boxes to make a gadget default or to make it available to anonymous users. For example,

Make Default

Making a gadget default is an administrative task. The administrator can decide which gadgets should be displayed by default to a newly-registered user when he/she opens the gadget portal. Once this option is checked, the gadget will be displayed by default in the Gadget Portal of a user unless he or she removes it.

Show Gadget To Anonymous User

The administrator of the Gadget Server can decide which gadgets are available for a anonymous user to be added to his/her Gadget Portal. Once this option is checked by an administrator, an anonymous user of the Portal can see it listed.