eXo Platform 3.5

- Prev
- Next

## Chapter 11. Operations With Netvibes Widget

The Netvibes widget uses Universal Widget API (UWA) - a powerful framework for Web widgets development - for both Netvibes widgets and many various environments.

The UWA widget consists of combinations from XHTML/XML, JavaScript/Ajax, CSS code with the MIME type application/x-uwa-widget. In eXo IDE, you can create the Netvibes widget, preview it and deploy to Netvibes Ecosystem.

### Note

If you want to get acquainted with writing your own widgets, refer page http://dev.netvibes.com/doc/.

## Create Netvibes Widget

To create a Netvibes widget, click the New icon on the toolbar and then select Netvibes Widget from the drop-down menu, or go to File > New > Netvibes Widget on the top menu.

The new Netvibes Widget file is opened in the editor, enabling you to edit and save it.

Illustration. Create new Netvibes widget

## Preview Netvibes Widget

To preview the Netvibes widget, do as follows:

- Step 1: Open your desired widget file in the Content Panel.

- Step 2: Click the Show Preview button on the toolbar; or go to Run > Show Preview on the top menu.

The selected widget is opened in the Preview Tab.

## Deploy Netvibes Widget To Netvibes Ecosystem

Netvibes widgets are placed in the remote system called Netvibes Ecosystem. This is the location where such widgets can be found and compiled for other platforms.

There are a couple of ways to deploy a Netvibes widget. You can do it manually, or use the deploy mechanism. Manual deployment is easier because you don�t need to get an API key from Netvibes.

Manual deployment:

- Step 1: Get the url of your Netvibes widget. To do this, select your widget and click on the menu View > Get URL. Copy the url.

- Step 2: Go to the netvibes ecosystem, click on Create or submit and Submit Widget.

- Step 3: Paste the url of your gadget, and don�t forget to remove the �/private� part from it. If you do not do this, Netvibes will not be able to access it.

- Step 4: Fill-in the form and finish the process. The widget is now available in the ecosystem.

For deployment using our wizard, you need to contact Netvibes at `<business@netvibes.com>` and ask for your API key.

- Step 1: Get the url of your netvibes widget. To do this, select your widget and click on the menu View > Get URL. Copy the url..

- Step 2: Click on Deploy UWA widget to Ecosystem button on the toolbar; or go to Run > Deploy UWA widget on the top menu to open the Deploy UWA widget to Ecosystem:

Illustration. Deploy UWA widget to Netvibes Ecosystem

- Step 3: Paste the url of your gadget, and don�t forget to remove the "/private" part from it, or netvibes will not be able to access it

- Step 4: Enter the information about the widget in the fields in the Step 2 form. The fields marked with asterisks (), including "Title", "Description", "Main language", "Most appropriate region" and "Most appropriate category" are required.

Click Next after completing your details.

Illustration. Dialog "Step 2. Detailed Information"

- Step 5: Enter your netvibes credentials and the API key/secret that netvibes gave you by email. All these fields are mandatory.

Illustration. Dialog "Step 3. Private Information"

Details:

Field | Description
--- | ---
Login | Your login at Netvibes Ecosystem.
Password | Your password at Netvibes Ecosystem.
Api Key | The string generated by Netvibes and used for identifying you.
Secret Key | The string generated by Netvibes and used for submitting your actions.

### Tip

Click the "Back" button to return to the previous step to edit your entered information.

- Step 6: Click the Deploy button to start deploying the widget to the Netvibes Ecosystem.

The result is displayed in the Output Panel. If the deployment is successful, you will receive the message below:

    [INFO]*[http://78.137.4.16:53081/rest/ide-vfs-webdav/repository/dev-monit/TestWidget.html] deployed successfully.

If unsuccessful, you will receive the error message which varies, depending on each case.

    [ERROR] Error: The link already exists.

### Note

The deployed widget can be found at the Ecosystem page (http://eco.netvibes.com/mine/widgets) on the "My creations" tab.

## View Netvibes Documentation

There is a convenient way to view the developer's documentation, while creating your widget in eXo IDE. When opening Netvibes widget in editor, click Show Documentation Toolbar item or select View > Documentation.

Top menu item and a panel with loaded documentation will be opened at the right part of the application.

Illustration. View Netvibes Documentation

- Prev
- Up
- Home
- Next