Kofax Analytics for ControlSuite

Installation Guide
Installing Kofax Analytics for ControlSuite

2
Installing Kofax Analytics for ControlSuite

Overview of the Installation Process

This guide is comprised of 8 lessons. We recommend you follow it in a linear way.

Prepare to Install

1. Download Resources and Documentation

2. Confirm Prerequisite Software

3. Windows User Account and Logon as Service Privileges

Install Kofax Insight

4. Install Kofax Insight

5. Activate the Insight License

Install the Kofax for Analytics Project

6. Create the Kofax Analytics for ControlSuite Project

7. Configure the Equitrac Database and Load Data

3
Installing Kofax Analytics for ControlSuite

Prepare to Install
Download Resources and Documentation

Step 1

Download Installation Media

Kofax provides a secure and easy-to-use method for downloading your installation
media.

The following download instructions are for Kofax Analytics for ControlSuite. Please
repeat these steps to download Kofax Insight.

An email similar to the one shown above will be sent to an email address specified
during the order process.

The serial number and registration code are listed in this email.

Selecting the Download Your Products link on the left side of the email will take
you to the Kofax Delivery site.

Note: You will have to create an account if it is your first time.

4
 Installing Kofax Analytics for ControlSuite

Step 2

Once the software has been added, it will appear in the list of available downloads. The
Analytics for ControlSuite Web Installer and the much larger Offline Installer will be listed and
ready for download.

Note:

• The versions of software available will be determined by those that are currently supported.
• Serial numbers can only be associated with one account on the Delivery Web site.

5
Installing Kofax Analytics for ControlSuite

Confirm Prerequisite Software

Step 1

Configure the Web Server Role

The quickest way to check/enable IIS settings is through Server Manager.

1. From the Start menu, open Server Manager.

2. Click Server Roles in the navigation tree.
3. Locate and expand Common HTTP Features and ensure the features are
enabled as shown in the image below.

6
Installing Kofax Analytics for ControlSuite

Step 2

Server Role - Health and Diagnostics

Navigate to Health and Diagnostics and ensure features are enable as
shown below.

Navigate to Health and Diagnostics and ensure features are enable as shown
below.

7
Installing Kofax Analytics for ControlSuite

Step 3

Server Role - Performance and Security

1. Navigate to Performance and ensure features are installed, as shown in the
image below.

2. Navigate to Security and repeat.

8
Installing Kofax Analytics for ControlSuite

Step 4

Server Role - Application Development

Navigate to Application Development and ensure the following features are installed, as shown
in the image below.

9
Installing Kofax Analytics for ControlSuite

Step 5

Server Role - Management Tools

Navigate to Management Tools and ensure these features installed, as shown
below.

10
Installing Kofax Analytics for ControlSuite

Step 6
Install WCF Services
1. In the left-hand menu navigate to Features, then WCF Services, and ensure
the features are installed, as shown below.

2. Click Next.

3. Click Install.

11
Installing Kofax Analytics for ControlSuite

Step 7
Check Internet Information Services (IIS)
1. From the Start menu, open IIS.

2. Navigate to Default Website, then right-click to select Edit Bindings.

12
Installing Kofax Analytics for ControlSuite

Step 8
Check Internet Information Services (IIS) Cont'd
• In the dialogue window, we can see that HTTPS has been assigned the 443
port.

• By clicking Edit, we can also see that it has been assigned to the
appropriate SSL Certificate.

13
Installing Kofax Analytics for ControlSuite

Step 9

Enable Windows and SQL Server Authentication mode

1. From the Start menu, open Microsoft SQL Server 2019, then SQL Server
Management Studio.

2. Right-click on the server name and click Properties.

14
Installing Kofax Analytics for ControlSuite

Step 10

Windows Authentication Mode

1. Select the Security tab.
2. Check that Windows Authentication mode has been enabled.

15
Installing Kofax Analytics for ControlSuite

Windows User Account and Logon as Service

Privileges

Step 1
Create a Service Account for Kofax Insight
1. From the Start menu, open Windows Administrative Tools, then Computer
Management.
2. Expand Local Users and Groups and right-click on the Users folder to
select New User.
3. Create a new user for the service account, giving it a User name,
a password that should be set to never expire.
4. Click OK.

16
Installing Kofax Analytics for ControlSuite

Step 2

Add the New Insight Service

1. Back in Computer Management, click on the Groups folder, under Local

Users and Groups.

2. In the right-hand panel, right-click (or double-click) the Administrators group.

3. In the Properties window, click Add.

4. In the Select Users window, type Insight Service, then click Check Names.

Once the user account has been verified, click OK, then Apply.

Note: In a domain environment, you will not need to create a local user account.

17
Installing Kofax Analytics for ControlSuite

Step 3

Add the Log On As a Service Right to the Service Account

To run the services the InsightService account must be granted the Log On As a
Service right.

1. From Administrative Tools, double-click Local Security Policy.

2. In the new window, select User Rights Assignment.
3. Double-click Log on as a service.

18
Installing Kofax Analytics for ControlSuite

Step 4

Verify the User Account

1. Click Add User or Group.
2. In the dialogue window, type the name of the user you wish to search, then
click Check Names.
3. Once the account has been verified, click OK.

19
Installing Kofax Analytics for ControlSuite

Create an SQL Login and an IIS Application

Pool
Step 1

Create new Login

We must provide the Server User with dbcreator privileges in order to proceed with
the Insight installation.

1. Ensure you have Microsoft SQL Server Management Studio open.

2. On the left of the screen, select the Security folder.
3. Right-click on the Logins folder, then select New Login.

20
Installing Kofax Analytics for ControlSuite

Step 2

Search for the User Account

1. In the new window, click Search.
2. In the dialogue box, type the following: Insight Service
3. Click Check Names. This should find the user name we created earlier in this
module.
4. Click OK.

21
Installing Kofax Analytics for ControlSuite

Step 3

Select Server Roles

1. On the left of the screen, click Server Roles.
2. Check the dbcreator box.
3. Click OK.

22
Installing Kofax Analytics for ControlSuite

Step 4

Windows Administrator Privileges for Sequel Server

Please ensure that you have the correct windows administrator privileges for Sequel
Server. To do so:

1. Expand the logins folders and find your account (In this case Trainee).
2. In the Login Properties window click on Server Roles and check that
the Trainee user has sysadmin privileges.
3. Once finished, sign out of SQL Server Management Console.

23
Installing Kofax Analytics for ControlSuite

Step 5

Create an IIS Application Pool

When installing Insight it is recommended to create your own IIS application pool.

1. From the Start menu, open > Administrator Tools > Internet Information
Services Manager (IIS).
2. In the left of the screen, right-click on Application Pools and select New
Application Pool.
3. In the dialogue box:
1. Give it the name InsightAppPool.
2. Choose .Net CLR Version v4.0.30319.
3. Choose Integrated as the Managed pipeline mode.
4. Check the Start application pool immediately box.

24
Installing Kofax Analytics for ControlSuite

Installing Kofax Insight

Step 1
Launch the Installation Wizard
1. Go to your 'C' drive and locate the folder in which you have stored the latest
version of Kofax Insight (Version 6.3) and double-
click the KofaxInsightSet_6.3.msi object.
2. In the Installation Wizard click Next.
3. You may be prompted to Run as Administrator. If so, click Restart.
4. Click Yes to allow this app to make changes to your device. The installer can now
run with administrator privileges.
5. Click Next to accept the terms of the license agreement.

25
Installing Kofax Analytics for ControlSuite

Step 2

Installation Wizard Completion

1. When asked What would you like to install on this computer?, choose Full Environment.
2. No changes are required on the Custom Setup screen so click Next to continue.

A green progress bar will illustrate the copying over of files to your server.

Note: Please note the location of the log folders.

3. Click Finish to open the Insight Installation Manager.

26
Installing Kofax Analytics for ControlSuite

Step 3

Insight Installation Manager

You will be prompted to configure a database for Insight Studio to store information.

1. Since you will be using a SQL Server installation, use the following information:
1. Insight Mode: Single
2. Connection Type: MS SQL
3. SQL Server Name: KTA-TRAIN
4. Select the Windows Authentication checkbox.
5. Set the Administration Database Name as Insight_Admin.
2. Click Next.
3. A Confirmation pop-up window will appear. Click OK.

27
Installing Kofax Analytics for ControlSuite

Step 4

Insight Web Applications IIS Settings

Only use the TLS/SSL if the user has configured IIS to use Https and set a local SSL
certificate.

1. Check the Use TLS/SSL checkbox.

2. We will associate Insight to run under the IIS Application Pool we created
earlier. Populate the Application Pool Name with your newly
created InsightAppPool.
3. Click the associated Set Identity button.
4. Enter 'KTA-TRAIN\InsightService' as the Account, and set the password.

Note: Please take note of this password as this is the default user (Administrator) in
Insight and is needed to log in to the Insight Administration console to activate the
license.
5. Click Next.

28
Installing Kofax Analytics for ControlSuite

Step 5

Set Insight Authentication Method

1. Set the Insight Authentication method to use Insight User, and confirm it is
the Administrator (default user) and click Next.

Note: we are not using Windows Authentication from Insight Data Services to the
Scheduler Service, so we will use the default user in Insight (Administrator).

2. Review the configuration detail. After reviewing, select Next. If changes need to
be made, select Previous to return to earlier sections.

29
Installing Kofax Analytics for ControlSuite

Step 6

Complete Insight Installation

1. An Installation summary screen is displayed.

2. Select Next after the installation is done. Address and fix any items that don’t
have a green checkmark.

3. Installation is now complete. Click Exit.

30
Installing Kofax Analytics for ControlSuite

Step 7

Confirm that Services are Working correctly

From the Start menu, open Insight Services.

1. Check that 2 Insight services are running:

1. Insight Bridge Service 6.3.0
Log On As should be set to InsightServices.
2. Insight Schedule Service 6.3.0
Log On As should be set to InsightServices.
2. If any of these are not set to the correct user, please update by right-
clicking the service name and accessing the Properties window.

31
Installing Kofax Analytics for ControlSuite

Step 8

Check IIS Accounts

From the Start menu, open IIS Services.

1. On the left of the screen select Application Pools.

2. Double-click Identity.
3. Set the IIS credentials (if necessary).

32
Installing Kofax Analytics for ControlSuite

Activate the Insight License

Step 1

Open the Administration Console

Open Google Chrome.

1. To access the Insight Admin console enter:

http(s)://<server-name>/Insight/Admin

Alternatively, or use the shortcut in the Start menu (Insight 6.3 > Admin
Console).

Note: To save time you should create a shortcut to the Insight Admin Console in
your browser using the Bookmarks toolbar.

2. Login with the following details:

Login: Administrator
Password: W0rkstation!

Note: this is the default user created in Insight during installation. You specified the
password during the installation in the previous section.
3. Click Login.

33
Installing Kofax Analytics for ControlSuite

Step 2

Activate the License

The License Manager is where licenses are added and maintained. The License
Manager will be displayed by default as no valid licenses exist for this installation.

1. Open License Manager.

2. Click Add new data.
3. Navigate to the location where you copied the training license.

e.g. C:\KTAAnalytics\LabFiles\License\.

Select the license file and click Open. The license is now activated.

After activating your license, your License Manager screen will reflect the
currently active license.

34
Installing Kofax Analytics for ControlSuite

Step 3

Check License Components and Options

The Components section of the License Manager shows what components are
provided by the license.

By clicking on a license in the above list you can see what components are covered by
that license.

The Options section defines your license in reference to:

• Maximum data sources to be used.

• The maximum number of named users.
• The maximum number of users who can concurrently use the system.

This information may be useful to ensure adherence to licensing agreements and

availability.

35
Installing Kofax Analytics for ControlSuite

Step 4

Log Out of the Console

1. Your login details are displayed at the top-right corner of the console.

2. You can logout using the Logout icon in the top-right corner.

36
Installing Kofax Analytics for ControlSuite

Create a Project for Kofax Analytics for

ControlSuite
You must create a new Insight project for use with Kofax Analytics for ControlSuite.

Before proceeding, extract the contents of KofaxAnalytics-1.0.0_For_ControlSuite.zip

on the server where Kofax Insight is installed. Make sure you unblock the file from the
File Properties window.

Step 1

Create the Project

Navigate to Start > All Programs > Insight 6.x.x > Admin Console.

1. On the Documents Tree, right-click Projects and select New Project.

2. When prompted, enter the project name (such as KAFCS).
3. In the Create New Project window, click the Import from file tab.

37
Installing Kofax Analytics for ControlSuite

Step 2

Select the Kofax Analytics for ControlSuite Project File

To select the Kofax Analytics for ControlSuite project file, then do the following:

1. Click the ellipsis adjacent to the Select file box. The Open file window appears.
2. In the Open file window, select either option:
1. The file is located on the client computer and will be copied to the server
for processing: Select Project_KAFCS-1.0.0.0.zip from KofaxAnalytics-
1.0.0_For_ControlSuite > Project that is already extracted on your local
computer.
2. The file is located on the server: Select a file from the server.
3. Click OK.

38
Installing Kofax Analytics for ControlSuite

Step 3

Enter Login Credentials and Test Database Connection

1. Enter the server name, database name and the login credentials to access
the KAFCS_Meta and KAFCS_Data databases.

2. Click Connect to test if the database connection is working.

Note The connection will fail if these databases do not exist.

3. Click OK to create a project. A confirmation message appears.

39
Installing Kofax Analytics for ControlSuite

Step 4

Create or Update the Database

1. To create a new database or update a pre-existing database, click Yes in the
confirmation window. Otherwise, the KAFCS_Meta and KAFCS_Data databases
are not created or updated.

Note Login credentials must have database owner rights to create the databases
manually. If the databases are created by Insight, the assigned user is granted
database owner rights automatically.

2. Wait until the project is created. A message confirms that the import is
successful.

3. Click OK.

40
Installing Kofax Analytics for ControlSuite

Step 5

Configure the Equitrac Database for the Project

Navigate to Insight Admin Console > Projects > KAFCS.

1. Click Projects > KAFCS > eqcas.

2. Enter the server name, database name, and login credentials to access
the eqcas database.

3. Click Connect to verify the Equitrac database connection.

Note The Insight server and the ControlSuite server (where the Equitrac database
resides) may exist in separate locations. Therefore, you must make sure that Kofax
Insight and the Equitrac database are well-connected (Kofax Analytics for
ControlSuite supports SQL server only).

4. Click Save.

41
Installing Kofax Analytics for ControlSuite

Load Equitrac Data

To ensure that your dashboard views include the proper data, you must use the
Insight Data Loader to run the following plans:

• One Time Plan

• Hourly Plan

Note:

• When loading the data, you must always run the One Time Plan before running the Hourly plan.
• The One Time Plan must be executed at least once; otherwise, the data might be displayed
incorrectly in the Kofax Analytics for ControlSuite landing page.

Step 1

Select the Project

1. Navigate to Start > All Programs > Insight 6.x.x > Data Loader.

2. On the Execution plans tab, select the project and an execution plan. For
example:
1. Project: KAFCS.
2. Execution Plan Name: One Time Plan.

3. Click Load.

42
Installing Kofax Analytics for ControlSuite

Step 2

Load Data
1. Under the Date rangesection, do the following:
1. Under From date, select Beginning of times.
2. Under To date, select Current time.
3. Select the Save "To date" as the date of last successful load check box.
4. Click Load data and wait for data load to complete.

Note: When performing a manual data load, ensure that only the One Time
Plan is selected.

2. Repeat the same steps for the Hourly Plan.

Note: After the initial data load, data is loaded by the Hourly execution plan every
hour according to the default schedule. By default, the Hourly plan is executed at 5
minutes past the hour.

Your installation of Kofax Analytics for ControlSuite should now be complete!

43
Installing Kofax Analytics for ControlSuite

Kofax Insight Administration

Verify Your License

Use the Insight License Manager to verify your Kofax Analytics for ControlSuite
license.

Start Insight Admin Console.

1. Select Documents Tree > License Manager. The License Manager appears.
2. In the Licenses section, confirm that the Validity Period is current and that the
Availability status is valid.
3. On the Actions toolbar, click Save.

44
Installing Kofax Analytics for ControlSuite

Step 1

Set Authentication Method

1. In the Admin Console select the Insight application for which you are setting
the authentication method.

Note: Keep in mind that authentication preferences are set separately for each
Insight application.
1. Admin Console
2. Data Loader
3. Studio
4. Themes and Formats
5. View (affects user access to the Kofax Analytics for ControlSuite
dashboard Viewer; setting already applied during the installation or
upgrade)
2. Set one of the following authentication methods.
1. No authentication
When selected, all users have access to the application selected in the
preceding step. Most organizations require an authentication method.
When selected for the Viewer, all users have access to the dashboard
views, and Kofax ControlSuite batch class assignments are not enforced.
In this situation, you can copy the "kafcs role" settings to the Default role.
Be sure to apply the Kofax Theme and set the default view for the role to
Main.
2. User's logins and passwords are defined within Insight platform.
Users are explicitly linked to roles.

Important! When selected, each user's Insight application login ID must

exactly match a corresponding user ID in Kofax ControlSuite. Otherwise, data
does not display on the dashboard. To create Insight users and assign roles to
them, see Create Insight users and Assign a role to users.
3. User properties are obtained from the environment: Windows.

With Windows authentication, each user must be a linked user or belong

to a linked group in Kofax ControlSuite. Therefore, you do not need to
create an Insight user for each dashboard user.

Note: The HTTP Request and Login panel options are not supported for use
with Kofax Analytics for ControlSuite.

45
Installing Kofax Analytics for ControlSuite

Step 2

User Roles and Access Rights

1. If you select Windows authentication in the previous step, select And then user
roles and access rights are determined by comparing these values to Fixed
values.

The External database option is not supported for use with Kofax Analytics for
ControlSuite.

Important If you select Windows authentication, follow the procedures in Configure

Insight for Windows authentication and Assign a role to users. If you set Windows
authentication for Admin Console without completing both of these procedures, you
cannot log in to the Admin Console later. In this situation, see "Recover from a
lockout" in the Kofax Insight Administrator's Guide.

2. On the Actions toolbar, click Save.

3. Repeat the procedure for each Insight application on the Application list.

46
Installing Kofax Analytics for ControlSuite

Step 2

User Roles and Access Rights

1. If you select Windows authentication in the previous step, select And then user
roles and access rights are determined by comparing these values to Fixed
values.

The External database option is not supported for use with Kofax Analytics for
ControlSuite.

Important If you select Windows authentication, follow the procedures in Configure

Insight for Windows authentication and Assign a role to users. If you set Windows
authentication for Admin Console without completing both of these procedures, you
cannot log in to the Admin Console later. In this situation, see "Recover from a
lockout" in the Kofax Insight Administrator's Guide.

2. On the Actions toolbar, click Save.

3. Repeat the procedure for each Insight application on the Application list.

47
Installing Kofax Analytics for ControlSuite

Configure Insight for Windows

Authentication
Use the procedure in this section to configure Insight for Windows Authentication.

Before configuring Insight, select Windows authentication in IIS for the web
application (default website).

Step 1

Verify Authentication Method

1. Navigate to Insight 6.x.x > Admin Console.

2. Verify that Windows is set as the authentication method for the applicable
Insight applications, as described in the Set authentication method.

3. User identifier: Specify a way to obtain the user's ID, which should be constant
for a specific user's login. Usually, it is a session property (Identity) that looks to
the Active Directory domain for the user ID.

1. In the Documents Tree, click User Mapping.

2. On the UserIdentifier (UID) tab, set the Session property to Identity.

48
Installing Kofax Analytics for ControlSuite

Step 2

Set the Session Properties

1. With User Mapping still selected, set the session properties for User
Name and Email.

1. Click the User Name tab, and set the Session property to the applicable
property for the display name, such as FullName. User Name is the
display name of a user account.

Usually, it is one of the Active Directory properties, such as Identity, name,

FullName, displayName or another convenient property. Your domain
administrator can provide all available Active Directory properties.

2. Click the Email tab, and set the Session property to EmailAddress.

Note: Email is the email address of the user account. It is used for self-
subscriptions only. Usually, it is the Active Directory property mail or
EmailAddress. Your domain administrator can provide the available Active
Directory properties.

3. On the Actions toolbar, click Save.

2. Assign Insight roles to Windows users.

49
Installing Kofax Analytics for ControlSuite

Manage Users and Roles

Kofax Analytics for ControlSuite uses roles to manage access rights to different
metrics, records, and views.

User access is limited to the set of views assigned within a project based on the
assigned roles.

For example, if multiple users have access to the same set of views containing labor
and operator performance information, you can create a Labor Manager role to
assign to users, as applicable.

Create Insight Users

If Insight authentication is selected, use Admin Console to set up one or more Insight
users and then assign roles to them.

By default, the Administrator user is assigned a password as specified during

installation. The Administrator user is assigned to the Administrator role, which allows
access to the Insight applications: Admin Console, Studio, Data Loader, and Themes
and Formats.

If necessary, the Administrator user password settings can be updated after

installation. After installation, the Administrator can add other users.

Step 1
When using Windows authentication, you do not need to create an Insight user for
each dashboard user.

1. Start Admin Console.

2. On the Documents Tree, click Users.
3. Right-click and then click New User. The New User dialog box appears.
4. Enter a name for the user such as Labor Manager, and then click OK.

50
Installing Kofax Analytics for ControlSuite

Step 2

1. Enter a user login, user display name, email address, and password. Also, select
the check box if the user should be able to update the password without
assistance from the administrator.

2. Select one or more roles to associate with the user.

Note: You can assign a user to multiple roles. If you assign a user to multiple roles
that have varying access rights, the user is granted combined rights for the assigned
roles. The user's default view is based on the default view for the first of the multiple
roles, based on the order of the Roles list in Admin Console. You can right-click a role
to move its position on the list.

3. On the Actions toolbar, click Save.

51