For use with Red Hat JBoss Portal 6.2.
Legal Notice
Abstract
- Preface
- I. Introduction
- II. Portal Administration
- 5. Portals
- 6. Portlets and Gadgets
- 6.1. Import Portlets and Gadgets
- 6.2. Manage Portlets and Gadgets
- 6.3. Display Gadgets
- 6.4. Add a new Category
- 6.5. Edit a Category
- 6.6. Delete a Category
- 6.7. Add Applications to a Category
- 6.8. Set Access Permission on Portlets
- 6.9. View/Edit portlet/gadget information
- 6.10. Add a Gadget
- 6.11. Manage Gadgets
- 6.12. Edit a Gadget
- 7. Gadgets in Portal
- 8. Navigation Nodes
- 9. Pages
- III. Site Administration
- 10. Language
- 10.1. Change Interface Language
- 10.2. Language for a user
- 10.3. Set language for a user
- 10.4. Right To Left Support
- 10.5. Multi-Language Navigation Nodes
- 10.6. Key Format
- 10.7. Creating Keys
- 10.8. Creating Keys using Create Page Wizard
- 10.9. Creating Keys using Navigation Management
- 10.10. Providing translation
- 11. Permissions
- 11.1. Manage Permissions
- 11.2. Set Site Permissions
- 11.3. Set Access Permissions on a Site
- 11.4. Set Edit Permissions on a Site
- 11.5. Set Page Permission
- 11.6. Set Access Permissions on a Page
- 11.7. Set Edit Permissions on a Page
- 11.8. Set Access Permission on a Category
- 11.9. Set Access Permission on a Portlet
- 12. Site Redirection
- 13. Mobile and Responsive Portal Site
- IV. Accounts, Memberships, Groups, and Users
- A. Revision History
1. Document Conventions
1.1. Typographic Conventions
Mono-spaced Bold
To see the contents of the filemy_next_bestselling_novelin your current working directory, enter thecat my_next_bestselling_novelcommand at the shell prompt and press Enter to execute the command.
Press Enter to execute the command.Press Ctrl+Alt+F2 to switch to a virtual terminal.
mono-spaced bold. For example:
File-related classes includefilesystemfor file systems,filefor files, anddirfor directories. Each class has its own associated set of permissions.
Choose → → from the main menu bar to launch Mouse Preferences. In the Buttons tab, select the Left-handed mouse check box and click to switch the primary mouse button from the left to the right (making the mouse suitable for use in the left hand).To insert a special character into a gedit file, choose → → from the main menu bar. Next, choose → from the Character Map menu bar, type the name of the character in the Search field and click . The character you sought will be highlighted in the Character Table. Double-click this highlighted character to place it in the Text to copy field and then click the button. Now switch back to your document and choose → from the gedit menu bar.
Mono-spaced Bold Italic or Proportional Bold Italic
To connect to a remote machine using ssh, typessh username@domain.nameat a shell prompt. If the remote machine isexample.comand your username on that machine is john, typessh john@example.com.Themount -o remount file-systemcommand remounts the named file system. For example, to remount the/homefile system, the command ismount -o remount /home.To see the version of a currently installed package, use therpm -q packagecommand. It will return a result as follows:package-version-release.
Publican is a DocBook publishing system.
1.2. Pull-quote Conventions
mono-spaced roman and presented thus:
books Desktop documentation drafts mss photos stuff svn books_tests Desktop1 downloads images notes scripts svgs
mono-spaced roman but add syntax highlighting as follows:
static int kvm_vm_ioctl_deassign_device(struct kvm *kvm,
struct kvm_assigned_pci_dev *assigned_dev)
{
int r = 0;
struct kvm_assigned_dev_kernel *match;
mutex_lock(&kvm->lock);
match = kvm_find_assigned_dev(&kvm->arch.assigned_dev_head,
assigned_dev->assigned_dev_id);
if (!match) {
printk(KERN_INFO "%s: device hasn't been assigned before, "
"so cannot be deassigned\n", __func__);
r = -EINVAL;
goto out;
}
kvm_deassign_device(kvm, match);
kvm_free_assigned_device(kvm, match);
out:
mutex_unlock(&kvm->lock);
return r;
}1.3. Notes and Warnings
Note
Important
Warning
2. Getting Help and Giving Feedback
2.1. Do You Need Help?
- Search or browse through a knowledge base of technical support articles about Red Hat products.
- Submit a support case to Red Hat Global Support Services (GSS).
- Access other product documentation.
2.2. We Need Feedback
Part I. Introduction
Table of Contents
Chapter 1. About the Portal
1.1. Related Links
- Technical documentation
- Other technical documentation, including an Installation Guide, a Development Guide, and an Administration and Configuration Guide can be found at https://access.redhat.com/site/documentation/JBoss_Portal_Platform/
- Non-technical documentation
- Links to non-technical documents are included on the front page of the portal:

1.2. Product Documentation
1.3. Supported Browsers
1.4. Accessibility Statement
Accessibility Features
- Text equivalents
- All decorative images have been brought into styles sheets. All images that are part of the HTML code with semantic meaning have text equivalents. Tool tips feature on actions, links, and buttons.
- Color
- Color is used as a decorative element. Semantic meaning of elements is defined using text descriptions.
- Readability
- All elements have explicit legends to avoid creating ambiguous semantics. Dynamic elements such as administration menus are modified to be compatible with screen reader software.
- Client-side Image Maps
- All image maps have suitable alternative text descriptions.
- Data Table Headers and Associations
- All tables elements have a table summary and column header descriptions to avoid ambiguity for screen readers when interpreting rows and columns.
- Iframe Elements
- All iframe elements have names and descriptions to avoid ambiguity for screen readers when interpreting content inside the element.
- Keyboard Navigation
- Dynamic elements such as administration menus have been modified to be keyboard compatible. All buttons and links can be accessed using TAB and ENTER keys.
- Electronic Forms
- Form elements have label elements attached with semantic descriptions.
- Skip Navigation
- For users with alternative input interface requirements, skip navigation is available. Skip navigation allows alternative input interface devices to bypass repetitive navigation links, such as administration menu links or page menu links, enabling users to navigate and interact to page content easier.
- Time Delay
- Authenticated users can configure the session time expiration, to reduce the need for repeated authentication actions.
Chapter 2. Terminology
2.1. What is a Portal
2.2. What is a Portlet
2.3. What is a Portlet Container
2.4. What is the Toolbar
See Also:
2.5. What are Gadgets
2.6. About Navigations
Portal Navigation Types
- Site
- This navigation links to separate sites of the parent Portal. Each site has only one navigation and it is automatically generated when the site is created.This functionality allows different sites to administer some Portal aspects (such as portlets) individually while maintaining other content standardized with the parent Portal.
- Group
- The content of this navigation differs depending on the type of account logged in.
- If a user account is active, this navigation holds personal links set up by that user.
- When using a management account, this navigation contains links to pages for registered users as well as administrative tasks and personal links.
- In an administrator account the navigation adds further management abilities, such as community and application management.
- Dashboard
- Each user has their own navigation Dashboard that contains links and portlets (or gadgets) that the user has selected. A user's navigation is created automatically when user is registered. This navigation only can be deleted when the user is deleted.
- Dashboard Editor
- The Dashboard Editor navigation appears when a user is on their dashboard page.The user can add multiple dashboard in new tabs and then edit the layout and content of those dashboards.
- Site/Group Editor
- This navigation appears as either Site Editor or Group Editor depending on the administrator's location within the portal.When in areas of the portal displaying content, the navigation shows as Site Editor and in areas pertaining to users the navigation shows as Group Editor.This navigation contains links to add a new pages to the portal, to edit a page or to change the portal's layout. Administrators can use these links to manage the portal.
See Also:
2.7. About Modes
- Public
- This mode is for guest users who are not registered with the Portal. It does not require a log in and restricts the visitor to the public pages in the portal. Visitors can register an account to gain access to the restricted pages. After being registered, they can use the Private mode but must still contact the Portal administrator to get more rights or a group manager to become a member and gain access to a group.
- Private
- This mode is for registered users only. Users set a user name and password during registration which they can then use to sign in. This mode offers users more site privileges. Registered users can manage private resources (creating, editing or deleting private pages), "borrow" pages from other users by creating links, and change the site language to suit their individual preference.
2.8. About Permissions
- Access Permissions
- Edit Permissions
- Move Apps Permissions
- Move Containers Permissions
See Also:
2.8.1. Access Permissions
2.8.2. Edit Permissions
/organization/management/executive-board group, any members of the Executive Board can change the Access and Edit permission of the given page.
Note
2.8.3. Move Apps and Move Containers Permissions
Example 2.1. Use of Move Apps and Move Containers Permission
- Set Move Containers Permissions on the Page and all the Containers in the page to a group. For example, group is
/organization/marketing/content-strategy. - Set Move Apps Permissions on the Page and all the Containers in to page to
Nobody. - Browse to the folder designated for adding applications in the Container hierarchy and set Move Apps Permissions to the group
/organization/marketing/content
/organization/marketing/content group can create pages with the predefined layout and add Applications to the locations designated by the template creator.
2.8.4. Move Apps Permission
- Add an Application as a child to the given Site, Page, or Container.
- Reorder child Applications of the given Site, Page, or Container.
- Remove a child Application from the given Site, Page, or Container.
2.8.5. Move Containers Permission
- Add a Container as a child to the given Site, Page, or Container.
- Reorder child Containers of the given Site, Page, or Container.
- Remove a child Container from the given Site, Page, or Container.
Chapter 3. Elements of the Portal
3.1. Functional Portlets
Default Portlets
- Account Portlet
- The Account Portlet allows users to register a new account and choose a preferred language for the Portal interface.

- Organization Portlet
- The Organization Portlet is used to manage user information, groups of users and groups memberships.

- Application Registry Portlet
- The Application Registry Portlet is used to manage different application categories. You can add, edit, set permissions and delete a category and its applications.

- Start Toolbar Portlet
- The Start Toolbar Portlet allows you to change the default language, the skin of the portal or to sign out.

3.2. Interface Portlets
Default Interface Portlets
- Homepage Portlet
- This Portlet is the home page for a portal. The home page is the first page displayed when you visit the site.
- Banner Portlet
- This Portlet contains the organization's slogan, logo, and icons.
- Navigation Portlet
- This Portlet provides a navigation bar. A navigation bar is a menu that helps users to visualize the structure of a site and provide links to quickly move from page to page.
- Sitemap Portlet
- This Portlet displays a site map page of a web site. It lists pages on a website, typically organized in hierarchical fashion.
- Breadcrumbs Portlet
- This Portlet displays the navigation path the user has taken from the home page to arrive at the current page.
- Dashboard Portlet
- This portlet is used for hosting small applications known as gadgets. The dashboard uses a variety of graphical effects for displaying, opening, and using gadgets.
- IFrame Portlet
- This Portlet is used to create in-line frames (IFrame) elements for a site. An IFrame is an HTML element which can embed another document into a parent HTML document. By using IFrames, embedded data is displayed inside a window within the browser window.
- Gadget Wrapper Portlet
- This Portlet allows users to view a gadget in canvas mode.
- Footer Portlet
- This Portlet provides the footer for a site. This footer provides information or links about the site's author/institutional sponsor, the date of the last revision made to the site, copyright information, comments form, and navigational links.
3.3. The Dashboard

3.4. Using the Dashboard Workspace
- Click in the toolbar to access the Dashboard.
- Click to open the Dashboard Workspace.

Default Gadgets
- Calendar
- The calendar gadget helps track and plan your events and activities.

- Todo
- This application helps you organize your day and work group. It is designed to keep track of your tasks in a convenient and transparent way.

- Calculator
- This application lets you perform most basic arithmetic operations and can be themed to match the rest of your portal.

- RSS Reader
- An RSS reader, or aggregator, collates content from various feed sources and displays them in one location. This content can include, but isn't limited to news headlines, blog posts or email. The RSS Reader gadget displays this content in a single window on your Portal page.

3.5. Add Gadgets
Important
Procedure 3.1. Add Gadgets from External Sources
- Obtain the URL (.xml or .rss) of the gadget you wish to add from the gadget source.The gadgets available from the Google Gadget homepage provide a link to View source. Clicking on this link will open a page showing the gadget's XML source. Use the URL of this page in the Dashboard Workspace, which ends with
.xml. For example, http://www.donalobrien.net/apps/google/currency.xmlNote
Remote gadgets can be only created using an .xml link or RSS URL. If you use a link that generates an RSS feed (for example, http://feeds.feedburner.com/gatein), a new RSS reader gadget is created automatically even if the URL does not end with.rss. - Return to the portal and click in the toolbar.
- Click on in the Dashboard to open the Dashboard Workspace.
- The Dashboard Workspace dialog appears.
- Paste the URL obtained in step 1 into the text box above the gadget list.

- Click the button to add the new gadget to the page.The new gadget will appear on the Dashboard alongside any other gadgets already in use. If required, the new gadget can be dragged to another position on the page.
Chapter 4. Toolbar
4.1. What is the Toolbar
4.2. User Actions in the Toolbar
- User Menu
- You can use the main menu (located under the product icon) to change the language or skin used in the portal or to sign out.
- Site
- The Site navigation function shows the different sites available in this Portal and allows users to directly edit the navigation tree.

- Group
- Using the Group navigation function users can easily see and access pages in the Portal.

- Dashboard
- You can use the Dashboard to create your own pages of gadgets.
The name shown in the image above is the default and can easily be changed when the Dashboard is open.
4.3. Administration Actions in the Toolbar
- Editor
- Portal Administrators have access to another navigation that allows them to:
- Add a new page to the current portal.
- Edit a particular page's properties.
- Change a page's layout.
This navigation appears next to the Dashboard navigation in the Toolbar and is named based on context. It will appear as either Site Editor, Dashboard Editor or Group Editor depending on the user's location within the portal.
Part II. Portal Administration
Table of Contents
- 5. Portals
- 6. Portlets and Gadgets
- 6.1. Import Portlets and Gadgets
- 6.2. Manage Portlets and Gadgets
- 6.3. Display Gadgets
- 6.4. Add a new Category
- 6.5. Edit a Category
- 6.6. Delete a Category
- 6.7. Add Applications to a Category
- 6.8. Set Access Permission on Portlets
- 6.9. View/Edit portlet/gadget information
- 6.10. Add a Gadget
- 6.11. Manage Gadgets
- 6.12. Edit a Gadget
- 7. Gadgets in Portal
- 8. Navigation Nodes
- 9. Pages
Chapter 5. Portals
5.1. Create a New Portal
- Click on Site in the toolbar, then click the Add New Portal button.
- This opens the Create New Portal window. Initially, the Portal Setting tab will be selected. On this tab, specify the following properties of the portal:
- Portal Name
- Enter the name of the new portal. This field is required and the value must be unique. The name must be between 3 and 30 characters and must begin with an alphabetical character or an underscore. Only alphabetical, numerical, dash and underscore characters are allowed.
- Label
- Enter a Label for the new portal. This field is optional.
- Description
- Enter a description of the portal. This field is optional.
- Locale
- Select the default display language for the portal.
- Skin
- Select a skin for a portal.
- Switch to the Properties tab and choose values of the following properties:
- Keep session alive
- This property determines session timeout behavior. Choose one of the following values:
- Never - The session will never timeout, even if an application requests it.
- On-demand - The session will timeout if an application requests it.
- Always - The session will time out after a set period.
- Show info bar by default
- If checked, portlets added to a page will show an information bar containing their name, a help drop-down menu and minimize/maximize buttons.
- Switch to the Permission Setting tab and set the permissions for the portal. Two types of permissions need to be set for a new portal; Access Permission and Edit Permission.
- Access Permission can be set to allow global access by checking the Make it Public box. Alternatively, specific permission for groups can be added by clicking Add Permission, then selecting a group in the left pane of the box and then a membership level in the right pane.
- Edit Permission requires specific permissions to be set. Click on Select Permission and choose a group and level as above.
- To use a template for your portal, switch to the Portal Templates tab. This tab lets you choose a template for the new portal from templates that are saved in the installation.
- Click Save to create the portal.
See Also:
5.2. Access a Portal

5.3. Edit Portal Layout


Note
- Red Hat JBoss Developer Studio JBoss Portlet Tools User Guide.
- Red Hat JBoss Portal Development Guide (Portlet Development part).
5.4. Edit Portal Navigation
5.5. Edit Portal Properties
5.6. Delete a Portal
- To delete a portal click on the Delete icon beside the portal you no longer require.The confirmation message will appear:
- Click OK
5.7. Change Portal Skins
- Method One
- Click on Site, then Edit Portal's Config.
- In the Portal Setting tab, select another skin Skin list
- Click Save to Finish.
- Method Two
- Mouse over the Start menu and click on Change Skin.
- Select a new skin from the Skin list. By clicking on the skin name a picture will appear in the preview pane.
- Click Apply to apply to the portal.
5.8. Switch Between Portals
5.9. Manage Services
org.exoplatform.portal.application.PortalStatistic classname. Adapt the procedures in these tasks to interact with other methods and properties for other portal classes available in the Services Management interface.
Task: Call a Method in the Services Management Interface.
- Click ++
- In the Services drop-down, select to display the available methods, including
getMaxTime. - In the Parameters column, type the name of the portal to query. For example, to perform the query using the default portal, type
classic. - In the Action column, click to display the execution time in the value group, underneath the Method table.
Task: Call a Property in the Services Management Interface.
- Click ++
- In the Services drop-down, select to display the available methods on the Methods tab.
- Click the Properties tab to display all available properties for the service.
- In the Action column, click to display the name of all known portals, underneath the Properties table.
Chapter 6. Portlets and Gadgets
- 6.1. Import Portlets and Gadgets
- 6.2. Manage Portlets and Gadgets
- 6.3. Display Gadgets
- 6.4. Add a new Category
- 6.5. Edit a Category
- 6.6. Delete a Category
- 6.7. Add Applications to a Category
- 6.8. Set Access Permission on Portlets
- 6.9. View/Edit portlet/gadget information
- 6.10. Add a Gadget
- 6.11. Manage Gadgets
- 6.12. Edit a Gadget
6.1. Import Portlets and Gadgets
Note
- In the Group menu, select Administration then Application Registry:
- Click Import Applications on the right hand side. A confirmation message will appear.
- Click OK to accept.
6.2. Manage Portlets and Gadgets
Important
6.3. Display Gadgets
- Go to the Dashboard (by clicking Dashboard in the Toolbar)
- Hover over Dashboard Editor and click Edit Page in the drop-down menu.
- The Page editor will appear.
- Hover over the Dashboard Portlet and click on the Edit icon (the 'pencil').

- Change the number of columns in the Number of columns field. The maximum number of columns is four (4).
- Click the Save button to accept the change.
- Click Close and then click Finish.
6.4. Add a new Category
- Hover over the Group menu, then Administration and click on Application Registry.
- Click the Add Category button on the action bar:The Category Setting tab: includes common information about a category.
- Category name
- The name of the category. This field is required and its length must be between 3 and 30 characters. Only alpha, digit, dash and underscore characters are allowed.
- 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.
The Permission Setting tab provides access to the Permission manager.The permission criteria are used whenever a user creates or modifies a page. In that case the user can only see and use portlets in those categories on which he or she has access to (as defined by groups and memberships).
6.5. Edit a Category
- Click the Edit icon located next to the title bar.
- Update the category information.
- Click the Save button to apply changes.
6.6. Delete a Category
- Click the Trash can icon located next to the title bar.
- Accept the deletion by clicking OK
6.7. Add Applications to a Category
- Click the "Plus" icon located next to the category (in the list on the left) to which you want to add an application.The image below shows the available application. You will see this list when you click the "Plus" icon.

- Display name
- The display name of a portlet/gadget.
- Application Type
- Either Portlet, Gadget or WSRP application.
- Enter the display name and select a type
- Select an application by checking the radio button. Note that there several pages of Portlet applications to choose from and that the content of the list changes when you select a different type of application from the Application Type drop-down menu.
- Click the Save button to add the selected application to the category.
6.8. Set Access Permission on Portlets
- In the Group menu, select Administration and then Application Registry.
- Select a category in the Category pane that includes the portlet you want to set permissions on. All portlets of that category will be listed underneath.
- To set permission for a portlet:
- Click the Add Permission button to add access permissions to more groups.
- Or check Make it public to allow everyone to access.
Whenever the user creates or modifies a page, he or she can only see and use gadgets/portlets that fulfill two conditions: the portlet is in a category which the user has access permission too and the user has access permission on the portlet
6.9. View/Edit portlet/gadget information
- Left pane
- All portlets and gadgets grouped by categories
- Right pane
- shows detail information about a portlet: Name, Display name, Description and Portlet preferences.
6.10. Add a Gadget
Procedure 6.1. Add a Remote Gadget
- Click on Add a remote gadget:

- Enter the url of the remote gadget in the URL field.
- Click Add. The new remote gadget is visible in gadget list on the left pane.
Procedure 6.2. Create a new Gadget
- Click on Create a new gadget:
- Enter the xml code of the new gadget in the
Sourcefield.
6.11. Manage Gadgets
6.12. Edit a Gadget

Chapter 7. Gadgets in Portal
Default Gadgets
- Calender
- The calendar gadget allows you to switch between daily, monthly and yearly views. You can customize the gadget to match your portal theme.
- ToDo
- ToDo helps you to organize your day and work group. It is designed to keep track of your tasks in a convenient and transparent way. Tasks can be highlighted using different colors.
- Calculator
- Calculator lets you perform basic arithmetic operations and can be customized to match your portal theme.
- RSS Reader
- RSS Reader collects content from various user feed sources and displays them in one location. This content includes, news headlines, blog posts or email. The RSS Reader gadget displays the content in a window on your portal page.
Note
Chapter 8. Navigation Nodes
8.1. Manage Navigation Nodes
8.2. Add a new node
- Click on Site then click on Edit Navigation of the portal to modify.
- Select a node from list (to create a new node like sub-node of the selected node) or click the Up icon to create a new node at the root level of the portal.
- Right-click on the selected navigation or node and select Add Node option. The ADD/EDIT PAGE NODE form appears:The Page Node Setting tab includes:
- Uri
- An identification of the node. The Uri is automatically created after adding a new node
- Node name
- The name of the node. This field is required and must be unique. Only alpha, digit, dash and underscore characters are allowed for this field and it must be between 3 and 30 characters.
- Extended label mode
- This is a new feature which allows Administrators to add labels to nodes in multiple supported languages. When the language of the site is changed, the nodes will display the appropriate localized label.
- Language
- Set the language for the node.
- Label
- The display name of the node on the screen. This field is not required and may be changed. This field must have a length between 3 and 120 characters.
- Visible
- This check box allows administrators to hide (and show) the page and its node at the navigation bar, the page navigation and the site map
- Publication date & time
- This option allows publishing this node for a period of time. Start Publication Date and End Publication Date only appear when this option is selected.
- Start Publication Date
- The start date and time to publish the node.
- End Publication Date
- The end date and time to publish the node.
In the Page Selector tab, you can select a page or not for this node.- Page Id
- The identification string of the page.
- Name
- The selected page's name.
- Title
- The selected page's title.
You do not have to enter values in these fields. They are automatically populated after selecting an existing page by clicking the Search and Select Page button.The Select Page form appears:This window lists all existing pages of Portal or Group with basic information for each page.To select a page for creating a node, select a page from the list or search for a specific page as follows:- Enter your page title into the Title field to do search to Title;
Or, enter the site name into the Site Name field to do search to the page's site name;Or, enter values into both fields to further limit your search results by both Title and Site Name. - Select the area in which you wish to search into the Type field.
- Click
to perform your search. All pages matching your search criteria will be listed.
- Click
on the row of the page you wish to select.
8.3. Edit a node
- Click +.
- Right-click on the selected node and select the optionEdit this Node.It displays the Page Node Setting tab.

- In the Page Node Setting tab you can change the value of these fields:
- Extended label node
- Language
- Label
- Visible
- Publication Date & time
- After making the desired changes, click to accept changes or to exit without saving.
- In the Page Selector tab you can search and select another page for this node by clicking the button.After completing the edits required for this node, click to accept the changes or to exit without saving.
See Also:
8.4. Copy a node
- Click on Site then click on Edit Navigation of the portal you want to modify.
- Right-click on the selected node and select Copy node option.
- Select the position that you want to paste this node and select Paste Node option.
8.5. Clone nodes
- Click on Site then click on Edit Navigation of the portal you want to modify.
- Right-click on selected node and select Clone node option.
- Select the position that you want to paste this node and select Paste Node option.
8.6. Cut a node
- Click on Site then click on Edit Navigation of the portal you want to modify.
- Right-click on the selected node and select Cut node option.
- Select the position that you want to paste this node and select Paste Node option. mark icon to Save.
8.7. Delete a node
- Click on Site then click on Edit Navigation of the portal you want to modify.
- Right-click on the selected node and select Delete node option.It will display an alert message confirming the removal of the node. Click the OK button to accept the deletion or Cancel button to quit without deleting the node.
8.8. Change Node Order
- Click on Site then click on Edit Navigation of the portal you want to modify.
- Select the node that you want to move. Right click on the selected node and then click on Move up or Move down
- The selected node will be moved up or down within the list.
Chapter 9. Pages
9.1. Add a New Page using the Page Creation Wizard

- Mouse over then select .
- Complete the fields in the right pane, using Page Parameter Definitions as a guide.
- Click or number '2' of the wizard steps to proceed to the next step.
- Select for a blank page.Alternatively, click the drop down arrow at the top of the right pane to see more templates to select.
- Click or number '3' of the wizard step to proceed to the next step.
- Drag and drop portlets from the pop-up panel into the main pane to create the content for the page.
- Applications
- Lists all existing portlets
- Containers
- Lists all existing containers
- View Page properties
- Shows various page settings (title, Page ID and more) and/or page permissions, which can be changed to suit the page.
Note
While in this view, click the Switch View mode button to view the content of this page as you design it.Switch between viewing the page by layout (showing containers and portlets) or previewing how the page will look when live. The contents of the page can be edited in either mode. - Once page configuration is complete, use the icons located in the top right corner of the Page Editor window to navigate as required:
- Click (the small left-facing arrow) to return the previous step.
- Click to create the page.
- Click to quit the page creation wizard, without saving any changes.
Page Parameter Definitions
- Current Selected Page Node
- The path of the selected node to add a new sub page
- Node Name
- The node name of the added page. It is required field. This field must start with a character and must have a length between 3 and 30 characters.
- Extended label mode
- This is a new feature which allows Administrators to add labels to pages in multiple supported languages. When the language of the site is changed, the pages will display the appropriate localized label.
- Language
- Set the language for the page.
- Display Name
- The display name of the node which contains the added page and must have a length between 3 and 30 characters.
- Visible
- This check box toggles the global visibility of this page.If checked, the page or the page node appears on the navigation bar, the page navigation and the site map. Page visibility depends on the "publication date & time" attribute.If unchecked, the page is not shown in the site map or navigation bar.
Important
The Visible check box must not be used as a security measure, as non-visible pages will still be accessible using a direct URL, such as http://localhost:8080/portal/private/classic/pagename.Instead, use the option to prevent direct URL access to a page. - Publication date & time
- This option allows publishing the page for a period of time. If this option is checked the visibility of the page depends on the publication period start and end date.
Important
The Publication Date & Time functionality must not be used as a security measure, as pages configured for time-specific publication will always be accessible using a direct URL regardless of publication dates. - Start Publication Date
- The start date and time to publish the page. This field is only visible if the Publication date & time box is checked.
- End Publication Date
- The end date and time to publish the page. This field is only visible if the Publication date & time box is checked.
Note
You can set date and time by clicking the Start Publication Date field and End Publication Date field and select a date in the calendar pop up. - Hide page when outside publishing window
- If a user accesses this page directly through a URL either before the Start Publication Date or after the End Publication Date, the user is redirected to the parent node. Additionally, an information message is displayed indicating the page is not available yet, or has expired.
9.2. Add a New Page using Page Management
- Mouse over Group in the Toolbar, highlight Administration then select Page Management.
- Click on Add New Page.
- The fields in this window are:
- Page Id
- A string that identifies the page. It is automatically generated when you finish creating the page.
- Owner type
- If the page Owner type is set to portal the page is created with shared ownership portal. Therefore users who have edit permissions on the portal level can edit this page type.If the page Owner type is group the page is created for a group. Therefore users who have manager permissions for that group can edit this page type.
- Owner Id
- The name of the current portal is automatically selected for Owner id ensuring the edit permissions are assigned to users who can edit the current portal.When the owner type is set to group, a list of groups will allow you to select one user as the 'owner'.
- Page Name
- The name of the page. This is a required field and must be unique. Only alphabetical, numerical, dash and underscore characters are allowed to be used for this field and the name must be at least 3 and no more than 30 characters in length.
- Page title
- The title of the page. This is an optional field. If you choose to add a title to the page it must be at least 3 and no more than 120 characters in length.
- Show Max Window
- The option allows users to choose whether the page is shown at maximum size or not.
- Click Save.
9.3. Edit a Page
- Click ++.
- Click the edit icon on the row of page to edit in the existing page list.Click View Page properties icon to show a form to edit page properties.
- The properties presented in the Page Properties window are Page ID, Owner type, Owner Id and so on.
- Permission Setting
- Permission on each page is set in two levels: Access right and Edit right.
- Access right
- Access right can be set to specific user groups or set to everyone (this includes unregistered users).Current access permissions on page are listed in Access Permission Setting tab and you can remove permissions (by clicking the delete icon) or add further permission (by clicking the Add Permission button).Populating the Make it public check box will allow all users (registered or unregistered) to access the page.
- Edit right
- The Edit right allows users to change information on a page. Edit right is set for a group of users only.Edit right can be set for one specific membership type within a particular group (* allows every membership type in a group).To reassign this right to another group, click Select Permission in the Edit Permission Setting tab to choose another one.
9.4. Delete a Page
- Mouse over Group in the Toolbar. Highlight Administration and then click on Page Management. You will be presented with a list of all existing pages.
- Click the trash can icon in the row of the page you want to delete. It will display the confirmation message.
- Click the OK button to complete the deletion or Cancel button to quit without deleting the page.
9.5. Drag and Drop the Page Body
- From the toolbar, click → .
- Click on the Portal Page, and drag and drop content as required.
Part III. Site Administration
Table of Contents
- 10. Language
- 10.1. Change Interface Language
- 10.2. Language for a user
- 10.3. Set language for a user
- 10.4. Right To Left Support
- 10.5. Multi-Language Navigation Nodes
- 10.6. Key Format
- 10.7. Creating Keys
- 10.8. Creating Keys using Create Page Wizard
- 10.9. Creating Keys using Navigation Management
- 10.10. Providing translation
- 11. Permissions
- 11.1. Manage Permissions
- 11.2. Set Site Permissions
- 11.3. Set Access Permissions on a Site
- 11.4. Set Edit Permissions on a Site
- 11.5. Set Page Permission
- 11.6. Set Access Permissions on a Page
- 11.7. Set Edit Permissions on a Page
- 11.8. Set Access Permission on a Category
- 11.9. Set Access Permission on a Portlet
- 12. Site Redirection
- 13. Mobile and Responsive Portal Site
Chapter 10. Language
- 10.1. Change Interface Language
- 10.2. Language for a user
- 10.3. Set language for a user
- 10.4. Right To Left Support
- 10.5. Multi-Language Navigation Nodes
- 10.6. Key Format
- 10.7. Creating Keys
- 10.8. Creating Keys using Create Page Wizard
- 10.9. Creating Keys using Navigation Management
- 10.10. Providing translation
10.1. Change Interface Language
- User's language
- Browser's language
- Portal's language
10.2. Language for a user
- Open up the Start menu and click on Change Language :
- The Interface Language Setting window lists all available languages installed in the Portal:

- Click on the desired language. The associated native word is highlighted.
- Click Apply to save your change. The site refreshes and displays its attributes in the selected language.
10.3. Set language for a user
- Public Mode
- The interface language is dictated by the language setting of the web browser.If the language is set to one that the portal does not support, the language displayed is the language set at the Portal level (see above).
- Private Mode
- The interface language is set when registering each user.
See Also:
10.5. Multi-Language Navigation Nodes
Note
10.6. Key Format
10.7. Creating Keys
- Use the method described in Section 10.8, “Creating Keys using Create Page Wizard”
- Use the methods described in Section 10.9, “Creating Keys using Navigation Management”
10.8. Creating Keys using Create Page Wizard
- Open the Site Editor menu and pick Add New Page.
- Enter a name for this new page
- Enter a resource key in the Display Name field.

- Click Next. On the next screen you may define a page layout out of existing templates.
- Click Next to finalize the page creation with portlets for instance.
10.9. Creating Keys using Navigation Management
- Click on Site in the Toolbar then Edit Navigation
- Click on Add Node
- The Create/Edit node dialog appears. Enter a resource key in the Label field
Reusing Keys
10.10. Providing translation
/jboss-as/server/<PROFILE>/deploy/gatein.ear/02portal.war/WEB-INF/classes/locale/navigation/portal/<PORTAL_NAME>_<LANGUAGE_CODE>.properties
Chapter 11. Permissions
- 11.1. Manage Permissions
- 11.2. Set Site Permissions
- 11.3. Set Access Permissions on a Site
- 11.4. Set Edit Permissions on a Site
- 11.5. Set Page Permission
- 11.6. Set Access Permissions on a Page
- 11.7. Set Edit Permissions on a Page
- 11.8. Set Access Permission on a Category
- 11.9. Set Access Permission on a Portlet
11.1. Manage Permissions
See Also:
11.2. Set Site Permissions
- New Site
- Click on on the Toolbar , then click on → tab.
- Existing Site
- Click on on the Toolbar, then click on → tab.
11.3. Set Access Permissions on a Site

- Click .
- On the Select Permission dialogue box, choose the appropriate group and membership options.

- After selecting a membership type, the selected permission is displayed in the access permission list.
11.4. Set Edit Permissions on a Site
- Click tab.
- Click to choose a group.
- Select a group and a membership type from the left and right panes, respectively, of the Select Permission dialog box.
Note
You can select * to assign all available membership types to the selected group.
11.5. Set Page Permission
- User
- If the owner type of a page is user then only the creator of the Page has Access or Edit Permissions.
- Group
- If the owner type of a page is group, initial permissions on page are:
- Access permission: everyone in that group.
- Edit permission: the manager of that group.
- Portal
- If the owner type of a page is portal, initial permissions are:
- Access permission: users who can access that portal.
- Edit permission: users who can edit that portal.
11.6. Set Access Permissions on a Page
- Open the Page. Select Site Editor on the Toolbar and select Edit Page.
- Click View Page Properties in the Page Editor dialog box.
- Click the Permissions tab.
11.7. Set Edit Permissions on a Page
Procedure 11.1. Edit Page
- Mouse over Site Editor on the Toolbar and select Edit Page.
- Click on View Page Properties in the Page Editor.
- Click the Permissions tab.
Procedure 11.2. Page Management
- Mouse over Group on the Toolbar, highlight Administration and click on Page Management.
- Using the Page Id column, locate the page to be edited, then click the edit icon (next to the trash icon). The Page Editor dialog box opens.
- Click on View Page Properties in the Page Editor.
- Click on the Permissions tab to edit all types of permissions.
Note
11.8. Set Access Permission on a Category
- Mouse over Group on the Toolbar, highlight Administration then click on Application Registry.
- In the list of categories available in the left pane, click the edit icon, then choose the Permission Setting tab.

11.9. Set Access Permission on a Portlet
- Select Group on the Toolbar. Highlight the Administration entry and click on Application Registry.

- Select a category on the left pane that includes the portlet to set rights for. The Access Permissions panel opens.
Chapter 12. Site Redirection
12.1. Site Redirection
12.2. About Site Redirection
- The user agent string of the browser accessing the site
- Any property which can be determined via javascript. This can include things like screen size, pixel density and if the device supports touch or not.
12.3. Manage Site Redirections
Procedure 12.1. Manage Site Redirection
- Navigate to → → .
- Select the site for which a new Site Redirect rule is to be created. The Sites screen lists the site types as classic and mobile.
- Existing Site Redirects listing will be shown, along with the button. Click the to add a new one or click the (wrench icon) to configure an existing one.
- Once a Redirect is created, a name must be given and selected the site where it will redirect to, based on the conditions to be configured. There is also a toggle indicating whether the redirect is currently enabled (ON) or disabled (OFF). By default it will be disabled on creation.
- Click → to define the conditions which will trigger the redirect.
- In the conditions modal, a name must be given to the Condition (a default name is created).
- In the User Agent String section valid Java regular expressions must be used in the Contains and Does not contain entries, which will be evaluated against the browser User Agent string. New conditions can be added (which will be overwritten with existing ones) by clicking the button (plus sign icon) and existing ones may be removed by clicking the button (trash icon).
- Predefined properties can be added to assist on condition matching, by clicking the button. Different operators are available for defining these properties.
- Click to create or update the condition or to revert the creation or changes.
- Conditions can be sorted (for performance reasons, having the less expensive ones on top, for instance) by dragging the condition row and dropping in the desired position.
- Configure Node Mappings maps landing site nodes to redirected site nodes. By default this functionality is enabled, to change select Use node name matching.
- Click to add a new node mapping. Existing Node Mappings can be deleted by clicking the .
- Nodes can be selected by clicking the both for the Origin and for the Redirect sites.
- Select a default action for unresolved nodes from the drop-down menu.
- Click to create (or update) the Site Redirect or button to cancel all the changes.
- Redirects can be sorted (for fine-graining purposes, such as having a mobile and a touch site redirect, for instance) by dragging and dropping in the desired position.
- Redirects can be deleted by clicking the button (icon trash) and confirming or canceling in the confirmation modal, as desired.
Administrator Credentials Required
Chapter 13. Mobile and Responsive Portal Site
13.1. Creating a Responsive Site
13.2. Portal Skin
13.3. Viewport
13.4. Mobile Template
13.5. Responsive Portlets
13.6. Portlet Layout
13.7. Creating Responsive Portlets
13.8. Manually Removing the Mobile Site
13.9. Deleting the Mobile Site and Configuration
Part IV. Accounts, Memberships, Groups, and Users
Table of Contents
Chapter 14. Accounts
14.1. Register New Accounts
Procedure 14.1. Registering a New User Account
- Click on the Navigation bar to open the Register New Account page.Complete the form with the required information:
- User Name
- The name used to log in. This user name must be between 3 and 30 characters long, start with a lowercase letter and end with a lowercase letter or digit. Only lowercase letters, numbers, periods, and underscore characters are allowed in a user name. Click the magnifying glass icon beside the user name to verify whether the user name is available.
- Password
- The password must be between 6 and 30 characters and can contain spaces.
- Confirm Password
- Re-type the password above. The Password and Confirm Password fields must be the same.
- First Name
- The user's first name. This name must be between 1 and 45 characters long.
- Last Name
- The user's last name. This name must also be between 1 and 45 characters long.
- Display Name
- The user's name displayed in portal screens when the user is logged in. The field is optional and if no value is entered, a value in the [First Name] [Last Name] format is used automatically.
- Email Address
- The user's email address. This must be in the appropriate format. For example,
username@company.com.
- Enter the text displayed at
Text Validationinto the empty field below it.Note
This field can be disabled by an administrator. See Section 14.2, “Captcha Behavior” for more information. - Click to register a new account or to remove entered values. The following field validation checks will prevent you from creating an account:
- The chosen user name already exists or is invalid.
- The user name contains less than 3 characters or more than 30 characters.
- The password contains less than 6 characters or more than 30 characters.
- The Password and Confirm Password fields do not contain identical values.
- The Email Address format is invalid.
- The text verification text entered does not match the sample.
- Fields marked as "required" are left unpopulated.
Note
14.2. Captcha Behavior
Task: Disable "Register New Account" Captcha Behavior
- Click ++.
- Click the icon in the Action column for the portal::classic::register Page ID.
- Click on the Register Account portlet, and then click the Edit Portal icon (pencil icon) to open portlet properties.
Note
Click the button in the Page Editor control to switch between WYSIWYG and Object mode. - Click the Edit Mode tab (if not already selected), and clear the Use captcha box to disable Captcha verification for new users.
- Click , and then click to commit the changes.
- In the Page Editor control, click to refresh the portlet.
- The Register New Account portlet will no longer display the Captcha field.
14.3. Sign In and Sign Out
- User name
- The registered user name.
- Password
- The registered password.
- Remember My Login
- Click this box to authenticate automatically each time.
- Forgot your User Name/Password?
- Initiates the process to retrieve a forgotten user name or password.
- Sign in
- Sign into the portal with a user name and password.
- Discard
- Close the Sign In form without logging in.
14.4. Sign In
- Open the portal by entering the URL into the browser address bar. For example,
http://localhost:8080/portal. - Click the link at the top right of the page if you are current in the Classic portal. The Sign In form appears.
- Type a valid user name and password into the correct fields.
- Select the Remember My Login check box to automatically return to the portal without signing in again.
- Click the button to submit the form or to escape.
See Also:
14.5. Sign Out
- In the upper left corner of the screen, hover your cursor over the Red Hat logo. A drop down menu will appear.
- Click Sign out.
14.6. Remember User Account

- Input your registered user name and password.
- Select the Remember My Login check box when logging into the portal at the first time.
- Click the Sign in button to sign in the portal.
14.7. Change Account Settings


- Select the Account Profiles tab.
- Your User Name cannot be changed. You can change your: First Name , Last Name, Display Name and Email.
- Once the desired changes have been made, click the Save button to submit them.
- Select the Change Password tab, it will display the following form.
- Input your current password to identify that you are the owner of this account.
- Input your new password, it must have at least 6 characters
- Reenter your password in the Confirm New Password field.
- Click the Save button to accept changes.
14.8. Account and Password Retrieval
- Click the link 'Forgot your User Name/Password?'
- The next screen offers two options:
- Forgot my password.
- Forgot my username.
Select the appropriate option and click . - You will be prompted to provide identification information depending on which option you selected:
- If you selected the Forgot my password option you will be prompted for your user name.
- If you selected Forgot my username you will be prompted for your email address.
Important
configuration.properties file.
Chapter 15. Memberships
15.1. Manage memberships

15.2. Add a new membership type
- In the Add/Edit Membership form, enter the values for the membership name field (required) and the description field (optional). Only letters, digits, dots, dashes and underscores are allowed for the membership name and it must be between 3 and 30 characters.
- Click the Save
15.3. Edit a membership type
- Click the edit icon in the Action column.
- Make the desired changes to the description.
- Click Save
Chapter 16. Groups
16.1. Manage groups

16.2. Add a New Group
- First choose where in the existing group structure you want the new group to be created. You may navigate up the tree by clicking on the green vertical little arrow at the top of the tree. The current path is displayed in the path bar.
- Click Add New Group.
- Group Name
- The name of the new group. This field is required and any length from 3 to 30 characters is allowed. Once saved this name cannot be edited.
- Label
- The display name of the group. Any length from 3 to 30 characters is allowed.
- Description
- A description of the group. Any length from 0 to 255 characters is allowed.
- Fill in the required fields. Only letters, numbers, dash and underscore characters are allowed for the Group Name field. The name must be unique within the portal.
- Click Save
16.3. Edit a group
- Find the group in the existing tree and click on the label
- Click the edit icon to display the Edit Selected Group window.
- Make the desired changes in the appropriate fields. You can not change the Group Name, however you may change to the Label field. You are also able to edit the Description field.
- Click Save
16.4. Add a new user to a group
- Find the group in the existing tree and click on its label. Existing group memberships are listed on the right hand side along with the Add Member window.

- Click on the magnify glass to open up the User selector.Select the check box next to the user name and then click
- Select the membership appropriate for this user. If the desired membership does not appear, click on the refresh icon to get the latest list.
- Click
See Also:
16.5. Edit the user membership in a group
- Click the edit icon in the Action column.
- Select another membership.
- Click Save.
Chapter 17. Users
17.1. Manage Users and Groups
17.2. Roles
Core Portal Memberships
- Member
- Manager
- Validator
Table 17.1. Role Attributes of Example Users
| User | Roles |
|---|---|
| root | manager:/platform/administrators,member:/platform/users,member:/organization/management/executive-board |
| john | member:/platform/administrators,member:/platform/users,manager:/organization/management/executive-board |
| mary | member:/platform/users |
| demo | member:/platform/guests,member:/platform/users |
Roles
- manager:/platform/administrators
- This role is for users to have access and edit administrators pages. Examples are the New Account, Community Management, Registry, Page Management, New Staff, Organization Management and WSRP Admin pages.
- member:/platform/administrators
- This role is similar to the manager role above. The main difference is that it does not have access to the administrators pages, but can access and edit everything that falls under the
*:/platform/administratorspages. - *:/platform/administrators
- This role has edit permissions for everything. This includes; the Home Page, Group Navigation, Portal Navigation, Register and Site Map (in the classic portal). This membership also has permission to create and manage portals and has full permission with group navigation.
- member:/platform/users
- This role allows standard users to log in.
- *:/platform/users
- This role has access to portal toolbars, dashboard, default gadgets (todo, rss, calculator and calendar) and basic portlets (sitemap and iframe). In general it can access but cannot edit these areas.
- member:/organization/management/executive-board
- This role can edit New Staff and Organization Management pages.
- member:/platform/guests
- Members of this role can access the Register and Site Map pages.
- *:/platform/web-contributors
- This role can edit the Contact Us page, has taxonomies permission to read, add nodes, set and remove properties in acme, classic and events and is the newsletter marketing moderator, general moderator and subscription redactor. They have access to the
ManageDrivePluginfor Collaboration and Events. This role also has access to toolbars. - *:/platform/administrators
- This role grants access to the edit mode drop-down in toolbar visible (
WCMAdminToolbarPortlet) - validator:*
- This role is not used. It can be removed if it is present in your instance.
Mandatory groups (groups that can not be deleted)
- /platform/administrators
- /platform/users
- /platform/guests
Mandatory membership types (Membership type that can not be deleted)
- member
17.3. Manage users

17.4. Add a user
- Mouse over Group in the Toolbar.
- Highlight Organization and then click on New Staff.The New Staff window will open:This window has two tabs; Account Setting and User Profile.
- To create a new user, all fields on the Account Settings tab that are marked with an asterisk must be filled in. The Display Name field is optional and when left blank, a value in format <First Name> <Last Name> is used.Further information about the user (such as nickname and birthday) can be added in the User Profile tab. This information is not required for the creation of the account.
- Click either Save or Reset to create or discard the new account.
17.5. Search for users
- Mouse over Group in the Toolbar. Highlight Organization and select Users and Groups Management.
- Select the information type (name, email, etc) to search against
- Type in a partial/full string which identifies the user record being searched. The * character can be used as a wild-card.
- Click the magnifying glass icon to begin the search.
17.6. Edit a user
- Locate the user you wish to edit.
- Click the edit icon (next to the trash icon).
- Select the Account Info tab to edit the main user information set including first name, last name or email address.
- User Name
- The User Name field cannot be changed. Other fields — First Name, Last Name, Display Name and Email Address — can be changed.
- Change Password
- The Change Password option allows an administrator to set a new password for a user. When the Change Password option is unchecked, New Password and Confirm Password are hidden. Passwords must contain between 6 and 30 characters.
- Select the User Profile tab to edit additional information about the user's profile such as the birthdate or the job title as well as some home and business metadata. You may also switch the default display language for that user.
- Select the User Membership tab to see a user's group membership information.
- User Membership
- The User Membership tab displays which group(s) the selected user belongs to. In the above figure, the user "demo" is a member of two groups: "guests" and "users". The parent group of both is "platform".To remove the user from a group, click the trash can icon.
- Click the Save.
17.7. Delete a user
- Locate the user you wish to deleteClick the trash icon in the Action column
- Click OK to confirm.









