JBoss.org Community Documentation

- Prev

## Chapter 5. Category, Portlets and Gadgets Administration

To administrate category, portlet and gadget, you first need to go to Application Registry by selectingGroup, thenAdministration, and Application Registry on the Toolbar. The form to organize portlets/gadgets into different categories will be displayed as below

Details:

- Tab bar consists of three items, including Categories , Portlet, Gadget.

- Action bar consists of some actions related to a category.

- Left pane lists all categories and portlets of each category.

- Breadcrumb bar is the path from a specific category to a specific portlet in that category.

- Right pane provides detailed information of a specific portlet.

## 5.1. Manage Categories

### 5.1.1. Add a new category

1. Click on the Action bar to open the form to add a new category.

   Details:

   In theCategory Settingtab:

   Category name

     The category's name that 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 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.

2. Enter values in the Category Setting tab.

3. Set the Access permission for your category. Accordingly, another users can only view and use portlets in your category to which they have access.

   For more details about how to set the Access permission, refer toSection 4.7, “”.

4. Click Save to accept adding a new category to the categories list. Your newly created category will be added to the list in the left pane.

### 5.1.2. Edit a Category

1. Click the Edit icon located next to the title bar.

2. Update the category information.

3. Click the Save button to apply changes.

### 5.1.3. Delete a Category

1. Click the Trash can icon located next to the title bar.

2. Click OK to accept deleting in the confirmation message.

### 5.1.4. Add Portlets/Gadgets to a Category

This function helps you add portlets to a specific category easily as follows:

1. Click the icon located next to the category name to which you want to add portlets/gadgets.

   Display name

     The display name of a portlet/gadget.

   Application Type

     Either Portlet or Gadget.

2. Enter the display name and select an application type.

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

4. Click the Save button to add the selected portlet/gadget to the category.

The selected portlet/gadget will be added to the category in the left pane.

## 5.2. Manage portlets and gadgets

To manage portlets and gadgets in a portal, you first need to hover your cursor over on the Administration bar, and select Applications. The Manage Applications page will appear.

Portlets and gadgets are organized into 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 Gadgets category.

### 5.2.1. Import portlets and gadgets

This feature enables you to import default portlets and gadgets into different categories as follows:

1. Click at the right corner on the Action bar.

2. Click OK in the confirmation message to accept importing portlets and gadgets automatically.

   All portlets and gadgets of all categories will be imported and listed on the left pane.

### 5.2.2. View/Edit detailed information of a portlet/gadget

To view details of a portlet/gadget, simply select one portlet/gadget in the left pane. The details of that portlet will be shown on the right pane.

Left pane

  All portlets and gadgets grouped by categories.

Right pane

  Details of a portlet: Name, Display Name, Description.

Edit a portlet

1. Click on the top corner of right pane.

   The Edit Application Information form will appear.

2. Make changes on these fields, except Application Name.

### 5.2.3. Edit a specific portlet

This section tells you how to access the edit mode of a portlet and edit it.

1. Define your desired portlet to check if this portlet has been existing in the portal or page. If not, drag and drop it from Edit Inline Composer to the main portal body while editing the portal's layout, or from Page Editor to the main page body in the Step 3 while creating a page and/or while editing a page.

2. Hover your cursor over your desired portlet, then click at the upper left corner of that portlet.

   The Edit form will be displayed.

   Normally, a portlet has four tabs: Window Settings, Select Icon, Decoration Themes and Access Permission. However, some portlets may also have Edit Mode and Preferences tabs. For example, IFrame and Dashboard portlets have the Edit Mode tab where administrators can define the interface details.

3. Make changes on fields in the various tabs.

   - The Window Settings tab allows you to change values related to settings of your selected portlet.

     Details:

     Table 5.1.

     Field | Description
     --- | ---
     Display Name | The display name of portlet which cannot be changed.
     Window Title | The portlet title with the length between 3 and 60 characters.
     Width | The portlet's vertical size. The value of this field must be in numeric format.
     Height | The portlet's horizontal size. The value of this field must be in numeric format.
     Show Info Bar | The option enables the information bar to be shown or hidden. If the Show Info Bar checkbox is not selected, portlet mode and window state will not be displayed in that portlet.
     Show Portlet Mode | The option enables the portlet mode to be shown or hidden.
     Show Window State | The option enables the portlet's window state to be shown or not.
     Description | The brief information of the portlet. The length must be between 0 and 255 characters.

   - The Select Icon tab allows you to select an icon for the portlet. By clicking Get Default, you do not have to select any icon from the list, the suitable icon will be got automatically.

   - The Decoration Themes tab allows you to select a theme for the portlet from the themes list. By clicking Get Default, you do not have to choose any theme, it will be automatically set.

   - The Access Permission tab allows you to set the access permission on the portlet. The portlet can be made public to everyone or restricted to specific groups.

     ## Note

     See the Set Access permission on a portlet section for details on how to assign the access permission on a portlet.

4. Click Save And Close to accept your changes.

### 5.2.4. Add a gadget

To add a gadget, you first need to turn into the Gadget page by selecting Gadget on the tab bar of the Manage Applications page.

You can add a remote gadget using its URL or create a new gadget into the list.

Add a remote gadget

1. Click the Add a Remote Gadget link.

2. Enter the link of your desired gadget which is in the .xml format in the Gadget URL field.

3. Click Add to accept your inputted URL.

   The selected gadget will be added to the gadgets list in the left pane with its details in the right pane.

Create a new gadget

1. Click the Create a New Gadget link.

2. Enter values in the form.

   For example:

3. Click Save to accept creating your new gadget.

## Note

To add the newly added remote gadget to a specific category, simply click the "Click here to add into categories" link at the bottom of the right pane. The table listing all categories will appear that allows you to select your desired category.

To update information of the added gadget, simply click to refresh information.

- You can delete a local gadget using corresponding to each gadget in the left gadgets list.

### 5.2.5. Add a new gadget from Dashboard

See the Add more external gadgets from Dashboard section for instructions on how to add new gadgets from the dashboard.

### 5.2.6. Edit a gadget

Click located at the header of the Gadget Details page to display the following window.

- PrevChapter 4. Portal Administration
- Top of page
- Front page