Installing the IBM Connections Portlets for WebSphere Portal

Install the IBM® Connections Portlets for IBM WebSphere® Portal using the Portal Solutions Installer.

Before you begin

Using the portlets, you can access only those IBM Connections offerings that you already installed and configured. Note the following restrictions and prerequisites before you install:
  • If you have a version of the portlets prior to the 3.0.1.1 Portlets Refresh release, which was installed manually without the PAA solution installer, you must uninstall the previous version before you install. Upgrading from a previous version that was installed manually is not supported. Before you run the PAA Solution installer, manually clear configuration settings from the previous installations. For example, remove any existing settings for the DynaCache, REP, search jars, or VMM configuration.
  • To enable LTPA single sign-on between an IBM Connections feature and a WebSphere Application Server configured for stand-alone LDAP, complete the steps in the section Configuring authentication. to enable single-sign on before you start the installation.
  • When Single Sign-On is enabled between Portal and Connections, the Portal administrator who installs and configures the IBM Connections portlets must be a valid Connections user. For example, the user you assign to manage the Virtual Member manager, as set using the -DICdsxAdminId parameter from Step 5, can be made a Portal administrator by following the steps in the article How to assign a new portal administration group aside from wpsadmins in the IBM WebSphere Portal wiki. You can also create a Connections profile for the default Portal administrator in the IBM Connections profiles database by following the steps in the topic Adding LDAP data to the Profiles database.
  • Anonymous Portal users can access the IBM Connections portlets and are treated as anonymous Connections users. However, authenticated Portal users must also be valid Connections users or they will get an error when they try to access a Connections portlet.

Procedure

  1. You can download the solution installer from the Greenhouse catalog. The PAA installer is already available on Portal 8.
  2. Download the Portlets Archive Install file, SNPortlets.paa. Open a command prompt and change to the following directory:
    • AIX®: [wp_profile_root]/ConfigEngine
    • Linux: [wp_profile_root]/ConfigEngine
    • Solaris: [wp_profile_root]/ConfigEngine
    • Windows: [wp_profile_root]\ConfigEngine
  3. Install the PAA, following the instructions for your operating system.
    Note:
    • This task can be run with the server running or stopped.
    • All of the required and optional parameters for the installation script are described in the topic Installation Options
    • If you are installing in a clustered environment, complete the installation steps on the primary node and then on all additional nodes.
    • Make sure that all node agents are running during the installation.
    AIX, Linux, or Solaris:
    ./ConfigEngine.sh install-paa -DPAALocation=[location-to-paa]/SNPortlets.paa -DWasPassword=[was-admin-pwd] 
    -DPortalAdminPwd=[portal-admin-pwd]
    Windows:
    ConfigEngine.bat install-paa -DPAALocation=[location-to-paa]/SNPortlets.paa 
    -DWasPassword=[was-admin-pwd] -DPortalAdminPwd=[portal-admin-pwd]
    z/OS: Complete the following steps:
    1. In the Portal configuration panel, select Application configuration tasks.
    2. Select Configure content with Solution Installer.
    3. Select Install and deploy a solution.
    4. Select Define variables.
      Note: Press F1 to display the help panel if you need assistance defining the variables.
    5. Generate the customization jobs.
    6. Follow the Customization dialog instructions for submitting the customization jobs.
  4. Register the PAA.
    Note:
    • Start the server before running this task.
    • All of the required and optional parameters for the installation script are described in the topic Installation Options
    • Follow the pattern from Step 3 for running the ConfigEngine command for your operating system.
    • If you are installing in a clustered environment, complete the installation steps on the primary node and then on all additional nodes.
    ConfigEngine deploy-paa -DappName=SNPortlets -DICinstallType=full -DWasPassword=[was-admin-pwd] 
    -DPortalAdminPwd=[portal-admin-pwd]
    Note: If you are deploying to a clustered environment and your PAA file contains XMLAccess script files, add the following two parameters to the deploy-paa task:
    • -DmaxTimeToWait
    • -DmaxAppTimeToWait
    These values define the time that the wplc-wait-for-sync-to-complete task waits to synchronize your nodes.  The default values are -DmaxTimeToWait=30 and -DmaxAppTimeToWait=5.  The values are in minutes.  If your clustered environment requires a longer synchronize time, add these parameters to your deploy-paa task with values that meet your requirements.
  5. Configure the portlets.
    Note:
    • Start the server before running this task.
    • All of the required and optional parameters for the installation script are described in the topic Installation Options
    • Follow the pattern from Step 3 for running the ConfigEngine command for your operating system.
    • If you are installing in a clustered environment, complete the installation steps on the primary node and then on all additional nodes.

    If you are installing on WebSphere Portal 8, run:

    ConfigEngine configure-SNPortlets -DICversion=5.0 -DICblogsHomepageHandle=[homepagehandle] 
    -DICemailSetting=[emailSetting] -DICtagSearchType=[tagSearchType] -DICdsxAdminId=[dsxAdminId] -DICdsxAdminPwd=[dsxAdminPwd]
    -DICbaseURLunsecured=[baseURLunsecured] -DICbaseURL=[baseURL]
    -DWasPassword=[was-admin-pwd] -DPortalAdminPwd=[portal-admin-pwd]

    For example:

    ConfigEngine configure-SNPortlets -DICversion=5.0 -DICblogsHomepageHandle=homepage 
    -DICemailSetting=email-exposed -DICtagSearchType=mysearch -DICdsxAdminId=fadams -DICdsxAdminPwd=passw0rd 
    -DICbaseURLunsecured=http://connections.example.com -DICbaseURL=https://connections.example.com 
    -DWasPassword=[was-admin-pwd] -DPortalAdminPwd=[portal-admin-pwd]
  6. Follow the steps in Configuring the ajax proxy to allow FileNet requests to allow requests to the FileNet server through the Ajax proxy.
  7. Configure Search.
    Note:
    • All of the required and optional parameters for the installation script are described in the topic Installation Options
    • Follow the pattern from Step 3 for running the ConfigEngine command for your operating system.
    • If you are installing in a clustered environment, complete the installation steps on the primary node and then on all additional nodes.

    If you are installing on WebSphere Portal 8, execute:

    ConfigEngine configure-SNPortletsSearch -DICversion=5.0 -DWasPassword=[was-admin-pwd] 
    -DPortalAdminPwd=[portal-admin-pwd]
  8. For the search service that contains the search collections that you added for the IBM Connections services, add a new parameter: ExternalSecurityResolverUrlUse with a value of https://host:port/<ConnectionsResourceId>/seedlist/authverify/getACLTokens where ConnectionsResourceID is any IBM Connections resource identifier.  For example:  https://connections.server.com/wikis/seedlist/authverify/getACLTokens For more information, refer to the Search service configuration parameters article in the WebSphere Portal knowledge center.
  9. Restart the server so that all changes take effect.
  10. If you are installing in a clustered environment, resynchronize the nodes.
  11. Follow the steps in Configuring common directory services for your security configuration to complete the configuration.
  12. Verify that the portlets are successfully installed.
  13. Follow the steps in Updating the portlet theme to assign a performance-optimized profile to the pages so that they meet portlets requirements.
    Note: By default, if a full profile exists in the theme, it is assigned to the pages. As the full profile loads more content than what is required for the portlets, make sure to perform these steps before you go live with your solution.