Change the portal URI

Portal Express, Version 6.0
Operating systems: i5/OS, Linux, Windows

Change the portal URI

This section describes how you can change the default portal URI after installation. This includes information about how to change the URI for a Producer portal.

Although IBM^® WebSphere^® Portal Express and Web Services for Remote Portlets are installed with a default URI, you can change this URI after installation to better suit the requirements of your organization.

Before you begin

Copy all a custom portlet application .WAR files that you deployed after the initial installation into the directory portal_server_root/installableApps. This step is required because after changing the portal URI all portlets must be redeployed. The redeployment is done by a configuration task in a step listed further below. The configuration task redeploys all portlet WAR files that are located in the directories portal_server_root/installableApps and portal_server_root/deployed/archive. Therefore copy your custom WAR files into that directory so that they are included in the redeployment. The portlet WAR files that are provided with WebSphere Portal Express are already located in that directory, therefore you do not need to copy them.

Notes:

For changing the WebSphere Portal Express URI: When you specify the context root (WpsContextRoot property), do not specify a value that is the same as a directory existing in a portlet WAR directory. For example, if you set the context root for WebSphere Portal Express to be /images and there is also a portlet with the directory structure /myPortlet.ear/myPortlet.war/images, this could cause a conflict if the portlet encodes URI references to resources in its own /images directory. In this situation, the portlet would be unable to display images because WebSphere Portal Express would look for the image resources according to its own context root path instead of the directory path that is specified by the portlet WAR file.
For changing the URI of a WSRP Producer portal: Changing the WSRP Producer context root does not require that you redeploy all portlets. You only need to run the modify-servlet-path configuration task.

Steps for this task
To change the URI, complete the following steps.Cluster note: If you are modifying the URI in a clustered environment, perform the steps described here only on the primary node. It is not necessary to complete the steps on secondary nodes in the cluster.

Stop the WebSphere Portal Express server.
Locate the wpconfig.properties file and create a backup copy before you change any values.

Windows and Linux: portal_server_root/config/wpconfig.properties
i5/OS: portal_server_root_user/config/wpconfig.properties

After making a backup, use a text editor to open the wpconfig.properties file and enter the values that are appropriate for your environment.
Notes:

Do not change any settings other than those that are specified in these steps. For instructions on working with these files, see Configuration properties reference for a complete properties reference, including default values.
Use forward slashes ( / ) and not backward slashes ( \ ) for all platforms.
Some values that are shown here in italics might need to be modified to your specific environment.

Section of properties file: IBM WebSphere Application Server properties

properties

Property Value
PortalAdminPwd The password for the WebSphere Portal Express administrator, as defined in the PortalAdminId property.

Recommended: Set this value according to a environment.

Default: None

WpsContextRoot The context root or base URI for the portal. All URLs beginning with this path will be reserved for the portal. The value of this property is part of the URL that is used to access WebSphere Portal Express from a browser. For example, http://hostname.example.com:10038/wps/portal, where hostname.example.com is the fully qualified host name of the machine where WebSphere Portal is running and 10038 is the default transport port that is created by WebSphere Application Server.

Recommended: Set this value according to a environment.

Sample value: home

Default: wps

WsrpContextRoot The context root or base URI for WSRP Producer.

Recommended: Set this value according to a environment.

Sample value: wsrp

Default: wsrp

WpsDefaultHome The default portal page. This is the page for users who are not logged in. The value of this property is part of the URL that is used to access WebSphere Portal Express from a browser. For example, http://hostname.example.com:10038/wps/portal, where hostname.example.com is the fully qualified host name of the machine where WebSphere Portal is running and 10038 is the default transport port that is created by WebSphere Application Server.

Recommended: portal

Sample value: ibm

Default: portal

WpsPersonalizedHome The portal page for users who have already logged in to the portal. This page cannot be accessed by anonymous users. The value of this property is part of the URL that is used to access WebSphere Portal Express from a browser. For example, http://hostname.example.com:10038/wps/portal, where hostname.example.com is the fully qualified host name of the machine where WebSphere Portal is running and 10038 is the default transport port that is created by WebSphere Application Server.

Recommended: myportal

Sample value: myibm

Default: myportal

WasPassword

Description: The password for WebSphere Application Server security authentication.

If a value is specified for WasPassword, a value must also be specified for WasUserid. If WasPassword is left blank, WasUserid must also be left blank.
Type: Alphanumeric text string

Recommended: Set this value according to a environment.

Default: ReplaceWithYourWASUserPwd

Save the file.
Open a command prompt and change to the following directory.

Windows and Linux:
portal_server_root/config.
i5/OS:
portal_server_root/config

Perform the following steps, depending on whether you are using an internal or external Web server.

Internal Web server

To change the context root of WSRP Producer or WebSphere Portal Express, enter the following command:

Linux:
./WPSconfig.sh modify-servlet-path -DPortalAdminPwd=password -DWasPassword=password
Windows:
WPSconfig.bat modify-servlet-path -DPortalAdminPwd=password -DWasPassword=password
i5/OS:
WPSconfig.sh -profileName profile_root modify-servlet-path -DPortalAdminPwd=password -DWasPassword=password
where profile_root is the name of the WebSphere Application Server profile where WebSphere Portal Express is installed, for example, wp_profile.

Check the output for any error messages before proceeding with the next task. If any of the configuration tasks fail, verify the values in the wpconfig.properties file.
Spell Checker does not work if the context root is not the default /wps/ . To enable Spell Checker, administrators must set the value of the SpellCheck_Portlet_Context property in the SpellCheckConfig.properties file, which is located in portal_server_root/shared/app/com/ibm/wps/odc/spellcheck/util directory, to the current context root value.
Enter the following command to configure the WebSphere Portal Express or the WSRP URI:

Linux:
./WPSconfig.sh action-update-portlets -DPortalAdminPwd=password -DWasPassword=password
Windows:
WPSconfig.bat action-update-portlets -DPortalAdminPwd=password -DWasPassword=password
i5/OS:
WPSconfig.sh -profileName profile_root action-update-portlets -DPortalAdminPwd=password-DWasPassword=password
where profile_root is the name of the WebSphere Application Server profile where WebSphere Portal Express is installed, for example, wp_profile.

Check the output for any error messages before proceeding with the next task. If any of the configuration tasks fail, verify the values in the wpconfig.properties file.
Restart server1 and the WebSphere Portal Express server.

External Web server (such as HTTP Server)

Enter the following commands to configure the WebSphere Portal Express URI:

Linux:
./WPSconfig.sh modify-servlet-path -DPortalAdminPwd=password -DWasPassword=password
Windows:
WPSconfig.bat modify-servlet-path -DPortalAdminPwd=password -DWasPassword=password
i5/OS:
WPSconfig.sh -profileName profile_root modify-servlet-path -DPortalAdminPwd=password -DWasPassword=password
where profile_root is the name of the WebSphere Application Server profile where WebSphere Portal Express is installed, for example, wp_profile.

Check the output for any error messages before proceeding with the next task. If any of the configuration tasks fail, verify the values in the wpconfig.properties file.
Regenerate the HTTP plug-in in WebSphere Application Server. If you are using a remote Web server, copy the generated plugin-cfg.xml file to the remote server.
Restart the Web server.
Perform these steps only if you are changing the WebSphere Portal Express URI or if portlets are installed.
The next steps should not be performed if you are changing only the WSRP Producer URI.

Update the portlets with the new context root information. Enter the following command to configure the WebSphere Portal Express URI:

Linux:
./WPSconfig.sh action-update-portlets -DPortalAdminPwd=password -DWasPassword=password
Windows:
WPSconfig.bat action-update-portlets -DPortalAdminPwd=password -DWasPassword=password
i5/OS:
WPSconfig.sh -profileName profile_root action-update-portlets -DPortalAdminPwd=password -DWasPassword=password
where profile_root is the name of the WebSphere Application Server profile where WebSphere Portal Express is installed, for example, wp_profile.

Regenerate the HTTP plug-in in WebSphere Application Server. If you are using a remote Web server, copy the generated plugin-cfg.xml file to the remote server.
Restart the Web server.

Restart server1 and the WebSphere Portal Express server.

Perform the following steps if you are using the Resource Manager portlet to manage your site and you changed the portal URI:

Use a text editor to open the wpconfig.properties file:

Linux:
portal_server_root/config/wpconfig.properties
Windows:
portal_server_root\config\wpconfig.properties
i5/OS:
portal_server_root_user/config/wpconfig.properties
You can also modify the wpconfig.properties file locally on your System i5 system by entering EDTF 'portal_server_root_user/config/wpconfig.properties' on a command line:

Edit the BasicAuthUrlBlackList and BasicAuthUrlWhiteList parameters to match the new URI.
Save the wpconfig.properties file.

Clustered environment only: Resynchronize the nodes and restart the cluster.

Open the deployment manager administrative console.
Click System Administration > Nodes, select the primary node from the list, and click Full Resynchronize.
Click Servers > Clusters.
Select the cluster and click Stop.
After the cluster has stopped, restart it by selecting the cluster and clicking Start.

Related information

Installing on Windows and Linux

Parent topic:
Configuring

Related concepts
Configuring security Configuration tools

Property	Value
PortalAdminPwd	The password for the WebSphere Portal Express administrator, as defined in the PortalAdminId property. Recommended: Set this value according to a environment. Default: None
WpsContextRoot	The context root or base URI for the portal. All URLs beginning with this path will be reserved for the portal. The value of this property is part of the URL that is used to access WebSphere Portal Express from a browser. For example, http://hostname.example.com:10038/wps/portal, where hostname.example.com is the fully qualified host name of the machine where WebSphere Portal is running and 10038 is the default transport port that is created by WebSphere Application Server. Recommended: Set this value according to a environment. Sample value: home Default: wps
WsrpContextRoot	The context root or base URI for WSRP Producer. Recommended: Set this value according to a environment. Sample value: wsrp Default: wsrp
WpsDefaultHome	The default portal page. This is the page for users who are not logged in. The value of this property is part of the URL that is used to access WebSphere Portal Express from a browser. For example, http://hostname.example.com:10038/wps/portal, where hostname.example.com is the fully qualified host name of the machine where WebSphere Portal is running and 10038 is the default transport port that is created by WebSphere Application Server. Recommended: portal Sample value: ibm Default: portal
WpsPersonalizedHome	The portal page for users who have already logged in to the portal. This page cannot be accessed by anonymous users. The value of this property is part of the URL that is used to access WebSphere Portal Express from a browser. For example, http://hostname.example.com:10038/wps/portal, where hostname.example.com is the fully qualified host name of the machine where WebSphere Portal is running and 10038 is the default transport port that is created by WebSphere Application Server. Recommended: myportal Sample value: myibm Default: myportal
WasPassword	Description: The password for WebSphere Application Server security authentication. If a value is specified for WasPassword, a value must also be specified for WasUserid. If WasPassword is left blank, WasUserid must also be left blank. Type: Alphanumeric text string Recommended: Set this value according to a environment. Default: ReplaceWithYourWASUserPwd