ICXT PDFExport installation

Database Setup DB2

• Login on the database server

ssh user@dbserver

• Change user to the DB2 instance user

[sudo] su - db2inst1

• Verify if DB2CODEPAGE property is set to 1208

db2set

• If not, set it

db2set DB2CODEPAGE=1208

• Copy all files that ends with _DB2.ddl to the home directory of the local DB2 user (e.g. /home/db2inst1/icxt-prepare)

mkdir ~/icxt-prepare

# copy the scripts from the DMGR to the database server
scp some-valid-user@your.dmgr.host:/opt/IBM/installs/ic360.deployment-8.0.0-pdfexport/db-setup/*_DB2.ddl ~/icxt-prepare/

# or use this line, if the DB and the DMGR are on the same box
cp /opt/IBM/installs/ic360.deployment-8.0.0-pdfexport/db-setup/*_DB2.ddl ~/icxt-prepare/

• Import the SQL file essapps-createDatabase_DB2.ddl

db2 -td@ -vf ~/icxt-prepare/essapps-createDatabase_DB2.ddl

• Import the SQL file icxt-createTables_DB2.ddl

db2 -td@ -vf ~/icxt-prepare/icxt-createTables_DB2.ddl

Database Setup ORACLE

• Login on the database server

ssh oracle@dbserver

• Copy all files that ends with _Oracle.ddl to the home directory of the local Oracle user (e.g. /home/oracle/icxt-prepare)

mkdir ~/icxt-prepare

# copy the scripts from the DMGR to the database server
scp some-valid-user@your.dmgr.host:/opt/IBM/installs/ic360.deployment-8.0.0-pdfexport/db-setup/*_Oracle.ddl ~/icxt-prepare/

# or use this line, if the DB and the DMGR are on the same box
cp /opt/IBM/installs/ic360.deployment-8.0.0-pdfexport/db-setup/*_Oracle.ddl ~/icxt-prepare/

• Import the DDL (as a user that has at least the SYSDBA role) by issuing following command:

sqlplus sysdba/password @essapps-createDatabase_Oracle.ddl

NOTE: The above command will create a user named ESSAPPS and will prompt for a password. If you prefer to specify the password right when calling the command, use the following syntax:

sqlplus sysdba/password @essapps-createDatabase_Oracle.ddl password

• Import the SQL file icxt-createTables_Oracle.ddl and use the ESSAPPS user that was created in the previous step:

sqlplus essapps/password @icxt-createTables_Oracle.ddl

Database Setup MS SQL Server

TO BE DEFINED

PDF Export executable

PDF Export requires the wkhtmltox binary package in order to render PDF documents. This is a binary dependency that needs to be deployed on your HCL Connections server. The necessary installation steps are outlined below.

1). Download and install the wkhtmltopdf binary package.

The binary package is available to download here: https://wkhtmltopdf.org/downloads.html. Please use the latest stable version 0.12.6 for installation.

Ensure to download the package according to your server operating system. Common examples are listed below, all distributions can be found via above link.

Once downloaded, install the package according to your system’s requirements.

RHEL/CentOS:

rpm -Uvh wkhtmltox-0.12.6-<version>.rpm

Windows:

• Download wkhtmltox-0.12.6-<version>.exe
• Execute binary file to run installer
• Install tool at appropriate location

2). Configure the PDF Export feature on WebSphere to leverage wkhtmltopdf binary In order for the PDF Export feature to use the wkhtmltopdf library, it needs to be able to invoke the tool via the system’s command line. There are two ways to ensure this is the case.

2.1). Configure path variables and add the wkhtmltopdf binary to it PDF Export tries to execute the command

wkhtmltopdf [args]

On the system’s command line (cmd on Windows, shell/bash on Linux). This can be enabled by adding the wkhtmltopdf to the system’s path variable. To test this, try to execute above command on the system’s command line. If the command is unrecognized, this is not configured correctly. Otherwise PDF Export is now ready and can be used.

2.2). Configure PDF Export to invoke wkhtmltopdf in the correct install location If wkhtmltopdf is not available by invoking the command listed in 2.1, you can instead make the PDF Export aware of what execution command is necessary to invoke it instead. E.g. if you have installed the feature at location

/opt/HCL/Connections/wkhtmltox/bin/wkhtmltopdf

You can add this via WebSphere configured. To do this, follow below steps:

• Resources > Resource Environment > Resource Environment entries.
• Then you can see “ic360”, click on it.
• There is “Custome properties” in the “Additional Properties”, select it then select “New” option.
• Add name as “wkhtmltopdf.command.exec” and value as wkhtmltox\bin directory like: “…\wkhtmltopdf\bin\wkhtmltopdf”
• Apply and Ok.
• Save the changes.
• 
• Restart ICXT server.

Note: In case of a clustered environment, this library needs to be installed the same way on all nodes of the cluster.

[OPTIONAL] Server side fonts

Without installed fonts, the PDF rendering may result in unsatisfactory result. If there are no font sets installed, we recommend to install DejaVu fonts (https://dejavu-fonts.github.io/).

Note for CentOS or RHEL, the library wqy-microhei-fonts should additionally be installed to support Chinese and Japanese.

• RHEL or CentOS:

sudo yum install dejavu-sans-fonts
sudo yum install wqy-microhei-fonts

To list Dejavu fonts, is installed or not, run the following command: fc-list | grep "DejaVu Sans"

Sample output:

/usr/share/fonts/TTF/DejaVuSansCondensed.ttf: DejaVu Sans,DejaVu Sans Condensed:style=Condensed,Book
/usr/share/fonts/TTF/DejaVuSans-BoldOblique.ttf: DejaVu Sans:style=Bold Oblique
/usr/share/fonts/TTF/DejaVuSansMono.ttf: DejaVu Sans Mono:style=Book
/usr/share/fonts/TTF/DejaVuSansCondensed-Oblique.ttf: DejaVu Sans,DejaVu Sans Condensed:style=Condensed Oblique,Oblique
/usr/share/fonts/TTF/DejaVuSansMono-Oblique.ttf: DejaVu Sans Mono:style=Oblique
/usr/share/fonts/TTF/DejaVuSansCondensed-BoldOblique.ttf: DejaVu Sans,DejaVu Sans Condensed:style=Condensed Bold Oblique,Bold Oblique
/usr/share/fonts/TTF/DejaVuSans-ExtraLight.ttf: DejaVu Sans,DejaVu Sans Light:style=ExtraLight
/usr/share/fonts/TTF/DejaVuSans-Oblique.ttf: DejaVu Sans:style=Oblique
/usr/share/fonts/TTF/DejaVuSansMono-Bold.ttf: DejaVu Sans Mono:style=Bold
/usr/share/fonts/TTF/DejaVuSansCondensed-Bold.ttf: DejaVu Sans,DejaVu Sans Condensed:style=Condensed Bold,Bold
/usr/share/fonts/TTF/DejaVuSansMono-BoldOblique.ttf: DejaVu Sans Mono:style=Bold Oblique
/usr/share/fonts/TTF/DejaVuSans.ttf: DejaVu Sans:style=Book
/usr/share/fonts/TTF/DejaVuSans-Bold.ttf: DejaVu Sans:style=Bold

• AIX: http://www.perzl.org/aix/index.php%3Fn%3DMain.Dejavu-fonts
• Windows: https://dejavu-fonts.github.io/Download.html
  • Fonts can be installed using following documentation: https://support.microsoft.com/en-us/help/314960/how-to-install-or-remove-a-font-in-windows
  • Download and unzip the latest DejaVu fonts ZIP archive
  • Login as Administrator and Click “Start”
  • Search for “run”
  • Enter %windir%\fonts
  • Drag and drop the extracted fonts from the ttf folder to the Fonts config window

Release configuration

• Open a Remote Desktop or SSH Session on the Deployment Manager and navigate to the release package

  • Windows
  • Linux: cd /opt/IBM/installs

• Create a copy of icxt-install_default.properties in the parent folder, or re-use a file from a previous installation

  • Windows
  • Linux: cp ic360.deployment-8.0.0-pdfexport/icxt-install_default.properties icxt-install.properties

• Open the file and adjust all values that are listed in the table below

  • Windows
• Linux: vi icxt-install.properties

WebSphere config:

Database config:

ICXT config:

Note: All properties that are starting with ree. will be created as Resource Environment Entry properties. Therefore, this property file can be used to setup the ICXT behavior.

Install preliminary ICXT requirements

• Open a Windows Command Shell and navigate to the install folder and invoke the install command
  • Windows ic360.deployment-8.0.0-pdfexport\icxt-prepare.bat icxt-install.properties
  • Linux: ic360.deployment-8.0.0-pdfexport/icxt-prepare.sh icxt-install.properties