introduction · web view2020. 8. 18. · solr - its major features include full-text search, hit...
TRANSCRIPT
Legal Notice
All information contained in the SEMANTIFY Installation Guide is presented in good faith and believed to be accurate. SEMANTIFY Inc. makes no warranties except as may be stated in its written agreement with its customers. In no event is SEMANTIFY liable to anyone for any indirect, special or consequential damages. The information and specifications of any SEMANTIFY product document are subject to change without notice.
© Copyright 2016, SEMANTIFY Inc.
Audience
System Administrators who want to know and Install the SEMANTIFY system.
Table of Contents Introduction 5 Hardware & Software Requirements 6 Software (Optional) 6 Administration Privileges 7 Multi Node Deployment and Connectivity 8 Installation Bundle Review 9 System Requirement Folder 9 Organizing Installation files and folders 9 Product Installation 13 Prerequisite Software setup 13 Installation Overview Steps 13 Unpacking the Software 13 Setting up the home path 15 Application Software Setup 18 Using MySQL 18 Using PostgreSQL 31 Database Schema Setup 47 Software (Optional) setup 47 Configuration 48 Verifying Product Installation 48 For MySQL 48 For PostgreSQL 51 Product Uninstallation 58 Appendix 59 MySQL 59 PostgreSQL 64 Tomcat - 69 - Solr - 75 - R Software - 78 -
Introduction
This guide describes the procedures required to install and configure the SEMANTIFY system on windows operating system.
The following is a typical sequence of tasks when installing the Semantify application.
Planning the Installation
Installing the Semantify system
The Semantify system is available as software bundles consist of software and utilities.
The "Appendix" section guides to those who want to install and configure prerequisite and other optional software.
Hardware & Software Requirements
Software
Databases
Hardware
Disk Space – Minimum 200 GB, if Answers Catalogue is deployed
Note: If JRE and Apache Tomcat are already configured, ensure that these versions are the same or higher, as available in the bundle.
Note: For all prerequisite or optional software Installation and configuration, please refer to their respective section under Appendix
Software (Optional)
Solr - Its major features include full-text search, hit highlighting, faceted search, real-time indexing, dynamic clustering, database integration and rich document (e.g., Word, PDF) handling. With this integration into the Semantify platform, the user can get more accurate insights into the data and allow users to explore a collection of information by applying multiple filters for unstructured apps
‘R’ is a free software environment for statistical computing, data analysis, and graphics. Semantify has the option to integrate R soft to get the best visualization of metrics and values to display in the form of reports and charts by correlation statistics.
Tesseract: is an optical character recognition engine for various operating systems. It is a software that scans and extracts texts from documents and converts them into documents that can be edited. Implementing into Semantify platform, a user can extract content from images and scanned documents concerning unstructured data where the data pattern is random and unorganized
PhantomJS - Simply, it is a browser which runs heedlessly. The benefits that it brings is speed and could also take screenshots if needed (e.g., on failures). The user can leverage this feature in the Semantify application by downloading and export the reports and charts
Text editor for editing installation files (Such as Notepad Plus)
GUI for accessing database (Such as SQLyog)
Administration Privileges
Note: Only authorized persons with administrator privileges are allowed to install Semantify and supporting software.
Multi-Node Deployment and Connectivity
In a situation, where Semantify to perform multiple parallel Semantify product related jobs such as Semantification, File Upload, etc., is achieved by deploying Semantify application individual services into multiple machines (Nodes) which have high hardware (Such as Processor, RAM, Disk space, etc.) resources. To establish this multi-node, connectivity is highly required.
For further details, please refer to the deployment guide.
Apache Tomcat
Node 1
jre
tomcat
Organizing Installation files and folders
Before starting the installations, create a folder structure for saving software included in the Semantify installable.
Create a root directory to install Semantify Enterprise Search, and refer to this directory as
<Semantify-base> (for example E:\Semantify).
Note: The folder name should not contain space; you can use an underscore instead.
Create a product directory under <Semantify-base>.
Semantify is installed in this folder. Refer to this directory as <Semantify-product-home>.
Create a temporary directory under <Semantify-base>.
The directory is used to extract the Semantify installation bundle. Refer to this directory as <Semantify-temp>.
Create a helper's tools directory under <Semantify-base>.
The directory is used to save additional software not part of standard installation. Refer to this directory as <helpers-home>.
Extract files from the Semantify installation bundle into <Semantify-temp>. The extracted files are listed below:
System–needs
Installer
Support
Extract the software package on your Windows version into the <Semantify-temp>/system-needs.
After unpacking the Semantify - install - bundle, the folder structure appears, as shown below:
Installer Folder
The Installer folder contains the Semantify setup file. It is the software that the end users use for the search.
Support Folder
The Support folder includes supporting software that is not a part of the standard installation. However, they help you in managing the entire system.
These include:
Configs
Tools
Docs
The Configs Folder
The Configs folder consists of configuration files for the following servers.
Application Server –Tomcat
The Tools Folder
The tools folder consists of software’s that are not a part of the installation. However, you may need them for additional tasks.
The software’s are:
app (Notepad Plus Plus) – Text editor
sqlyog – MySQL IDE to execute database commands
Extract the files (as required) in the tools folder from
<Semantify-temp>/support/tools into <helpers-home>
The Docs Folder
The user guide for installation process is located in this folder.
Product Installation
Prerequisite Software setup
Installation Overview Steps
The installation of Semantify is a multi-step process (with only the first three steps required):
Install and configure the Jre 1.8
Install and configure the Tomcat
Install and configure the Database ( MySQL or PostgreSQL or Oracle)
Install the Semantify Enterprise Application.
Install the optional software such as PhantomJS, Solr, OCR, R- Soft etc,
Note: Install any of the optional components available for Semantify. These optional components may be required depending on the functionality of Semantify.
Unpacking the Software
SEMANTIFY installation bundle is delivered in an archive format. You will need to unpack the software into the folders as mentioned below.
Jre archive into jre <Semantify-base>
Tomcat archive into <Semantify-base>
Solr archive to <Semantify-base>
After unpacking the software, the folders in the <Semantify-base> appears as detailed below.
Setting up the home path
Unpack the software and define home paths for jre, tomcat and MySQL/ PostgreSQL, as described below.
<jre-home> as <Semantify-base>\jre
<tomcat-home> as <Semantify-base>\tomcat
Perform the following to set home path
Open System Properties (Right click My Computer>Properties>Advanced Settings).
In the System Properties window, click Advanced tab and then click Environment Variables, as shown in Figure 2.
Figure 2: System Properties
The Environment Variables window appears, as shown in Figure 3.
Figure 3: Environment Variables
New Variable window appears, as shown in Figure 4.
Enter the home path for Tomcat with the following details:
Variable name – TOMCAT_HOME
Figure 4: New Variable
Similarly, set the home path for MySQL/PostgreSQL with the following details:
Variable name – MYSQL_HOME or PostgreSQL_HOME
Variable value – E:\Semantify\mysql or \PostgreSQL
Application Software Setup
Set up of JRE Runtime environment.
Tomcat service is not running.
MySQL service is up and running.
Refer to the following placeholders, as described in organizing file and directories section:
<Semantify-base>
<Semantify-product-home>
<solr>
<Semantify-temp>
<jre-home>
<tomcat-home>
After reviewing the prerequisites, perform the following steps to install Semantify Enterprise Search.
Open the command prompt as an administrator, as explained below:
Click Start> All Programs>Accessories.
Right-click Command prompt>Run as administrator.
If the User Account Control dialog box appears, click yes.
At the command prompt, execute the following command,
E:>\bin\java -jar <Semantify-temp> \installer\ Semantify-installer-MySQL.j
SEMANTIFY installation wizard appears, as shown in Figure 22.
Figure 22: Welcome
Figure 23: Information
Figure 24: Licensing Agreements
Review the Licensing Agreement details and select ‘I accept the terms of this license agreement’ to proceed with installation.
Click Next.
Figure 25: Insert Caption
Click Next.
A warning message appears to either create the selected directory or override the selected directory.
Click Yes to continue.
App Database Configuration window appears, as shown in Figure 26.
Figure 26: App Database Configuration
The values in App Database Configuration window are default values. If the values in file, <mysql-home>sqlCreateSchemaCommands.sql, are changed, update the values in this window also.
Update port number as used for MySQL server.
Click Next.
Based on the values, connection to the MySQL service is validated and then Answer Catalog Database Configuration window appears, as shown in Figure 27.
Figure 27: Answer Catalog
The values in App Catalog Database Configuration window are default values. If the values in the file, <mysql-home>sqlCreateSchemaCommands.sql, are changed, update the values in this window.
Click Next.
Connection to the MySQL service is validated and the Unstructured Database Configuration window appears, as shown in 28.
28: Unstructured Database Configuration
The values in Unstructured Database Configuration window are default values. If the values in the file, <mysql-home>sqlCreateSchemaCommands.sql, are changed, update the values in this window.
Click Next.
Connection to the MySQL service is validated and the Solr Server Configuration appears, as shown in Figure 29.
Figure 29: Solr Server Configuration
Click Next.
Path to the Solr Server is validated and the App Server Configuration window appears, as shown in Figure 30.
Figure 30: App Server Configuration
Click Browse to select <Semantify-product-home> as target path, as shown in Figure 31.
Figure 31: Update tomcat home
Click Next.
Path to the App Server is validated and the Installation begins, as shown in Figure 32.
Figure 32: Installation Finished
The Setup Shortcuts window appears, as shown in Figure 33.
Figure 33: Setup Shortcuts
Create shortcuts as required.
Click Next. The installation Confirmation window appears, as shown in Figure 34.
Click Done to close the window.
Figure 34: Installation Finished
Set up of JRE Runtime environment.
Tomcat service is not running. PostgreSQL service is up and running.
Refer to the following placeholders, as described in organizing file and directories section:
<semantifi-base>
<semantifi-product-home>
<solr>
<semantifi-temp>
<jre-home>
<tomcat-home>
After reviewing the prerequisites, perform the following steps to install Semantify Enterprise Search.
1. Open the command prompt as an administrator, as explained below:
Click Start All ProgramsAccessories.
If the User Account Control dialog box appears, click Yes.
At the command prompt, execute the following command,
<semantifi-temp> \installer\ semantifi-installer-
Figure 26: Installing Semantifi Jar
Figure 27: Welcome
Click Next. Information window appears, as shown in Figure 28.
- 5 -
Semantify Proprietary & Confidential
Figure 28: Information
Click Next. Licensing Agreements window appears, as shown in Figure 29.
Figure 29: Licensing Agreements
Review the Licensing Agreement details. Select ‘I accept the terms of this license agreement’.
Click Next. Target Path window appears as shown in Figure 30.
Figure 30: Insert Caption
Click Browse to select <semantifi-product-home> as target path, as shown in Figure 31.
Figure 31: Update target path
Click Next. A warning message appears to either create the selected directory or override the selected directory.
Click ‘Yes’ to continue. App Database Configuration window appears, as shown in Figure 32.
Figure 32: App Database Configuration
The values in App Database Configuration window are default values. If the values in file, <postgres-home>sqlCreateSchemaCommands.sql, are changed, update the values in this window also.
Update port number as used for PostgreSQL server.
Click Next. Based on the values, connection to the PostgreSQL service is validated and then Answer Catalog Database Configuration window appears, as shown in Figure 33.
Figure 33: Answer Catalog
The values in App Catalog Database Configuration window are default values. If the values in the file, <postgres-home>sqlCreateSchemaCommands.sql, are changed, update the values in this window.
Click Next. Connection to the postgresql service is validated and the Unstructured Database Configuration window appears, as shown in 34.
34: Unstructured Database Configuration
The values in Unstructured Database Configuration window are default values. If the values in the file, <postgres-home>sqlCreateSchemaCommands.sql, are changed, update the values in this window.
Click Next. Connection to the postgresql service is validated and the Solr Server Configuration appears, as shown in Figure 35.
Figure 35: Solr Server Configuration
Click Next. Path to the Solr Server is validated and the App Server Configuration window appears, as shown in Figure 36.
Figure 36: App Server Configuration
Click Browse to select <semantifi-product-home> as target path, as shown in Figure 37.
Figure 37: Update tomcat home
Click Next. Path to the App Server is validated and the Installation begins, as shown in Figure 38.
Figure 38: Installation
Figure 39: Installation Finished
After Installation is complete, click Next. The Setup Shortcuts window appears, as shown in Figure 40.
Figure 40: Setup Shortcuts
Create shortcuts as required. Click Next. The installation Confirmation window appears, as shown in Figure 41.
Click ‘Done’ to close the window.
Figure 41: Installation Finished
Database Schema Setup
The database schema setup applies to PostgreSQL using scripts. Refer to the PostgreSQL under Appendix section for more information.
Software (Optional) setup
· OCR
· PhantomJS
Note: The OCR and PhantomJS packages are inclusive of software package (Windows only).
Configuration
To configure the Tomcat, refer to Tomcat section under appendix
To configure the MySQL or PostgreSQL database, refer to MySQL or PostgreSQL section under appendix
To configure the Solr, refer to Solr section under appendix
Verifying Product Installation
For MySQL
To verify that, SEMANTIFY has been installed correctly in the system, perform the below steps:
1. Check the installation log file in the path <Semantify-product-home>/log/Semantify_Installation.log.
Check for the word “SEVERE” for any failures.
Connect to MySQL, server and verify the existence of the schemas provided during the product installation procedure.
If you have changed the Solr server port number, then change the Solr Server port number in the MySQL file, ‘sqlSolrPortUpdate.sql’ present in the folder <Mysql-home>, as shown in Figure 35.
Figure 35: Update Solr Server port number
After updating the Solr Server port number, execute the following command at the command prompt:
<Semantify-home>mysql\bin>psql -h localhost -p 9876 -U Semantify -q –f "<Semantify-home>\mysql\sqlSolrPortUpdate.sql" -d Semantify
Start tomcat service from Windows Services.
Verify Tomcat sever status, by opening Tomcat’s Home page in a browser, using the URL, http://localhost:8765.
Figure 36: Tomcat home page
Verify status of SEMANTIFY application in Tomcat’s Manager.
i. Click Tomcat Manager in the left pane of the Administration section.
The Tomcat Manager page appears, as shown in Figure 37.
Figure 37: Semantify Status
ii. Ensure the status of Semantify and SemantifyBatch, in the column name ‘Running’ is true.
Figure 38: Semantify icon
Click SEMANTIFY icon on the desktop, to open the Semantify Search application, as shown in Figure 38.
Semantify home page appears, as shown in Figure 39.
Figure 39: Semantify Search home page
Enter the default username and password to login.
Click Sign in. SEMANTIFY home search page appears, as shown in Figure 40.
Contact SEMANTIFY Support, for default username and password.
On the menu bar, click Publish Apps, as shown in Figure 40.
Admin Console appears, as shown in Figure 41.
Figure 40: Semantify Search page
Figure 41: Administration Console
For PostgreSQL
To verify that, SEMANTIFY has been installed correctly in the system, perform the below steps:
1. Check the installation log file in the path
<semantifi-product-home>/log/Semantifi_Installation.log.
Check for the word “SEVERE” for any failures.
Connect to PostgreSQL, server and verify the existence of the schemas provided during the product installation procedure.
5. If you have changed the Solr server port number, then change the Solr Server port number in the PostgreSQL file, ‘sqlSolrPortUpdate.sql’ present in the folder
( Installation Guide )
Figure 42: Update Solr Server port number
After updating the Solr Server port number, execute the following command at the command prompt:
E:\semantifi\pgsql\bin>psql -h localhost -p 9876 -U semantifi -q –f "E:\semantifi\pgsql\sqlSolrPortUpdate.sql" -d semantifi
Start tomcat service from Windows Services.
Verify Tomcat sever status, by opening Tomcat’s Home page in a browser, using the URL, http://localhost:8765.
Figure 43: Tomcat home page
Verify status of SEMANTIFI’S Application in Tomcat’s Manager.
Click Tomcat Manager in the left pane of the Administration section. The Tomcat Manager page appears, as shown in Figure 44.
Figure 44: Semantifi Status
Check the status of semantifi and semantifiAdmin, in the Running column.
Figure 45: Semantifi icon
Click SEMANTIFI icon on the desktop, to open the Semantifi Search application, as shown in Figure 45. Semantifi home page appears, as shown in Figure 46.
Figure 46: Semantifi Search home page
Enter the default username and password to login.
Click Sign in. SEMANTIFI home search page appears, as shown in Figure 47. Contact SEMANTIFI Support, (refer
Support section) for default username and password.
In the menu bar, click Publish Apps, as shown in Figure 47. Admin Console appears, as shown in Figure 48.
Figure 47: Semantifi Search page
Figure 48: Administration Console
The following steps explain the procedure to uninstall Semantify Enterprise Search.
1. Navigate to the <Semantify-product-home> directory.
Run the setup file in the path, <Semantify-product-home>\uninstaller.exe.
Uninstaller window appears with information.
Review the content.
After uninstallation, click Next.
The completion window appears with confirmation message, “Un-installation completed successfully”.
Click Done. If any files or folders are left after this step in <Semantify-product-home> directory, remove them manually.
Appendix
MySQL
Organize the support files in the folders as mentioned below:
Create a data directory in <mysql-home> with a name "data", and refer to this directory as "<mysql-data>".
Create a log files directory in <mysql-home> with a name "logs", and refer to this directory as "<mysql-logs>".
Copy config files from the support location to the installation location as shown in the following table:
Table 1: Files and Directories
Source Directory
Destination Directory
<tomcat-home>
<tomcat-home>
<Semantify-temp> \support\configs\tomcat-config\server.xml
<tomcat-home>\conf This ensures that tomcat listens on port 8765 for http requests.
<Semantify-temp> \support\configs\mysql-config\RegisterServer.bat
<mysql-home>
MySQL-config\ SetupPasswdForRootAtMySqlSchema.sql
<mysql-home>
<mysql-home>
Installing MySQL database
SEMANTIFY requires a light-weight relational database system to store its configuration entries, semantic index, reporting data, knowledge entities, and audit trail. This installation is configured based on MySQL database. SEMANTIFY has data definition scripts that initialize the required table structures. Allocate about 20 GB of table space for the SEMANTIFY database. SEMANTIFY connects via JDBC client components to connect and manipulate its configurations.
1. Unzip the mysql archive file in to the directory <mysql-home>. (Ensure the path don't contain spaces).
In the folder <mysql-data>in <mysql-home> directory, "example-mysql.ini" file is present.
Rename the file example-mysql.ini, as ‘semantify-mysql.ini’. The file name is used while registering the mysql service. (make sure the path is with forward slash "/")
In the file, replace <mysql-home> and <mysql-data> with the actual file path.
Save the file.
1. Copy RegisterService.bat and UnRegisterService.bat files into <mysql-home> directory.
Update the <mysql-home> entry RegisterService.bat file, as shown in.
Figure 18: Default Regitster file
Enter the actual path of <mysql-home>as, present in your system. (make sure path is with backward slash "\"), as shown in Figure 19.
Figure 19: Updated Register file
To register as a service, execute the command RegisterService.bat at the command prompt, as shown in Figure 20.
Figure 20: Execute Register file
To un-register the service, execute the command UnRegisterService.bat.
To start the service, open windows services and start MySQL service, as shown in Figure 21.
Figure 21: Start Service
To set the password for the user "root" on mysql as "root", open command prompt (administrator mode) and change the prompt directory to <mysql-home>\bin
Execute the command "mysql -u root -h localhost -P 3326":
Now the prompt appears as "mysql". This confirms the connection to MySQL instance (server).
To connect to the database “mysql"
{mysql-prompt}> use mysql
{mysql-prompt}> SET PASSWORD FOR 'root'@'localhost' = PASSWORD('root');
Exit from mysql server connection
{mysql-prompt}> quit;
Connecting to MySQL via command prompt
1. Open a command prompt and change the directory to <mysql-home>\bin
At the command prompt, execute the following command
"mysql -u root -h localhost -P 3326" as below
E:\Semantify\ mysql\bin> -u root -h localhost -P 3326 -p
Type password, root (without quotes)
The prompt appears as "mysql". (means connected to MySQL instance server)
You can use the regular sql commands at the prompt.
To exit mysql, type "quit;" command
Updating MySQL server files
The following steps describe the procedure to update the path of MySQL installation. You can also change the port number of MySQL.
1. Open the file <Mysql-home>\RegisterServer.bat, as shown in Figure 9.
Figure 9: MySQL default file
Update the path of <Mysql-home> and <MySQL-data>, as shown in Figure 10.
Figure 10: MySQL updated file
PostgreSQL
Installing PostgreSQL database
SEMANTIFI requires a light-weight relational database system to store its configuration entries, semantic index, reporting data, knowledge entities, and audit trail. This installation is configured based on PostgreSQL database. SEMANTIFI has data definition scripts that initialize the required table structures. Allocate about 20 GB of table space for the SEMANTIFI database. SEMANTIFI connects via JDBC client components to connect and manipulate its configurations.
Instantiating the PostgreSQL server
The following steps describe the procedure to install the PostgreSQL server.
1. Open Command Prompt as an administrator
i. Click Start > All Programs > Click Accessories
Right-click Command prompt and then, click Run as administrator.
At the command prompt, execute the following command, to instantiate the PostgreSQL database.
<postgresql-home>\bin\initdb --username=semantifi --auth=password -- encoding=utf8 --pwfile=<postgresql-home>\.pwd --pgdata=<postgresql-data>
--xlogdir=<postgresql-logs>
After the PostgreSQL database initializes, command prompt appears, as shown in Figure 22.
Installation Guide
Figure 22: PostgreSQL initialization
In line 59, uncomment the line and change "listen_address" from localhost to '*',in the line 63, uncomment the line and change "port" to 9876, as shown in Figure 24 (as this port is mentioned in file <postgresql-home>\RegisterServer.bat).
Figure 23: postgresql.conf
Registering PostgreSQL server as a Windows service
After initiating the PostgreSQL database, to make the PostgreSQL sever available to the SEMANTIFI system, register the PostgreSQL server as a window service. Follow the steps mentioned below to register the service.
1. Open Command Prompt as an administrator.
At the Command Prompt, execute the following command to run Postgres Register Server batch file.
<postgresql-home>RegisterServer.bat
Note: Always, keep service "PostgreSQL9876" status as running.
At the Command Prompt, execute the command to set PostgreSQL password in environment variables.
Set PGPASSWORD=<password mentioned in the .pwd file>
Figure 25: Postgres Service
Creating Semantify database in PostgreSQL
After the PostgreSQL service starts, create a database named as "semantifi". Follow the steps mentioned below:
Open the command prompt as an administrator, and perform the following:
i. Click Start> All Programs> Accessories.
Right-click Command prompt> Run as administrator.
If the User Account Control dialog box appears, click Yes.
At the command prompt, execute the following command, to create Semantifi database.
<postgresql-home>\bin\createdb -h localhost -p 9876 -U semantifi -O semantifi semantifi "Semantifi Application Database"
Create required Roles and Schemas defined in the file, "sqlCreateSchemaCommands.sql", present in <postgresql-home>.Modify the file details as per your requirement.
At the command prompt execute command.
<postgresql-home>\bin\psql -h localhost -p 9876 -U semantifi -q -f "<postgresql- home>sqlCreateSchemaCommands.sql" -d semantifi
You can communicate with PostgreSQL database in following two ways, GUI
Command prompt
Verifying Connection to PostgreSQL via command prompt
You can also connect to PostgreSQL using a command prompt, as described below:
1. At the command prompt, execute the command,
<postgres-home>\bin\psql -U semantifi -h localhost –P 9876 Command prompt changes to "semantifi=#" (semantifi prompt is the username), which means it is connected to the PostgreSQL instance (server).
Type regular SQL commands at this prompt.
To logout, type "\q" at the command prompt.
Tomcat
Updating server files
You have to update the path of the webserver Tomcat and the database MySQL in the respective batch files, based on the installation in your system. This enables the webserver and the database to register as a windows service. The following sections describe the procedure to update the path in the respective batch files.
Updating Tomcat server files
1. Open the file, <tomcat-home>\RegisterServer.bat, in a Notepad (or Notepad++, provided in the bundle) and update <tomcat-home> and <jre-home> path (defined in Table 1), as shown in Figure 5.
Figure 5: Update path
Modify the memory settings based on system capability for all the three variables:
JVM_MEMORY_START
JVM_MEMORY_MAX
PERMGEN_SPACE_MAX
Similarly, update <tomcat-home> and <jre-home> in the file <tomcat home>\UnRegisterServer.bat.
Enabling Support for HTTPS
Semantify supports HTTPS connection for a secured information transfer. To enable a secured connection, you must have a keystore file. Generally, organizations generate certificates in a windows environment and handover the keys and certificates in a .pfx file.
Semantify provides two options to configure the Tomcat server using the keystore file.
Using the keystore file given by client
Generating the keystore file using java keytool
Before beginning the process of enabling HTTPS, create a folder with a name SSL for saving the keystore file, in the path mentioned below:
SSL folder path: <Semantify-home>\SSL
Using keystore file given by client
Copy and paste the keystore file of your organization into the <Semantify-home>\SSL folder.
Follow the steps mentioned in the section, configuring server for HTTPS, to enable HTTPS.
Generating Keystore file using keytool
Follow the steps described below to generate keystore file using Java keytool.
1. Open command prompt as an administrator, and change the command prompt to <Semantify-home>\SSL folder.
Execute the following command,
<Semantify-home><jre-home>\bin\keytool -genkey -keyalg RSA -alias selfsigned -keystore Semantify.jks -storepass <password>-validity 360 -keysize 2048
Note: Make a note of the password you type in the above command.
After the command is executed, system displays set of questions, as shown in Figure 6.
Figure 6: SSL
What is the name of your organization unit?
What is the name of your organization?
What is the name of your city or locality?
What is the name of your state or province?
What is the two letter country code for this unit?
Enter the password, you typed in the command, in step 2.
The system generates the keystore file in the <Semantify-home>\SSL folder.
Configuring sever file for HTTPS
To enable the HTTPS connection, you have to append the keystore file attributes into the connector tags in the Tomcat server file.
Keystore file
Keystore password
1. In the file, <Semantify-home>\<tomcat-home>\conf\server.xml, comment and uncomment the sections shown in Figure 7.
Figure 7: Uncomment Https scheme
Append the keystore details in the https connector, as described in the Figure 8.
Figure 8: Append Keystore values
Note: The values in the keystoreFile and keystorePass, shown in the above figure depends on the keystore file (client keystore file or keytool generated keystore file)
Registering Tomcat server as a Windows service
After setting the path of Tomcat, <tomcat-home>, you will need to register the Tomcat server as a windows service. The service name of Tomcat server is "Tomcat8765", as defined in config file, in <tomcat-home>, refer to Table 1.
1. Open the command prompt, as an administrator and change the command prompt to <tomcat-home>.
Execute the batch script RegisterServer.bat, to register Tomcat service, as shown in Figure 16.
Figure 16: Execute RegisterServer
Start the service "Tomcat8765" from Windows Services, as shown in Figure 17.
Figure 17: Windows Services
Open Tomcat's Home page in a browser with the URL http://localhost:8765. Tomcat home page appears.
Check the Tomcat manager access.
i. Click Tomcat manager link on the left pane of the home page.
ii. Type Username and Password as "Semantify".
Stop Tomcat service.
Note: Do not start the Tomcat service till the SEMANTIFY product installation is done.
Solr
Configuring Solr Server (optional)
Note: Note: Solr is part of standard installation. Solr configuration varies on the installation types and should be configured only when specifically mentioned to configure.
Solr is a standalone full-text search server, with other features that includes, hit highlighting, faceted search, dynamic clustering, database integration and rich document handling.
The following steps describe the procedure to configure Solr server:
1. Open solrStartup.bat file present in the folder <Semantify-home>\solr\scripts\, as shown in Figure 11.
Figure 11: solrStartup default file
In the solrStartup.bat, update the path of jre and logs in the solrStartup.bat file, as shown in Figure 12.
Figure 12: Updated solrStartup file
Note: If you want to change default port (7075) number of solr server, then refer page 22.
Run the batch file <Semantify-home>/solr/scripts/solrStartup.bat, as an administrator, as shown in Figure 13.
Figure 13: Run solrStartup
After you execute solrStartup batch file, command prompt window appears.
To check status of Solr, enter the path ‘http://localhost:7075/solr’ in a browser. (for default Solr installation).
Figure 14: Solr home page
Modifying Solr Server
Note: Note: Solr is part of standard installation. Solr configuration varies on the installation types and should be configured only when specifically mentioned to configure.
You can change the Solr Server port number based on your system environment.
To modify Solr Server port number
1. Open the file, jetty.xml in the folder <Semantify-home>/<solr>/server1/etc, as shown in Figure 15.
Figure 15: Modifying Solr port
Update the port number and save the file.
After updating the port number, execute SolrStartup batch file, as described in page 21.
Note: If you change the port number, after installing Semantify Enterprise Search, refer page 43).
R Software
Installing R software custom packages
To enable R-Soft features, you need to install following R soft custom packages:
aod_1.3
chron_2.3-47
data.table_1.9.6
Once the packages are installed, R-Soft integrates with Semantify and displays the statistical values in the Rank & Plot type of graphs.
Note: Install custom packages after installing R-Soft.
To install custom packages
1. Extract the R_Soft.zip file present in the tools folder in the path, <semantify-temp>/support/tools/R_Soft> folder.
1. In the R-Soft GUI, on the menu bar, click Packages and then click ‘Install package(s) from local zip files…’, as shown in Figure 17.
Figure 17: R-Soft GUI
Figure 18: R_Soft custom package
Select custom packages in the R_Soft folder in the path, <semantify-temp>/support/tools/R_Soft>.
Installation confirmation message appears, as shown in Figure 19.
Figure 19: Installation Confirmation
Need to append below line in Rprofile.site and its file location is at <R_Soft-instalation-home>\R-3.1.2\etc\
options(defaultPackages=c(getOption("defaultPackages"),"aod","data.table"))
<Semantify-product-home> "product"
<Semantify-temp> "temporary"
<helpers-home> "helpers"
<semantify-temp>temporary
<solr>solr
<helpers-home> helpers
<Semantify-product-home>product
<tomcat-home>tomcat
All information contained in the SEMANTIFY Installation Guide is presented in good faith and believed to be accurate. SEMANTIFY Inc. makes no warranties except as may be stated in its written agreement with its customers. In no event is SEMANTIFY liable to anyone for any indirect, special or consequential damages. The information and specifications of any SEMANTIFY product document are subject to change without notice.
© Copyright 2016, SEMANTIFY Inc.
Audience
System Administrators who want to know and Install the SEMANTIFY system.
Table of Contents Introduction 5 Hardware & Software Requirements 6 Software (Optional) 6 Administration Privileges 7 Multi Node Deployment and Connectivity 8 Installation Bundle Review 9 System Requirement Folder 9 Organizing Installation files and folders 9 Product Installation 13 Prerequisite Software setup 13 Installation Overview Steps 13 Unpacking the Software 13 Setting up the home path 15 Application Software Setup 18 Using MySQL 18 Using PostgreSQL 31 Database Schema Setup 47 Software (Optional) setup 47 Configuration 48 Verifying Product Installation 48 For MySQL 48 For PostgreSQL 51 Product Uninstallation 58 Appendix 59 MySQL 59 PostgreSQL 64 Tomcat - 69 - Solr - 75 - R Software - 78 -
Introduction
This guide describes the procedures required to install and configure the SEMANTIFY system on windows operating system.
The following is a typical sequence of tasks when installing the Semantify application.
Planning the Installation
Installing the Semantify system
The Semantify system is available as software bundles consist of software and utilities.
The "Appendix" section guides to those who want to install and configure prerequisite and other optional software.
Hardware & Software Requirements
Software
Databases
Hardware
Disk Space – Minimum 200 GB, if Answers Catalogue is deployed
Note: If JRE and Apache Tomcat are already configured, ensure that these versions are the same or higher, as available in the bundle.
Note: For all prerequisite or optional software Installation and configuration, please refer to their respective section under Appendix
Software (Optional)
Solr - Its major features include full-text search, hit highlighting, faceted search, real-time indexing, dynamic clustering, database integration and rich document (e.g., Word, PDF) handling. With this integration into the Semantify platform, the user can get more accurate insights into the data and allow users to explore a collection of information by applying multiple filters for unstructured apps
‘R’ is a free software environment for statistical computing, data analysis, and graphics. Semantify has the option to integrate R soft to get the best visualization of metrics and values to display in the form of reports and charts by correlation statistics.
Tesseract: is an optical character recognition engine for various operating systems. It is a software that scans and extracts texts from documents and converts them into documents that can be edited. Implementing into Semantify platform, a user can extract content from images and scanned documents concerning unstructured data where the data pattern is random and unorganized
PhantomJS - Simply, it is a browser which runs heedlessly. The benefits that it brings is speed and could also take screenshots if needed (e.g., on failures). The user can leverage this feature in the Semantify application by downloading and export the reports and charts
Text editor for editing installation files (Such as Notepad Plus)
GUI for accessing database (Such as SQLyog)
Administration Privileges
Note: Only authorized persons with administrator privileges are allowed to install Semantify and supporting software.
Multi-Node Deployment and Connectivity
In a situation, where Semantify to perform multiple parallel Semantify product related jobs such as Semantification, File Upload, etc., is achieved by deploying Semantify application individual services into multiple machines (Nodes) which have high hardware (Such as Processor, RAM, Disk space, etc.) resources. To establish this multi-node, connectivity is highly required.
For further details, please refer to the deployment guide.
Apache Tomcat
Node 1
jre
tomcat
Organizing Installation files and folders
Before starting the installations, create a folder structure for saving software included in the Semantify installable.
Create a root directory to install Semantify Enterprise Search, and refer to this directory as
<Semantify-base> (for example E:\Semantify).
Note: The folder name should not contain space; you can use an underscore instead.
Create a product directory under <Semantify-base>.
Semantify is installed in this folder. Refer to this directory as <Semantify-product-home>.
Create a temporary directory under <Semantify-base>.
The directory is used to extract the Semantify installation bundle. Refer to this directory as <Semantify-temp>.
Create a helper's tools directory under <Semantify-base>.
The directory is used to save additional software not part of standard installation. Refer to this directory as <helpers-home>.
Extract files from the Semantify installation bundle into <Semantify-temp>. The extracted files are listed below:
System–needs
Installer
Support
Extract the software package on your Windows version into the <Semantify-temp>/system-needs.
After unpacking the Semantify - install - bundle, the folder structure appears, as shown below:
Installer Folder
The Installer folder contains the Semantify setup file. It is the software that the end users use for the search.
Support Folder
The Support folder includes supporting software that is not a part of the standard installation. However, they help you in managing the entire system.
These include:
Configs
Tools
Docs
The Configs Folder
The Configs folder consists of configuration files for the following servers.
Application Server –Tomcat
The Tools Folder
The tools folder consists of software’s that are not a part of the installation. However, you may need them for additional tasks.
The software’s are:
app (Notepad Plus Plus) – Text editor
sqlyog – MySQL IDE to execute database commands
Extract the files (as required) in the tools folder from
<Semantify-temp>/support/tools into <helpers-home>
The Docs Folder
The user guide for installation process is located in this folder.
Product Installation
Prerequisite Software setup
Installation Overview Steps
The installation of Semantify is a multi-step process (with only the first three steps required):
Install and configure the Jre 1.8
Install and configure the Tomcat
Install and configure the Database ( MySQL or PostgreSQL or Oracle)
Install the Semantify Enterprise Application.
Install the optional software such as PhantomJS, Solr, OCR, R- Soft etc,
Note: Install any of the optional components available for Semantify. These optional components may be required depending on the functionality of Semantify.
Unpacking the Software
SEMANTIFY installation bundle is delivered in an archive format. You will need to unpack the software into the folders as mentioned below.
Jre archive into jre <Semantify-base>
Tomcat archive into <Semantify-base>
Solr archive to <Semantify-base>
After unpacking the software, the folders in the <Semantify-base> appears as detailed below.
Setting up the home path
Unpack the software and define home paths for jre, tomcat and MySQL/ PostgreSQL, as described below.
<jre-home> as <Semantify-base>\jre
<tomcat-home> as <Semantify-base>\tomcat
Perform the following to set home path
Open System Properties (Right click My Computer>Properties>Advanced Settings).
In the System Properties window, click Advanced tab and then click Environment Variables, as shown in Figure 2.
Figure 2: System Properties
The Environment Variables window appears, as shown in Figure 3.
Figure 3: Environment Variables
New Variable window appears, as shown in Figure 4.
Enter the home path for Tomcat with the following details:
Variable name – TOMCAT_HOME
Figure 4: New Variable
Similarly, set the home path for MySQL/PostgreSQL with the following details:
Variable name – MYSQL_HOME or PostgreSQL_HOME
Variable value – E:\Semantify\mysql or \PostgreSQL
Application Software Setup
Set up of JRE Runtime environment.
Tomcat service is not running.
MySQL service is up and running.
Refer to the following placeholders, as described in organizing file and directories section:
<Semantify-base>
<Semantify-product-home>
<solr>
<Semantify-temp>
<jre-home>
<tomcat-home>
After reviewing the prerequisites, perform the following steps to install Semantify Enterprise Search.
Open the command prompt as an administrator, as explained below:
Click Start> All Programs>Accessories.
Right-click Command prompt>Run as administrator.
If the User Account Control dialog box appears, click yes.
At the command prompt, execute the following command,
E:>\bin\java -jar <Semantify-temp> \installer\ Semantify-installer-MySQL.j
SEMANTIFY installation wizard appears, as shown in Figure 22.
Figure 22: Welcome
Figure 23: Information
Figure 24: Licensing Agreements
Review the Licensing Agreement details and select ‘I accept the terms of this license agreement’ to proceed with installation.
Click Next.
Figure 25: Insert Caption
Click Next.
A warning message appears to either create the selected directory or override the selected directory.
Click Yes to continue.
App Database Configuration window appears, as shown in Figure 26.
Figure 26: App Database Configuration
The values in App Database Configuration window are default values. If the values in file, <mysql-home>sqlCreateSchemaCommands.sql, are changed, update the values in this window also.
Update port number as used for MySQL server.
Click Next.
Based on the values, connection to the MySQL service is validated and then Answer Catalog Database Configuration window appears, as shown in Figure 27.
Figure 27: Answer Catalog
The values in App Catalog Database Configuration window are default values. If the values in the file, <mysql-home>sqlCreateSchemaCommands.sql, are changed, update the values in this window.
Click Next.
Connection to the MySQL service is validated and the Unstructured Database Configuration window appears, as shown in 28.
28: Unstructured Database Configuration
The values in Unstructured Database Configuration window are default values. If the values in the file, <mysql-home>sqlCreateSchemaCommands.sql, are changed, update the values in this window.
Click Next.
Connection to the MySQL service is validated and the Solr Server Configuration appears, as shown in Figure 29.
Figure 29: Solr Server Configuration
Click Next.
Path to the Solr Server is validated and the App Server Configuration window appears, as shown in Figure 30.
Figure 30: App Server Configuration
Click Browse to select <Semantify-product-home> as target path, as shown in Figure 31.
Figure 31: Update tomcat home
Click Next.
Path to the App Server is validated and the Installation begins, as shown in Figure 32.
Figure 32: Installation Finished
The Setup Shortcuts window appears, as shown in Figure 33.
Figure 33: Setup Shortcuts
Create shortcuts as required.
Click Next. The installation Confirmation window appears, as shown in Figure 34.
Click Done to close the window.
Figure 34: Installation Finished
Set up of JRE Runtime environment.
Tomcat service is not running. PostgreSQL service is up and running.
Refer to the following placeholders, as described in organizing file and directories section:
<semantifi-base>
<semantifi-product-home>
<solr>
<semantifi-temp>
<jre-home>
<tomcat-home>
After reviewing the prerequisites, perform the following steps to install Semantify Enterprise Search.
1. Open the command prompt as an administrator, as explained below:
Click Start All ProgramsAccessories.
If the User Account Control dialog box appears, click Yes.
At the command prompt, execute the following command,
<semantifi-temp> \installer\ semantifi-installer-
Figure 26: Installing Semantifi Jar
Figure 27: Welcome
Click Next. Information window appears, as shown in Figure 28.
- 5 -
Semantify Proprietary & Confidential
Figure 28: Information
Click Next. Licensing Agreements window appears, as shown in Figure 29.
Figure 29: Licensing Agreements
Review the Licensing Agreement details. Select ‘I accept the terms of this license agreement’.
Click Next. Target Path window appears as shown in Figure 30.
Figure 30: Insert Caption
Click Browse to select <semantifi-product-home> as target path, as shown in Figure 31.
Figure 31: Update target path
Click Next. A warning message appears to either create the selected directory or override the selected directory.
Click ‘Yes’ to continue. App Database Configuration window appears, as shown in Figure 32.
Figure 32: App Database Configuration
The values in App Database Configuration window are default values. If the values in file, <postgres-home>sqlCreateSchemaCommands.sql, are changed, update the values in this window also.
Update port number as used for PostgreSQL server.
Click Next. Based on the values, connection to the PostgreSQL service is validated and then Answer Catalog Database Configuration window appears, as shown in Figure 33.
Figure 33: Answer Catalog
The values in App Catalog Database Configuration window are default values. If the values in the file, <postgres-home>sqlCreateSchemaCommands.sql, are changed, update the values in this window.
Click Next. Connection to the postgresql service is validated and the Unstructured Database Configuration window appears, as shown in 34.
34: Unstructured Database Configuration
The values in Unstructured Database Configuration window are default values. If the values in the file, <postgres-home>sqlCreateSchemaCommands.sql, are changed, update the values in this window.
Click Next. Connection to the postgresql service is validated and the Solr Server Configuration appears, as shown in Figure 35.
Figure 35: Solr Server Configuration
Click Next. Path to the Solr Server is validated and the App Server Configuration window appears, as shown in Figure 36.
Figure 36: App Server Configuration
Click Browse to select <semantifi-product-home> as target path, as shown in Figure 37.
Figure 37: Update tomcat home
Click Next. Path to the App Server is validated and the Installation begins, as shown in Figure 38.
Figure 38: Installation
Figure 39: Installation Finished
After Installation is complete, click Next. The Setup Shortcuts window appears, as shown in Figure 40.
Figure 40: Setup Shortcuts
Create shortcuts as required. Click Next. The installation Confirmation window appears, as shown in Figure 41.
Click ‘Done’ to close the window.
Figure 41: Installation Finished
Database Schema Setup
The database schema setup applies to PostgreSQL using scripts. Refer to the PostgreSQL under Appendix section for more information.
Software (Optional) setup
· OCR
· PhantomJS
Note: The OCR and PhantomJS packages are inclusive of software package (Windows only).
Configuration
To configure the Tomcat, refer to Tomcat section under appendix
To configure the MySQL or PostgreSQL database, refer to MySQL or PostgreSQL section under appendix
To configure the Solr, refer to Solr section under appendix
Verifying Product Installation
For MySQL
To verify that, SEMANTIFY has been installed correctly in the system, perform the below steps:
1. Check the installation log file in the path <Semantify-product-home>/log/Semantify_Installation.log.
Check for the word “SEVERE” for any failures.
Connect to MySQL, server and verify the existence of the schemas provided during the product installation procedure.
If you have changed the Solr server port number, then change the Solr Server port number in the MySQL file, ‘sqlSolrPortUpdate.sql’ present in the folder <Mysql-home>, as shown in Figure 35.
Figure 35: Update Solr Server port number
After updating the Solr Server port number, execute the following command at the command prompt:
<Semantify-home>mysql\bin>psql -h localhost -p 9876 -U Semantify -q –f "<Semantify-home>\mysql\sqlSolrPortUpdate.sql" -d Semantify
Start tomcat service from Windows Services.
Verify Tomcat sever status, by opening Tomcat’s Home page in a browser, using the URL, http://localhost:8765.
Figure 36: Tomcat home page
Verify status of SEMANTIFY application in Tomcat’s Manager.
i. Click Tomcat Manager in the left pane of the Administration section.
The Tomcat Manager page appears, as shown in Figure 37.
Figure 37: Semantify Status
ii. Ensure the status of Semantify and SemantifyBatch, in the column name ‘Running’ is true.
Figure 38: Semantify icon
Click SEMANTIFY icon on the desktop, to open the Semantify Search application, as shown in Figure 38.
Semantify home page appears, as shown in Figure 39.
Figure 39: Semantify Search home page
Enter the default username and password to login.
Click Sign in. SEMANTIFY home search page appears, as shown in Figure 40.
Contact SEMANTIFY Support, for default username and password.
On the menu bar, click Publish Apps, as shown in Figure 40.
Admin Console appears, as shown in Figure 41.
Figure 40: Semantify Search page
Figure 41: Administration Console
For PostgreSQL
To verify that, SEMANTIFY has been installed correctly in the system, perform the below steps:
1. Check the installation log file in the path
<semantifi-product-home>/log/Semantifi_Installation.log.
Check for the word “SEVERE” for any failures.
Connect to PostgreSQL, server and verify the existence of the schemas provided during the product installation procedure.
5. If you have changed the Solr server port number, then change the Solr Server port number in the PostgreSQL file, ‘sqlSolrPortUpdate.sql’ present in the folder
( Installation Guide )
Figure 42: Update Solr Server port number
After updating the Solr Server port number, execute the following command at the command prompt:
E:\semantifi\pgsql\bin>psql -h localhost -p 9876 -U semantifi -q –f "E:\semantifi\pgsql\sqlSolrPortUpdate.sql" -d semantifi
Start tomcat service from Windows Services.
Verify Tomcat sever status, by opening Tomcat’s Home page in a browser, using the URL, http://localhost:8765.
Figure 43: Tomcat home page
Verify status of SEMANTIFI’S Application in Tomcat’s Manager.
Click Tomcat Manager in the left pane of the Administration section. The Tomcat Manager page appears, as shown in Figure 44.
Figure 44: Semantifi Status
Check the status of semantifi and semantifiAdmin, in the Running column.
Figure 45: Semantifi icon
Click SEMANTIFI icon on the desktop, to open the Semantifi Search application, as shown in Figure 45. Semantifi home page appears, as shown in Figure 46.
Figure 46: Semantifi Search home page
Enter the default username and password to login.
Click Sign in. SEMANTIFI home search page appears, as shown in Figure 47. Contact SEMANTIFI Support, (refer
Support section) for default username and password.
In the menu bar, click Publish Apps, as shown in Figure 47. Admin Console appears, as shown in Figure 48.
Figure 47: Semantifi Search page
Figure 48: Administration Console
The following steps explain the procedure to uninstall Semantify Enterprise Search.
1. Navigate to the <Semantify-product-home> directory.
Run the setup file in the path, <Semantify-product-home>\uninstaller.exe.
Uninstaller window appears with information.
Review the content.
After uninstallation, click Next.
The completion window appears with confirmation message, “Un-installation completed successfully”.
Click Done. If any files or folders are left after this step in <Semantify-product-home> directory, remove them manually.
Appendix
MySQL
Organize the support files in the folders as mentioned below:
Create a data directory in <mysql-home> with a name "data", and refer to this directory as "<mysql-data>".
Create a log files directory in <mysql-home> with a name "logs", and refer to this directory as "<mysql-logs>".
Copy config files from the support location to the installation location as shown in the following table:
Table 1: Files and Directories
Source Directory
Destination Directory
<tomcat-home>
<tomcat-home>
<Semantify-temp> \support\configs\tomcat-config\server.xml
<tomcat-home>\conf This ensures that tomcat listens on port 8765 for http requests.
<Semantify-temp> \support\configs\mysql-config\RegisterServer.bat
<mysql-home>
MySQL-config\ SetupPasswdForRootAtMySqlSchema.sql
<mysql-home>
<mysql-home>
Installing MySQL database
SEMANTIFY requires a light-weight relational database system to store its configuration entries, semantic index, reporting data, knowledge entities, and audit trail. This installation is configured based on MySQL database. SEMANTIFY has data definition scripts that initialize the required table structures. Allocate about 20 GB of table space for the SEMANTIFY database. SEMANTIFY connects via JDBC client components to connect and manipulate its configurations.
1. Unzip the mysql archive file in to the directory <mysql-home>. (Ensure the path don't contain spaces).
In the folder <mysql-data>in <mysql-home> directory, "example-mysql.ini" file is present.
Rename the file example-mysql.ini, as ‘semantify-mysql.ini’. The file name is used while registering the mysql service. (make sure the path is with forward slash "/")
In the file, replace <mysql-home> and <mysql-data> with the actual file path.
Save the file.
1. Copy RegisterService.bat and UnRegisterService.bat files into <mysql-home> directory.
Update the <mysql-home> entry RegisterService.bat file, as shown in.
Figure 18: Default Regitster file
Enter the actual path of <mysql-home>as, present in your system. (make sure path is with backward slash "\"), as shown in Figure 19.
Figure 19: Updated Register file
To register as a service, execute the command RegisterService.bat at the command prompt, as shown in Figure 20.
Figure 20: Execute Register file
To un-register the service, execute the command UnRegisterService.bat.
To start the service, open windows services and start MySQL service, as shown in Figure 21.
Figure 21: Start Service
To set the password for the user "root" on mysql as "root", open command prompt (administrator mode) and change the prompt directory to <mysql-home>\bin
Execute the command "mysql -u root -h localhost -P 3326":
Now the prompt appears as "mysql". This confirms the connection to MySQL instance (server).
To connect to the database “mysql"
{mysql-prompt}> use mysql
{mysql-prompt}> SET PASSWORD FOR 'root'@'localhost' = PASSWORD('root');
Exit from mysql server connection
{mysql-prompt}> quit;
Connecting to MySQL via command prompt
1. Open a command prompt and change the directory to <mysql-home>\bin
At the command prompt, execute the following command
"mysql -u root -h localhost -P 3326" as below
E:\Semantify\ mysql\bin> -u root -h localhost -P 3326 -p
Type password, root (without quotes)
The prompt appears as "mysql". (means connected to MySQL instance server)
You can use the regular sql commands at the prompt.
To exit mysql, type "quit;" command
Updating MySQL server files
The following steps describe the procedure to update the path of MySQL installation. You can also change the port number of MySQL.
1. Open the file <Mysql-home>\RegisterServer.bat, as shown in Figure 9.
Figure 9: MySQL default file
Update the path of <Mysql-home> and <MySQL-data>, as shown in Figure 10.
Figure 10: MySQL updated file
PostgreSQL
Installing PostgreSQL database
SEMANTIFI requires a light-weight relational database system to store its configuration entries, semantic index, reporting data, knowledge entities, and audit trail. This installation is configured based on PostgreSQL database. SEMANTIFI has data definition scripts that initialize the required table structures. Allocate about 20 GB of table space for the SEMANTIFI database. SEMANTIFI connects via JDBC client components to connect and manipulate its configurations.
Instantiating the PostgreSQL server
The following steps describe the procedure to install the PostgreSQL server.
1. Open Command Prompt as an administrator
i. Click Start > All Programs > Click Accessories
Right-click Command prompt and then, click Run as administrator.
At the command prompt, execute the following command, to instantiate the PostgreSQL database.
<postgresql-home>\bin\initdb --username=semantifi --auth=password -- encoding=utf8 --pwfile=<postgresql-home>\.pwd --pgdata=<postgresql-data>
--xlogdir=<postgresql-logs>
After the PostgreSQL database initializes, command prompt appears, as shown in Figure 22.
Installation Guide
Figure 22: PostgreSQL initialization
In line 59, uncomment the line and change "listen_address" from localhost to '*',in the line 63, uncomment the line and change "port" to 9876, as shown in Figure 24 (as this port is mentioned in file <postgresql-home>\RegisterServer.bat).
Figure 23: postgresql.conf
Registering PostgreSQL server as a Windows service
After initiating the PostgreSQL database, to make the PostgreSQL sever available to the SEMANTIFI system, register the PostgreSQL server as a window service. Follow the steps mentioned below to register the service.
1. Open Command Prompt as an administrator.
At the Command Prompt, execute the following command to run Postgres Register Server batch file.
<postgresql-home>RegisterServer.bat
Note: Always, keep service "PostgreSQL9876" status as running.
At the Command Prompt, execute the command to set PostgreSQL password in environment variables.
Set PGPASSWORD=<password mentioned in the .pwd file>
Figure 25: Postgres Service
Creating Semantify database in PostgreSQL
After the PostgreSQL service starts, create a database named as "semantifi". Follow the steps mentioned below:
Open the command prompt as an administrator, and perform the following:
i. Click Start> All Programs> Accessories.
Right-click Command prompt> Run as administrator.
If the User Account Control dialog box appears, click Yes.
At the command prompt, execute the following command, to create Semantifi database.
<postgresql-home>\bin\createdb -h localhost -p 9876 -U semantifi -O semantifi semantifi "Semantifi Application Database"
Create required Roles and Schemas defined in the file, "sqlCreateSchemaCommands.sql", present in <postgresql-home>.Modify the file details as per your requirement.
At the command prompt execute command.
<postgresql-home>\bin\psql -h localhost -p 9876 -U semantifi -q -f "<postgresql- home>sqlCreateSchemaCommands.sql" -d semantifi
You can communicate with PostgreSQL database in following two ways, GUI
Command prompt
Verifying Connection to PostgreSQL via command prompt
You can also connect to PostgreSQL using a command prompt, as described below:
1. At the command prompt, execute the command,
<postgres-home>\bin\psql -U semantifi -h localhost –P 9876 Command prompt changes to "semantifi=#" (semantifi prompt is the username), which means it is connected to the PostgreSQL instance (server).
Type regular SQL commands at this prompt.
To logout, type "\q" at the command prompt.
Tomcat
Updating server files
You have to update the path of the webserver Tomcat and the database MySQL in the respective batch files, based on the installation in your system. This enables the webserver and the database to register as a windows service. The following sections describe the procedure to update the path in the respective batch files.
Updating Tomcat server files
1. Open the file, <tomcat-home>\RegisterServer.bat, in a Notepad (or Notepad++, provided in the bundle) and update <tomcat-home> and <jre-home> path (defined in Table 1), as shown in Figure 5.
Figure 5: Update path
Modify the memory settings based on system capability for all the three variables:
JVM_MEMORY_START
JVM_MEMORY_MAX
PERMGEN_SPACE_MAX
Similarly, update <tomcat-home> and <jre-home> in the file <tomcat home>\UnRegisterServer.bat.
Enabling Support for HTTPS
Semantify supports HTTPS connection for a secured information transfer. To enable a secured connection, you must have a keystore file. Generally, organizations generate certificates in a windows environment and handover the keys and certificates in a .pfx file.
Semantify provides two options to configure the Tomcat server using the keystore file.
Using the keystore file given by client
Generating the keystore file using java keytool
Before beginning the process of enabling HTTPS, create a folder with a name SSL for saving the keystore file, in the path mentioned below:
SSL folder path: <Semantify-home>\SSL
Using keystore file given by client
Copy and paste the keystore file of your organization into the <Semantify-home>\SSL folder.
Follow the steps mentioned in the section, configuring server for HTTPS, to enable HTTPS.
Generating Keystore file using keytool
Follow the steps described below to generate keystore file using Java keytool.
1. Open command prompt as an administrator, and change the command prompt to <Semantify-home>\SSL folder.
Execute the following command,
<Semantify-home><jre-home>\bin\keytool -genkey -keyalg RSA -alias selfsigned -keystore Semantify.jks -storepass <password>-validity 360 -keysize 2048
Note: Make a note of the password you type in the above command.
After the command is executed, system displays set of questions, as shown in Figure 6.
Figure 6: SSL
What is the name of your organization unit?
What is the name of your organization?
What is the name of your city or locality?
What is the name of your state or province?
What is the two letter country code for this unit?
Enter the password, you typed in the command, in step 2.
The system generates the keystore file in the <Semantify-home>\SSL folder.
Configuring sever file for HTTPS
To enable the HTTPS connection, you have to append the keystore file attributes into the connector tags in the Tomcat server file.
Keystore file
Keystore password
1. In the file, <Semantify-home>\<tomcat-home>\conf\server.xml, comment and uncomment the sections shown in Figure 7.
Figure 7: Uncomment Https scheme
Append the keystore details in the https connector, as described in the Figure 8.
Figure 8: Append Keystore values
Note: The values in the keystoreFile and keystorePass, shown in the above figure depends on the keystore file (client keystore file or keytool generated keystore file)
Registering Tomcat server as a Windows service
After setting the path of Tomcat, <tomcat-home>, you will need to register the Tomcat server as a windows service. The service name of Tomcat server is "Tomcat8765", as defined in config file, in <tomcat-home>, refer to Table 1.
1. Open the command prompt, as an administrator and change the command prompt to <tomcat-home>.
Execute the batch script RegisterServer.bat, to register Tomcat service, as shown in Figure 16.
Figure 16: Execute RegisterServer
Start the service "Tomcat8765" from Windows Services, as shown in Figure 17.
Figure 17: Windows Services
Open Tomcat's Home page in a browser with the URL http://localhost:8765. Tomcat home page appears.
Check the Tomcat manager access.
i. Click Tomcat manager link on the left pane of the home page.
ii. Type Username and Password as "Semantify".
Stop Tomcat service.
Note: Do not start the Tomcat service till the SEMANTIFY product installation is done.
Solr
Configuring Solr Server (optional)
Note: Note: Solr is part of standard installation. Solr configuration varies on the installation types and should be configured only when specifically mentioned to configure.
Solr is a standalone full-text search server, with other features that includes, hit highlighting, faceted search, dynamic clustering, database integration and rich document handling.
The following steps describe the procedure to configure Solr server:
1. Open solrStartup.bat file present in the folder <Semantify-home>\solr\scripts\, as shown in Figure 11.
Figure 11: solrStartup default file
In the solrStartup.bat, update the path of jre and logs in the solrStartup.bat file, as shown in Figure 12.
Figure 12: Updated solrStartup file
Note: If you want to change default port (7075) number of solr server, then refer page 22.
Run the batch file <Semantify-home>/solr/scripts/solrStartup.bat, as an administrator, as shown in Figure 13.
Figure 13: Run solrStartup
After you execute solrStartup batch file, command prompt window appears.
To check status of Solr, enter the path ‘http://localhost:7075/solr’ in a browser. (for default Solr installation).
Figure 14: Solr home page
Modifying Solr Server
Note: Note: Solr is part of standard installation. Solr configuration varies on the installation types and should be configured only when specifically mentioned to configure.
You can change the Solr Server port number based on your system environment.
To modify Solr Server port number
1. Open the file, jetty.xml in the folder <Semantify-home>/<solr>/server1/etc, as shown in Figure 15.
Figure 15: Modifying Solr port
Update the port number and save the file.
After updating the port number, execute SolrStartup batch file, as described in page 21.
Note: If you change the port number, after installing Semantify Enterprise Search, refer page 43).
R Software
Installing R software custom packages
To enable R-Soft features, you need to install following R soft custom packages:
aod_1.3
chron_2.3-47
data.table_1.9.6
Once the packages are installed, R-Soft integrates with Semantify and displays the statistical values in the Rank & Plot type of graphs.
Note: Install custom packages after installing R-Soft.
To install custom packages
1. Extract the R_Soft.zip file present in the tools folder in the path, <semantify-temp>/support/tools/R_Soft> folder.
1. In the R-Soft GUI, on the menu bar, click Packages and then click ‘Install package(s) from local zip files…’, as shown in Figure 17.
Figure 17: R-Soft GUI
Figure 18: R_Soft custom package
Select custom packages in the R_Soft folder in the path, <semantify-temp>/support/tools/R_Soft>.
Installation confirmation message appears, as shown in Figure 19.
Figure 19: Installation Confirmation
Need to append below line in Rprofile.site and its file location is at <R_Soft-instalation-home>\R-3.1.2\etc\
options(defaultPackages=c(getOption("defaultPackages"),"aod","data.table"))
<Semantify-product-home> "product"
<Semantify-temp> "temporary"
<helpers-home> "helpers"
<semantify-temp>temporary
<solr>solr
<helpers-home> helpers
<Semantify-product-home>product
<tomcat-home>tomcat