Installing KwikWork CADViewer

The following steps are required to install KwikWork CADViewer.

Overview

There are four components for creating SVG renditions and displaying SVG file types.

KwikWork DWG Caching Service - A Windows only background service responsible for
1. Downloads the DWG files to the conversion server
2. Executes the CADViewer conversion process
3. Uploads the SVG rendition back to the FileNet custom KwRendition class
4. Updates the request to completed
CADViewer- Third party software from TaylorMade Software bundled as cadviewer.zip
1. The CADViewer component can be installed on the application WebSphere instance or on a remote server, however, CADViewer can only be installed on Windows or Linux.
2. CADViewer Converter - Linux or Windows server application that converts DWG files to SVG files
3. CADViewer JSViewer - Viewer for displaying SVG files
KwikWork CADViewer - FileNet Viewer Plugin that acts as a wrapper for CADViewer
1. Downloads the SVG files to the server
2. Redirect the iFrame to CADViewer for display
Sweeps Process:
1. FileNet Sweep process searches the object store for DWG files and executes the KW DWG Sweeps Code Module
2. KW DWG Sweeps Code Module creates "request" records in the custom class KwQueueRequest of documents that are queued to be rendered to SVG

Install KwikWork DWG Caching Service

This is a Windows only service.

Copy "KW DWG Caching Service.zip" to the server
Copy to any location (i.e. c:\IBM\) and unzip
Edit <location>/properties/config.properties
Note: if previously installed, the config.properties file was copied to <user home>/KwikWork/ directory. This file in the user home location can be modified or can be renamed/deleted and the file will be copied again to the user home location.
1. Set the URI value to the FileNet server whose object store contains the DWG files for conversion
2. Set the object store ID
3. Set user ID
4. Set password - password must be encrypted using jasyph (http://www.jasypt.org) with key from zip file's readme.txt
5. Set localPathToDWGFile which is the temporary working directory
6. Set serviceId, default is 9 for DWG Cache. The serviceId enables multiple rendition types for the same repository. If the DWG service Id is changed, it must be changed in the desktop's configuration. Configuration - Advanced - DWG Conversion Service ID
Edit <location>InstallDWGCacheService(32 or 64).bat
1. Set the PR_JVM to your installed JVM
Open a command prompt to the directory and run "InstallDWGCacheService64.bat -i" (or 32 for 32 bit processor)
Start the service in Windows Services and set to auto start
A log file will be generated at c:\logs (this can be set in the <location>/log4j.xml)
If you have any issues with the service running:
1. Verify your JVM path is set correctly in InstallDWGCacheService64.bat
2. Verify the JVM version is at least 1.8.0_112 or greater
3. Verify your permissions or reinstall using administrator. If you have appropriate permissions, the following key will have 4 folders in regedit:
  HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Apache Software Foundation\Procrun 2.0\KwikWorkDWGCacheService64\Parameters\

Install CADViewer

CADViewer can be installed on the same WebSphere server or on a remote server (Windows or Linux only).

Same Server Configuration

In WebSphere:
1. Navigate to Applications, Enterprise Applications, Add new application: cadviewer.war
  1. cadviewer_war should now show in Enterprise Applications.
2. Navigate to Environment, Shared Libraries, Add New:
  1. Select server scope
  2. Name: cadviewer
  3. Classpath: path to <WebSphere AppServer filepath>\cadviewer_war.ear\cadviewer.war\WEB-INF\classes
    (i.e.: C:\IBM\WebSphere\AppServer\profiles\AppSrv02\installedApps\ECMNode02Cell\cadviewer_war.ear\cadviewer.war\WEB-INF\classes)
  4. Apply and Save
3. Navigate to Applications, Enterprise Applications, Navigator Application, References, Shared library references, navigator module, add cadviewer and save.
See Configure CADViewer Instructions below
Setup up recurring task to delete temporary DWG files stored for rendering to SVG
1. On AIX / Linux:
  1. Edit crontab to run every 30 min to find files that are 30 mins old and delete the folder and files:
  2. Verify your IBM install path exists: /opt/IBM/kwcn/cache/ - update line 4 as needed to correct path to IBM install as defined in KwikWorkViewer-<date>.jar/viewer.properties - localPathToDWGFile.
  3. From terminal: crontab -e [username]
  4. Type "i" to insert
  5. Paste: 0,30 * * * * find /opt/IBM/kwcn/cache/dwg/* -mmin +30 -exec rm -r {} \;
  6. Esc, ":x" to save
2. On Windows:
  1. In the KW Viewer zip, locate the "removeDWGFiles.bat".
  2. Edit the file so that the 2 path locations match the KwikWorkViewer-<date>.jar/viewer.properties - localPathToDWGFile
  3. Setup a recurring nightly task to execute the .bat file.

Remote Server Configuration

On the remote server, install and configure a SFTP program such as OpenSSH for Windows https://github.com/PowerShell/Win32-OpenSSH/wiki/Install-Win32-OpenSSH
Set the SFTP service to start automatically
Create or use a user with permissions to read/write to use with the SFTP processes.
If installing the CADViewer component on WebSphere:
1. Navigate to Applications, Enterprise Applications, Add new application: cadviewer.war
  1. cadviewer_war should now show in Enterprise Applications
2. Set the context path: Enterprise Applications > cadviewer_war > Context Root For Web Modules set to "/cadviewer"
If installing on Apache Tomcat:
1. The configuration files were preconfigured for C:\tomcat as tomcat_home
2. Copy the WAR file to the <tomcat home>/webapps/ directory and start the tomcat service.
3. Configure the CADViewer Component - see Configure CADViewer instructions below.
4. Set up the tomcat engine as a service and auto start by following instructions in the tomcat/bin/service.bat file.

Configure CADViewer

If WebSphere, navigate on the server to <appserver filepath>\cadviewer_war.ear\cadviewer.war\
If Tomcat, navigate to <tomcat home>/webapps/cadviewer/
Edit cvjs_config_servlets.xml, search and replace the following values:
1. If WebSphere:
  1. http://ecm.devenchoice.org:9081/ with your URL
  2. C:/IBM/WebSphere/AppServer/profiles/AppSrv02/installedApps/ECMNode02Cell/ with your path.
2. If Tomcat:
  1. http://ecm.devenchoice.org:9081/ with your URL
  2. C:/tomcat/webapps/cadviewer with your path
If running Linux, the path to the converter must be changed from windows to linux:
1. Search and replace cadviewer.war/converters/ax2019/windows/ with cadviewer.war/converters/ax2019/linux/
2. Change:
  <init-param>
  <param-name>ax2019_executable</param-name>
  <param-value>AX2019</param-value>
  </init-param>
  To:
  <init-param>
  <param-name>ax2019_executable</param-name>
  <param-value>ax2019_L64_19_04_16</param-value>
  </init-param>
Optionaly, to change the encryption key, navigate to <webapp>\<cadviewer>\html\fileviewer.jsp and edit "secretKey" to a unique 16 character value and save the file.
1. The secretKey must match the KwikWork Viewer viewer.properties secretKey
Reset the web service

Install KwikWork Viewer Plugin

Open the KWCN-DWG-Viewer-<date>.jar file with a zip utility
Edit viewer.properties as needed to match the server settings and save.
1. The secretKey must match CADViewer fileviewer.jsp secretKey and must be 16 characters.
Save the Jar file
Log into KwikWork Content Navigator Portal, Administration View Settings, Plug-ins:
1. Add the new plugin: KwikWorkViewer-<date>.jar and save
2. Viewer Maps, Edit the KWCN Viewer Map
3. Add new mapping:
  1. For Repository select "FileNet Content Manager"
  2. For viewer select KwikWorkViewer
  3. In New File Types, manually add the following:
    dwg
    application/dwg
    model/vnd.dwf
    application/acad
    image/vnd.dwg
    svg
    image/svg+xml
  4. Click OK
  5. Move this mapping up to the top of the list
  6. Save

Create FileNet ACCE Sweeps Process

Navigate to Sweep Management - Sweep Actions - New Sweep Action
Set Java class handler to com.enchoice.CreateRendition and check Configure code module
Check "Configure code module"
Name the code module and import the KWCN Create Rendition Sweeps Jar file
Move Next and Finish
Next, create a Job Sweep - Custom Job for a one time sweep, or to continuously run, create a Sweep Policy.
A filter expression is required, at a minimum the sweep process needs MimeType = ‘application/dwg’. Other filters can be added such as modifiedDate.
Set the sweep action to the sweep action created in the previous steps.

Resetting Renditions

In the event all SVG renditions need to be recreated, the rendition requests and SVG renditions need to be deleted first.

In ACCE, search the KwikWork Service Queue Request class where Queue Name equals 'BatchToSVG' and delete the records.
Search the KwikWork Rendition class where Queue Name equals BatchToSVG and delete the records.