Perform the following steps on the deployment manager server or one of the HCL
Connections servers. If installed from the deployment manager, ensure each of the nodes has access
to the Connections Provisions directory.
Procedure
- Extract the installation files.
The section
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.
- Log into the Connections server or the deployment manager
with an Administrative account.
- Change to the directory where the HCL Docs components
were extracted.
- cd /opt/install/Docs/Docs (Linux)
- cd C:\install\Docs\Docs (Windows)
- Extract the DocsLCExtension_2.0.0.zip file.
- Linux™: unzip -d
/opt/install/Docs/DocsLCExtension ./native/DocsLCExtension.zip
- Windows™: Extract native/DocsLCExtension_2.0.0.zip into C:\install\Docs\DocsLCExtension.
- For Linux™, go
to the directory /opt/install/Docs/Docs/DocsLCExtension/installer,
set the permissions of the
*.sh
(shell scripts) using chmod
755 *.sh
.
- Configure the cfg.properties file.
- Open the following cfg.properties file
in a text editor.
- /opt/install/Docs/Docs/DocsLCExtension/installer/cfg.properties (Linux)
- C:\install\Docs\DocsLCExtension\installer\cfg.properties (Windows)
- 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, for example, if you are setting
up a server instead of a cluster, review the other options in the
cfg.properties files.
Table 1. File propertiesThis
table provides suggested default values pertaining to file configuration.
Field |
Value |
ext_install_root |
DocsLCExtension_INSTALLPATH,
for example, /opt/IBM/IBMDocs/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 |
ic_extension_path |
/opt/IBM/ConnectionsData/provision/webresources |
deamon_shared_path |
/opt/IBM/ConnectionsData |
files_scope |
Cluster |
files_scope_name |
ConnectionsFilesCluster |
files_node_name |
<Leave as Blank since using Cluster> |
news_scope |
Cluster |
news_scope_name |
ConnectionsNewsCluster |
news_node_name |
<Leave as Blank since using Cluster> |
common_scope |
Cluster |
common_scope_name |
ConnectionsCommonCluster |
common_node_name |
<Leave as Blank since using Cluster> |
docs_server_url |
http://Connections.example.com/docs |
ignore_event |
false |
ic_version |
4.5 |
auth_type |
BASIC |
docs_admin_j2c_alias |
connectionsAdmin |
restart_connections Note: This parameter is new
in 1.0.6. |
False |
- Save the file and close the editor.
- Run the installer.
- Open a terminal window under the root account.
- Navigate to the directory :
- /opt/install/Docs/Docs/DocsLCExtension/installer (Linux)
- C:\install\Docs\DocsLCExtension\installer (Windows)
- Run the following command:
./install.sh
(Linux)
install.bat
(Windows)
- A License agreement is displayed. If you accept the
agreement, press the "a" key and then press Enter.
- 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 |
- 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.
- Restart Connections Servers. When installing the HCL Docs extension,
the required Connections servers will not be restarted automatically
if you have the restart_connections property
set to false. You must ripple start the following
Connections Clusters to make HCL Docs function
properly:
- The Cluster in which Files is running
- The Cluster in which News is running
- The Cluster in which Common is running
Additionally, in order to enable HCL Docs Mobile, the
Connections Cluster in which the Mobile application runs needs to
be ripple started. This one is not restarted automatically even if
you do set restart_connections to true.
Results
When the installation is finished, check the icext_install.log file
for errors and repeat this task if necessary. The log file is in the
extension installation root.
Note: You can do additional checks,
but these verification steps will be successful only after completion
of the post-installation tasks.
Additional checks which
you can do from the node to determine if installation was successful
include:
- Log in to Connections Files. The New button
should have been modified to add the options .
- If you have an existing document, spreadsheet, or presentation
(or you can upload one), click the file name and the Edit
in HCL Docs button is displayed. If you switch to a Connections
community, from the Files for that Community, you can see similar
changes in the New button and the Edit
in HCL Docs button.