Home
Deploying HCL Connections Docs 2.0 CR3
Welcome to the HCL Connections Docs 2.0 CR3 documentation, where you can find information about installing and deploying HCL Docs 2.0 CR3. HCL Docs is a collaborative productivity suite that enables you to work on documents, spreadsheets and presentations together in the cloud. If you have HCL Docs 2.0, HCL Docs 2.0 CR1, or CR2 already installed, to install CR3, you only need to download the HCL Docs 2.0 CR3 zip package from FixCentral and extract the package. Then follow the instructions in the PDF file to install CR3. But if you have a version prior to HCL Docs 2.0, before installing CR3 package, you must follow instructions in this guide to install and deploy HCL Docs 2.0.
Installing
To install HCL Docs, complete the following procedures in the sequence shown.
Post-installation tasks
These post-install steps are required after an installation or uninstall/install of HCL Docs. During an upgrade, these changes are preserved so do not need to be repeated during the upgrade process.
Optional post-installation tasks
Complete the post-installation tasks that are relevant to your deployment.
Configuring the soap.client.properties file
Each of the WebSphere® Application Server nodes and the Deployment Manager has a soap.client.properties file that you can configure so that the WebSphere credentials do not need to be entered every time the server is stopped. This task is optional.

Deploying HCL Connections Docs 2.0 CR3
Welcome to the HCL Connections Docs 2.0 CR3 documentation, where you can find information about installing and deploying HCL Docs 2.0 CR3. HCL Docs is a collaborative productivity suite that enables you to work on documents, spreadsheets and presentations together in the cloud. If you have HCL Docs 2.0, HCL Docs 2.0 CR1, or CR2 already installed, to install CR3, you only need to download the HCL Docs 2.0 CR3 zip package from FixCentral and extract the package. Then follow the instructions in the PDF file to install CR3. But if you have a version prior to HCL Docs 2.0, before installing CR3 package, you must follow instructions in this guide to install and deploy HCL Docs 2.0.
- Overview
  HCL Connections™ Docs extends HCL Connections, offering real-time, co-editing support designed to help users collaborate on documents together.
- Planning
  Before installing HCL Docs, review the system requirements and deployment options, and then complete the worksheets.
- Installing
  To install HCL Docs, complete the following procedures in the sequence shown.
  - Pre-installation tasks
    A series of pre-installation tasks must be completed before you can deploy the HCL Docs infrastructure. These tasks include installing the system prerequisites and configuring both Windows™ and Linux™ operating systems.
  - Installing the HCL Docs components
    You can run theHCL Docs GUI Installer or use the scripts to install the components.
  - Post-installation tasks
    These post-install steps are required after an installation or uninstall/install of HCL Docs. During an upgrade, these changes are preserved so do not need to be repeated during the upgrade process.
    - Configuring the IBM® HTTP Server
      Configure the IBM® HTTP Server as a reverse proxy server to route HCL Docs, File Viewer, and Conversion requests to the appropriate servers.
    - Configuring the Windows™ task scheduler for the Conversion server
      This task must be completed on each of the Conversion servers. The HCL Docs conversion server has monitors to ensure that the processes that convert the different documents into formats that are used by the HCL Docs editors are available and working properly. It is done through the task schedulers in Windows™. To ensure these schedulers are active and available, they need to be configured properly for your Windows environment.
    - Changing Symantec Endpoint Protection (SEP) settings
      In some customers' environment, SEP (Symantec Endpoint Protection) is running on the Conversion server. Its default configuration causes serious NFS access performance issue. Follow the steps to change SEP settings to avoid this problem.
    - Restarting the Servers
      Once you have set the servers to start automatically and configured the task schedulers, validate that the configuration is correct by restarting the servers on which the HCL Docs components are installed.
    - Registering HCL Docs in Connections News
      You can register HCL Docs in Connections News. Then when you @mention a person in comments, the person can see a notification in their home page. The person can also receive an email depending on their email notification duration settings.
    - Testing your deployment
      Verification of the installation is necessary to ensure HCL Docs is operational. Follow this procedure to verify that all components of HCL Docs are working.
    - Optional post-installation tasks
      Complete the post-installation tasks that are relevant to your deployment.
      - Configuring the soap.client.properties file
        Each of the WebSphere® Application Server nodes and the Deployment Manager has a soap.client.properties file that you can configure so that the WebSphere credentials do not need to be entered every time the server is stopped. This task is optional.
      - Configuring the servers to start automatically at boot
        By default the WebSphere® Application servers, Proxy servers, and node agents are not automatically started if the system is restarted. To ensure that these servers are restarted automatically after a reboot of any of the HCL Docs servers, configure the WebSphere Application servers and node agents to start automatically when the system boots.
      - Enabling HCL Docs entitlement
        After HCL Docs is installed, you can give users and groups entitlement to use it.
      - Enabling File Viewer entitlement
        After File Viewer is installed, you can give users and groups entitlement to use it.
      - Enabling UI customization support
        With HCL Connections™ Docs, users can create their own custom.css file in which they can modify or add additional CSS code snippets to change Docs' look and feel.
      - Customizing the font list
        You can customize your font list after you install HCL Docs. Then you can see your newly added font list in the Font Name drop-down list on the toolbar of documents, spreadsheets, or presentations editors.
      - Adding new nodes into HCL Docs clusters
        To add servers into installed HCL Docs for workload balancing, for Docs and Conversion servers you need to add new cluster members into the cluster, and then run install_node.bat or install_node.sh on the new added machines. For Viewer and Proxy servers, you only need to add new cluster members.
      - Customizing product name
        After installing and deploying HCL Docs, you can customize the product name.
      - Disabling downloading and printing documents from HCL Docs UI
        If you want to disable the function of downloading and printing documents from HCL Docs UI, follow instructions in this page.
      - Configuring File Viewer to support watermarks
        Starting with release 2.0 CR2 iFix003, configure the Viewer server so that users can add watermarks to documents and spreadsheets.
      - Configuring HCL Docs to automatically check in documents to FileNet in IBM Content Navigator
        In HCL Docs 2.0 CR3 integration with FileNet, auto check-in is supported and content input in HCL Docs can be automatically checked into FileNet repository when closing the edit session.
  - Uninstalling HCL Docs components
    You can use the installer or use uninstall scripts to uninstall HCL Docs automatically.
- Upgrading or migrating
  You can upgrade HCL Connections™ Docs from the previous two releases to the current release by using the installer or upgrade scripts. You can also install the latest release on new hardware and then do a side-by-side migration from the old to the new.
- Security
  You might need to refer to this section during deployment. HCL Docs supports WebSEAL. This section is for setting up single sign-on (SSO) if installing HCL Docs in the same cell as IBM® Connections.
- Performance tuning
- Troubleshooting and support
  To isolate and resolve problems with your deployment, you can use the troubleshooting and support information.

Configuring the soap.client.properties file

Each of the WebSphere® Application Server nodes and the Deployment Manager has a soap.client.properties file that you can configure so that the WebSphere® credentials do not need to be entered every time the server is stopped. This task is optional.

Procedure

Locate the following file:
- Windows™: C:\IBM\WebSphere\AppServer\profiles\<profileName>\properties\soap.client.props
- Linux™: /opt/IBM/WebSphere/AppServer/profiles/<profile_name>/properties/soap.client.props
  Note: The path may need to be modified, depending on the AppServer version.
Open the file with a text editor.

Modify the following fields to include your WebSphere® credentials:

Table 1. Properties fieldsThis table provides the fields you need to modify.
Field	Value
com.ibm.SOAP.loginUserId	`WASADMIN_USERNAME`, for example, `wasadmin`
com.ibm.SOAP.loginPassword	`WASADMIN_PASSWORD`, for example, `password`

Save the file and close the editor.
Run the following commands to encode the password so that it isn’t stored in plain text:
- Windows™: ../bin/PropFilePasswordEncoder.bat soap.client.props com.ibm.SOAP.loginPassword
- Linux™: ../bin/PropFilePasswordEncoder.sh soap.client.props com.ibm.SOAP.loginPassword

Rate this topic

5 stars 4 stars 3 stars 2 stars 1 star

Comment on this topic.

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners immixGroup, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box. Note: To report a problem or question about the product software, do not use this form. Instead, go to the HCL Software Support site.