Install Lasernet Keep (Interactive Installation)

This guide describes how to use the interactive installation wizard to install Lasernet Keep (in standalone mode) on a supported Windows operating system.

Important

The instructions on this page describe installing Lasernet Keep in standalone mode only.

Note

For information about how to upgrade an existing Keep system, see the Lasernet Keep Upgrade Guide.

How to Follow This Installation Guide

Follow the subsequent sections of this guide in sequence. In summary, the process is:

1. Complete the prerequisite and preparatory steps. This includes making decisions (for example, which network port numbers Keep will use), acquiring and installing prerequisite software (such as the Java runtime environment (JRE) that the installer will use), and preparing a database for Keep to use.

2. Install Keep. This involves making selections and entering values at each stage of the installation wizard, so that it can install Keep according to your requirements and appropriately configure the application server (Wildfly) that Keep runs on.

3. Apply a license to Keep.

4. Complete post-installation tasks. This includes ensuring that relevant network ports are open and running basic Keep functionality tests.

This guide also contains an Elements of a Keep Installation section. Understanding what elements comprise a basic Keep installation can help you understand why the prerequisite steps of the installation process are needed and what the Keep installer does. This understanding can also help you administer your Keep system after you have successfully installed and started it.

Elements of a Keep Installation

The Keep installer installs the following basic elements of a Keep system:

• A JDK

• Wildfly (application server)

• Keep software and files (as an EAR file installed in Wildfly's \standalone\deployment\ directory)

• A Windows service to provide easy start/stop/restart control over Keep

The following elements must be present before you run the Keep installer:

• A database for Keep to use.

  Note

  The installer does not create this database. Instead, you must create it as a prerequisite task of the installation process.

• A JRE for the installer to use.

  Note

  The installer is a Java application, so you must install a JRE for the installer to run on. Installing this JRE is a prerequisite task of the installation process. However, the installed JRE can be removed after Keep has been successfully installed, because the installer installs a JDK for Wildfly (and consequently Keep) to run on.

The following diagram illustrates how these elements interact.

Prerequisite and Preparatory Tasks

Decide Whether Keep Will Use HTTP or HTTPS

By default, the installer configures Keep to use HTTPS.

If Keep will use HTTPS, you must obtain a keystore that contains relevant certificates. If these are not available during installation, the installer can create a temporary self-signed certificate, which you can replace later.

Decide Which Network Ports Keep Will Use

To avoid conflicts with other applications, consider what port Keep will use for HTTPS connections and (if relevant) HTTP connections.

Tip

If multiple instances of Keep will run on the same server, use the port offset feature to ensure that they do not use the same ports. In the Keep installer, you can specify the same port numbers when you install each Keep instance (for example, port 443 for HTTPS), but you can specify a different port offset for each Keep instance.

For example, if two instances of Keep are installed and both instances' HTTPS Port is set to 443, and you set Port offset to 0 for the first instance and to 1 for the second instance, the first server's HTTPS port will be 443, and the second server's HTTPS port will be 444.

This configuration occurs at the Configure Wildfly (Application Server) stage of the installation process.

Create and Configure a Database

Before you install Keep, you must create a database for it to use. When Keep starts for the first time, it will configure the database.

Microsoft SQL Server

If necessary, install Microsoft SQL Server. For information about compatible Microsoft SQL Server versions, see the Lasernet Keep Compatibility Matrices.

Then, to create a suitable database, follow the instructions on the Create a Microsoft SQL Server Database for Keep page.

Oracle

If necessary, install an Oracle database management system. For information about compatible Oracle versions, see the Lasernet Keep Compatibility Matrices.

For information about creating a suitable Oracle database, contact Formpipe.

Install a Java Runtime Environment (JRE)

The Keep installer runs on Java. For this reason, you must install a JRE or JDK on the Keep server before you run the Keep installer.

For more information about this install-time Java requirement (and about the associated Java licensing implications), see Lasernet Keep and Java Licensing.

For information about compatible JREs,  see the Lasernet Keep Compatibility Matrices.

Check that the Keep Server is Running a Supported Operating System

For information about compatible Microsoft Windows operating systems, see the Lasernet Keep Compatibility Matrices.

Install Keep

The Keep installation wizard has several pages. Together, these pages collect information that enables the installer to:

• Install Keep application files

• Install Wildfly

• Install a JDK

• Configure Wildfly

After collecting this information, it installs this software and configures Wildfly.

1. Run the Keep Installer

To run the interactive installer, double-click the installer EXE file (for example: Lasernet-Keep-v11.0.0.exe). The installer will display its Welcome page.

Click Next.

Note

The installer is also available as a JAR file. Use the JAR file instead of the EXE installer if you have advanced installation requirements that necessitate the use of a JAR file.

2. Accept the End User Software Licence Agreement

Review the displayed End User Software Licence Agreement.

If you accept the terms of the agreement, click I accept the terms of this license agreement, then click Next.

3. Select "New" Installation Type

Because this is a new installation (rather than an upgrade), click New. Then, click Next.

4. Enter a Node Name

5. Choose an Installation Location

Check whether the default installation path (which includes the node name) is appropriate. If necessary, enter a different location (or click Browse to select a location).

Then, click Next.

6. Choose Which Components to Install

7. Configure Wildfly (Application Server)

The next few pages of the installation wizard collect configuration settings for the application server (Wildfly).

Application Server Configuration Page

Application Port Configuration Page

HTTPS Certificate Configuration Page

HTTPS Generated Certificate Configuration Page

8. Configure Keep

In Archive path (on the Lasernet Keep configuration page), enter an existing location for Keep to use as the document archive location, or click Browse to select a location. Then, click Next.

Warning

Ensure that Keep has read and write permissions to this location.

Note

For standalone Keep systems, you can specify a local path, such as the default c:\archive

To specify a remote location, you can use one of the following types of path:

• UNC path: Enter a reference to a network share. For example, \\nas\share\ARCHIVE

• iSCSI target: This type of path is robust and appears as a local path to the application.

If you want to use an advanced type of path (such as an Azure path), you must do this as a separate configuration task after you have successfully installed Keep.

It is not recommended to use other remote path options such as symlinked paths and mapped drives.

9. Configure the Database Connection

The information that you enter on this page enables Keep to connect to the database that you created during the earlier Create and Configure a Database part of the installation process.

Select target database: Select the type of database that Keep will be using.

Warning

Do not use the H2 database type for production systems. It is intended only for temporary test installations.

Hostname: Enter the host name of the computer that is hosting the database.

Database name, Username, Password, and Retype Password: Enter values that match those used when you created the database.

Unless directed otherwise, use the default Min connection pool size and Max connection pool size.

To continue, click Next.

10. Configure the Windows Service

11. Review the Pre-Installation Summary

The Summary Configuration Data page summarizes the settings and configuration values that the installer will use to install and configure Keep and the application server (Wildfly).

The HTTP Port and HTTPS Port that the new installation will use are calculated from the port number and offset entered earlier and are displayed here. If they differ from the default values, make a note of them.

To start installing the software, click Next.

12. Install the Software and Monitor Installation Progress

Apply a License to Keep

To use the new Keep instance, you must apply a valid license to it.

To do this, follow these steps:

1. In a web browser, go to <base-URL>:<port>/keep (substitute <base-URL> for the base URL of the Keep installation or for https://localhost if appropriate), and substitute <port> for the Keep HTTPS port). If Keep is using its default port numbers with no offset applied, you can omit :<port>. For example, https://KeepServer/keep.

2. On the Welcome to Keep page, enter the following credentials, then click Log in:

   • Username: admin

   • Password: ChangeMe

3. On the Password Expired page, enter a new password for the admin user, then click Change Password.

4. On the Welcome to Keep page, use the new password to log in as the admin user.

5. On the Licence Required page, click Browse (see a in the image below), select your Keep license file, then click Activate (b). Alternatively, paste the license key text (from that file) into the box (c), then click Activate.

   Note

   If a license file is not available to you at this time, you can temporarily activate Keep for 30 days. To do this, click Evaluate (see d below) in the Evaluation Mode area.

   

6. After the license successfully activates (or Keep enters evaluation mode), the Keep home page opens.

Complete any Necessary Post-Installation Tasks

After completing the steps above, you might need to complete some of the following tasks.

Make Post-Installation Configuration Changes (in the node.properties File)

If you need to change or update some of the configuration values that were used during installation, you can edit them in the node.properties file which is in the \standalone\configuration\ area of the Keep installation's directory.

For example: C:\Program Files\Formpipe Software\Lasernet Keep\Server_<Keep version number> - [<node name>]\wildfly-<Wildfly version number>.Final\standalone\configuration\. Appropriately substitute <Keep version number>, <node name>, and <Wildfly version number>.

The node.properties file is the default location for changing installation values. Do not make changes in other XML configuration files (to change configuration values) because those files do not have primacy over node.properties.

Example of Adjustable Values

# The bind address for the management interface
jboss.bind.address.management=127.0.0.1

# The port for the web management console and jboss cli, also used by the windows service.
# Note that this is fixed and not affected by the port offset if set
jboss.management.http.port=9990
jboss.management.https.port=9993

Refer to the information in the node.properties file itself for full details and explanations of the various properties that can be set. These properties include the Keep logging level.

Other Post-Installation Tasks

Open Ports

Ensure that the HTTP and HTTPS ports chosen during installation are accessible through any firewalls between the target machine and clients.

Remove the 'Data Definition Language' Role

Once the installation is complete, the database account can (and should ideally) have its permissions tightened to remove the ability to DROP, UPDATE, and ALTER tables. For example, remove the db_ddladmin role so the user only has the db_datareader and db_datawriter roles for SQL Server.

Perform a System Test

Once Keep has started and has been activated, perform a series of actions that will enable you to confirm that the installation is working as expected. For example, you could:

1. Test logging in to Keep.

2. Run a search, or upload, or both.

   Note

   A new Keep system does not provide any searches or uploads, and its archive is empty. To enable you to run this part of the system test, you must add an upload configuration to Keep and add a search too. After you do that, you can upload documents to the archive and run searches for them.  

3. View a document image from a search.

Azure Storage Paths

If you wish to use Azure for one or more storage paths, you must set these up after Keep is installed and running. Log in to Keep and configure the paths on the Server Settings page.

Collation Setup

If Keep runs without errors, leave the collation settings as their default values. On SQL Server and Oracle, the default collation is based on the locale setting of the server that the database system is installed on.

How to change collation on Oracle (See NLS_SORT)

How to change the collation on MS SQL Server

Warning

The collation that is used must be case-insensitive, so that it is compatible with the Keep server.

Known Issues

Installing with Oracle Database – Extra Permission Needed

Note

Keep installations that use an Oracle database require you to follow extra configuration steps.

Keep cannot select dba_ind_columns. For example:

Sql = SELECT index_name FROM dba_ind_columns WHERE UPPER(table_name) = 'TBLDOCUMENTS' AND UPPER(column_name) = 'SKEY1'

Error Msg = ORA-00942: table or view does not exist

The solution is to grant the pdm user the SELECT ANY DICTIONARY permission:

GRANT SELECT ANY DICTIONARY to pdm;