JBoss.orgCommunity Documentation

Chapter 4. Portal Administration

4.1. About Administration bar
4.1.1. User actions in the Administration bar
4.2.
4.2.1. Create a new portal
4.2.2. Switch between portals
4.2.3. Edit a portal
4.2.4. Delete a portal
4.3.
4.3.1. Add a new node
4.3.2. Edit a node
4.3.3. Copy/Paste a node
4.3.4. Clone a node
4.3.5. Cut a node
4.3.6. Delete a node
4.3.7. Change nodes order
4.4.
4.4.1. Add a new page using Page Creation Wizard
4.4.2. Add a new page using Page Management
4.4.3. Edit a page
4.4.4. Delete a page
4.5.
4.5.1. Add a user
4.5.2. Manage users
4.5.3. Manage groups
4.5.4. Manage memberships
4.6. Manage page navigation
4.6.1. Portal's page navigation
4.6.2. User's page navigation
4.6.3. Group's page navigation
4.7.
4.7.1. Set permissions on a portal
4.7.2. Set permissions on a page
4.7.3. Set access permission on a category
4.7.4. Set access permission on a portlet

Note

The functions stated in this section are advanced and for users as administrators only.

The Administration bar is a toolbar which allows users and administrators to execute tasks within the portal quickly and easily.

Depending on the role of each user, he/she can see different actions on the Administration bar.

You can perform this action only when you are a member of the /platform/administrators group.

  1. Hover your cursor over on the Administration bar, then select Portal --> Sites from the drop-down menu.

  2. Click the Add New Portal button.

    By default, the Create New Portal window, which contains the Portal Settings tab, will open.

  3. Enter a string into the Portal Name field. This field is required and must be unique. Only alphabetical, numerical and underscore characters are allowed for this field with the length from 3 to 30 characters.

  4. Select the default display language for the portal from the Locale field.

  5. Click the Properties tab to set the properties of a portal.

    Details:


  6. Click the Permission Settings tab to set permissions on the portal.

    The list of access permissions for the portal is empty by default. You have to select at least one or tick the Make it public (everyone can access) checkbox to assign access permission to everyone.

  7. Click the Portal Templates tab to select the template for your portal.

  8. Click Save to accept creating your new portal.

When you have the edit permission, follow either of two ways below to go to the relevant form that allows you to do actions related to editing a portal.

The first way

The second way

To edit your selected portal's layout, your first need to follow one of ways above to open the Edit Layout form.

New applications, containers or gadgets can be dragged and dropped from the Edit Inline Composer window to the main portal body.

You can rearrange elements in the portal body by dragging and dropping them into your desired positions. Also, you can edit or remove any element by hovering your cursor over it and selecting , or respectively.

Note

For more details on how to edit elements, see the Edit a specific portlet section.

Configurations of a portal include settings, properties and permissions that can be set by following one of ways above to open the Edit Configurations window.

In this window, you can make changes on fields in the various tabs, except the Portal Name in the Portal Settings tab.

Note

For more details on these fields, refer to the Create a new portal section.

If you are the portal administrator or the portal administrator has granted you the appropriate permission privileges, you can execute some special actions related to portal nodes, including copying, editing, cutting, cloning, deleting, adding existing nodes. To do so, you first need to go to the nodes list by following steps described in the Edit navigation section, then right-clicking your desired node to open the drop-down menu.

  1. Select Add New Node to create a node as a sub-node of the selected node.

    The Add/Edit Page Node form appears.

  2. Enter values in the Page Node Settings tab.

    Details:

    Table 4.2. 

    Field Description
    Asterisk (*) This mark next to each field means that it is required to enter values in the field.
    Uri An identification of the node that is auto-created after the new node has been created.
    Node Name The node name which must be unique. Only alphabetic, numeric and underscore characters are allowed with its length from 3 to 30 characters and without ANY SPACES.
    Extended Label Mode Tick this checkbox to activate the extended label mode for your page node's label. If this checkbox is deselected, the Language field will disappear.
    Language Select your desired language for the node label from the drop-down menu.
    Label The display name of the node on the screen in the selected language. This field is not required and may be changed. Its length must be between 3 and 120 characters, including SPACES. For example, if you want to create a French label for your node, first select the Extended Label Mode checkbox. Next, from the Language drop-down list, select your desired language and enter your French label into the Label field.
    Visible This checkbox enables the page and its node to be shown or hidden at the navigation bar and sitemap.
    Publication Date & Time This option enables this node to be published for a given period. Two fields, including Start Publication Date and End Publication Date only display when this option is checked.
    Start Publication Date The start date and time to publish the node.
    End Publication Date The end date and time to publish the node.

    Note

    You can set date and time by clicking Start Publication Date and End Publication Date and selecting a date from the calendar pop-up.

  3. Select a page for this node in the Page Selector tab if you want.

    Details:


    You do not need to enter values in these fields. They are automatically recorded after you have selected an existing page by clicking Search and Select Page.

    The Select Page form appears.

    This window lists all existing pages of Portal or Group with basic information for each page.

    You can select a page for creating a node by simply clicking , or search for a specific page as follows:

    i. Enter your page title into the Title field to search by title;

    Or, enter the site name into the Site Name field to search by the page's site name;

    Or, enter values into both fields to further limit your search results by both Title and Site Name.

    ii. Select the area in which you want to search into the Type field.

    iii. Click to perform your search. All pages matching your search criteria will be listed.

    iv. Click on the row of the page to select.

    After selecting a page, the details of this page will be displayed in the Page Selector form.

  4. Select one icon in the Icon tab if you want.

  5. Click Save to accept the new node page, or X to close the form.

The Page Creation Wizard is available to the portal's administrators and facilitates them to create and publish portal pages quickly and easily. The whole process to create a new page can be divided into 3 specific steps:

Select a navigation node and create the page

In the first step, you have to set Node Name and Display Name of your page. You are also able to decide the pages visibility and the publication period of the page.

  1. Hover your cursor over My Sites and click one portal/site to which you want to add a new page from the drop-down menu.

    You will be switched to your selected portal only after a few seconds.

  2. Hover your cursor over Edit on the Administration bar.

  3. Select Page --> Add Page from the drop-down menu to open the Page Creation Wizard form.

    The wizard is divided into two sections.

    Details:


  4. Click Next or number '2' of the wizard steps to go to Step 2.

Select a page layout template

Arrange the page layout

In this step, you can arrange the page's layout as follows:

  1. Hover your cursor over to open the drop-down menu.

  2. Select Portal --> Pages to go to the Pages Management page.

  3. Click Add New Page to open the Add New Page form with the Page Settings tab.

    Details:


  4. Define the page layout in the Page Layout template.

  5. Define permissions in the Permission Settings tab. This tab consists of two sub-tabs named Access Permission Settings and Edit Permission Settings.

  6. Click Save to accept creating a new page.

  1. Open the Page Properties page by following one of the two ways:

    The first way

    i. Open the Navigation Management form by doing the steps in the Edit navigation section.

    ii. Right-click your desired node and select Edit Node's Page from the drop-down menu.

    The second way

    i. Hover your cursor over and select Portal --> Pages to open the Pages Management page.

    ii. Click corresponding to the page you want to edit.

    The Edit Page form will be displayed in the Page Properties window.

  2. Click View Page Properties in the Page Editor window to edit page properties.

    i. In the Page Settings tab, you cannot change values in Page Id, Owner Type, Owner Id, and Page Name.

    ii. In the Permission Settings tab, you can change or add more access and edit permissions. This form is only supported for pages of a group or a portal. Because the user's page is private, noone can access or edit it, except the creator.

    Note

    For more details on how to assign permissions on a page, refer to the Set permissions on a page section.

  3. Click Save, then select in Page Editor for all changes to take effect, or to abort.

To perform these actions, you first need to hover your cursor over at the top right of the site, then select User.

  1. Click Add Users from the drop-down menu.

    The Create New Account window will open with two tabs: Account Settings and User Profile.

  2. Fill all fields in the Account Settings tab which must be completed. For more details on these fields, see here.

    Further information about the user, such as nickname, or birthday, can be added in the User Profile tab that is not required.

  3. Click Save to accept your new account. If you want to refresh the input information, simply click Reset.

By clicking Groups And Roles, you will see the Organization form which allows you to manage users, groups and memberships.

As an administrator, you can easily find, edit information of users, and even remove them from the system via the User Management tab. By default, all registered users will be shown in this tab.

Via the User Management tab, you also can define each user belonging to user groups and his memberships (roles) in these groups. You cannot add users to a group but can remove them from the group.

  1. Locate the user you want to edit his information.

  2. Click corresponding to the user with the information you want to edit.

  3. Select the Account Info tab to edit main information of the user, including First Name, Last Name, or Email Address.

    For more details on these fields, see here.

  4. Select the User Profile tab to edit the personal information of the selected user, including Profile, Home and Business. You may also switch the default display language for that user by selecting another language from the Language field where all available languages are displayed in the alphabetical order.

  5. Select the User Membership tab to see the group membership information of the user.

    The User Membership tab displays which groups the selected user belongs to.

    To remove the user from a group, click .

  6. Click Save to accept your changes.

Select the Group Management tab in the Organization form. This tab is used to add, edit or delete a group. You can also add or delete a user to a group and edit the user membership in the group.

By default, all existing groups will be displayed on the left pane. The right pane shows information of the selected group and of its members with the Add Member form.

Navigation types in eXo Platform are outlined in the Manage navigation nodes.

Each group has only one page navigation. Only managers of the navigation group and users of the administrators group can add/list/edit/delete the navigation or edit properties.

To manage the group's page navigation, hover your cursor over on the Administration bar, then select Portal --> Group Sites from the drop-down menu.

The Group Navigation Management page will appear.

Permissions play an important role in accessing and performing actions in eXo Platform. Depending on these permissions assigned by an administrator, users can gain access to various components and another actions, such as editing portals, pages, or portlets.

Details about permission types and levels can also be found in the Permission section.

You can set the portal permissions (Access permission and Edit permission) for a specific user via the Permission Settings tab.

The Permission Settings tab can be opened in some various ways, depending on the following approaches.

For new portals:

For existing portals:

The first way

The second way

After entering into the Permission Settings tab, you first need to select the Access Permission Settings sub-tab to set the access permissions on a portal.

  • If you want to assign the access permission to users in the public mode (without signing in), simply select the Make it public (everyone can assess) checkbox.

  • If you do not want everyone to access the portal, first deselect the Make it public (everyone can access) checkbox, and do the followings:

    1. Click the Add Permission button to open the Select Permission form.

    2. Select one group in the left pane, and one membership type in the right pane. In the list of membership types, the asterisk (*) means that any membership types of the selected group are allowed.

    3. Click Save to finish your settings.

  • After you have selected a membership type, the selected permission is displayed in the access permission list.

  • You can select only one group with one membership type at each time. If you want to add more, click the Add Permission button and select again.

After entering into the Permission Settings tab, you first need to select the Edit Permission Settings sub-tab to set the edit permissions on a portal and do the followings:

  1. Click the Select Permission button to open the Permission Selector form.

  2. Select one group in the left pane and one membership type in the right pane. You can select * if you want to assign all available membership types to the selected group.

  3. Click Save to finish your settings.

To set permissions on a page, you first need to go to the Permission Settings tab via different ways:

Via Edit Page:

  1. Hover your cursor over My Sites on the Administration bar, then select the page you want to configure from the drop-down menu.

    You will be directed to your selected site.

  2. Continue hovering your cursor over Edit on the Administration bar, then select Page --> Layout from the drop-down menu.

  3. Click View Page Properties in the Page Editor window.

  4. Select the Permission Settings tab.

Via Page Management:

  1. Hover your cursor over on the Administration bar, and select Portal --> Pages to open the Pages Management page.

  2. Locate the page you want to edit using the Page Id column, then click in the Action column. You will be taken to the Page Editor window.

  3. Select the Permission Settings tab.