JBoss.orgCommunity Documentation

Chapter 7. Gadgets Administration

7.1. Manage Gadgets in User Workspace
7.1.1. Add a Gadget
7.1.2. Edit a Gadget
7.1.3. Remove a Gadget
7.2. Import Portlets and Gadgets
7.3. Manage Portlets and Gadgets
7.3.1. Introduction
7.3.2. Add a new Category
7.3.3. Edit a Category
7.3.4. Delete a Category
7.3.5. Add Portlets/Gadgets to the specific Category
7.3.6. Set Access Permission on Portlets
7.3.7. View detail information of the specific Portlets
7.3.8. Add a Gadget
7.3.9. Add a remote Gadget
7.3.10. Create a new Gadget
7.3.11. Add a new Gadget to the Dashboard Portlet
7.3.12. Manage Gadgets

7.1. Manage Gadgets in User Workspace

  1. gadget is a small convenient application that helps you perform private actions. GateIn Portal provides you with some useful gadgets: todo, calendar, calculator and RSS Reader. Besides using ready-to-use gadgets in your User Workspace. You can easily add gadgets organized in categories in your User Workspace to meet the need of your work :

To add a gadget, you can follow these steps:

1. Open the User Workspace on your left pane.

2. Click the tool!images/Tool.png! icon to add a new category

The Gadget Containers Management dialog appears:

Click the add icon !images/AddIcon.png! to show the Gadget Container Form .

Name Description
Label The display name of the category. This field is required and must have at least 3 characters.
Description The brief description of the category.A length from 0 to 255 characters is allowed. This field is not required.

Enter values for fields in the Gadget Container Form .

Click on the Save button to accept adding a new category or click Cancel to quit. After you added the new category you will see it in the dialog :

Edit the information of an existing category by selecting it from the left pane, the selected category is marked by a symbol. Then click the edit icon to show the edit form. Change the current category information and click on the button to accept changes.

Delete an existing category by selecting it from the left pane. In the message box Click on the OK button to confirm the deletion or click the Cancel button.

3. Click on the Save button in the Gadget Containers Management dialog to accept or on the Cancel button to quit. Added categories will be displayed in list in the User Workspace.

4. Click the list icon!images/ListIcon.png! to see category list and select one in list.

5. Click the add icon!images/AddIcon1.png! at the bottom of the User Workspace to open the Add Application dialog:

6. Select a gadget by clicking the add icon !images/PlusIcon.png! that is located next to the the gadget. The selected gadget is displayed immediately in the user workspace. Normally, you can see only two gadgets in the User Workspace. When there are more gadgets, some gadgets are not visible.

7. Click the scroll down icon !images/DownIcon.png!images/ or the scroll up icon!images/ UpIcon.png! at the bottom of the User Workspace to see the other gadgets. If there are no more gadgets to scroll to, the color of the scroll down and scroll up icon switches to gray color.

To edit a gadget, click !images/EditIcon.png! icon.

Remove a gadget from the User Workspace by using the functional bar!images/FunctionBar.png! at the upper right corner of that gadget.

Click the remove icon !images/RemoveIcon.png! . When the confirmation message appears, click the OK button to accept or the Cancel to quit.

7.2. Import Portlets and Gadgets

This convenient feature that helps you import default portlets/gadgets automatically in different categories and these portlets/gadgets will be listed on the left pane.

  1. info("Technical Information about the Portlet Import: The Application Registry looks in all webapps of your application server for a file located at WEB-INF/portlet.xml and registers the portlets found there. When the user clicks on "Auto Import" the portlets of all webapps are imported. If there is a portlet.xml file in a webapp a new category is created whose name is the webapp war name (or the webapp folder name). All the portlets that are configured in the portlet.xml file are added to the new category.")

1. Go to Administration-> Application Registry page-> Organize item on the navigation bar. A form for organizing portlets/gadgets will be displayed:

2. Click the Auto Import button!images/Auto1.png! at upper right corner on the action bar. A pop up will be shown:

2. Click the OK button to accept importing gadgets automatically. All portlets/gadgets categories will be imported and listed on the left pane.

7.3. Manage Portlets and Gadgets

Portlets and gadgets are organized in different categories. Each category contains one or several portlets or gadgets. You can also mix portlets and gadgets into one category. By default all gadgets are placed in the ExoGadgets category.

You easily add a new category by following these guides:

Go to Administration -> Application Registry page -> Organize item.

1. Open a form to add a new category on the right pane by clicking the Add Category button on the action bar:

The Category Setting tab: includes common information about a category.

Name Description
Category name The name of the category which you want to add. This field is required and its length must be between 3 and 30 characters.
Display name The display name of the category in list and its length must be between 3 and 30 characters.
Description A brief description of the category. Any length from 0 to 255 characters is allowed.

The Permission Setting tab: used to set the access permission for a category.

{info} This access permission enters the game whenever a user creates or modifies a page. In that moment the user only can see and use portlets in those categories on which he or she has access permission (defined by groups and memberships). {info}

Figure 7.1. {info} This access permission enters the game whenever a user creates or modifies a page. In that moment the user only can see and use portlets in those categories on which he or she has access permission (defined by groups and memberships). {info}


2. Enter values for required fields in this form.

3. Click the Save button to accept adding a new category into a category list. The new category will be added into a list on the left pane.

You can edit a category in list by following:

1. Click the edit icon!images/EditIcon1.png! on the title bar of a category that you want to edit.

2. Change the information of the selected category.

3. Click the Save button to accept changes.

You also easily remove a category from a list:

1. Click the trash can icon!images/DeleteIcon.png! on the Title bar of the category that you want to delete.

2. Click on the OK button on the message to accept deleting or click on the Cancel button to quit.

You can follow these steps to add a portlet/gadget to your prefered category :

1. Click the "add" icon!images/AddIcon.png! on the title bar of a category to which you want to add portlets. An interface will appear in the right pane as you can see below:

Name Description
Display nameThe display name of a portlet/gadget that you want to add to a category.
Application Typethe type of selected object.

2. Enter the display name and select a type for the selected portlet/gadget.

3. Select a portlet/gadget by checking the radio button.

4. Click the Save button to accept adding a portlet/gadget to a category.

You easily set an access permission on a portlet by following these guides:

1. Go to GateIn Start -> Page Navigations -> select Administration --> Application Registry

2. Select a category on the left pane that includes the portlet you want to set right. Then all portlets of the selected category are listed immediately and detail information of each portlet is displayed on the right pane.

3. To set permission for a portlet:

Whenever the user creates or modifies a page he or she can only see and use portlets that fulfill two conditions: the portlet is in a category on which the user has access permission (see category section above) and the user has access permission on the portlet

You easily view detail information of all specific portlets by following these guides:

1. On the navigation bar, go to the Administration-> Application Registry page-> Portlet item . A form to view all portlets will appear:

Name Description
Left pane lists all portlets in two parts: Local and Remote
Right pane shows detail information about a portlet: Name, Display name, Description and Portlet preferences.

2. Select one portlet in the list on the left pane. The detail information of that portlet appears on the right pane.

You can follow these steps to add a gadget to the gadget list :

1. Go to the Administration --> Application Registry and click on Gadget :

There are two ways to add gadgets:

1. Open the form to add a remote gadget by clicking Add a remote gadget :

2. Enter a link to an .xml file in the URL field.

3. Click on the Add button to accept the entered URL or on the Cancel button to quit. The added gadget will be added into gadget list on left pane of the Dashboard portlet.

1. Show the form to add a new gadget by clicking Create a new gadget :

Source: The source code to create a new gadget. This source will be a .xml file.

2. Enter a value for the Source field in this form.

3. Click the Save button to create a new gadget. The created gadget will be added to the gadget list on the left pane of the Dashboard Portlet.

You also edit, refresh and delete a local gadget as well as a remote gadget:

You can add a new gadget to the gadget list in the Dashboard portlet :

1. Go to the Dashboard on the navigation bar. Click on the Add Gadgets link :

  1. dialog to add a new gadget will appear :

2. Enter a link (a .xml file or RSS) in the text box on the left pane.

3. Click on the icon!images/PlusIcon.png! to add a new gadget to the gadget list beneath.

1. Click the edit icon!images/EditGadget.png! . It will display a dialog:

2. After editing , click the Save button to accept changing or Cancel button to quit.

1. Click the trash can icon!images/DeleteGadget.png! on the row of the gadget that you want to delete. It will display an alert message :

2. Click the OK button to accept deleting or Cancel button to quit without deleting.