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.
Procedure
Deployment verification steps:
- For the HCL Docs, Conversion, and File Viewer components, there
are "sanity checks" provided to help verify whether the deployment
is functional. To perform the sanity checks, from a browser, use these
URLs to check the HCL Docs, Conversion, and File Viewer servers:
- HCL Docs server:
http://Docs01.renovations.com:<WC_defaulthost port>/sanity/check?app=docs&querytype=report or
http://DocsWin01.renovations.com:<WC_defaulthost port>/sanity/check?app=docs&querytype=report
- Conversion server:
http://DocsWin01.renovations.com:<WC_defaulthost port>/sanity/check?app=conversion&querytype=report or
http://Docs01.renovations.com:<WC_defaulthost port>/sanity/check?app=conversion&querytype=report
to check all conversion servers
- Both HCL Docs and Conversion
servers:
http://Docs01.renovations.com:<WC_defaulthost port>/sanity/check?app=all&querytype=report or
http://DocsWin01.renovations.com:<WC_defaulthost port>/sanity/check?app=all&querytype=report
- File Viewer server
http://Docs01.renovations.com:<WC_defaulthost_port>/vsanity/check
Note:- Before running sanity check, for example,
http://<docs-server-hostname>:<WC_defaulthost port>/sanity/check
, make sure the<docs-server-hostname>:<WC_defaulthost port>
has been created in . Otherwise, create it first, and then restart Docs cluster to make the change work. - The domain of Conversion server host name (.renovations.com)
must be the same as that used by the request URL. Otherwise, one of
the Conversion sanity test cases will fail because of the security
constraint. If the domain that you set up for HCL Docs environment
and Conversion server is different from sanity check request URL,
you can add a machine host name in the host file, for example:
After modifying the Conversion host file, you must stop and restart IBMConversionSanity application from Websphere console to make the change take effect. After your verification, you'd better remove the added host name. It might cause other issues in your environment.# IP address and its host name in the same domain with the sanity check request URL. # If there are many host names defined in the Conversion Server host file, add it in the very beginning. 127.0.0.1 DocsWin01.renovations.com DocsWin01.cn.ibm.com ...
- HCL Docs server:
- Verify routing to the HCL Docs, Conversion, and File Viewer applications is
working. From a browser, use the following URLs:
http://Connections.renovations.com/viewer/version
http://Connections.renovations.com/docs/version
http://Connections.renovations.com/conversion/version
Note: The version installed for the server components should be returned. HTTPS can be used if your deployment uses HTTPS. If the installed version is not returned, verify that you successfully mapped the application to each web server and that the plugin-cfg.xml file has been correctly updated and propagated. - Verify the HCL Docs and File Viewer extensions are
installed and active within Connections. From a browser, perform the
following steps to check for the extension jars: http://Connections.renovations.com/connections/resources/web/.bundles
- -
com.ibm.concord.lcfiles.extension.provision_RELEASE_VERSION.jar
(HCL Docs Extension) - -
com.ibm.concord.viewer.lcfiles.extension.provision_RELEASE_VERSION.jar
(File Viewer Extension)
Note: Both jarsThe jar should be shown and active. If they are not shown, recheck the extension install or upgrade logs for errors and verify that the appropriate Connections clusters were restarted (at a minimum, verify the cluster containing the Common application). - -
- Application verification: From the IBM® Connections Files application, complete the
following steps: