Skip to main content

Installing KwikWork in a Cluster

The following steps are required  to install KwikWork for Content Navigator.

 

Expand the installer

The installer needs to be expanded on the Content Navigator server by following the steps below:

 

 

unzip KwcnSetup-5.0.x.zip

 

Create Shared Libraries

  1. Copy the kwcn-client.jar file from the installer to the 'ECMClient/plugins' directory on each node. Note: The directory path should be identical on each node.
  2. Create a directory called RepositoryAPI in the the IBM directory.  Copy the files 'Jace.jar' and 'Pe.jar' from the 'navigator.ear\navigator.war\WEB-INF\lib' directory to the RepositoryAPI directory.  Note: The directory path should be identical on each node.
  3. Log into the WebSphere Integrated Solutions Console on the application server where IBM Content Navigator is installed then navigate to Environment → Shared libraries.




  4. Click 'New' to create a new shared library called KwcnClient at the scope of the Cell.  In the 'Classpath' field enter the path of the kwcn-client jar file located in the Plugins directory then click the 'OK' button and save directly to the master configuration.




  5. Click 'New' to create a new shared library RepositoryAPI (this name is mandatory for KwikWork to function correctly) at the scope of the Cell.  In the 'Classpath' field enter the path of the RepositoryAPI directory in the IBM directory then click the 'OK' button and save directly to the master configuration.




  6. In the WebSphere enterprise applications section, edit the navigator application.  Add a new shared library reference for the navigator web module and point it to the KwcnClient shared library that was created then click 'OK' and save to the master configuration.

 

 

 

 

Install the KwikWork Engine in IBM WebSphere

The KwikWork engine can be installed in WebSphere by following the steps below.

  1. Log into the WebSphere Integrated Solutions Console on the application server where IBM Content Navigator is installed.



  2. Navigate to Applications → Application Types → WebSphere enterprise applications using the vertical navigation tree on the left then click the install button above the list of installed applications.



  3. Click the 'Choose File' button under 'Path to the new application' and locate the kwcn-engine.ear file in the installer that was extracted earlier.  Select the ear file, click 'Open' on the dialogue box then click Next.




  4. Choose 'Fast Path' if it is not already selected then click Next.




  5. Leave the default values for all steps of the install process.

  6. Finally verify the settings on the Summary page and click 'Finish' for WebSphere to install the Kwcn Engine then save to master configuration.




  7. Edit the newly installed kwcn-engine and click 'Environment entries for the application' then update the WorkingFolder to point to the location on the server where KwikWork configurations will be stored.  Click 'Ok' and save to master configuration.




  8. Finally, start the KwikWork Engine by checking the box for kwcn-engine then clicking Start.




 

Configure KwikWork Database

The KwikWork engine supports clustered environments and leverages a packaged OrientDB database to synchronize configurations among all nodes.  This requires that the database be configured using the 'hazelcast.xml' configuration of OrientDB using the following steps.

  1. Stop all nodes in the cluster.
  2. On the master node, navigate to the '/kwcn/orientdb/config' folder then open the 'orientdb-server-config.xm' file.

  3. Set OHazelcastPlugin's "enabled" to true.

  4. Open the 'hazelcast.xml' file on the master node then add the cluster members in the tcp-ip section of the file by entering the host name of each node and assigning a port number starting at 2434.


  5. Copy the 'kwcn/orientdb' folder to all replica nodes replacing the existing orientdb folders.
  6. On each node server, open the orientdb-server-config.xml and update line 9 by assigning a unique name to each node.
  7. Start the master node then after it has started successfully, start the secondary nodes.

 

Add KwikWork UX License

  1. Navigate to the KwikWork working folder on the server.



  2. From the working folder, navigate to the 'import/license' folder then copy the KwikWork UX license key provided by enChoice to the license folder.



  3. After a few second the license file should disappear from within the /kwcn/import/license' folder.  Once this has occurred, verify that it has been copied to the 'kwcn/import/success' folder.

  4. Finally, restart the kwcn-engine application from the WebSphere console.


Add KwikWork for Content Navigator to IBM Content Navigator

1. Log-in to the Content Navigator admin desktop.

 Example: http://server1:9080/navigator

 2. Load the KwikWork for Content Navigator plug-in

    1. Click on Plug-ins from the left navigation bar



    2. Click on new plug-in

    3. The KwikWork plug-in jar file in now part of the kwcn-engine application and the path should be http://localhost:9081/kwcn-web/kwcn-plugin.jar (substitute 9081 for the port of the WebSphere application server where Navigator and the Kwcn Engine are installed).  Once the path is entered click on "Load" 




    4. After the plug-in loads click on save and then close.



    3. Add the KwikWork feature(s) to the appropriate desktop(s):

    KwikWork can be configured for each IBM Content Navigator desktop after the plug-in is loaded using the following steps:

    1. Open the Content Navigator Administration panel.  By default, this should open the desktops configuration panel.



    2. Click on the desired desktop and click edit from the top menu.
    3. Open the Layout tab by clicking on layout.



    4. Check the box to select the KwikWork UX feature.
    5. Select KwikWork UX as the default feature from the drop-down.
    6. Click "Save" or "Save and Close" to complete the configuration.
    7. Navigate to the desktop where the KwikWork features were added then edit the KwikWork for Content Navigator plugin in the Administration View.
    8. In the field at the bottom of the settings, enter the ID of the primary repository of the desktop then click the 'Prepare UX Repository' button.

    Configuring KwikWork for Same Server Cluster

    After KwikWork has been installed in the previous steps, the following steps will enable a distributed database architecture for sharing the OrientDB database between two or more KwikWork instances on the same server.  Each KwikWork instance must have its own OrientDB database which the data will be synchronized.

    • WebSphere changes only need to be completed on the primary WebSphere server

    • The default <workingFolder> location on windows is "c:\IBM\kwcn" or on Linux/AIX "/opt/IBM/kwcn"

    1. Copy the primary instance's working folder (i.e. c:\ibm\kwcn ) to the second instance location (i.e c:\ibm\kwcn2 ).

    2. Edit the OrientDB Config File in both instances:<workingFolder>/orientdb/config/orientdb-server-config.xml  

      1. In the handler node for OHazelcastPlugin, uncomment and set enabled to true.

      2. If “nodeName” has been created, each instance must have a unique nodeName value. Rename as needed to have a unique name. If nodeName has not been created yet it will be created automatically during OrientDB initialization with a unique name.

    3. Update both instances of <workingFolder>/kwcn/orientdb/config/hazelcast.xml network settings:

      1. Set port auto-increment to false and port 2431 for instance 1 and 2432 for instance 2.

      2. Add the member nodes using the local IP address and port 2431 for instance 1 and local IP address and port 2432 for instance 2.
      3. Also add any additional server member nodes.


    4. In WebSphere, create an environment variable KW_WORKING_FOLDER for each ICN server node to point to its specific working folder.  After Save, be sure to click Review and check Synchronize.

       

    5. In WebSphere, Update the KW application working folder parameter to the WebSphere Environment Variable “${KW_WORKING_FOLDER}”.  After Save, be sure to click Review and check synchronize.

       

    6. Restart the server nodes in WebSphere

    JavaScript errors detected

    Please note, these errors can depend on your browser setup.

    If this problem persists, please contact our support.

    Contact Support Close