Installing Viewer Extension on IBM® Connections

Perform the following steps on the Deployment Manager server or on one of the Connections servers. If installing from the Deployment Manager, ensure that the node has access to the Connections provisions directory.

Extract the installation files

Note: This procedure assumes you have extracted the HCL Docs packages as stated in the topic "Installing the HCL Docs components." If you extracted the packages into another directory, update the steps accordingly.
  1. Log into the Connections server or the deployment manager with an Administrative account.
  2. Change to the directory where the HCL Docs components were extracted.
    • Linux: cd /opt/install/Docs/Viewer
    • Windows: cd C:\install\Docs\Viewer
  3. Extract the file
    • Linux: unzip -d /opt/install/Viewer/ViewerLCExtension native/
    • Windows: Extract native\ into C:\install\Viewer\ViewerLCExtension.
  4. For Linux, go to the directory /opt/install/Docs/Viewer/ViewerLCCustomizeApp/installer, and set the permissions of the *.sh (shell scripts) using chmod 755 *.sh.

Configure the file

  1. Open the following file in a text editor such as gedit or nano.

    gedit /opt/install/Docs/Viewer/ViewerLCCustomizeApp/installer/

  2. Modify the following parameters in the file. An example is provided in the table.
    Note: You can review the file parameter description within the file for each of these fields. The values in the table are for typical deployments. For other types of configurations, for example, if you are setting up a server instead of a cluster, review the other options in the files.
    Table 1. File propertiesThis table provides suggested default values pertaining to file configuration.

    Field Value
    ext_install_root /opt/IBM/IBMViewer/extension
    was_dm_profile_root /opt/IBM/WebSphere/AppServer/profiles/Docs01 -or- /opt/IBM/WebSphere/AppServer/profiles/dmgr (depending upon where the install is being run from)
    was_soap_port 8879
    enable_upload_conversion Yes
    auth_type BASIC
    viewer_admin_j2c_alias <Leave as Blank since using BASIC auth_type>
    files_scope Cluster
    files_scope_name ConnectionsFilesCluster
    files_node_name <Leave as Blank since using Clusters>
    news_scope Cluster
    news_scope_name ConnectionsNewsCluster
    news_node_name <Leave as Blank since using Clusters>
    restart_connections (1.0.6 new parameter) FALSE
    common_scope Cluster
    common_scope_name ConnectionsCommonCluster
    common_node_name <Leave as Blank since using Clusters>
  3. Save the file and close the editor.

Run the installer

  1. Open a terminal window under the root account.
  2. Navigate to the directory /opt/install/Docs/Viewer/ViewerLCCustomizeApp/installer
  3. Run the following command: ./
  4. A License agreement is displayed. If you accept the agreement, press the "a" key and then press Enter.
  5. When prompted, enter your WebSphere® Application Server credentials.
    Table 2. WebSphere® Application Server credentialsThis table provides suggested default values for WebSphere® Application Server credentials.

    Field Value
    WAS Administrative Username WASADMIN_USERNAME, for example, wasadmin
    WAS Administrator password WASADMIN_PASSWORD, for example, password
  6. When the installation is finished, the command prompt is displayed. If an error occurred with the install process, the configuration is reverted. Correct the error and try again.


When the installation is finished, check the format in the viewerExtension.log file for errors and repeat this task if necessary. The log file is in the extension installation root directory.

Additional checks which you can do from the node to determine if installation was successful include: Log in to Connections Files. If you have an existing document, spreadsheet, or presentation (or can upload one), click the file name and a new View button is displayed. If you switch to a Connections community, from the Files for that community, you can see the new View button.

Note: These verification steps will be successful only after completion of the post-installation tasks.