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.
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.
Upgrading to HCL Docs 2.0
You can upgrade HCL Connections™ Docs from the previous two releases to the current release by using the installer or upgrade scripts.
Upgrading HCL Docs using the scripts
If you do not want to use the installer to upgrade, perform the procedures to upgrade HCL Docs using the scripts.
Upgrading Editor Proxy
Do a silent upgrade of Editor proxy.

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.
- 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.
  - Upgrading to HCL Docs 2.0
    You can upgrade HCL Connections™ Docs from the previous two releases to the current release by using the installer or upgrade scripts.
    - Upgrading the database
      Learn how to update the database for HCL Docs that is deployed in your environment.
    - Upgrading the HCL Docs components using the installer
      For upgrading HCL Docs from 1.0.6 or 1.0.7 to 2.0, follow the instructions in this section. Use the installer to upgrade from HCL Docs 1.0.7 to 2.0.
    - Upgrading HCL Docs using the scripts
      If you do not want to use the installer to upgrade, perform the procedures to upgrade HCL Docs using the scripts.
      - Upgrading the Document Format Conversion Application
        You must finish upgrading the Document Format Conversion Application before upgrading HCL Docs.
      - Upgrading Editor Application
        Do a silent upgrade of the Editor Application.
      - Upgrading Editor Extension
        Do a silent upgrade of the Editor Extension.
      - Upgrading Editor Proxy
        Do a silent upgrade of Editor proxy.
      - Upgrading Viewer Application
        Do a silent upgrade of the HCL File Viewer application.
      - Upgrading Viewer Extension
        Do a silent upgrade for Viewer Extension.
    - Updating drafts after upgrading
      After upgrading, you must update the drafts that were created in previous versions in case they are lost or cannot be opened.
    - Verifying the upgrade
      After you complete upgrading all of the components to again make HCL Connections™ Docs available to your users, it is suggested that you do some testing to ensure that your upgrade was successful.
    - Special steps when an upgrade to HCL Docs 2.0 occurs before that to Connections 5.5 and 6.0
      After upgrading to HCL Docs 2.0, if you migrate or upgrade to IBM Connections 5.5 or 6.0, you must do some additional steps to ensure that HCL Docs 2.0 is working well.
  - Migrating to HCL Docs 2.0
    You install HCL Connections™ Docs 2.0 on new hardware with the previous version of HCL Docs kept intact on old hardware. Then you must perform a side-by-side migration of data to make sure the new system work well with no missing data, and the transition to the new system is transparent to end user.
- 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.

Upgrading Editor Proxy

Do a silent upgrade of Editor proxy.

About this task

The steps are based on Linux, but are basically the same for Windows.

Procedure

Extract the Installation Files
1. Log into the server where Editor Proxy is installed with an administrative account.
2. Extract native/DocsProxyFilter_2.0.0.zip to /opt/install/Docs/DocsProxyFilter.

Update the cfg.properties file

Open the cfg.properties file from previous releases in a text editor such as gedit or nano.
- gedit /opt/IBM/IBMDocs/proxy/cfg.properties

Review and update as needed, the following parameters in the file. An example is provided in the table.

Table 1. Default values for file
Field	Value
docs_install_root	/opt/IBM/IBMDocs
was_proxy_profile_root	/opt/IBM/WebSphere/AppServer/profiles/Docs01 -or- /opt/IBM/WebSphere/AppServer/profiles/dmgr Note: depending upon where the upgrade is being run from
was_soap_port	8879
was_ipc_port	<Leave as Blank>
scope	Cluster
proxy_scope_name	IBMDocsProxyCluster
proxy_node_name	<Leave as Blank since using cluster>
docs_context_root	/docs

Save the file and exit the editor.

Run the upgrade
1. Open a terminal window under the root account
2. Navigate to the directory: /opt/install/Docs/DocsProxyFilter/installer
3. Execute the following command: ./upgrade.sh -installRoot /opt/IBM/IBMDocs
4. You will be presented with a License agreement. If you accept the agreement, press the 'a' key followed by enter.
5. When prompted, enter your WebSphere® Application Server credentials.
  Table 2. WebSphere® Application Server credentials
  
  Field Value
  
  WAS Administrative Username wasadmin
  
  WAS Administrator password password
6. When the upgrade is finished, it will return you to the command prompt. If an error occurred with the upgrade process, it will revert the configuration. Correct the error and try again.
7. Check the proxy_upgrade.log file for errors. If some WebSphere® Application Server settings are updated, the detailed upgrade information is in was_config_upgrade.log. These logs will be located in the /opt/IBM/IBMDocs/proxy/logs directory.
  Note: You can set options for the upgrade scripts:
  - -h: Displays help for the installation arguments.

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.