Installing Viewer Application

The Viewer Application component can be installed into the Connections node or its own node within the Connections cell. Note that you only need to install File Viewer on one of the nodes in the cluster as this makes all the config and other install files available to any additional File Viewer node in the cluster. The File Viewer can also be installed from the WebSphere® Deployment Manager node. If this is installed from the Dmgr, ensure that node has access to the viewer_share.

Extract the installation files

Note: The sections assumes you have extracted the HCL Docs packages highlighted in the beginning of this chapter. If you extracted the packages into another directory, update the steps accordingly.
  1. Log into the server from which you will deploy the File Viewer with an administrative account.
  2. Change to the directory to which you extracted the HCL Docs components:
    • cd C:\install\Docs\Viewer (Windows)
    • cd /opt/install/Docs/Viewer (Linux)
  3. Extract the Viewer_2.0.0.zip file
    • Linux: unzip -d /opt/install/Docs/Viewer/ViewerApp ./native/Viewer_2.0.0.zip
    • Windows: Extract native\Viewer_2.0.0.zip into C:\install\Docs\Viewer\ViewerApp.
  4. For Linux, go to the directory /opt/install/Docs/Viewer/ViewerApp/installer/, set the permissions of the *.sh (shell scripts) using chmod 755 *.sh.

Configure the cfg.properties file

  1. Open the following cfg.properties file in a text editor such as gedit, GNU nano, or Notepad.

    gedit /opt/install/Docs/Viewer/ViewerApp/installer/cfg.properties

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

    Field Value
    viewer_install_root ViewerCluster_INSTALLPATH, for example, /opt/IBM/IBMViewer
    shared_data_dir* NFSCLIENT_VIEWERDATA_LINUX, for example, /opt/IBM/viewer_data
    was_install_root The path of WebSphere Application Server profile used on this server, for example, /opt/IBM/WebSphere/AppServer/profiles/AppSrv01
    was_soap_port 8879
    conversion_url (Needs to point to the IBM® HTTP Server pool) http://Connections.example.com/conversion
    files_path NFSCLIENT_CONNECTIONSDATA_LINUX, for example, /opt/IBM/ConnectionsData/files/upload
    editor_installed Yes
    scope Cluster
    scope_name IBMViewerCluster
    node_name <Leave as Blank since using Cluster>
    browser_cache No
    enabled_print No
    auth_type FORM
    auth_host <Leave as blank since using FORM>
    multi_tenancy false
    housekeeping_frequency weekly
    housekeeping_age_threshold_of_rendition_latest_version 30
    housekeeping_size_threshold_of_rendition_cache 256
    convert_on_upload Yes to enable, No to disable
    ecm_admin_j2c_alias JAAS Alias for CCM Object Store Administrator. The J2C alias must exist in WebSphere Application Server deployment where HCL Docs is on. The value must be the same as you set in Security > Global security > JAAS - J2C authentication data, for example, filenetAdmin
    ecm_cmis_server_url The host name, port and context root for IBM CMIS server for CCM or IBM Content Navigator Integration, for example, http://navigator.yourdomain.com/fncmis. Leave it default if not integrating with CCM or ECM repository.
    ecm_fncs_server_url The host name, port and context root for IBM FNCS server for CCM or IBM Content Navigator Integration, for example, http://navigator.yourdomain.com/dm. Leave it default if not integrating with CCM or ECM repository.
    ecm_community_server_url The host name, port and context root for HCL Connections server, for example, http://connections.yourdomain.com/communities. Leave it default if not integrating with CCM repository.
    Note:
    • * shared_data_dir defines the local path from which the Viewer Data is accessed. If this storage is remote, this specifies the local path to which the remote shared storage has been mounted. If this storage is local (for example in the case where File Viewer and Conversion are deployed on the same node or where the NFS or CIFS/SMB server is being hosted on the File Viewer node), this can specify the local path. See the topic HCL Docs Shared Storage Servers for details on the server and client configuration parameters. Additionally, when the storage is remote, it needs to be mounted prior to the start of theFile Viewer. Refer to Mounting the NFS share on a Windows server for instructions on how to do this when you are using NFS and File Viewer has been deployed on Windows. See the topic Mounting the NFS share on a Linux server for instructions on how to do this when you are using NFS and File Viewer has been deployed on Linux. See the topic Mounting the CIFS share on a Windows server for instructions on how to do this when using CIFS/SMB and File Viewer has been deployed on Windows. See the topic Mounting the CIFS shares on a Linux server for instructions on how to do this when you are using CIFS/SMB and File Viewer has been deployed on Linux.
    • files_path defines the path to be used to access the FILES_CONTENT_DIR. If File Viewer is deployed on an existing Connections node with access to the FILES_CONTENT_DIR, this property should be left blank. In all other cases, files_path defines the local path to which the Files Content Store remote shared storage has been mounted. See the topic HCL Docs Shared Storage Servers for details on the server and client configuration parameters. Additionally, this shared storage needs to be mounted prior to the start of the File Viewer. If the Files Content Store is to be accessed using CIFS/SMB, see the topic Configuring the Connections file content directory for File Viewer using CIFS instructions on how to do this. If the Files Content Store is to be accessed using NFS, see the topic Configuring the file content directory for File Viewer using NFS for instructions on how to do this.
    Table 2. File properties for integration with other repositoriesThis table provides suggested default values for integration with other repositories.
    Field Value
    external_s2s_method Identify what server to server call authentication method is used from Viewer to third party. It can be one of oauth2, j2c_alias, s2s_token, and cookies. The default value is oauth2.
    external_customer_id Identify the customer id when external_s2s_method equals oauth2. The value is the domain or id of the third party, such as abc.com.
    external_oauth_endpoint The third party oauth endpoint to do oauth2 authentication. It is used when external_s2s_method equals oauth2. The value is https://abc.com/auth/oauth/versions/2/token.
    external_j2c_alias The alias must exist in Viewer WebSphere and is used to do server to server call when external_s2s_method equals j2c_alias. The value is externalAdmin.
    external_s2s_token token used to do server to server call. It is used when external_s2s_method equals s2s_token
    external_token_key token used to do server to server call. It is used when external_s2s_method equals s2s_token. The default value is token.
    external_as_user_key the header name to act as a user when does server to sever call when external_s2s_method equals j2c_alias or s2s_token. The default value is as-user.
    external_cmis_atom_pub CMIS atom pub url, and it is used when the repository is CMIS. The default value is https://abc.com/cmisatom
    external_object_store The object store name that cmis is using, and it is used when the repository is CMIS. Leave it blank or use default value "" if there is no ObjectStore defined.
    docs_call_back_url Docs callback URL used by repository. The default value is https://abc.com/docs/driverscallback
    external_repository_home third party repository home page or the files list page, and it is used to go back to third party page within Viewer page. The default value is https://abc.com/myfiles.
    external_meta_url the file meta url, and it is used when the repository is REST api. {ID} must have to match a real file id. The default value is https://abc.com/files/{ID}/meta.
    external_get_content_url The file content to get url, and it is used when the repository is REST api. {ID} is must have to match a real file id. The default value is https://abc.com/files/{ID}/content.
    external_profiles_url the url to get user profiles. The default value is https://abc.com/profiles.
  3. Save the file and close the editor.

Run the installer

From the server from which you will deploy the File Viewer, do the following:
  1. Open a terminal window under the root account.
  2. Navigate to the directory: /opt/install/Docs/Viewer/ViewerApp/installer
  3. Run the following command: ./install.sh
  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 3. 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.

Results

When the installation is finished, check the viewerInstall.log file for errors and repeat this task if necessary. The log file is in the viewer_install_root/logs directory, where viewer_install_root is the value you specified in response file for File Viewer installation directory. Verify that you can get the version of File Viewer that you installed: http://Docs01.example.com:WC_defaulthost/viewer/version.txt.