IBM WebSphere Portal Solution Installer. User Guide 1.2

Transcription

1 IBM WebSphere Portal Solution Installer User Guide 1.2 Version 1 Release 3

2 1 INTRODUCTION INTRODUCING SOLUTION INSTALLER ABOUT THIS DOCUMENT WHO SHOULD USE THIS DOCUMENT INSTALLING SOLUTION INSTALLER TO WEBSPHERE PORTAL SOLUTION INSTALLER TEST ENVIRONMENT BEFORE INSTALLING INSTALLING SOLUTION INSTALLER Installing Solution Installer on Windows Installing Solution Installer on Linux Installing Solution Installer on AIX Installing Solution Installer on IBM i Installing in a clustered environment SETTING UP THE PAA OFFERING DIRECTORY AND REGISTERING IT WITH THE CONFIGENGINE UNINSTALLING SOLUTION INSTALLER REMOVING SOLUTION INSTALLER PAAS AND THEIR REGISTRATIONS UNINSTALLING SOLUTION INSTALLER Uninstalling Solution Installer on Windows Uninstalling Solution Installer on Linux Uninstalling Solution Installer on AIX Uninstalling Solution Installer on IBM i RUNNING SOLUTION INSTALLER INSTALLING A PAA FILE TO WEBSPHERE PORTAL UNINSTALLING A PAA FILE UPDATING WCM LIBRARIES VIRTUAL PORTALS SOLUTION INSTALLER RUNTIME CONFIGURATION DESCRIPTION OF PROPERTIES FILES SOLUTION INSTALLER RUNTIME CONFIGURATION FILE INSTALLATION TROUBLESHOOTING INSTALLING SOLUTION INSTALLER WCM LIBRARIES ON LINUX CHANGING THE PORT NUMBERS IN PROPERTIES FILES INSTALLING ON A CLUSTER SERIALIZATION ISSUE WITH PZN NODES FILE UPLOAD WITH TAI ENABLED...23

3 1 Introduction 1.1 Introducing Solution Installer The IBM WebSphere Portal Solution Installer is a utility for installing, uninstalling, and updating solutions or applications WebSphere Portal. The basis of the Solution Installer is a standard format for application distribution, the Portal Application Archive (PAA) format. This format is described in full in the Developers guide and developers who want to prepare their applications to be installed by the Solution Installer should refer to this document. 1.2 About this document This document provides instructions for the following items: Installing and uninstalling the Solution Installer to/from WebSphere Portal Using the Solution Installer to install, uninstall, and update PAA formatted Portal applications Knowledge of IBM WebSphere Portal and Portal Applications is assumed in this document. 1.3 Who should use this document This document is intended for the following users: Portal Administrators who want to install Solution Installer Portal Administrators who want to install PAA formatted applications using the Solution Installer.

4 2 Installing Solution Installer to WebSphere Portal This chapter provides instructions for WebSphere Portal administrators who want to install Solution Installer. First, you deploy the Solution Installer to IBM WebSphere Portal. Then you set up the Portal Application Archive (PAA) offering directory. AFinally, you register it with the WebSphere Portal ConfigEngine. All subsections in this section are required reading. To successfully activate the Solution Installer, all steps in sections 2.3 and 2.4 must be completed. 2.1 Solution Installer test environment Solution Installer 1.2 has been verified in the following software environments Portal Environment: IBM WebSphere Portal Version 6.1.5, , Operating System: Windows Server 2008 Red Hat Enterprise Linux (RHEL) 5 IBM AIX 6.1 IBM i V7R1 2.2 Before installing Uninstall any existing Solution Installers before you install a new version. Refer to the uninstall section of this document for uninstallation instructions. Note: You will need a compression tool for the installation. Prior to installing Solution Installer, in order to provide the access credentials to perform configuration tasks on the Portal server, you need to set the 'WasPassword and the PortalAdminPwd properties in this file: profile_dir/configengine/properties/wkplc.properties Instructions on what values these properties should be set to can be found in the wkplc.properties file. Note: You can also pass the relevant properties on the command line. Add a -D before the property name. For example to pass in the WasPassword property, you would type - DwasPassword=password.

5 2.3 Installing Solution Installer Installing Solution Installer on Windows To install the Solution Installer on Windows, use the command line to run a batch file. The batch file script automates the installation. It runs ConfigEngine tasks. 1. Extract the SolutionInstaller.zip file to a temporary directory. For example: C:\temp\. 2. Set Profile_Directory in settings.properties. Open settings.properties in the C:\temp\SolutionInstaller\commands\windows directory. Set Profile_Directory to the WebSphere Application Profile directory path. For example: Profile_Directory=C:/IBM/WebSphere/wp_profile 3. Run the installation script. a. Open a command line prompt. b. Go to the c:\temp\solutioninstaller\commands\windows directory. c. Enter and run the following command: install-solutioninstaller.bat Results The batch file copies the relevant files to the./portalserver/solutioninstaller directory and installs Solution Installer to WebSphere Portal. The results of the installation are recorded in install.log, which is created in the same directory as install- SolutionInstaller.bat. Refer to install.log to analyze and troubleshoot any errors or problems with the installation. Note: You can verify the command completed successfully by checking that SolutionInstaller is appearing in ConfigEngine/registry.xml. Next step: Complete all steps outlined in sections and Installing Solution Installer on Linux To install Solution Installer on Linux, run a shell script from a terminal window. The script automates the installation by running IBM WebSphere Portal ConfigEngine tasks. 1. Extract the SolutionInstaller.zip file to a temporary directory. For example: /opt/temp/. 2. Set Portal settings in settings.properties. Open settings.properties which is in /opt/temp/solutioninstaller/commands/linux. Set Profile_Directory to the WebSphere Application Profile directory path. For example: Profile_Directory=/opt/IBM/WebSphere/wp_profile Set UnixFilePermissions to the value of the file permissions of your PortalServer directory. This will ensure that the permissions are reset after Solution Installer installation has completed. The default value is Ensure install-solutioninstaller.sh contains the correct UNIX end-of-line characters. a. Open a terminal and go to /opt/temp/solutioninstaller/commands/linux directory.

6 b. Run the following command: dos2unix b install-solutioninstaller.sh. 4. Ensure you have run permission on install-solutioninstaller.sh. a. Open a terminal and navigate to /opt/temp/solutioninstaller/commands/linux directory. b. Run the following command to determine if you have run permission: ls l. c. If you do not have run permission, run the following command: chmod 755 install-solutioninstaller.sh. 5. Run the installation script. a. Open a terminal and navigate to /temp/solutioninstaller/commands/linux directory. b. Enter and run the following command:./install-solutioninstaller.sh. Results The shell script copies the relevant files to the PortalServer/SolutionInstaller directory and installs Solution Installer to WebSphere Portal. The results of the installation are recorded in install.log, which is created in the same directory as install- SolutionInstaller.sh. Refer to install.log to analyze and troubleshoot any errors or problems with the installation. Note: You can verify the command completed successfully by checking that SolutionInstaller is appearing in ConfigEngine/registry.xml. Next step: Complete all steps outlined in sections and Installing Solution Installer on AIX To install Solution Installer on AIX, run a shell script from a terminal window. The script automates the installation by running IBM WebSphere Portal ConfigEngine tasks. 1. Extract the SolutionInstaller.zip file to a temporary directory. For example: /tmp/. 2. Set Portal settings in settings.properties. Open settings.properties which is in /tmp/solutioninstaller/commands/aix. Set Profile_Directory to the WebSphere Application Profile directory path. For example: Profile_Directory=/usr/IBM/WebSphere/wp_profile Set UnixFilePermissions to the value of the file permissions of your PortalServer directory. This will ensure that the permissions are reset after Solution Installer installation has completed. The default value is Ensure you have run permission on install-solutioninstaller.sh. a. Open a terminal and go to /tmp/solutioninstaller/commands/aix directory. b. Run the following command to determine if you have run permission: ls l. c. If you do not have run permission, run the following command: chmod 755 install-solutioninstaller.sh. 4. Run the installation script. a. Open a terminal and go to /tmp/solutioninstaller/commands/aix directory. b. Enter and run the following command:./install-solutioninstaller.sh. Results The shell script copies the relevant files across to the PortalServer/SolutionInstaller directory and installs the Solution Installer on WebSphere Portal. The results of the

7 installation are recorded in install.log, which is created in the same directory as install- SolutionInstaller.sh. Refer to install.log to analyze and troubleshoot any errors or problems with the installation. Note: You can verify the command completed successfully by checking that SolutionInstaller is appearing in ConfigEngine/registry.xml. Next step: Complete all steps outlined in sections and Installing Solution Installer on IBM i To install Solution Installer on IBM i Series, run a shell script from a terminal command window. The script automates the installation by running IBM WebSphere Portal ConfigEngine tasks. 1. Extract the SolutionInstaller.zip file to a temporary directory. For example: /tmp/. 2. Set Portal settings in settings.properties. Open settings.properties which is in /tmp/solutioninstaller/commands/iseries. Set Profile_Directory to the WebSphere Application Profile directory path. For example: Profile_Directory= /QIBM/UserData/WebSphere/AppServer/V7/ND/profiles/wp_profile 3. Ensure you have run permission on install-solutioninstaller. a. Open a terminal and go to /tmp/solutioninstaller/commands/iseries directory. b. Run the following command to determine if you have run permission: ls l. c. If you do not have run permission, run the following command: chmod 755 install-solutioninstaller 4. Run the installation script. a. Open a terminal and go to /tmp/solutioninstaller/commands/iseries directory. b. Enter and run the following command:./install-solutioninstaller Results The shell script copies the relevant files across to the PortalServer/SolutionInstaller directory and installs the Solution Installer on WebSphere Portal. The results of the installation are recorded in install.log, which is created in the same directory as install- SolutionInstaller.sh. Refer to install.log to analyze and troubleshoot any errors or problems with the installation. Note: You can verify the command completed successfully by checking that SolutionInstaller is appearing in ConfigEngine/registry.xml. Next step: Complete all steps outlined in sections and Installing in a clustered environment The current clustered environment automatically supported by Solution Installer can handle multiple clusters of nodes within a cell. However, it is unable to automatically handle a cluster of servers within a node. Solution Installer assumes that there is only one portal server per node. Provision has yet to be included to handle multiple servers in a cluster inside of a

8 single node. However, if you want to use a cluster with multiple servers per node you need to run some additional steps after the solution installer has been configured. The Solution Installer installation scripts rely on settings found in the profile/configengine/properties/wkplc.properties file to provide the relevant environment information. When installing in a clustered environment, the WasRemoteHostName property must point to the host name of the deployment manager. The WasSoapPort property must also be equal to the soap port number of the deployment manager for a successful install. Without setting this information, the Solution Installer is installed to the current node. During a synchronisation with the deployment manager, the settings are overwritten. Many of the configuration changes performed during the installation are lost. After configuring your cluster, run the installation script from the primary node first. Then run it on all the secondary nodes. Before you run the script on the secondary nodes, complete the following steps: 1. Go to the following directory: Windows: wp_profile_root\configengine\properties Linux: wp_profile_root/configengine/properties AIX: wp_profile_root/configengine/properties IBM i: wp_profile_root/configengine/properties 2. Locate and open wkplc.properties in a text editor. 3. Ensure the value for the PrimaryNode parameter is false. If you do want to use the type of scenario outlined with multiple servers per node you can do the following for each subsequent server in the cluster: On each node, open a command window, go to the profile/configengine directory, and run the following command by passing in server specific values. ConfigEngine.sh bat action-create-app-server-library-references-components/solutioninstaller -DServerName=servername -DWasUserid=wasUserid -DWasPassword=password 2.4 Setting up the PAA offering directory and registering it with the ConfigEngine This step has been included in the operating system specific batch and shell scripts for installing the Solution Installer since version Therefore, depending on which version of the Solution Installer you are installing, this step might not be necessary. However, running the task a second time recreates the current configuration once no changes have been made to the runtime properties in section 5 of this document.

9 Windows: a. Open a command line prompt and go to the ConfigEngine directory. For example, C:\IBM\WebSphere\wp_profile\ConfigEngine. b. Enter and run the following command: ConfigEngine.bat si-setup. c. Restart portal server. Linux: a. Open a terminal window and navigate to ConfigEngine directory. For example, /opt/ibm/websphere/wp_profile/configengine. b. Enter and run the following command:./configengine.sh si-setup. c. Restart portal server. AIX: a. Open a terminal window and navigate to ConfigEngine directory. For example, /usr/ibm/websphere/wp_profile/configengine. b. Enter and run the following command:./configengine.sh si-setup. c. Restart portal server. IBM i: a. Open a terminal window and navigate to ConfigEngine directory. For example, /QIBM/UserData/WebSphere/AppServer/V7/ND/profiles/wp_profile/ConfigEngine. b. Enter and run the following command:./configengine.sh si-setup. c. Restart portal server. Notes: 1. Before running the command, you need to add values for the WasPassword and PortalAdminPwd properties in the wkplc.properties file in the ConfigEngine/properties folder. 2. You can verify that the command completed successfully by checking that the paa folder is created in the WebSphere_root directory. For example: C:\IBM\WebSphere\paa. 3. The default setting for the PAA offering is offering name 'paa' and will be located in the parent directory of the Portal Server. For example: C:\IBM\Websphere. If you want to change the offering name or location, you will need to edit the SolutionInstaller.properties file in this directory: PortalServer/SolutionInstaller/components/SolutionInstaller. 4. The si-setup task must be run on each node in the cluster. When running si-setup on secondary nodes on the AIX, i and Linux operating systems, the following parameter should be passed on the command line, - Dsi.wps.UnixFilePermissions. This parameter should equal the value of the UnixFilePermissions property found in the PortalServer/wps.properties file on the primary node, or the value of the file permissions of the PortalServer directory on the secondary node. For example: ConfigEngine.sh si-setup -Dsi.wps.UnixFilePermissions=550

10 3 Uninstalling Solution Installer This chapter provides instructions for WebSphere Portal administrators who want to uninstall Solution Installer from WebSphere Portal. When upgrading Solution Installer to a later version, it is only necessary to complete the steps outlined in section 3.2, prior to the installation of the later version. Otherwise the PAA files that you have previously installed to the ConfigEngine will also be removed. However, if you want to also remove the PAA offering and all resources of Solution Installer then you should also complete the steps in section Removing Solution Installer PAAs and their registrations Windows: a. Open a command line prompt and go to the ConfigEngine directory. For example, C:\IBM\WebSphere\wp_profile\ConfigEngine. b. Enter and run the following command: ConfigEngine.bat si-remove-setup. Linux: a. Open a terminal and go to the ConfigEngine directory. For example, /opt/ibm/websphere/wp_profile/configengine. b. Enter and run the following command:./configengine.sh si-remove-setup. AIX: a. Open a terminal and go to the ConfigEngine directory. For example, /usr/ibm/websphere/wp_profile/configengine. b. Enter and run the following command:./configengine.sh si-remove-setup. IBM i: a. Open a terminal and go to the ConfigEngine directory. For example, / /QIBM/UserData/WebSphere/AppServer/V7/ND/profiles/wp_profile/ConfigEngine. b. Enter and run the following command:./configengine.sh si-remove-setup. Notes: 1. You can verify that the command completed successfully by checking that the paa folder is removed from the WebSphere_root directory. 2. Only the offering is removed if there are no assemblies currently contained within ConfigEngine.

11 3.2 Uninstalling Solution Installer Uninstalling Solution Installer on Windows 1. Ensure property Profile_Directory is set correctly in settings.properties (refer to step 2 in section 2.3.1). 2. Run the uninstallation script. a. Open a command line prompt. b. Navigate to the /PortalServer/SolutionInstaller/commands/windows directory. c. Enter and run the following command: uninstall-solutioninstaller.bat. Results The batch file uninstalls Solution Installer. The results of the operation are recorded in uninstall.log, which is created in the same directory as uninstall-solutioninstaller.bat. Refer to uninstall.log to analyze and troubleshoot any errors or problems with the uninstallation Uninstalling Solution Installer on Linux 1. Ensure property Profile_Directory is set correctly in settings.properties (refer to step 2 in section 2.3.2). 2. Ensure uninstall-solutioninstaller.sh contains the correct UNIX end-of-line characters. a. Open a terminal and go to /PortalServer/SolutionInstaller/commands/linux directory. b. Run the following command: dos2unix b uninstall-solutioninstaller.sh. 3. Ensure you have run permission on uninstall-solutioninstaller.sh. a. Open a terminal and navigate to /PortalServer/SolutionInstaller/commands/linux directory. b. Run the following command to determine if you have run permission: ls l c. If you do not have run permission, run the following command: chmod 755 uninstall-solutioninstaller.sh 4. Run the uninstallation script. a. Open a terminal and go to /PortalServer/SolutionInstaller/commands/linux directory. b. Enter and run the following command:./uninstall-solutioninstaller.sh. Results The shell script uninstalls the Solution Installer. The results of the uninstallation are recorded in uninstall.log, which is created in the same directory as uninstall- SolutionInstaller.sh. Refer to uninstall.log to analyze and troubleshoot any errors or problems with the uninstallation.

12 Notes: 1. This command unregisters Solution Installer from the ConfigEngine only. It should no longer appear in the ConfigEngine/registry.xml. 2. You can verify that the command completed successfully by checking that SolutionInstaller is removed in ConfigEngine/registry.xml Uninstalling Solution Installer on AIX 1. Ensure property Profile_Directory is set correctly in settings.properties (refer to step 2 in section 2.3.3). 2. Ensure you have run permission on uninstall-solutioninstaller.sh. a. Open a terminal and go to /PortalServer/SolutionInstaller/commands/AIX directory. b. Run the following command to determine if you have run permission: ls l c. If you do not have run permission, run the following command: chmod 755 uninstall-solutioninstaller.sh 3. Run the uninstallation script. a. Open a terminal and go to /PortalServer/SolutionInstaller/commands/AIX directory. b. Enter and run the following command:./uninstall-solutioninstaller.sh. Results The shell script uninstalls the Solution Installer. The results of the uninstallation are recorded in uninstall.log, which is created in the same directory as uninstall- SolutionInstaller.sh. Refer to uninstall.log to analyze and troubleshoot any errors or problems with the uninstallation. Notes: 1. This command unregisters Solution Installer from the ConfigEngine only. It should no longer appear in the ConfigEngine/registry.xml. 2. You can verify that the command completed successfully by checking that SolutionInstaller is removed in ConfigEngine/registry.xml Uninstalling Solution Installer on IBM i 1. Ensure property Profile_Directory is set correctly in settings.properties (refer to step 2 in section 2.3.4). 2. Ensure you have run permission on uninstall-solutioninstaller. a. Open a terminal and go to /PortalServer/SolutionInstaller/commands/iSeries directory. b. Run the following command to determine if you have run permission: ls l c. If you do not have run permission, run the following command: chmod 755 uninstall-solutioninstaller 3. Run the uninstallation script. a. Open a terminal and go to /PortalServer/SolutionInstaller/commands/iSeries directory. b. Enter and run the following command:./uninstall-solutioninstaller

13 Results The shell script uninstalls the Solution Installer. The results of the uninstallation are recorded in uninstall.log, which is created in the same directory as uninstall- SolutionInstaller.sh. Refer to uninstall.log to analyze and troubleshoot any errors or problems with the uninstallation. Notes: 1. This command unregisters Solution Installer from the ConfigEngine only. It should no longer appear in the ConfigEngine/registry.xml. 2. You can verify that the command completed successfully by checking that SolutionInstaller is removed in ConfigEngine/registry.xml.

14 4 Running Solution Installer This chapter provides instructions for WebSphere Portal Administrators who want to install, uninstall or update applications, which are in PAA format. 4.1 Installing a PAA file to WebSphere Portal Installing a PAA file to WebSphere Portal involves: Extracting the PAA files, generating code and registering the PAA files with the ConfigEngine Resolving component version clash issues if there are any Deploying the content of the PAA file to WebSphere portal To install a PAA file follow these steps: 1. Open a Windows command prompt or Linux terminal window and go to the ConfigEngine directory. For example, Windows: C:/IBM/WebSphere/wp_profile/ConfigEngine Linux: /opt/ibm/websphere/wp_profile/configengine AIX: /usr/ibm/websphere/wp_profile/configengine IBM i: /QIBM/UserData/WebSphere/AppServer/V7/ND/profiles/wp_profile/ConfigEngine 2. Enter and run the following command to register the PAA file with the ConfigEngine Windows: ConfigEngine.bat install-paa DPAALocation=<paafile> For example, ConfigEngine.bat install-paa DPAALocation=C:/Project/paas/samplepaa.paa Linux:./ConfigEngine.sh install-paa DPAALocation=<paafile> For example,./configengine.sh install-paa DPAALocation=/opt/workspace/paas/samplepaa.paa AIX:./ConfigEngine.sh install-paa DPAALocation=<paafile> For example,./configengine.sh install-paa DPAALocation=/tmp/paas/samplepaa.paa IBM i:./configengine.sh install-paa DPAALocation=<paafile> For example,./configengine.sh install-paa DPAALocation=/tmp/paas/samplepaa.paa Note: You can verify that the command completed successfully by checking that the PAA folder has a subfolder named as the paa file. For example, C:/IBM/WebSphere/paa/samplepaa. 3. Open a file browser, for example, windows explorer, go to the paa directory, for example, C:/IBM/WebSphere/paa. 4. Go to the sub directory for the PAA being installed. 5. Open the components.properties file to check for conflicts with previously installed components (see section 4.3 for more details) Notes: 1. There is a property in the components.properties file for each component in the assembly to be installed. 2. Those components that are not already installed to Portal are set to true and those

15 that are installed are set to false. 3. If there are no clashes or you do not want to replace existing components with the updates from the new assembly, go to step 8 to continue the deployment. Otherwise, you need to complete steps 6 and Edit components.properties file and change any previously installed components that you want to update from false to true. 7. Type and run the following command: Windows: ConfigEngine.bat update-paa-components -DappName=<assemblyName> For example, ConfigEngine.bat update-paa-components -DappName=samplepaa Linux:./ConfigEngine.sh update-paa-components -DappName=<assemblyName> For example,./configengine.sh update-paa-components -DappName= samplepaa AIX:./ConfigEngine.sh update-paa-components -DappName=<assemblyName> For example,./configengine.sh update-paa-components -DappName= samplepaa IBM i:./configengine.sh update-paa-components -DappName=<assemblyName> For example,./configengine.sh update-paa-components -DappName= samplepaa Notes: 1. This command removes the registration of the component from the original assembly and registers the new version with the current assembly. 2. The update command does not remove the artifacts from WebSphere portal. It just removes the registration of the component from the ConfigEngine. 8. Type and run the following command to deploy PAA content to Portal: Windows: ConfigEngine.bat deploy-paa -DappName=samplepaa Linux:./ConfigEngine.sh deploy-paa -DappName=samplepaa AIX:./ConfigEngine.sh deploy-paa -DappName=samplepaa IBM i:./configengine.sh deploy-paa -DappName=samplepaa The deploy-paa task installs the components registered during the install-paa phase that have their value set to true in the components.properties file. If you want the Solution Installer register all components automatically without editing the components.properties file, you need to pass in the parameter forcedeploy and set it to true, for example: Windows: ConfigEngine.bat deploy-paa -DappName=samplepaa -DforceDeploy=true Linux:./ConfigEngine.sh deploy-paa -DappName=samplepaa -DforceDeploy=true AIX:./ConfigEngine.sh deploy-paa -DappName=samplepaa -DforceDeploy=true IBM i:./configengine.sh deploy-paa -DappName=samplepaa -DforceDeploy=true 4.2 Uninstalling a PAA file Complete the following steps to remove an assembly from WebSphere Portal: 1. Open a command prompt and go to the ConfigEngine directory. For example, Windows: C:/IBM/WebSphere/wp_profile/ConfigEngine Linux: /opt/ibm/websphere/wp_profile/configengine AIX: /usr/ibm/websphere/wp_profile/configengine IBM i: /QIBM/UserData/WebSphere/AppServer/V7/ND/profiles/wp_profile/ConfigEngine

16 2. Type and run the following command: Windows: ConfigEngine.bat remove-paa DappName =<assemblyname> For example, ConfigEngine.bat remove-paa DappName =samplepaa Linux:./ConfigEngine.sh remove-paa DappName =<assemblyname> For example,./configengine.sh remove-paa DappName =samplepaa AIX:./ConfigEngine.sh remove-paa DappName =<assemblyname> For example,./configengine.sh remove-paa DappName =samplepaa IBM i:./configengine.sh remove-paa DappName =<assemblyname> For example,./configengine.sh remove-paa DappName =samplepaa Note: This command checks whether there are any dependencies on the components in this assembly from other assemblies registered to the current offering. Only components that have no dependencies and have their value set to true in the components.properties file are removed. To overwrite the settings in the components.properties file you need to pass in the parameter forceremove and set it to true, for example: Windows: ConfigEngine.bat remove-paa DappName =samplepaa -DforceRemove=true Linux:./ConfigEngine.sh remove-paa DappName =samplepaa -DforceRemove=true AIX:./ConfigEngine.sh remove-paa DappName =samplepaa -DforceRemove=true IBM i:./configengine.sh remove-paa DappName =samplepaa -DforceRemove=true To uninstall the PAA assembly from the ConfigEngine 1. Open a command prompt and go to the ConfigEngine directory. For example, Windows: C:/IBM/WebSphere/wp_profile/ConfigEngine Linux: /opt/ibm/websphere/wp_profile/configengine AIX: /usr/ibm/websphere/wp_profile/configengine IBM i: /QIBM/UserData/WebSphere/AppServer/V7/ND/profiles/wp_profile/ConfigEngine 2. Type and run the following command: Windows: ConfigEngine.bat uninstall-paa -DappName=<assemblyName> Or ConfigEngine.bat uninstall-paa -DappName=<assemblyName> - DforceUninstall=true Linux:./ConfigEngine.sh uninstall-paa -DappName=<assemblyName> Or./ConfigEngine.sh uninstall-paa -DappName=<assemblyName> - DforceUninstall=true For example, ConfigEngine.sh uninstall-paa -DappName=samplepaa AIX:./ConfigEngine.sh uninstall-paa -DappName=<assemblyName> Or./ConfigEngine.sh uninstall-paa -DappName=<assemblyName> - DforceUninstall=true IBM i:./configengine.sh uninstall-paa -DappName=<assemblyName> Or./ConfigEngine.sh uninstall-paa -DappName=<assemblyName> - DforceUninstall=true Note: The uninstall-paa command checks whether components are required by other

17 assemblies. It only removes those components that are not registered as dependencies and have their value set to true in the components.properties file. To remove all components included in an assembly, add the optional parameter 'forceuninstall' and set it to true. Although the uninstall-paa command removes any components from the ConfigEngine registry, it does not remove the expanded PAA files from the disk. The reasons are due to the possibility that other assemblies have a reliance on components of this assembly. In addition, the user might have performed some configuration tasks on the content of the expanded PAA file, such as, editing customizable properties, thus it is left up to the user to decide whether they want to delete the file content from disk or not. Updating components Solution Installer provides functions for updating previously installed components on WebSphere Portal. At runtime, Solution Installer extracts the list of installed components registered with the ConfigEngine from the component registry. Then, each component name in the PAA is compared to the previously installed list. A properties file (components.properties) is written to the PAA assembly directory consisting of the list of components in the application, and a true or false value based on whether or not the component is to be installed (for example. componentname1=true). If the component is not already installed, then the value is set to true. If the component is already installed, then the value is set to false, and a message is added, based on a comparison between the versions. Note: This is a case sensitive comparison. An installed component componentname is registered as a different component to a component named componentname in an assembly. If the installed version is more recent, then the message Newer version of component installed, change to true to force install is added. If the installed version is an older version of the component, then the message Older version of component installed, change to true to force install is added. In both cases, a message is added with the versions of the installed and supplied components. If the versions are equal, then the message Current version of component installed, change to true to force install is added. For all false values in the properties file, the user must verify that installing the version of the component supplied with the application, by changing the value to true, will not render any previously installed application unusable. Note: to the user must verify that these updates will not impact existing applications. The component.properties file is then used in the deploy-paa task to install the list of specified components.

18 4.3 Updating WCM libraries The install-paa command offers an extra parameter, -Dwcmdetect=true, to control the behaviour of WCM library installs on WebSphere Portal server version or later. Examples of usage Windows: ConfigEngine.bat install-paa DPAALocation=<paafilepath> Dwcmdetect=true Linux:./ ConfigEngine.sh install-paa DPAALocation=<paafilepath> Dwcmdetect=true AIX:./ ConfigEngine.sh install-paa DPAALocation=<paafilepath> Dwcmdetect=true IBM i:./ ConfigEngine.sh install-paa DPAALocation=<paafilepath> Dwcmdetect=true When you run the install-paa task with the setting '-Dwcmdetect=true", a properties file is created in the paa/componentname directory with the PAA name as the file name. For example, C:/IBM/WebSphere/paa/samplepaa/samplepaa.properties The property file contains a list of all the libraries that are installed on your WebSphere Portal server. All values are set to false. Setting the value in this property file to true for a WCM library, directs Solution Installer to delete the old version library and install the new version from the PAA. The value false means that the old version library is not changed. If you want to update the library, set the library to true. Otherwise, leave the value as false. If you do not have a previous version of the PAA installed or you are working on a clean Portal server, then the WCM libraries in the PAA have not been installed to the WebSphere Portal 7.0 server and you can ignore the property file created. Notes: To use this feature, you must: 1. Restart the portal server after running the si-setup command (see section 2.4). 2. Use a new command window to run the install-paa command after the Portal server has restarted completely. 3. Change the property portal_version=7 in SolutionInstaller.properties which is under SolutionInstaller/components/SolutionInstaller if you are running on Portal Virtual portals When installing the content of a PAA file to a virtual portal, you need to pass the context root and optionally the host name of the virtual portal to the deploy-paa' task. This is done using the DVirtualPortalContext and DVirtualPortalHostName parameters. Alternatively, these properties can be set in the wkplc.properties file. For example, to deploy an assembly called myassembly to a virtual portal called myvirtualportal on a server with the host name of MyComputer.MyExample.com, you would use the following command:

19 On Windows: ConfigEngine.bat deploy-paa DappName=myAssembly DVirtualPortalHostName=MyComputer.MyExample.com DVirtualPortalContext= myvirtualportal On Linux:./ConfigEngine.sh deploy-paa DappName=myAssembly DVirtualPortalHostName=MyComputer.MyExample.com DVirtualPortalContext= myvirtualportal On AIX:./ConfigEngine.sh deploy-paa DappName=myAssembly DVirtualPortalHostName=MyComputer.MyExample.com DVirtualPortalContext= myvirtualportal On IBM i:./configengine.sh deploy-paa DappName=myAssembly DVirtualPortalHostName=MyComputer.MyExample.com DVirtualPortalContext= myvirtualportal

20 5 Solution Installer Runtime Configuration This chapter provides details of the configuration options available to control how Solution Installer installs a PAA formatted application to WebSphere Portal. 5.1 Description of properties files Solution Installer runtime configuration file This file is located in PortalServerDir/SolutionInstaller/components/SolutionInstaller directory and is named SolutionInstaller.properties. There is generally no need to edit this file but the following are possible exceptions to this general rule. To use a directory other than WebSphereDir\paa in which to install PAA offerings. To include custom code extension points with suffixes other than applysifeaturepack and removesifeaturepack. These can be appended to the existing applysifeaturepack and removesifeaturepack suffixes using a comma as separator. Change the portal_version=7, in SolutionInstaller.properties which is under SolutionInstaller/components/SolutionInstaller if you are running Solution Installer on Portal 7 and installing WCM libraries which are included in the PAA. 5.2 Running Solution Installer without an internet connection Since version , Solution Installer does not retrieve external DTDs when parsing documents. Therefore, content can be installed without an Internet. However, if you are running the Solution Installer on a machine that does have an Internet connection, you can allow the xml parser to retrieve the external DTDs for validation. Set the offlinemode property in the SolutionInstaller.properties file to false. When this property is set to true, it means that no attempt is made to retrieve external DTDs by the xml parser when reading xml content. It is set to true by default.

21 6 Installation Troubleshooting This chapter provides details of troubleshooting steps available if you have problems installing a PAA file using Solution Installer. 6.1 Installing Solution Installer Verify that the Solution Installer directory was copied to the temp\solutioninstaller directory before running the SolutionInstaller task. Make sure there is a directory called components under the SolutionInstaller directory and not another high level directory created by a compress archive tool. 6.2 WCM libraries on Linux Occasionally there is an issue with installing WCM libraries to a WebSphere Portal server instance running on Linux where the library fails to install. This issue can occur due to a restriction that Linux places on the number of files that can be open at a given time. To fix this issue, try increasing the ulimit value for the system. You can set it to either a numeric value or to unlimited. The following examples show how this variable can be set: ulimit -n ulimit -n unlimited 6.3 Changing the port numbers in properties files If you change the value of the WC_defaulthost property using the administration console, you also need to make a change in the wkplc.properties and wkplc_comp.properties file. This issue is due to the value not replicating automatically to these files and this is where the ConfigEngine and Solution Installer retrieve information concerning the system. When making the change to the properties files, the following properties must be set to the value of the WC_defaulthost port. WpsHostPort=<value of WC_defaulthost port> in the wkplc.properties file XmlAccessPort=<value of WC_defaulthost port> in the wkplc_comp.properties file. 6.4 Installing on a cluster A PAA file installed on a cluster must be installed on the primary node, and all of the installation components (WCM libraries, JSP files, users, etc.) registered as part of the

22 installation are replicated to the nodes in the cluster as normal. Shared JAR files need to be installed on all secondary nodes in addition to the primary node. Thus, if there are shared jar files that need to be added to the class-path on each node, you will need to run both the install-paa and deploy-paa tasks for the PAA file on each subsequent node. This will ensure that the files appear on the class-path of each node. 6.5 Serialization issue with PZN nodes file upload with TAI enabled When trying to upload a PZN.nodes file containing business rules to WebSphere Portal with Trust Association Interceptor (TAI) enabled, The Serialization prevents the business personalisation rules from being uploaded. The recommended fix is to disable TAI before installing the PAA file containing the business rules and re-enabling TAI after the deploy-paa task has completed. See the following tech note for instructions.