Page Comparison - Administrator's Guide (v.41 vs v.42) - Portal 3.0

Version 41 by William Stephens
on Sep 28, 2011 14:50.

<< Changes from 40 to 41

compared with

Current by William Stephens
on Sep 28, 2011 15:32.

Key

This line was removed.

This word was removed. This word was added.

This line was added.

Changes (12)

View Page History

...

h1. Portal 3.0 Administrators Guide

{cagridroundpanel}
{pre:class=cagridheaderfont}Table of Contents{pre}
{toc:outline=false|exclude=Portal 2.0 Administrators Guide|style=bullets}
{cagridroundpanel}

h1. Creating the Administrative User
----
In order to create a caGrid Portal administrative account, we will need valid caGrid credentials. If you already have an account with the NCICB Dorian Identity Provider (IdP), or with the NCICB AuthenticationService IdP (i.e. you have an NIH account), then you do not need to create a new caGrid account. If you don't have either of these accounts, you can create a new caGrid account through the portal.

To create a new account, click on the "Register" link under the main navigation at the top of the page. The registration dialog will open where you can enter the required information. When you have successfully completed the registration, you will immediately have a caGrid account, but you need to login at least once in order to have a caGrid Portal account. Click on the "Log in" link under the main navigation at the top of the page. Enter your username and password and click the Login button. You'll see a greeting under the main navigation at the top of the page. Then click the Logout link.

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=link-to-register-detail.png|caption=Link to Register}

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=register-dialog-detail.png|caption=Register Dialog}

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=greeting-detail.png|caption=Greeting}

h2. Assign Liferay Role
----
At this point, we've created a caGrid Portal account. Now we need to give this account administrative privileges.

After the portal is installed, there will be a single default administrative user whose username is 'portaladmin'. The password of this user is determined at installation time. See the installation guide for details.

Go to the Control Panel in https://<host>:<secure_port>/group/control_panel and login as portaladmin.

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=portaladmin-login-detail.png|caption=Portal Administrator Login}

NOTE: 'portaladmin' is the default username for the admin user. If you changed the username when installing the portal, then the URL will change accordingly.

NOTE: Make sure you go to the HTTPS version of this URL. Otherwise, the portaladmin password will be sent in clear text across the network, which is a security risk.

Once successfully logged in click on "Roles" under the "Portal" section of the left hand side navigation. You will see a page like the following.

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=ctrl-panel-roles.png|caption=Control Panel Roles}

From the Control Panel, you can perform all Liferay administrative operations. The Liferay administrative guide, along with other relevant documentation, can be found [here|http://www.liferay.com/documentation/5.2].

In the list of roles find the one with name "Administrator". Click on the "Actions" button on the right to reveal a context menu. Click on "Assign Members"

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=ctrl-panel-roles-menu.png|caption=Role Context Menu}

Now you should see a screen like this, with 3 levels of nested tabs:

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=ctrl-panel-roles-assign-members.png|caption=Assign Members Landing View}

Notice that the Current tab is selected. Select the Available tab next to it. In the Available tab, you should see the account that you just created. Select the checkbox next to this account and press the Update Associations button.

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=ctrl-panel-roles-assign-members-available.png|caption=Available Members}

Now, sign out by clicking on the "Back to Portal Admin" link at the top of the page and then on "Log Out". You'll be redirected to the caGrid Portal home page.

h1. Deleting User Accounts
----
The portal requires that user accounts be associated with exactly one email address. However, caGrid users can have multiple sets of grid credentials that are all associated with the same email address. If a user tries to log in with more than one of these sets of credentials, the portal will complain that an account already exists with that email address, and indicate that the user should log in with those credentials instead, or contact the administrator to request that the account be deleted.

To delete a user account, you must go to the portaladmin's private pages. Follow the instructions given in the [Creating the Admin User|#Creating the Administrative User] section to log in as portaladmin.

*NOTE:* If you see messages saying "You do not have the roles required to access this portlet", then you will need to close your browser, re-open it, and try again.

Go to the *Users* tab of the _Enterprise Admin_ portlet and search for the desired user account. Select the checkbox next to the user's account row, then click the *Deactivate* button. Then search for the account again, this time selecting *No* from the *Active* drop-down list in the advanced search view. Select the checkbox next to the account and click the *Delete* button.

h1. Banning and Unbanning Services
----
Services can be banned by the Portal administrator. When a service is banned, users cannot discover it in the Portal. There may be cases where banned services eventually come back on-line; in other words, become unbanned. In such cases, the Portal continues to ignore the service. It is then the responsibility of the service owner to recognize that the service is not being displayed in the Portal, and contact the Portal administrator to request that the service be unbanned.

h2. Administrative User Interface
----
In caGrid Portal 3.0 there is an administrative UI for banning and unbanning services. You need to log in as an admin user, see [here|#Login as Portal Administrator].

To ban or unban a service:
# Navigate to the caGrid Portal service discovery page For example: [http://cagrid-portal.nci.nih.gov/web/guest/tools/service-discovery]\|http://cagrid-portal.nci.nih.gov/web/guest/tools/service-discovery\]
# In the Discovery portlet, search for the service you want to ban or unban. As an admin user, you will be able to see ALL services, including those that are already banned.
# Click the *More Details* link to see the details of this service
# On the details page, click the *Ban Service* or *Unban Service* button as appropriate. The service is immediately banned or unbanned.

*Note:* A banned service can only be unbanned and vice versa. Once you ban a service, the service is immediately hidden in the caGrid Portal. Alternatively, once you unban a service, the service is immediately visible to all Portal users.
{image-with-caption:tablealign=center|pagename=portal:Ban Service|attachmentname=Portal_2.1_admin_ban.png|caption=Ban Service}

h2. Command Line Utility
----
You can also use a command-line tool to ban or unban a service. To run the tool, you must have access to the cagrid-portal release and the configuration for the target instance.

To unban a service, run the following from the cagrid-portal directory:
{code}ant aggr:ban-mgr -Dtarget.env=<env_name>
{code}
The tool prompts you to choose whether to ban or unban the service and then prompts you to enter the service's URL. You can manually ban services by specifying _ban_ as the operation.
{code}ant aggr:ban-mgr -Dtarget.env=<env_name>
{code}

h1. Creating a Friendly URL
----
We will demonstrate this capability creating a friendly URL of the form: [http://example.com/web/guest/register] that will redirect unregistered visitors to the home of the portal [http://example.com/web/guest] where they can register.

Login as an administrative user and go to the control panel.

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=ctrl-panel-home.png|caption=Control Panel Home}

Click on "Communities" in the "Portal" section of the left hand side navigation.

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=cpanel-communities-list.png|caption=Communities List}

Look for the "Guest" community in the list and click on the "Actions" button. A menu will appear, click on the "Manage Pages" option.

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=cpanel-community-actions-menu.png|caption=Community Actions Menu}

Click on the "Home" page on the left, select the "Children" tab, then the "New Page" tab. In the "Name" field enter "Register". In the "Type" field select "URL". Leave "Hidden" and "Copy Parent" unchecked. Click on the "Add Page" button.

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=cpanel-community-add-page.png|caption=Community Add Page}

At the top of the page you will see confirmation that the page was added successfully and the new page now appears in the hierarchy on the left of the main panel.

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=cpanel-community-added-page-ok.png|caption=Community Add Page}

Click on the new created page named "Register" and select the "Page" tab. Here you can edit various fields. In the URL field enter a url of the form: [http://example.com/web/guest]. Click on the "Save" button at the bottom of the page.

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=cpanel-community-edit-page.png|caption=Community Add Page}

At the top of the page you will see confirmation that the page was edited successfully.

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=cpanel-community-edited-page-ok.png|caption=Community Add Page}

After this steps when a visitor navigates to [http://example.com/web/guest/register] she will be redirected automatically to [http://example.com/web/guest] .

h1. Giving a User "Catalog Admin" Permissions.
----
Navigate to the control panel as a Portal Admin user.

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=cpanel-home.png|caption=Control Panel Home}

Select the "Roles" option in the left hand navigation. Search for the "Catalog Admin" role in the list that will appear on the right side panel.

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=cpanel-roles.png|caption=Control Panel Roles}

Click on the "Actions" button. A context menu will appear.

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=cpanel-roles-actions-menu.png|caption=Role Actions Menu}

Select "Assign Members". The following screen will appear.

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=cpanel-roles-assign-members.png|caption=Role Assign Members}

Select the "Assign Members" tab, then the "Users" tab, then the "Available" tab, as shown in the following image. Search for and select the desired user account and click on the "Update Associations" button.

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=cpanel-roles-assign-members-available.png|caption=Update Associations}

A confirmation message will appear at the top of the page.

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=cpanel-roles-assigned-member-ok.png|caption=Confirmation Message}

h1. Refreshing the Grid Statistics.
----
It is possible to recalculate the Grid Statistics shown on the front page. This is a function restricted to administrators.

Go to the Control Panel in https://<host>:<secure_port>/group/control_panel and login as portaladmin.

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=portaladmin-login-detail.png|caption=Portal Administrator Login}

NOTE: 'portaladmin' is the default username for the admin user. If you changed the username when installing the portal, then the URL will change accordingly.

NOTE: Make sure you go to the HTTPS version of this URL. Otherwise, the portaladmin password will be sent in clear text across the network, which is a security risk.

Once logged in navigate to the home page. Under the map you will see a new "Refresh Stats" link.

{image-with-caption:tablealign=center|pagename=portal30:Administrator's Guide|attachmentname=refresh-stats-link.png|caption=Refresh Stats Link}

By clicking on it the recalculation background process will be triggered.

h1. Deploying Portlets

caGrid Portal also hosts portlets developed by external teams. Admin can use the Liferay Administration interface to deploy these portlets. Following are the steps to deploy the caBIO Portlet to the Portal (These instructions will change for other portlets and will be specified in the individual deployment request)

h3. Phase 1: Deploy a Portlet WAR

# Login as Liferay Portal Admin by going to https://<host>:<secure_port>/user/portaladmin

# Select Navigate to the page you want to add the Portlet to.

## The caBIO Portlet is usually placed on https://<host>:<secure_port>/web/guest/community

# At the far, right hand side of the page, you will find a "*Welcome Portal Admin\!"* button

## Hover over the button and select the *Add Application* link.

{gallery:include=Screen shot 2011-09-28 at 2.41.44 PM.png}

# The Add Application menu opens
# Click the *Install More Applications* link

{gallery:include=addPortlet.png}

## You will be taken to the Liferay Server's Plugin Installer page
# Click the *Upload File* tab

{gallery:include=Screen shot 2011-09-28 at 2.43.56 PM.png}

## Click the Browse button and navigate the the Portlet WAR that you want to deploy (ex: cabioportlets.war)
## Optionally provide a context for the War (ex: caBIO)

## Click Install.

## Click the *Install* button.

# After a few seconds you will see green checkboxes that indicate that the portlet has been installed

...

# On the left hand menu, click the *Plugins Configuration* link

{gallery:include=Screen shot 2011-09-28 at 2.46.31 PM.png}

# on the "Plugins Configuration", click the *Last* link (your new portlet is added to the end of the portlet list.)
# Click on the name of your newly installed Portlet

...

h3. Phase 3: Add Portlet to Portal

# Navigate to the page you want to add the Portlet to (you must be logged in as Portal Admin)
# At the far, right hand side of the page, you will find a *Welcome Portal Admin\!* button
## Hover over the button and select the *Add Application* link.
{gallery:include=Screen shot 2011-09-28 at 2.41.44 PM.png}
# The Add Application menu opens
# If your Portlet is not listed, search for it using the name (ex. search for "bio" to find caBIO)
## Click the *Add* link
# If you are unable to find your portlet, you may need to restart the Portal and then retry Phase 3.
## Shutdown the Portal server (JBOSS/Tomcat) (Optional Step)
## Startup the Portal server. The Portlet will deploy once the server has started up completely (Give it a few minutes and check the log to see when the Portlet has deployed)
# Logout of the Portal

# In Now when you open the Portal in a web browser (http://<host>:<port>/web/guest/community), you can see the caBIO Portlet on the page.

This displays a list of portlets that you can deploy in the caGrid Portal.
# Shutdown the Portal server (JBOSS/Tomcat) (Optional Step)
# Startup the Portal server. The Portlet will deploy once the server has started up completely (Give it a few minutes and check the log to see when the Portlet has deployed)

!addPortlet.png!

* Select the "caBIO" application (This might be under its own section or under undefined category). Just select "Add" or drag and drop the portlet on to the current page
Note: If you place the Portlet in a section and need to move it or remove it. Select "Toggle edit controls" from the drop down menu.
* Logout
* Now when you open the Portal in a web browser (http://<host>:<port>/web/guest/community), you can see the caBIO Portlet on the page.