JBoss.orgCommunity Documentation
GateIn
This is a very rough documentation issued from the merge, content still has to be validated, we still hope that it can help the beta testers. Thanks !
- 1. Introduction
- 2. Terms GateIn 3.0
- 3. Portlets
- 4. Accounts
- 5. Portal Administration
- 5.1. Toolbar
- 5.2. User management
- 5.2.1. Manage users
- 5.2.2. Search a user
- 5.2.3. Edit a user
- 5.2.4. Delete a user
- 5.2.5. Manage groups
- 5.2.6. Add a New Group
- 5.2.7. Edit a group
- 5.2.8. Add a new user to a group
- 5.2.9. Edit the user membership in a group
- 5.2.10. Delete a group
- 5.2.11. Manage memberships
- 5.2.12. Add a new membership type
- 5.2.13. Edit a membership type
- 5.2.14. Delete a membership type
- 5.3. Manage Permissions
- 5.4. Change Portal Skins
- 5.5. Manage Navigation Nodes
- 5.6. Change Node Order
- 5.7. Manage Pages
- 5.8. Page Creation Wizard
- 5.9. Drag and Drop the Page Body
- 5.10. Create a New Portal
- 5.11. Manage Portals
- 5.12. Switching between Portals
- 6. Language administration
- 7. Portlets and Gadgets Administration
- 7.1. Import Portlets and Gadgets
- 7.2. Manage Portlets and Gadgets
- 7.2.1. Display Gadgets
- 7.2.2. Add a new Category
- 7.2.3. Edit a Category
- 7.2.4. Delete a Category
- 7.2.5. Add Portlets/Gadgets to the specific Category
- 7.2.6. Set Access Permission on Portlets
- 7.2.7. View detail information of the specific Portlets
- 7.2.8. Add a Gadget
- 7.2.9. Add a new Gadget to the Dashboard Portlet
- 7.2.10. Manage Gadgets
GateIn 3.0 is a merge of two mature projects; JBoss Portal and eXo Portal. It takes the best of both offerings and incorporates them into a single new project. The aim is to provide an intuitive portal for as-is use and a framework to build upon depending on your needs.
This book explains various apsects of GateIn 3.0, such as managing users and access permissions, using portlets and changing simple interface features such as skins, langauage and page orientation.
Refer to the GateIn 3.0 Installation Guide for information on downloading and installing the product or see the GateIn 3.0 Reference Guide for information on more advances topics.
GateIn 3.0 is the community project that GateIn 3.0 is based on. GateIn project homepage. http://www.gatein.org
GateIn downloads: www.jboss.org/gatein/downloads.html
Further documentation about the Red Hat GateIn 3.0 and other Red Hat products can be found at www.redhat.com/docs
GateIn 3.0 is a web-based application that provides users with personalized User Interface (UI). This interface allows users to easily search applications or information or communicating with other users.
The Portal provides a graphical aggregation of enterprise content and business applications with flexible management and personalization options.
A portlet is a small, self-contained web application. Portlet interface components are managed and displayed within a Portal. Typically, a portal page is displayed as a collection of non-overlapping portlet windows, with each portlet window displaying a different portlet. Hence a portlet (or collection of portlets) resembles a web-based application hosted in a portal.
Portlets can be configured to generated differing content and GateIn 3.0 has a number of default portlets that can be plugged into any portal.
This bar contains all user and administration actions. It helps users and the administrator access and perform actions easily, quickly and effectively. You can see the toolbar below as it appears in the Portal:
In this image you can see the three Navigations referred to in Section 2.4, “Navigation” as well as the main Menu button (on the far left of the toolbar) and the name of the current user (on the far right).
In this example the current user is the site administrator, hence the extra "Site Editor" menu.
Portal navigations are menus that list hyperlinks to other parts of a Portal. They can help users to visualize the structure of a site. The default navigation menus in GateIn 3.0 are located in a bar across the top of the 'Home' page.
There are three navigation types.
- Site
This navigation links to separate sites of the main Portal. Each site has only one navigation and it is automatically created when the site is created. This functionality allows different sites to administer some Portal aspects individually, such as portlets, while maintaining other content standardized with the parent Portal.
- Group
The content of this navigation differs depending on the type of account logged in. For user accounts the Groups navigation holds personal links set up by the user. For management accounts, it keeps the links to pages for registered Portal users as well as administrative tasks and personal links. In the administrator account, the navigation adds further management abilities such as Internationalization and community management.
- Dashboard
Each user has own navigation 'Dashboard' that houses 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.
When logged in as an Administrator, a fourth navigation appears in the Toolbar:
- 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 of the portal 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.
A gadget is a mini web application that a portal user can add to their web page. Some useful gadgets that are packaged by default with GateIn 3.0:
See the Default Gadgets section of Section 3.3.1, “Using the Dashboard Workspace” for more information about these gadgets.
GateIn 3.0 has two 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 a group.
- Private
This mode is for registered users. Users set a username and password during registration which they can use to sign in. This mode allows users more site privileges. Registered users can manage private resources (creating, editing or deleting private pages), "borrow" pages from other users by creating hyperlinks and change the language for individual needs.
Permission settings control what users can and cannot do within the portal and are set by portal administrators.
Permission types dictate what a user can do within the portal. There are two permission types used in GateIn 3.0:
- Access
This permission type allows users to utilize portal content, that is; sign in, rearrange portlets, etc. This permission can be set for multiple member groups.
- Edit
This permission type allows users to change portal content. This includes actions such as changing page information, deleting pages etc. The edit permission is set for only one group at a time.
Permission levels dictate where in the portal the user's permission type applies. There are three permission levels:
- Portal
The portal permission level includes all pages within the portal. Therefore, a user with the access permission type can view (but not edit) all the pages within the portal. A user with edit permission at the portal level, can change any page in the portal.
- Page
The page permission level restricts the user to particular pages. Users are only able to see and/or edit (depending on their permission type) pages they have been given access to.
- Portlet
The portlet permission level allows users create a page by dragging and dropping portlets into a page. Some portlets are only used for administrators while some are used for individuals thus administrators have to set the appropriate access permissions.
Permission types and levels can be used to effectively control who can do what within the portal. For more information on setting permissions refer to Section 5.3, “Manage Permissions”
Portlets are pluggable user interface components that are managed and displayed within a portal. Functional Portlets support all functions of a Portal. They are built into the portal and are accessed via toolbar links as required when actioning portal tasks.
GateIn 3.0 provides the following portlets by default.
- Account Portlet
This Portlet allows users to register a new account and choose a preferred language for displaying the Portal interface.
- Organization Portlet
This Portlet is used to manage user information, groups of users and groups memberships.
- Application Registry Portlet
This Portlet is used to manage different application categories. You can add, edit, set permissions and delete a category and its applications.
- Internationalization Portlet
This Portlet is used to translate a word or a phrase from the current language to another language.
- Star Toolbar Portlet
The Star Toolbar Portlet is used to change language and skin of the portal or to sign out.
The Interface Portlets are the face of the Portal. They provide the means for users to interact with the portal. GateIn 3.0 consists of the following Interface Portlets:
- Banner Portlet
This Portlet is considered the welcome gateway of a Portal. It contains the organization's slogan, logo, and icons etc.
- HomePage Portlet
This Portlet is used to provide the home page for a portal. The home page is the first page displayed when you visit the site.
- Navigation Portlet
This Portlet provides a navigation bar. A 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 is used to provide a site map page of a web site. It lists pages on a website, typically organized in hierarchical fashion.
- Breadcumbs Portlet
This Portlet displays the 'path' the user has taken from the home page to arrive at the currrent page.
- Dashboard Portlet
This portlet is used for hosting mini-applications known as gadgets. The dashboard uses a variety of graphical effects for displaying, opening, and using gadgets.
Refer to Section 3.3, “Dashboard Portlet” or Chapter 7, Portlets and Gadgets Administration for more information.
- Iframe Portlet
This Portlet is used to create inline frames (IFrame) elements for a site. An Iframe is a HTML element which can embed another document into a parent HTML document. By using IFrames, embedded data is displayed inside a sub-window of browser.
- 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.
The Dashboard portlet is used for hosting mini applications known as gadgets. The Dashboard uses a variety of graphical effects for displaying, opening and using gadgets. Gadgets can be moved, rearranged, created and deleted. More than one instance of the same gadget can be opened at the same time and each instance of the same gadget can have different settings. The gadgets instances are as independent as different portlets instances.
Click on Dashboard in the toolbar to access the Dashboard portlet.
Click on Add Gadgets to open the Dashboard Workspace.
The active Dashboard can be individually named by clicking on the default name ("Click and Type Page Name") where it appears below the current user name (see image below) and entering a new name.
The Dashboard Workspace lists all available gadgets. There are four gadgets built into GateIn 3.0 by default, however you can add many more.
Default Gadgets:
- Calendar
The calendar gadget allows users to switch easily between daily, monthly and yearly view and, again, is customizable to match your portal's theme.
- 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. Tasks can be highlighted with different colors.
- Calculator
This mini-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, user-specified 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.
- More Gadgets
Further gadgets can be obtained from the Google Gadget site. GateIn 3.0 is compatible with most of the gadgets available here.
To add more gadgets from external sources:
Obtain the URL (.xml or .rss) of the gadget you wish to add from the gadget source.
For example; the gadgets available at Google Gadget provide a link to View source. Clicking on this will open a page showing the gadget's XML source. Use the URL of this page in the Dashboard Workspace. The URL should end in
.xmlURL Types
Remote gadgets can be only created using an .xml link or RSS URL. However, if you use a link that generates an RSS feed (for example: http://feeds.feedburner.com/gatein), a new RSS reader gadget will be created automatically.
Return to your portal and click the Dashboard link in the toolbar.
Click on Add Gadgets 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 on the plus icon to add the new gadget to the page.
Users who visit the Portal and who are not registered are limited in the content they can see. Users who need access to deeper content or who need to undertake actions within the prtal should register themselves and then contact the portal administrator to have appropriate permissions added to their account.
Users can quickly and easily register a new account for themselves. Complete the steps below:
Click Register on the Navigation bar.
The Register page will appear:
The Account Setting information includes:
- User Name
The name used to login.
- 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.
- Last Name
The user's last name.
- Email Address
The user's email address. This must be in the appropriate format. For example: username@abc.com.
Fill in the form.
Click the 'find' icon beside the user name field to check if the chosen username is available.
Click Subscribe to register a new account or Reset to refresh all entered values. You cannot add a new account if one of these cases occurs:
The chosen User name already exists or is invalid.
The nominated Password has less than 6 characters or more than 30 characters.
The Password and Confirm Password fields are not the same.
The Email Address format is not valid.
A required field (or fields) is empty.
After adding a new account, you should contact the administrator to get appropriate permissions added to your account.
Note
Be sure you enter your email address carefully. If you should forget your user name or password, you can recover it with this email address.
After registering your account, you can sign in to GateIn 3.0 to go into private mode.
To sign in to a portal, users must complete the Sign in form. This form contains the following elements:
- User name
The registered user name.
- Password
The registered password.
- Remember My Login
This option allows users to return to GateIn 3.0 and be automatically authenticated based on the value of a cookie provided by the
bvarlistentryser. Thus users do not have to perform an explicit authentication again.- Forgot your User Name/Password?
To follow some steps to get the forgotten user name or password. Please refer [Portal:Account and Password Retrieval] for more details.
- Sign in
To sign into GateIn 3.0 with user name and password.
- Discard
Close the Sign In form without logging in.
Procedure 4.1. Sign In
Go to your Portal by entering the URL into the address bar of your browser (For example http://localhost:8080/portal).
Click the Sign in link at the top right of the page if you are current in the Classic portal. The Sign in form appears:
Input your registered User name and Password .
Select the Remember My Login check box when you sign in GateIn 3.0 at the first time if you want to automatically return to GateIn 3.0 without signing in again. You can see Section 4.3, “Remember User Account” for more details.
Click the Sign in button to submit the form or Discard to escape.
If the user name does not exist or the user name and/or password is invalid an alert message will appear. To attempt the login again; click the OK button on the alert message to be returned to the Sign In form. Enter the user name and password again.
After signing in, you will be redirected to the homepage and welcomed with your full name in the top right corner of the page.
Users can return to the GateIn 3.0 and be automatically authenticated with a cookie provided by their browser. Thus users do not have to perform an explicit authentication each time they access the portal.
Input your registered user name and password.
Select the Remember My Login check box when logging in GateIn 3.0 at the first time.
Click the Sign in button to sign in the portal.
You must remember to close your browser without signing out (as signing out will delete the cookie). This will allow you to re-enter the portal without having to sign in again.
Users can follow this guide to change account information.
To change your account information, click on the account name in the top navigation bar:
The Account Profiles form will appear:
If you want to change your Account Profile information:
Select the Account Profiles tab. This will display your current basic information.
Your User Name cannot be changed. You can change your: First Name , Last Name and Email.
Once the desired changes have been made, click the Save button to submit them.
If you want to change your Password :
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
Re-enter your password in the Confirm New Password field.
Click the Save button to accept changes.
You can recover your username or password should you forget them by following these steps:
Click the link 'Forgot your User Name/Password?' (beneath the Password field of the Sign in form). This presents the form that guides you through recovering your username and/or password.
This form offers two options to select:
Forgot my password. If you forget your password, you need to select this option.
Forgot my username. If you forget your username, you need to select this option.
Select the appropriate option and click Next.
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 username:
If you selected Forgot my username you will be prompted for your email address.
Enter the approprate value into the open field.
Click the Send button to send the entered values.
After you submit the form an email will be send to your email address with the requested information, either your username or password.
If you forgot your password you will be sent a new (temporary) password. Your original password will not be valid after this email is sent. You will be directed to update your password the next time you sign in.
- 5.1. Toolbar
- 5.2. User management
- 5.2.1. Manage users
- 5.2.2. Search a user
- 5.2.3. Edit a user
- 5.2.4. Delete a user
- 5.2.5. Manage groups
- 5.2.6. Add a New Group
- 5.2.7. Edit a group
- 5.2.8. Add a new user to a group
- 5.2.9. Edit the user membership in a group
- 5.2.10. Delete a group
- 5.2.11. Manage memberships
- 5.2.12. Add a new membership type
- 5.2.13. Edit a membership type
- 5.2.14. Delete a membership type
- 5.3. Manage Permissions
- 5.4. Change Portal Skins
- 5.5. Manage Navigation Nodes
- 5.6. Change Node Order
- 5.7. Manage Pages
- 5.8. Page Creation Wizard
- 5.9. Drag and Drop the Page Body
- 5.10. Create a New Portal
- 5.11. Manage Portals
- 5.12. Switching between Portals
The Toolbar offers a convenient way for users and administrators to undertake portal actions quickly and easily.
- User Menu
You can use the user menu 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.
- Editor
Portal Administrators have access to another navigation that offers links to add a new page to the current portal, edit a particular page's properties or to change a page's layout. This navigation appears next to the Dashboard navigation in the Toolbar and is contextually-named. It will appear as either Site Editor or Group Editor depending on the user's location within the portal.
To assist Administrators to manage a number of registered users GateIn 3.0 offers a number of tools to manage users, groups and memberships easily and effectively.
Select the Group navigation in the Toolbar. Under the Executive Board's Pages heading is a link to Organization options.
Clicking Users and Groups Management in this list will open an easily navigated table of current registered users.
Administrators can see all existing registered users and search, edit or even delete them. Each user's groups and memberships (roles) in these groups are also available. You can not add users to a group but you can remove them from the group.
The Administrator can search for specific users by username, first name, last name or email address.
Select the parameter (name, email, etc) by which you would like to search from the drop-down menu.
Type the search terms for the user that you want to locate. You may not need to enter the complete title as the tool will present partial match search results.
Click the 'find' icon to begin the search.
Locate the user you wish to edit.
Click the edit icon (next to the trash icon) in the list entry of that user.
Select the Account Info tab to view and change the essential user information.
- User Name
The User Name field cannot be changed. Other fields First Name , Last Name , 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 at least 6 characters and can contain letters, numbers and punctuation marks.
Select the User Profile tab to view and change profile information. The Language field is used to set the display language for that user.
Select the User Membership tab to see a user's group membership information.
- User Membership
The User Membership tab indicates which group (or groups) 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 on the row of the membership you want to revoke.
Click the Save button to submit changes.
Locate the user you wish to delete in the User Management form.
Click the trash icon in the list entry corresponding to the user that you want to delete.
Click the OK button in the confirmation message to confirm or the Cancel button to quit without changing anything.
Select the Group Management tab in the Organization form.
By default, all existing groups will be displayed on the left pane. This tab is used to add new, edit or delete a group. The right pane shows information about the selected group including information about the members in the specific group and a small form to add a new user to a group.
Choose the path to create a new group by selecting the groups from list on the left pane or clicking the arrow icon if you want to create a group in a higher level. The selected path is displayed in the path bar.
Click the Add New Group icon. The Add New Group form will be displayed on the right pane:
- 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 3 to 30 characters is allowed.
Fill in the required fields. Only letters, numbers and underscore characters are allowed for the Group Name field. The name must be unique within the portal.
Click the Save button to accept entered values or the Cancel button to quit.
Select the path to the group you want to edit by selecting the groups from list on the left pane.
Click the edit icon to show the Edit Group form for the selected group. This form is identical to the New Group form.
Make the desired changes in the approapraite fields. You can not change the Group Name, however you may change to the Label field if you wish to refer to the group by a different name. You are also able to edit the Description field should it be appropriate.
Click the Save button to accept changes or the Cancel button to cancel changes and return to the Group Info form.
Select the path to the group you want to edit by selecting the groups from the list on the left pane. The Group's information is displayed including the user list and a form which allows the addition of a new user.
Enter the username of the new user of the selected group.
If you are unsure of the exact username of the user you wish to add to the group, you can use the search function to locate them.
Refer to Section 5.2.2, “Search a user” for instructions on how to locate a user.
After you have found the required username, click the Add button and the complete username will populate the Add member form.
Select the membership for the user in a group from memberships list. The refresh icon can be used to update the memberships list if there are any changes to incorporate.
Click the Save button to accept adding the selected user to a specific group with the selected membership type.
Click the edit icon corresponding to a specific user with a membership in the Group Info table to open the Edit Membership form :
Change the membership of the selected user by selecting another value in the Membership field.
Complete editing the selected user by clicking the Save button.
Select the path to the group you want to delete by selecting the groups from list on the left pane.
Click the trash icon to delete the group.
Click the OK button on the confirmation message to accept or the Cancel button to quit without deleting.
The roles of an user in the specific group are managed in the Membership Management form.
Currently there are three membership types: Manager, Member and Validator. By default, Manager has the highest rights in a group.
Administrators can add new, edit or delete a membership type. Select the Membership Management tab in the Organization portlet.
This will open a membership type list and a form to add new/edit:
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.
Click the Save button to accept adding the new membership or click Reset button to clear the entered values.
Click the edit icon in the row of the membership type you want to edit. The selected Membership type information is displayed in the Add/Edit Membership form.
Make the desired changes in this form.
Click Save to accept changes.
Permissions play an important part in accessing and performing actions in the Portal. Depending on permissions assigned by an administrator, users can either access or edit portals, pages and portlets. GateIn 3.0 has several permission levels:
Details about permission types and levels can be found in Section 2.7, “Permissions”
Administrators have to set permissions for new portals as well as existing portals:
- New portals
On the Toolbar click on Site then click on the Add New Portal button, select the Permission Setting tab then the Access Permission Setting sub tab.
Warning
EDIT_WARNING: The Add New Portal button mentioned in the above paragraph is not present in GateIn 3.0 Beta 3 TH: In fact it is there but not so intuitive, i added a screenshot, and explained to explicitely *click* on "Site"
- Existing portals
On the Toolbar click Site then Edit Portal's Properties of the chosen portal, then select the Permission Setting tab.
Public access
If you do not want your Portal to be publicly accessible, ensure the Make it public check box is clear.
If the Make it public check-box is clear, you will need to add permissions by member group.
Click the Add Permissions sub-tag on the Permission Setting tab.
Make the appropriate selections from the group and membership options presented in the Permission Selector dialogue box.
After selecting a membership type, the selected permission is displayed in the access permission list. You can only select one group with one membership type at a time. If you want to add more, click Add Permission and select again. Repeat the process for as many permission settings as you require.
Only users who are in the portal editor group can edit that portal. Access rights can be given to several groups but edit rights can only be given to a group with a membership type. To assign an edit permission to a user, you must add him to the editor group of the respective portal.
Use one of these following paths to open the permission setting function of the portal:
On the Toolbar select Site and click on Add New Portal.
Permission Setting tab and the Edit Permission Setting sub-tab.
Warning
EDIT_WARNING: The Add New Portal button mentioned in the above procedure is not present in GateIn 3.0 Beta 3 TH: Same as before, it is there, just not intuitively placed :-/
Or for an existing portal;
On the Toolbar click Site then Edit Portal's Properties.
Select the Permission Setting tab.
Go to the Edit Permission Setting sub tab.
Once you have the Edit Permission Setting screen open, follow the steps below to set the edit permissions of the portal.
Click Select Permission to choose a group.
Select a group and a membership type from the left and right panes, respectively, of the Permission Selector window (select * if you want to assign all available membership types to the selected group).
Click on the Save button to accept.
In some cases, permissions on a page are initialized and users who have the edit permission can change the page.
- User
If the owner type of a page is "user", you don't have to set permissions, no one except the creator has access and 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.
These following process will help you quickly set access permission for a page:
Select Site Editor on the Toolbar and click the Edit Page entry.
Click on the View Page Properties button in the Page Editor applet.
Click the Permission Setting tab. You will see the Access Permission Setting sub tab.
To be able to access a page users have to be in one of the groups that have access permission to that page. There may be several groups that have access rights to a page. A list of the permissions for that page will be shown (provided the Make it public check-box has not been used).
Click the Add Permission button
Select a group you want to add on the left and then select a membership type on the right.
After selecting a membership type, the selected permission is displayed in the access right list. Each time, you can only select one group with one membership type. If you want to add more, click the Add Permission button and select again.
If you want to allow any visitors to access the page tick the Make it public check-box. Any permission set for that page will be relaxed and the permissions list will disappear. When you click Save the page will be made accessible to the public.
Only users who are in the page's editor group can edit it. The access right can be set for several groups but the edit right only can be set for one group. To give a user the edit permission, you must add them to the editors group of that page.
This can be accessed on of two ways:
Select Site Editor on the Toolbar and click the Edit Page entry.
Select Site Editor on the Toolbar and click the Edit Page entry.
Click on the View Page Properties button in the Page Editor applet.
Click the Permission Setting tab then the Edit Permission Setting sub tab.
Or;
Select the Group navigation on the Toolbar, go to Administration and click on Page Management.
Locate the page you want to edit using the Page Id column then click the edit icon (next to the trash icon). You will be taken to the Page Editor applet.
As, above, click on the Permission Setting tab then the Edit Permission Setting sub tab.
You will see the Current Permission listed.
Click the Select Permission button to set new or change another group.
Select a group with a membership type (select * if you want all membership types in a selected group)
After selecting a specific membership from the right, the selected information is displayed.
Click the Save button to accept.
Setting access permission on a category allows to be able to list those categories when editing a page in order to add portlets or widgets. Follow these below steps to set access permission on a category:
Select Group from the Toolbar. Highlight the Administration entry and click on Application Registry.
In the list of categories in the left pane, click the edit icon, then choose the Permission Setting tab.
To set permissions for a category:
Click the Add Permission button to add access permissions to more groups .
Or select the Make it public check box to allow everyone to access.
Follow these below steps to set access permission on a portlet:
Select Group from the Toolbar. Highlight the Administration entry and click on Application Registry.
Select a category on the left pane that includes the portlet you want to set rights for. Then all portlets of the selected category are listed immediately and detail information of each portlet is displayed on the right pane.
To set permissions for a portlet:
Click the Add Permission button to add access permissions to more groups .
Or select the Make it public check box to allow everyone to access.
Warning
EDIT_WARNING: The Administration menu entry reported to be under the GateIn Start button does not exist in GateIn 3.0 Beta 3. Therefore some of the instructions in this section may be incomplete or inaccurate. TH: Same :) Click on Site.
Skins are graphic styles that display an attractive user interface. Each skin has its own characteristics with different backgrounds, icons, and other visual elements. In order to be user-friendly and flexible, users are allowed to change the skin they use on the portal without having edit rights.
Skins can be changed temporarily (and are reset at log-out) or permanently.
- Change the skin temporarily
Go to GateIn 3.0 Start and click on Change Skin.
Select a new skin from the list on the left of the Skin Settings box. When you highlight a skin in the list a preview will appear in the pane on the right of the box.
If you are happy with your choice, click the Apply button to have it applied to the portal.
Or, if you decide not to change the skin, click Cancel to close the dialogue box without making any changes to the portal.
- Change the skin permanently
Click on Site, then Edit Portal's Properties for the portal of your choice.
In the Portal Setting tab: select one skin type in the Skin list field to change and display a skin.
Click Save and Finish icon so that the modification can take effect.
More information about adding skins to a portal see the GateIn 3.0 Reference Guide at www.redhat.com/docs
Warning
The User Workspace has been deprecated in GateIn 3.0 Beta 3. The introductory paragraph below may be obsolete. Also The Administration menu entry reported to be under the GateIn Start button does not exist in GateIn 3.0 Beta 3. Therefore some of the instructions in this section may be incomplete or inaccurate.
With enough privileges you can take all actions related to a node such as : add a new node, edit, copy, cut, delete and clone node.
Click on Site then click on Edit Navigation of the portal you want 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 new Node option. The Add new 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 and underscore characters are allowed for this field and it must have at least 3 characters.
- 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 allow 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 input values in these fields. It is automatically displayed after selecting an existing page by clicking the Search and Select Page button. The Select a page form appears:
This window lists of all existing pages is displayed with basic information. You can follow these guides to select a page for creating a node:
Select a page from list or search a specific page :
Enter a search term related to the page which you want to search:
Choose the field you wish to search in:
Click the 'find' icon to perform the search. All pages matching with search term will be listed.
Click the OK icon on the row of the page you wish to select.
After selecting a page, the details of this page will be displayed in the Page Selector form.
After configuring the page node settings, the page selector and the node's icon, click the Save button to accept or the Cancel button to quit without creating a new node.
Click on Site then click on Edit Navigation of the portal you want to modify.
Right-click on the selected node and select Edit this Node option.
This will display a form to edit this node:
In the Page Node Setting tab you can change the value of these fields:
Label
Visible
Publication Date & time
After you finish making the desired changes, click the Save button to accept changes or Cancel button to exit without change.
In the Page Selector tab you can also search and select another page for this node by clicking the Search and Select Page button.
You can see more details on how to select a page for a node in Section 5.5.1, “Add a new node”.
After you finish edit any another page required for this node, click the Save button to accept changing or Cancel button to leave without saving any changes.
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. Click the mark icon to Save.
The Clone node function allows you to copy a node.
The differences between clone node and copy node is that the clone node has its own page and which has the same content as the selected node.
Therefore there will be a new page that has the same name as the cloned node's page shown in the page list when you access Manage Pages.
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. Click the mark icon to Save.
In Manage Pages you will see:
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.
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.
You can easily change the position of nodes in the navigation bar following these steps:
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.
GateIn 3.0 users can quickly add, edit, delete and view pages effectively in a comprehensive list. Follow the guide below to manage portal pages:
You easily add a new page by following these simple steps:
Go to Group ->Administration -> Page Management.
Click on Add New Page
Enter values for fields in the Page Setting tab
- 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 portal the page is created for a portal. Therefore only users who have edit permissions on the portal level can create this page type.
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.
If the page Owner type is group the page is created for a group. Therefore only users who have manager permissions for that group can create this page type.
- Owner Id
The name of the page owner. 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 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 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 30 characters in length.
- Show Max Window
The option allows users to choose whether the page is shown at maximum size or not.
Enter values for fields in the Permission Setting tab
- Access Permission
The content of this tab is identical to the Owner type field in the Page Setting tab. Therefore, all users having access rights for the type selected in the Owner type field will appear in this tab. But users can also change the value of this tab.
Check the check box if you want to share access with everyone or click the Add Permission button to assign permission on group level, then select a group and membership or click the trash can icon to remove a group from the list.
- Edit Permission
The content of this tab depends on the value of the Owner type field in the Page Setting tab.
If the Owner type is "group", edit permission is assigned to users who are "manager" of the group that is selected in Owner id. You can only change this value when editing the page.
Click the Save button to accept creating a new page or the Cancel button to quit the form.
Go to Group in the Toolbar. Highlight Administration and then click on Page Management.
Click the edit icon on the row of page you want to edit in the existing pages list.
Click the edit icon to show a form to edit page properties.
The properties presented in the Page Properties window are the same as those outlined in Section 5.7.1, “Add a new Page in the Page List”.
- Permission Setting
This form is supported for pages with group or portal ownershuip types. Because a user's page is private, no user, other than the creator, can access or edit it.
Permission on each page is set in two levels: Access right and Edit right.
- Access right
The page Access right can be set to specific user groups or set to everyone (this includes unregistered users). Current access permissions on page are listed and you can remove permissions (by clicking the delete icon) or add further permission (by click 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 only is set for a group of users. Edit right can be set for one specific membership type within a particular group (* allows every membership type in a group). If you want to re-assign this right to another group, click Select Permission to choose another one.
- Editing page container layout
Click the Show Container icon to show current container layout of selected page on your right and all the container layouts list on the left pane.
If you want to change the current layout, select a layout type from the list on the left pane, then drag the template you want into the right pane. The new container will be displayed on the right pane. You can change the position of the current container by dragging it to another place on the right pane or remove it completely by clicking the delete icon in the right corner.
- Editing page portlet layout
Click the Show Portlet icon to show current portlet layout of page.
If you want to change the current layout, select a layout type from the list on the left pane, then drag it into the right pane. The new portlet will be added and displayed in the right pane. You can change the position of the current portlet by dragging it to the place you want on the right pane, or remove it completely by clicking the delete icon.
View any page in the existing pages list by clicking on the View icon corresponding to the page you want to view.
Go to 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 process the deletion or Cancel button to quit without deleting the page.
A page creation wizard is included in GateIn 3.0 to help administrators to create and publish a page quickly and easily.
Go to Site Editorand click on Add New Page. Yhe Page Creation Wizard will appear.
The wizard includes two parts: the left pane contains a list of navigations and shows the page list and the right pane displays the main information of the page selected in this list.
In the left pane, select the navigation that you want to create a new page for. Clicking a navigation displays the pages already existing for that navigation.
Select a page from the list or click on arrow up icon to add a page at root.
- 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.
- 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 allows to hide this page. If not checked the page is under no circumstances shown, even if the publication period is OK. If checked the page or the page node appears on on the navigation bar, the page navigation and the site map. If "visible" is checked the visibility can depend on the "publication date & time" option.
- 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.
- Start Publication Date
The start date and time to publish the page
- End Publication Date
The end date and time to publish the page.
Setting Time and Date
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
Click Next or number '2' of the wizard steps to go to step 2.
Select Empty Layout or click the icon to see more templates to select.
Click the Next button or number '3' of the wizard step to go to step 3. You can drag portlets from the popup panel into the main pane to create the content of this page.
- Applications
Allows listing all existing portlets
- Containers
Allows listing all existing containers
- Switch View mode
Allows viewing a page in preview mode
Click the Show Container icon if you want to see the existing containers and re-select the layout of the page. You can click on the Switch icon to view the content of this page.
Click Save to accept creating a new page, the Back button to return the previous step or the Abort button to quit without creating a new page.
To assist administrators to modify or personalize their portal GateIn 3.0 allows you to easily drag and drop page content within the page.
Go to Site Editor in the toolbar and click on Edit Layout It will display :
Click on the Portal Page, drag and drop within the portal page.
Creating a new portal requires you to have a special permission that only an administrator can give you. You need follow these guides to create a new portal.
Click on Site in the toolbar.
Click the Add New Portal button. By default, the Create New Portal form is shown with the Portal Templates tab.
By default, Portal template is Classic. Select the Portal Setting tab.
Enter a value for the Portal Name field. This field is required and must be unique. Only alphabetical, numerical and underscore characters are allowed for this field and the name must have at least 3 characters.
Select a display language for the portal by selecting a language from the list.
Select a skin for a portal by selecting one from the skin list.
Click on the Properties tab to fill in the Keep session alive property. There are 3 options:
- 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.
Click on the Permission Setting tab and set the permissions for the Portal.
By default the access permissions list for the portal is empty. You have to select at least one or tick on the Make it public check box to assign access permission to everyone.
Click on Save to accept creating a new portal.
You also can edit or delete a portal. See more details in Section 5.11, “Manage Portals”
Portals can easily be managed by editing or deleting.
You can change aspects of the current using portal, such as properties or layout if you have the edit right (granted by an Admininstrator).
If you have edit rights, follow these steps to edit the current portal:
Go to Editor on the Toolbar and click Edit Site Layout.
Click the Properties button in the Edit Inline Composer. The edit Form of the portal will be shown:
This form is where you can change portal settings.
Procedure 5.1. Change Timeout Settings
Click the Propertites tab of the edit form. Select an option for Keep session alive
This option controls how long your session is kept alive. There are 3 options:
- 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.
Select the option that best suits your needs.
Click the Save button to accept changes or the Cancel button to quit.
Procedure 5.2. Set permissions for the portal
Go to the Permission Setting tab of the edit form and then the Edit Permission Setting sub-tab.
Click the Select Permission button and then select a group with the Membership type you want. Only one group can have the Edit Permission of the portal.
Click the Save button to accept changes or the Cancel button to quit.
GateIn 3.0 allows users to switch between portals simply and easily.
Go to Site on the Toolbar for a list all portals in which you have at least the access right
You easily switch between Portals by simply clicking on the portal that you wish to switch to and waiting for few seconds for the change to take effect.
GateIn 3.0 allows users to choose their interface language to work with.
The priority of the interface language setting is:
User's language
Browser's language
Portal's language
Users should pay attention to this order to change the language type appropriately.
You can change the interface language permanently in three ways :
This methods allows you to change the interface language of the current Portal.
You easily change the interface language of the current Portal by following guides:
Go to Editor on the Toolbar and click Edit Page. The Edit Inline Composer popup will appear:
Click on Portal Properties to edit the portal's properties.
You can change display language of the portal by selecting another language in the Locale field of the Portal Setting tab.
Click Save and Finish to set the new language.
You can set the interface language for yourself by doing the following:
Go to Editor on the Toolbar and click Change Language
The Interface Language Setting form is displayed with a list of all supported languages. The current using language is marked with an icon.
Select another language by clicking on its name in the list of available languages.
Click the Apply button and wait for few seconds for the change to take affect.
You can also set the interface language for yourself alone (and not for the entire Portal) this way:
Click on the GateIn Logo on the left corner to show the Interface Language Setting form:
The Interface Language Setting form will appear:
Select another language in list. The selected language will be marked with an icon.
Click the Apply button to change the interface language or click the Cancel button to quit without changes.
There are two modes to set the interface language for a specific user.
- Public Mode
When accessing the portal in Public Mode, the interface language is dictated by the language setting of your web browser.
If you have set the language of your browser to one that GateIn 3.0 does not support, the displaying language will be the language set at the Portal level (see above).
- Private Mode
The interface language in Private Mode is set when registering each user. See step four of the process to register a new account Section 4.1, “Register New Accounts”.
GateIn 3.0 supports Right to Left (RTL) languages.
The Account Portlet
The Application Registry Portlet
The Organization Portlet:
GateIn 3.0 supports a multi-language environment for your portal allowing you to internationalize any menu entry on the navigation.
As the navigation bar is composed of nodes, you have to modify the display names of the nodes to enable this. Instead of entering the display name of the node in a defined language (English, for example) you have to use a language-neutral 'resource key'.
This resource key is then used to define the label that is shown for that node on the navigation bar, the menu and the breadcrumb.
The resource key format is: #{key}
The resource key can contain any text that you consider to be reasonable. It should, however, be human-readable and must not contain spaces.
There are three ways to create a key for a node:
To use a guided wizard to create keys, follow these steps:
Go to Group and click on Add New Page. This will activate the Create Page Wizard.
Click the Next button.
Enter a resource key in the Display Name field.
Click on the Next button to continue and click on the Save button.
Go to GateIn Start -> Administration -> Basic --> Edit Page Wizard
Click on the Next button.
Enter a resource key in the Display Name field.
Go to GateIn Start -> Administration -> Advanced --> Edit Page and Navigation.
There are two alternatives:
Create a new node: Select the parent path, right click and click on Add new node option .
Edit an existing node: Right click on the node you want to create/edit key and click on Edit this node in the pop-up menu.
A Create/Edit node dialog appears. Enter a resource key in the Label field
Note
You can reuse the same resource key in several nodes.
- 7.1. Import Portlets and Gadgets
- 7.2. Manage Portlets and Gadgets
- 7.2.1. Display Gadgets
- 7.2.2. Add a new Category
- 7.2.3. Edit a Category
- 7.2.4. Delete a Category
- 7.2.5. Add Portlets/Gadgets to the specific Category
- 7.2.6. Set Access Permission on Portlets
- 7.2.7. View detail information of the specific Portlets
- 7.2.8. Add a Gadget
- 7.2.9. Add a new Gadget to the Dashboard Portlet
- 7.2.10. Manage 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.
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.")
Go to Group-> Administration-> Application Registry on the navigation bar. A form for organizing portlets/gadgets will be displayed:
Click the Auto Import button at upper right corner on the action bar. A pop up will be shown:
Click the OK button to accept importing gadgets automatically. All portlets/gadgets categories will be imported and listed on the left pane.
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 Gadgets category.
You can change the number of columns available in the Dashboard Portlet.
Click on Site Editor : Edit Page
Click on Edit Portlet button (which is displayed a pencil icon when you mouse-over the portlet in edit mode). It will show a dialog to change the number of columns to display gadgets.
Change the number of columns and click the Save button to accept the changes.
You easily add a new category by following these guides:
Go to Administration -> Application Registry page -> Organize item.
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.
- 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.
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).
Enter values for required fields in this form.
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:
Click the edit icon on the title bar of a category that you want to edit.
Change the information of the selected category.
Click the Save button to accept changes.
You also easily remove a category from a list:
Click the trash can icon on the Title bar of the category that you want to delete.
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 :
Click the "add" icon 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:
- Display name
The display name of a portlet/gadget that you want to add to a category.
- Application Type
the type of selected object.
Enter the display name and select a type for the selected portlet/gadget.
Select a portlet/gadget by checking the radio button.
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:
Go to Group in the Toolbar, highlight Administration and then click on Application Registry.
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.
To set permission for a portlet:
Click the Add Permission button to add access permissions to more groups.
Or check the Make it public check box to allow everyone to access.
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:
Go to Group in the Toolbar, highlight Administration and then click Application Registry. On the Application Registry page, click the Portlet item. A form to view all portlets will appear:
- 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.
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 :
Go to Group in the Toolbar, highlight Administration and then click Application Registry. On the Application Registry page, click the Gadget item
There are two ways to add gadgets:
Procedure 7.1. Add a remote Gadget
Open the form to add a remote gadget by clicking Add a remote gadget :
Enter a link to an .xml file in the URL field.
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.
Procedure 7.2. Create a new Gadget
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.
Enter a value for the Source field in this form.
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 :
Go to the Dashboard on the navigation bar. Click on the Add Gadgets link :
The dialog to add a new gadget will appear :
Enter a link (a .xml file or RSS) in the text box on the left pane.
Click on the icon!images/PlusIcon.png! to add a new gadget to the gadget list beneath.
Procedure 7.3. Edit a Gadget
Click the edit icon. This will display a dialog:
After editing , click the Save button to accept changing or Cancel button to quit.
Procedure 7.4. Refresh a Gadget
Local gadget
After editing information about the gadget that you want to, click the icon!images/Refresh.png! to refresh all information of that gadget.
Remote gadget
When information of a remote gadget has been changed by another server, click the icon!images/Refresh.png! means it will update information of a remote gadget from that server.
