Kofax Reporting. Administrator's Guide

(1)

Kofax Reporting

2.0.0

(2)

Third-party software is copyrighted and licensed from Kofax’s suppliers.

THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE SECRETS OF KOFAX, INC. USE, DISCLOSURE OR REPRODUCTION IS PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF KOFAX, INC.

Kofax, the Kofax logo, and the Kofax product names stated herein are trademarks or registered trademarks of Kofax, Inc. in the U.S. and other countries. All other trademarks are the trademarks or registered trademarks of their respective owners.

U.S. Government Rights Commercial software. Government users are subject to the Kofax, Inc. standard license agreement and applicable provisions of the FAR and its supplements.

You agree that you do not intend to and will not, directly or indirectly, export or transmit the Software or related documentation and technical data to any country to which such export or transmission is restricted by any applicable U.S. regulation or statute, without the prior written consent, if required, of the Bureau of Export Administration of the U.S. Department of Commerce, or such other governmental entity as may have jurisdiction over such export or transmission. You represent and warrant that you are not located in, under the control of, or a national or resident of any such country.

DOCUMENTATION IS PROVIDED “AS IS” AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.

(3)

Preface

Introduction

This guide contains information about installing and configuring Kofax Reporting. To use this guide, you should have a thorough understanding of Windows standards, applications, and interfaces, and a thorough understanding of the Internet and your network configuration.

This guide is intended for system administrators who are installing and configuring Kofax Reporting, or who need a description of the installation procedures, requirements, and configuration.

Chapter 1 Overview

Kofax Reporting gives system administrators, business process managers, and other

stakeholders important information about Kofax-managed business processes. This product serves as the single conduit across many Kofax products, providing centralized storage of historical operational metrics and audit data. For a list of Kofax products supported with this release of Kofax Reporting, see Supported Software.

Architecture

Kofax Reporting uses a distributed architecture for delivering information from one or more Kofax application sites to a central reporting site. Between sites, the information is transported in a message-based store and forward mode. Kofax Reporting supports three transport mechanisms:

▪ HTTP

▪ Message queues

▪ Third-party enterprise service bus (ESB)

With all three mechanisms, Kofax applications provide reporting data through API calls to the reporting integration API. The API uses web service calls to feed the data into a local transport entry point.

At the central site, an extract/transform/load (ETL) agent uses web service calls to read data from the central transport entry point. The data is then transformed and stored in the database.

HTTP Transport

The Kofax Reporting API, which is integrated in Kofax applications such as Kofax Capture, communicates with the central site through a message-based protocol implemented over web services. The following diagram shows a distributed deployment, in which two web service architecture (WSA) components are inserted between reporting data producers (Kofax applications on site A) and the data consumer (central reporting site). This scenario does not require any external transport mechanisms.

(8)

Overview

Message Queue Transport

In this scenario, all messaging between sites is transmitted through IBM WebSphere MQ or MSMQ. WSA usually runs as a service on each computer with a Kofax application; or it can also run on a standalone server.

The Kofax Reporting API sends the reporting data to WSA using the same web service interface as in the HTTP transport scenario; WSA handles the translation to IBM WebSphere MQ or MSMQ.

The WSA server at the central reporting site receives information from the message queue and stores the information locally. The ETL Agent then pulls data from the WSA storage.

(9)

Overview

Transport Through a Third-Party ESB

This scenario leverages an existing enterprise service bus (ESB), such as Sonic. Implement the Kofax Reporting web service interface on an ESB by importing the Reporting WSDL into the ESB integration tool. The ESB takes care of the communication.

The client DLL communicates directly to the local ESB server on the Kofax applications site. At the central site, the ETL Agent pulls information from the central ESB server.

(10)

Overview

Central Site

The following diagram shows details about Kofax Reporting core components at the central site. The ETL Agent continuously pulls information from the central transport entry point and stores the information in the staging database.

At configurable intervals, the agent takes all available information from the staging tables and populates the data warehouse.

Data consumers such as business intelligence applications (Kofax Altosoft) or third-party reporting tools access only the data warehouse tables and views.

(11)

Overview

Components

This section describes the Kofax Reporting environment.

Kofax Reporting API

Kofax applications such as Kofax Capture use the API to forward information about batch processing events and administrator actions to the reporting platform.

WSA Sender (application site)

This component runs on the same computer as the Kofax application or on another computer at the same site. The WSA Sender acts as a web server and receives web service calls from the API. The web service calls contain data from the Kofax applications. The received data is stored in local temporary storage and later delivered to the central site through a configured transport.

ESB (application site)

As an alternative to WSA, customers can use a third-party ESB. A local ESB receives information from the API and delivers the information to the central site.

(12)

Overview

IBM WebSphere MQ or MSMQ

You can use message queues as the transport mechanism between sites. Alternatively, you can rely on HTTP transport or ESB transport.

WSA Receiver (central site)

This component runs at the central site as a Windows service, on one or more computers. The WSA Receiver takes data from the local WSA and stores the data until the extract/ transform/load (ETL) agent picks up the data.

ESB (central site)

This component receives data from a remote ESB and makes the data available to the ETL Agent.

ETL Agent

The extract/transform/load (ETL) agent runs at the central site. The agent retrieves Kofax application data from the central WSA or central ESB and stores the data in the staging database. In configurable intervals (usually in off-peak times), the ETL Agent transforms the data from the staging database and stores the data in a data warehouse.

Staging Database

This central database (SQL Server or Oracle) temporarily stores the reporting data from Kofax applications.

Data Warehouse

(13)

Chapter 2 System Requirements

Before installing and operating Kofax Reporting, carefully read the following requirements. For the most recent information about system requirements, see the Cross-Platform

Compatibility Matrix (CPCM).

Hardware Requirements

The Kofax Reporting ETL Agent requires at least 1 GB of free RAM.

Supported Operating Systems

Kofax Reporting client software is supported on the following operating systems (both 32 and 64 bit unless noted otherwise):

▪ Windows 8 ▪ Windows 7 ▪ Windows Vista

▪ Windows XP (32-bit only) ▪ Windows Server 2012 ▪ Windows Server 2008 R2 ▪ Windows Server 2008

▪ Windows Server 2003 (32-bit only)

Kofax Reporting server software is supported on the following operating systems (both 32 and 64 bit unless noted otherwise):

▪ Windows Server 2012 ▪ Windows Server 2008 R2 ▪ Windows Server 2008

▪ Windows Server 2003 (32-bit only)

Supported Virtualization Servers

The following virtual server environments are supported with Kofax Reporting: ▪ Microsoft

▪ Hyper-V role on Windows Server 2008 R2 ▪ Hyper-V Server 2008 R2 (standalone) ▪ VMware

▪ VMware vSphere 4.1 (ESX and ESXi hypervisor architectures) ▪ VMware vSphere 4.0 (ESX and ESXi hypervisor architectures)

(14)

System Requirements

▪ VMware ESX Server 3.5 ▪ Citrix

▪ Citrix XenServer 5.6 ▪ Citrix XenServer 5.5 ▪ Citrix XenServer 5.0

Supported Software

The following minimum versions of Kofax products support Kofax Reporting: ▪ Kofax Capture 10.0.1

▪ Kofax Transformation Modules 6.0.0 ▪ Kofax Front Office Server 4.0.0 ▪ Kofax TotalAgility 7.0.0 ▪ Kofax Altosoft Insight 4.3.0

Various tools and applications can access the data collected by Kofax Reporting. We recommend Kofax Altosoft business intelligence solutions.

Kofax Reporting can be used with Microsoft Message Queuing (MSMQ) or IBM WebSphere MQ.

Microsoft .NET Framework 4 is required for Kofax Reporting Configuration Tool, ETL Agent, and Kofax License Utility. The setup process attempts to download and install the framework if it is not installed on the target computer.

Note Third-party software requires appropriate license. Customers must provide their own

licenses; third-party licenses are not included in the Kofax Reporting license.

Supported Database Management Systems

Kofax Reporting supports the following database systems: ▪ Microsoft SQL Server 2008 R2 (with failover clustering)

▪ Microsoft SQL Server 2012 (with failover clustering and always-on failover clustering) ▪ Oracle 11 RDBMS on Windows, Linux, UNIX (with real application clusters)

Note Kofax TotalAgility does not support the Oracle operating system.

(15)

Chapter 3 Installation

Use the information in this chapter to install Kofax Reporting. Install the following components at the central site:

▪ Kofax Reporting Configuration tool ▪ ETL Agent

▪ Kofax License Utility ▪ Databases

▪ WSA Receiver (when using IBM MQ/MSMQ/HTTP transport) ▪ ESB (when using ESB transport)

Install the following components at the application site: ▪ WSA Sender (when using MQ/MSMQ/HTTP transport) ▪ ESB (when using ESB transport)

The setup includes the integration SDK. The SDK provides sample code, describes how to integrate Kofax Reporting with an ESB transport, and includes information about Kofax Reporting views and tables.

Performance Considerations

To correctly scale your installed solution, consider the following:

WSA Sender instances

WSA components are complicated applications with multiple processes. They require significant CPU processing power and actively use input/output operations on the hard disk. These operations decrease computer performance and can degrade the performance of other Kofax applications.

Install WSA on a dedicated computer if your Kofax application generates a significant amount of reporting data. You can also have multiple computers with Kofax applications on the same site send reporting data through a single dedicated WSA Sender.

Or, install the WSA Sender directly on a computer with the Kofax application to increase the reliability and speed of delivery for reporting data to WSA Sender. This configuration also works well for smaller installations.

Multiple instances of WSA Sender on a single computer can be useful, for example, when you have multiple Kofax applications sending reporting data in parallel, each using a dedicated sender instance. If one Kofax application floods the sender with reporting data that takes a while to process, another sender can transfer reporting data from other applications without delay.

WSA Receiver instances

Multiple WSA Receiver instances can increase the amount of reporting data to be processed in parallel. Often, a single sender is linked with a single receiver. If a certain sender-receiver pair is overwhelmed, other WSA pairs can process data without delay.

(16)

Installation

Alternatively, WSA Senders can send reporting data to multiple WSA Receivers grouped in a network load balancing cluster. Refer to Network Load Balancing.

ETL Agent instances

You can install multiple instances of an ETL Agent on a single computer. One instance is considered primary, and the others are secondary. If the primary instance fails, a secondary instance becomes the primary.

Installing the Configuration Tool

Install the Kofax Reporting Configuration tool in the central site.

1 From the Kofax Reporting installation ISO, start setup.exe.

A setup splash screen is displayed.

2 Click Install Configuration tool.

The setup wizard appears.

3 Accept the default settings in the setup wizard 4 On the installation window, click Install.

5 When the configuration tool is installed, click Finish.

If you use an Oracle database, install Oracle Data Access Components (ODAC) on the same computer as the configuration tool. ODAC is available from Oracle website.

Installing WSA

The web service architecture (WSA) is an option for communicating between application sites and the central reporting site. The other option is an Enterprise Service Bus (ESB.)

Install the WSA Receiver at the central site and the WSA Sender at the application site. At the application site, install WSA on a dedicated computer or on the computer with Kofax applications. At the central site, install WSA on a dedicated computer or on the same computer as the ETL Agent.

1 Disable Sophos and any other anti-virus or firewall applications on the system.

Sophos Endpoint Security, Control 10.0, and other anti-virus and firewall applications are known to cause installation problems.

To temporarily disable Sophos:

a Navigate to <Sophos>\Sophos Anti-Virus\Web Intelligence\ where <Sophos> is the

directory where the Sophos anti-virus software is installed.

b Run the following command: swi_lsp32_util.exe -u -d swi_ifslsp.dll 2 From the Kofax Reporting installation ISO, start setup.exe.

3 Install WSA on both the central (server) site and the application (client) site:

▪ To install WSA on the central site, click Install WSA Receiver. Multiple instances of WSA Receiver are supported on one computer. Click an instance to start the setup wizard.

(17)

Installation

▪ To install WSA at the application site, click Install WSA Sender. Multiple instances of WSA Sender are supported on one computer. Click an instance to start the setup wizard.

For tests and demonstrations, you can install both the sender and receiver WSA on the same computer.

4 Specify the destination folder and click Next. 5 To configure the WSA Receiver:

Tip You can keep the default values during installation and configure WSA later. See

Configuring WSA.

a Select the Transport mode: HTTP, MSMQ, IBM WebSphere MQ. b Use the default value for the Local server name.

c Specify the Local port. 6 To configure the WSA Sender:

Tip You can keep the default values during installation and configure WSA later. See

Configuring WSA.

a Select the Transport mode: HTTP, MSMQ, IBM WebSphere MQ. b Specify the Local server name as it is known to the client applications. c Specify the Local port.

d Specify the Central URL (the URL of the WSA Receiver on the central site).

e Specify the Client config. file (path and file name). The WSA Sender saves the URL of

the web service interface to this configuration file. Kofax applications read the file and use it for connecting to the web service interface.

For example, Kofax Capture looks for this configuration file in one of the following folders:

▪ C:\ProgramData\Kofax\Capture\Config\Reporting.Client.Configuration.xml (Windows Vista, 7, 8, Windows Server 2008, 2012)

▪ C:\Documents and Settings\All Users\Application Data\Kofax\Capture\Config \Reporting.Client.Configuration.xml (Windows XP, Windows Server 2003)

7 Click Next and click Install.

8 If a firewall warning appears, click Unblock.

9 Once the Kofax Reporting - WSA installation is finished, click Finish.

10 Restart Sophos or anti-virus applications that you stopped before installing WSA. Note If you install WSA on a computer with a desktop version of the Windows operating

system (for example, Windows 7), use the Windows Power Options to keep the computer from going into sleep mode.

Command Line Installation

You can install WSA using a command line instead of the user interface. ▪ Enter the following command to install WSA with the default values:

(18)

Installation

▪ Enter the following command to install WSA and modify some values:

msiexec.exe /i D:\WSASender\Kofax.Reporting.WSA.Sender.msi INSTALLDIR=”C: \WSA\WSA-Sender” TRANSPORT_MODE=3 /quiet

The following switches and parameters control the installation:

▪ To modify the installation directory, use the parameter INSTALLDIR, such as, INSTALLDIR=%ProgramFiles%/Kofax/Reporting/WSA-Sender

▪ To modify the transport mode, use TRANSPORT_MODE with one of the following values: ▪ 1: HTTP

▪ 2: MSMQ ▪ 3: IBM MQ

▪ To modify the name of the local server, use LOCAL_SERVER_NAME="myserver" ▪ To modify local port of the web service interface, use LOCAL_PORT="25480"

▪ To specify the central queue for MSMQ, use CENTRAL_QUEUE_MSMQ="DIRECT=OS:. \private$\reporting"

▪ To specify the central queue for IBM MQ, use

CENTRAL_QUEUE_IBMMQ="REPORTING.QUEUE.MANAGER:2REPORTING.QUEUE" ▪ To specify the URL of the receiver WSA in the central site, use CENTRAL_URL="http://

localhost:25481"

▪ To suppress the installer user interface, use the "/quiet" switch.

Installing the ETL Agent

Install the Kofax Reporting ETL Agent at the central site.

2 Click Install ETL Agent.

Multiple instances of the ETL Agent can be installed on a single computer.

3 Click the instance to install.

4 Optionally, modify the service name and the destination folder. 5 Click Next and click Install.

6 Once the ETL Agent installation is finished, click Finish.

Running the ETL Agent under a different Windows user requires the following: ▪ The right to “Log on as a service.”

▪ Membership in the “performance log user” group. (This membership is needed if the ETL Agent trace configuration has debugging enabled.)

Installing the ETL Agent as a Windows cluster resource is not supported.

If you use an Oracle database, install Oracle Data Access Components (ODAC) on the same computer as the ETL Agent. ODAC is available from Oracle website.

(19)

Installation

Installing the Kofax License Utility

Install the Kofax License Utility at the central site along with the ETL Agent.

2 Click Install ETL Agent. 3 Click Install License Utility.

4 Optionally, modify the destination folder. 5 Click Next and click Install.

6 Once the Kofax License Utility installation is finished, click Finish.

Kofax Reporting requires a system license. The ETL Agent checks the license.

Installing Database Scripts

Install Kofax Reporting database scripts on any computer. You need the scripts for installing databases in the central site.

Caution If you are upgrading Kofax Reporting, back up your database installation scripts.

The upgrade process overwrites the current scripts and any customizations that the scripts contain. By default, the installation process saves the scripts in the program files folder,

\Kofax\Reporting\Database Scripts.

2 Click Install Scripts for manual database installation.

3 Accept the default settings in the setup wizard. 4 On the installation window, click Install.

5 After the database scripts are installed, click Finish.

This procedure makes the scripts for manual database installation available in the following folder: <programs>\Kofax\Reporting\Database Scripts

▪ alter_kofax_analytics.sql—MS SQL script for data warehouse; for upgrades

▪ alter_kofax_analytics_staging.sql—MS SQL script for staging database; for upgrades ▪ alter_kofax_analytics_oracle.sql—Oracle script for data warehouse; for upgrades

▪ alter_kofax_analytics_staging_oracle.sql—Oracle script for staging database; for upgrades ▪ kofax_analytics.sql—MS SQL script for data warehouse; for new installations

▪ kofax_analytics_staging.sql—MS SQL script for staging database; for new installations ▪ kofax_analytics_oracle.sq—Oracle script for data warehouse; for new installations ▪ kofax_analytics_staging_oracle.sql—Oracle script for staging database; for new

installations

(20)

Installation

Running MS SQL Database Installation Scripts

Before running these scripts, verify that a compatible database server is already installed.

1 Stop the ETL Agent.

2 Log on to the Microsoft SQL Server Management Studio as the database administrator. 3 Create the staging database and data warehouse.

4 Run the following scripts to create database objects:

▪ For the staging database—kofax_analytics_staging.sql ▪ For the data warehouse—kofax_analytics.sql

5 Create a SQL Server user for the ETL Agent. Alternatively, create two users, one for each

database.

6 Assign the following role to the user:

▪ For the staging database—kfx_staging

▪ For the data warehouse—kfx_etl, kfx_reader, kfx_advanced_reader

7 Start the ETL Agent.

Running Oracle Database Installation Scripts

Before running these scripts, verify that a compatible database server is already installed.

1 Stop the ETL Agent.

2 Log on to a database management tool, such as Oracle SQL Developer, as the sys user

(role SYSDBA).

3 Create two users, one for the staging database and one for the data warehouse, such as

StagingUser or DwhUser.

4 Assign a tablespace quota to each user, or grant each user unlimited tablespace privilege. 5 Grant the following privileges to the created users:

GRANT CREATE TYPE, CREATE ANY INDEX, DROP ANY INDEX, CREATE SESSION, CREATE PROCEDURE, CREATE VIEW, ALTER SESSION, CREATE SEQUENCE, CREATE TABLE, CREATE TRIGGER, CREATE ROLE, GRANT ANY OBJECT PRIVILEGE, GRANT ANY PRIVILEGE TO <user_name>;

6 To prompt for a username and password, edit the scripts and uncomment the first

paragraph.

▪ For the staging database—kofax_analytics_oracle_staging.sql ▪ For the data warehouse—kofax_analytics_oracle.sql

7 Run the scripts to create database objects.

For example, the following is a sample sqlplus command:

sqlplus DwhUser/pwd@localhost @kofax_analytics_oracle.sql

8 Revoke the system privileges granted in step 4 for both users:

REVOKE CREATE TYPE, CREATE ANY INDEX, DROP ANY INDEX, CREATE SESSION, CREATE PROCEDURE, CREATE VIEW, ALTER SESSION, CREATE SEQUENCE, CREATE TABLE, CREATE TRIGGER, CREATE ROLE, GRANT ANY OBJECT PRIVILEGE, GRANT

(21)

Installation

9 Assign the following database roles to the user:

▪ For the staging database—kfx_staging

▪ For the data warehouse—kfx_etl, kfx_reader, kfx_advanced_reader

10 Start the ETL Agent.

Installing the Integration SDK

The Kofax Reporting integration software development kit includes the following: ▪ Documentation for Kofax Reporting views and tables.

▪ Documentation and sample code for integration with Sonic ESB 8.0.

2 Click Install SDK.

3 Accept the defaults in the setup wizard. 4 On the installation window, click Install.

5 After the integration SDK installation is finished, click Finish.

The SDK includes:

▪ KofaxReportingTables.docx—database table description ▪ KofaxReportingViews.docx—database view description

▪ IntegrationWithSonicESB_8.docx—description of a sample integration with Sonic ESB 8 ▪ ESB8_Scripts.zip—sample code for ESB integration

Network Load Balancing

Network load balancing (NLB) is the ability to distribute the workload to multiple computers. In Kofax Reporting, WSA Receivers can run in a load-balancing scenario.

NLB by itself only provides failover when an NLB node in the cluster is completely shut down; NLB directs all TCP-based traffic to the remaining working NLB nodes. NLB does not provide a failover solution when a node is running but the TCP-based services on the node (such as, web service listeners) have problems, or if the service is stopped.

Therefore, WSA includes a feature called NLB Port Control that monitors the health of the processes. If a problem occurs, the port control makes the node unavailable.

NLB divides the workload between two or more computers, which run in parallel.

(22)

Installation

Configuration hints:

▪ In the WSA Sender, configure the NLB IP address and port in the Central URL field. See

Configuring WSA.

▪ If you are using a remote configuration of WSA Receiver from the Kofax Reporting Configuration tool, do not use the NLB port. Configure each WSA Receiver node individually. See Configuring WSA Remotely.

Installing Windows NLB on Windows Server 2008/2012

Install Windows NLB on each WSA Receiver node as an operating system feature.

1 Start the Server Manager. 2 Select Features.

3 Click Add Features.

4 Select Network Load Balancing. 5 Click Next and click Install.

6 Configure a fixed IP address on the node.

Installing Windows NLB on Windows Server 2003

Install Windows NLB on each WSA Receiver node as an additional service in the Local Area Network Properties.

1 Open the Windows Control Panel and navigate to Network Connections. 2 Right-click Local Area Network and select Properties.

3 Click Install.

4 Select Service and click Add.

5 Select Network Load Balancing and click OK. 6 Activate Network Load Balancing and click Close.

(23)

Installation

Creating a New Cluster

1 Run nlbmgr (Windows Network Load Balancing Manager.)

2 Right-click Network Load Balancing Cluster and select New Cluster. 3 Enter the IP address of a cluster host and click Connect.

4 Select an interface and click Next.

5 We recommend that you change the Default state to Suspended, select Retain suspended state after computer restarts.

The Message Connector updates the state after startup.

6 Click Next.

7 Click Add, enter the cluster IP address, click OK, and click Next. 8 In the Full Internet name field, enter the name of the cluster computer. 9 Unless you have 2 or more network adapters on each node, select Multicast. 10 Click Next.

11 To add port rules for web service input (default 25500 for receiver instance 1), click Add. 12 Select Multiple host as a Filtering mode and set Affinity to None.

13 Click Finish.

Adding Cluster Nodes

1 To manage an NLB cluster, run nlbmgr (Windows Network Load Balancing Manager.) 2 Right-click the cluster and select Add Host.

3 Specify the IP address of the node and click Connect. 4 Select an interface and click Next.

5 Click Next again, then click Finish.

About NLB Unavailability

The NLB port control is not available for a short time (usually 1 to 8 seconds) during which failover is not provided and the web service connection to the common NLB IP address fails. The following situations cause this to occur:

▪ The WSA node stops abruptly. In this case, the NLB, not the port control, handles the situation. The NLB requires about 5 seconds to detect a failed node and from 2 to 3 seconds to remove the failed node and redistribute the load to live nodes.

▪ A node starts. Some seconds elapse between when the NLB service starts (with enabled ports - depends on cluster host configuration) and when the WSA with port control starts. Eliminate most of this delay by properly configuring the cluster. See Creating a New Cluster, step 5.

▪ A WSA process failure occurs. Up to 3 seconds elapse before the WSA port control detects the failure and disables the ports for NLB.

If the web service client supports retries, the second attempt is usually outside of the time window and the connection request is directed to a working node.

(24)

Installation

Upgrading from Kofax Reporting 1.0.0

Caution Before upgrading your version of Kofax Reporting, back up your database

installation scripts. The upgrade process overwrites the current scripts and any

customizations that the scripts contain. By default, the installation process saves the scripts in the program files folder, \Kofax\Reporting\Database Scripts.

1 Install the new database scripts (see Installing Database Scripts).

2 Stop all reporting services on the server site (ETL Agent, WSA Receiver). 3 Update the staging database:

a Use a standard database management tool to log on to the staging database as a user

with full access.

b Run the script for your site, such as alter_kofax_analytics_staging.sql (MS SQL) or

alter_kofax_analytics_staging_oracle.sql (Oracle).

When the script finishes without error, the staging database contains the new structure.

4 Update the data warehouse:

a Use a standard database management tool to log on to the data warehouse as a user

with full access.

b Run the script for your site, such as alter_kofax_analytics.sql (MS SQL) or

alter_kofax_analytics_oracle.sql (Oracle).

When the script finishes without error, the data warehouse contains the new structure.

5 Install the updated server components.

Note The first version of Kofax Reporting let you specify a custom Windows service

name from some Kofax Reporting components (WSA Sender, WSA Receiver, ETL Agent). Upgrading resets the service name to the default value.

a Configuration tool: see Installing the Configuration Tool.

b ETL Agent: see Installing the ETL Agent.

c License utility: see Installing the Kofax License Utility.

d WSA Receiver: see Installing WSA. Installing the components starts the services.

6 Optionally, update WSA Sender instances on Kofax application sites. a Stop the WSA Sender service.

b Update Kofax applications, if necessary.

c Update the WSA Sender (refer to Installing WSA). Installing WSA starts the service.

(25)

Chapter 4 Configuration

This section describes how to configure Kofax Reporting. The subsequent sections describe this process in more detail.

1 In the central site, configure the ETL Agent and connect to the databases. See Configuring the Central Site.

2 On the application site, enable reporting within the application (if necessary) and

configure the path to the transport entry point (WSA Sender/ESB). See Configuring Kofax Applications.

3 Configure the transport mechanism:

▪ Message Queuing (MQ):

▪ Microsoft Message Queuing (MSMQ)—see Configuring Microsoft Message Queuing

▪ IBM Message Queuing—see Configuring IBM WebSphere Message Queuing

▪ HTTP transport—see Configuring WSA.

▪ Enterprise service bus (ESB)—see Configuring Enterprise Service Bus

Configuring the Central Site

Use the Kofax Reporting Configuration tool to configure the ETL Agent and connect to the databases. Set up the databases before you configure the central site; see Installing Database Scripts.

1 Start Configuration from the Kofax Reporting group in the Windows Start menu. 2 Either open an existing configuration, or create a new one.

To create a new configuration:

a Click New on the Home tab.

b Type a descriptive name for the new configuration.

c Enter the Location. If the ETL Agent is already installed on the same computer, the

Location field is automatically populated. By default, this is:

▪ C:\Documents and Settings\All Users\Application Data\Kofax\Reporting \KofaxReportingETLAgent\Config (Windows Server 2003)

▪ C:\ProgramData\Kofax\Reporting\KofaxReportingETLAgent\Config

(Windows Server 2008/2012)

If the ETL Agent is not already installed on the central site, enter the path where the configuration should be stored, or browse to the location.

Note To make a configuration active, it must be in the designated folder.

To open an existing configuration:

a Click Open on the Home tab.

(26)

Configuration

3 Click Staging database in the Kofax Reporting pane to display the database settings. 4 In the Server Type field, select either Oracle or MS SQL Server.

For MS SQL Server:

a Click Load SQL Servers on the Database tab to search for all Microsoft SQL Server

instances on the network. Skip this step to type the connection information manually.

b In the Server field, select an instance, or type the instance name (servername

\instancename).

c In the Port field, type the port for connecting to the database.

d Select Use SQL Server User to access the database with a specific account. If you do

not specify an account, the user under which the ETL Agent service is running is used to connect to the database.

e Click Get List of Databases. Either select a database from the Database Name field or

type the database name directly.

f Click Test Connection to verify that the ETL Agent can connect to the database.

For Oracle:

a In the Server field, type the name of the server where the database is running. b In the Port field, type the port for connecting to the database.

c In the Connection Type field, select either of the following:

▪ Basic— Connect through the Oracle Call Interface ▪ TNS— Use an alias entry from a tnsnames.ora file

d Enter the User Name and Password credentials to connect to the database. e In the Service Name field, type the global database name in the format

database_name.database_domain.

f In the Target Schema field, type the schema.

g Click Test Connection to verify that the ETL Agent can connect to the database 5 Click Warehouse database in the Kofax Reporting pane. Either click Copy Configuration

to copy the settings from the Staging database pane and skip to step 7, or follow step 6 to configure the warehouse database manually.

6 To configure the warehouse database manually. in the Server Type field, select either Oracle or MS SQL Server.

For MS SQL Server:

a Click Load SQL Servers on the Database tab to search for all Microsoft SQL Server

instances on the network. Skip this step to type the connection information manually.

b In the Server field, select an instance, or type the instance name (servername

\instancename).

c In the Port field, type the port for connecting to the database.

d Select Use SQL Server User to access the database with a specific account. If you do

not specify an account, the user under which the ETL Agent service is running is used to connect to the database.

(27)

Configuration

f Click Test Connection to verify that the ETL Agent can connect to the database.

For Oracle:

a In the Server field, type the name of the server where the database is running. b In the Port field, type the port for connecting to the database.

c In the Connection Type field, select either of the following:

▪ Basic— Connect through the Oracle Call Interface ▪ TNS— Use an alias entry from a tnsnames.ora file

d Enter the User Name and Password credentials to connect to the database. e In the Service Name field, type the global database name in the format

database_name.database_domain.

f In the Target Schema field, type the schema.

g Click Test Connection to verify that ETL Agent can connect to the database

7 Click ETL Settings in the Kofax Reporting pane to display the ETL Agent configuration

settings.

a Use the Run daily from and To fields, to restrict the time when the ETL Agent

analyzes data from the staging database, transforms it, and stores it to the data warehouse.

b In the Wait time between jobs (minutes) field, specify how long the ETL Agent should

wait before starting another round of data transfer from the staging database to the warehouse database. The default value is 60 minutes.

c In the Purge interval for field detail data (days) field, specify how many days the ETL

Agent should wait before deleting field detail data (table field_accum_fact) from the data warehouse. The default is 5 days.

d In the URL field, type the URL for the WSA Receiver or ESB in the central site. The

ETL Agent polls these sites for reporting data. You can add multiple entries. When using Windows NLB, do not use the URL of the NLB cluster; add the URLs of all computers in the cluster.

8 Click Workstations in the Kofax Reporting pane to display the list of client computers

that have sent information to this ETL Agent.

9 Click Save on the Home tab to save the configuration.

Configuring Advanced Settings of ETL Agent

The ETL Agent has an internal configuration file that generally does not need modification. Use these advanced parameters to customize performance and for troubleshooting.

The configuration file is located in the ETL Agent program files directory, by default:

%Program Files%\Kofax\Reporting\ETLAgent\Kofax.Reporting.ETLAgent.exe.config

(28)

Configuration

Parameter Description

PurgeFieldDataBatchSize Deleting large data from indexed tables can be expensive, therefore the ETL Agent deletes data in batches of a given size. This parameter determines how many rows are deleted in a single transaction when purging old field data. The ETL Agent continues to delete data in batches until all data is deleted. The default value should be appropriate for most databases.

Default = 10000

DatabaseCmdTimeoutSec This parameter controls the number seconds a SQL command can take before timing out. The default value should be appropriate for most databases.

Default = 600

MQ2StagingServiceEnabled Set this parameter to False to disable saving WSA data in the staging database. Use this parameter for debugging. Default = True

ETLServiceEnabled Set this parameter to False to disable processing data from the staging database into the warehouse. Use this parameter for debugging.

Default = True

ETLBatchSize This parameter controls the number of messages that are

processed at one time when processing data from the staging database to the warehouse. The default value should be appropriate for most databases, however, for very large batches (for example, if an average batch contains 100 documents and each document contains 100 pages), you may need to decrease this value.

Default = 10000

WSABatchSize This parameter controls the number of messages that

are processed at one time when processing data from the WSA database to the staging database. The default value should be appropriate for most databases, however, for very large batches (for example, if an average batch contains 100 documents and each document contains 100 pages), you may need to decrease this value.

Default = 10000

DeleteStagingDataBatchSize Deleting large data from indexed tables can be expensive, therefore the ETL Agent deletes data in batches of a given size. This parameter determines how many rows are deleted in a single transaction when purging processed staging data. The ETL Agent continues to delete data in batches until all data is deleted. The default value should be appropriate for most databases.

(29)

Configuration

Parameter Description

MaxMQ2StagingIterationsNum This parameter determines how many times the WSA to staging database process runs, until the system checks if it is time to run an ETL job.

Default = 10

DeleteStagingDataOlderThanDays This parameter determines how many days the staging data stays in the database before it is deleted. By default the data is deleted immediately after being processed. Use this parameter for debugging.

Default = -1

DropIndexesOnMq2Staging Do not change the default setting.

When this parameter is set to True, the ETL Agent drops indexes in the staging database when loading data into the staging database and then recreates the indexes to extract data before an ETL job.

Default = True

1 Edit the Kofax.Reporting.ETLAgent.exe.config file with a text editor. 2 Save the changes and close the file.

3 Restart the ETL Agent service to make the changes effective.

Configuring Kofax Applications

Enable support for Kofax Reporting in your Kofax applications (for example, Kofax Capture).

1 Install a compatible version of the Kofax application. See the Kofax Reporting Release Notes

for updated information about supported versions.

2 Enable reporting in the Kofax application if necessary. See the documentation for your

specific product for instructions.

3 Specify the URL for the transport entry point (WSA Sender or ESB). Kofax

applications must know the URL for the transport entry point to start sending reporting data. Kofax applications read the URL from a special configuration file, Reporting.Client.Configuration.xml. Use one of the following:

▪ WSA Sender writes its URL to the configuration file during installation (refer to

Installing WSA).

▪ WSA Sender writes its URL to the configuration file during configuration (refer to

Configuring WSA Advanced Settings, Advanced tab).

▪ Edit the configuration file with a text editor and type the URL.

▪ Start Kofax.Reporting.Configuration.Client.exe and type the URL. (For example,

<Kofax>\CaptureSS\Servlib\Bin\Kofax.Reporting.Configuration.Client.exe,

although the path may vary depending on the application.)

This general procedure might not apply for all Kofax applications. See the documentation for your specific Kofax application. Also, see Kofax Product Support for Kofax Reporting, available on the Kofax Support web.

(30)

Configuration

Configuring Microsoft Message Queuing

1 On the central site, create a new queue. Kofax Reporting supports transactional queues.

Authentication and privacy level are not supported.

2 On the central site, install the Message Queuing Server and WSA Receiver. The WSA

Receiver on the central site only reads from a local transactional MSMQ queue.

3 On the application site, install the Message Queuing Server and WSA Sender. The WSA

Sender on the application site sends messages to a remote transactional queue located on the central site.

4 Configure the WSA Sender and the WSA Receiver. See Configuring WSA for detailed instructions.

a In the General Settings tab, set Transport to MSMQ; configure the MQ User and

Password, and set the Central Queue to the queue created in step 1. For example: ▪ DIRECT=OS:.\private$\PrivateQueueName ▪ DIRECT=OS:Computer_Name\PublicQueueName ▪ DIRECT=OS:Computer_Name\private$\PrivateQueueName ▪ DIRECT=TCP:IP_Address\PublicQueueName ▪ DIRECT=TCP:IP_Address\private$\PrivateQueueName ▪ DIRECT=HTTP://URL_Address/msmq/PublicQueueName ▪ DIRECT=HTTPS://URL_Address/msmq/private$/PrivateQueueName ▪ DIRECT=HTTPS://URL_Address/msmq/PublicQueueName ▪ DIRECT=HTTPS://URL_Address/msmq/private$/PrivateQueueName

b In the MQ tab of the WSA Sender, you can enable support for the dead letter queue

(DEADXACT).

To use HTTP/HTTPS, install and configure Internet Information Services (IIS) on the WSA Receiver. See the MSMQ documentation. The HTTP/HTTPS protocol is only supported for sending messages to MSMQ, that is, on the application site. It is not supported for receiving messages from MSMQ on the central site.

Messages sent from the WSA Sender to a remote transactional queue are first stored in a local outgoing queue (created automatically). MSMQ automatically transfers the messages to the destination remote queue.

Messages that cannot be delivered to the destination queue are automatically moved by MSMQ to the local MSMQ system transactional dead letter queue (DEADXACT) on the WSA Sender and the property CLASS contains the reason for the failure (for example, remote queue does not exist, remote server not reachable and so forth). The WSA Sender service has a built-in mechanism that checks periodically in the background for the DEADXACT queue and a retry mechanism that takes the messages from the DEADXACT queue and requeues them into the outgoing queue.

Configuring IBM WebSphere Message Queuing

Kofax recommends that you use a dedicated Queue Manager for Kofax Reporting. It is possible reuse an existing Queue Manager, however, if the WSA is configured for "Check

(31)

Configuration

Dead Letter Queue", the Queue Manager will take all the messages from the dead letter queue, including messages that may not belong to Kofax Reporting.

1 Configure the central site. See Configuring the Central Site for IBM WebSphere Message Queuing.

2 Do one of the following:

▪ If you install MQ Server on the application site, proceed with Configuring the Application Site (with MQ Server).

▪ If you install MQ Client on the application site, proceed with Configuring the Application Site (with MQ Client).

Configuring the Central Site for IBM WebSphere Message Queuing

1 On the central site, install MQ Server and the WSA Receiver. 2 Configure the the MQ Server:

a Create a queue manager, for example REPORTING.QUEUE.MANAGER. Enable the

Create server-connection channel. Create a listener configured for TCP/IP. Specify the names of the local queue and local dead letter queue (you create these queues in steps b and c).

b Create a local queue, for example 2REPORTING.QUEUE. Set Default persistence to Persistent.

c To have WSA check the dead letter queue, create a local dead letter

queue, for example REPORTINGDEADLETTER.QUEUE using the

SYSTEM.DEAD.LETTER.QUEUE template. Set the Default persistence to Persistent.

d Create a receiver channel, for example SEND_REC_CHANNEL. 3 Configure the WSA Receiver:

a In the General Settings tab, set Transport to IBM WebSphere MQ.

Configure the MQ User and Password and set Central Queue to

REPORTING.QUEUE.MANAGER:2REPORTING.QUEUE.

b Optionally configure WSA to check the dead letter queue. See Configuring WSA for detailed instructions.

Configuring the Application Site (with MQ Server)

1 On the application site, install MQ Server and the WSA Sender. 2 Configure the MQ Server:

a Create a queue manager, for example, REPORTING.CLIENT.QUEUE.MANAGER

with local and dead letter queues.

b To manage the server on the application site from the central site, add a remote queue

manager, for example REPORTING.CLIENT.QUEUE.MANAGER and connect the remote queue manager to MQ Server in the central site.

c Create a local transmission queue, for example

REPORTING.TRANSMISSION.QUEUE. Set Default persistence to Persistent and set Usage to Transmission.

d Use the SYSTEM.DEFAULT.REMOTE.QUEUE template to create a remote queue

(32)

Configuration

to Persistent. Set the remote queue as the local queue of the central MQ Server. Set the queue manager to the reporting queue manager of the central MQ Server. Set the transmission queue to the previously created transmission queue.

e Create a sender channel, for example SEND_REC_CHANNEL. Use the same name

as the receiver channel on the central site. Set the connection name to the name/IP address of the central MQ Server. Set the transmission queue to the previously created transmission queue.

3 Configure the WSA Sender:

Configure the MQ User and Password and set Central Queue to

REPORTING.CLIENT.QUEUE.MANAGER:REPORTING.REMOTE.QUEUE. b Optionally configure WSA to check the dead letter queue. If you use the dead letter

queue, make sure there is a dead letter queue defined for the queue manager on the application site. See Configuring WSA for detailed instructions.

Configuring the Application Site (with MQ Client)

1 On the application site, install MQ Client and the WSA Sender. 2 Configure the MQ Server on the central site:

a Create a client-connection channel, for example REPORTING.CONN.CH. Set the

queue manager to the reporting queue manager for the central MQ Server. Set the connection name to the name of the MQ Server computer.

b Create a server-connection channel. Use the same name as the client-connection

channel. On the MCA tab, specify the ID of the remote user that uses MQ Client to send data.

c Copy the file C:\Program Files\IBM\WebSphere MQ\Qmgrs\REPORTING! QUEUE!MANAGER\@ipcc\AMQCLCHL.TAB from the MQ Server computer to

the MQ Client computer, C:\Program Files\IBM\WebSphere MQ (assuming default installation paths).

3 Configure the WSA Sender:

Configure the MQ User and Password, and set Central Queue to

REPORTING.QUEUE.MANAGER:2REPORTING.QUEUE.

b Optionally configure WSA to check the dead letter queue. If you use a dead letter

queue, make sure there is a dead letter queue defined for the queue manager on the application site. See Configuring WSA for detailed instructions.

Configuring the MQ Cluster

MQ Server on the central site can be configured to run in a cluster. These sample steps are for a cluster of three queue managers on two computers:

▪ The first computer has one queue manager. This queue distributes the load to the two queue managers on the second computer.

▪ The second computer has two queue managers. Each queue manager has its instance of WSA Receiver.

(33)

Configuration

2 On the second computer, create two queue managers, each with two local queues. 3 Optionally, add all queue managers to a single MQ Explorer.

4 Create a queue manager cluster (for example REPORTINGCLUSTER). Add all queue

managers to the cluster.

5 On queue managers 2 and 3, create a cluster queue (for example

REPORTING.CLUSTER.QUEUE) and configure it to be shared in cluster REPORTINGCLUSTER. Set the default bind type to Not fixed.

6 On queue manager 1, create a client-connection channel and a server-connection channel

with the same name.

7 Copy the file C:\Program Files\IBM\WebSphere MQ\Qmgrs\REPORTING!CL1!

QUEUE!MANAGER\@ipcc\AMQCLCHL.TAB from the first computer to the MQ Client computer, C:\Program Files\IBM\WebSphere MQ (assuming default installation paths).

8 On the MQ Client computer on the application site, edit the

WSA Sender configuration file and set the Central Queue to

REPORTING.CL1.QUEUE.MANAGER:REPORTING.CLUSTER.QUEUE. 9 On the second clustered computer, edit the WSA

Receiver configuration and set the Central Queue to

REPORTING.CL2.QUEUE.MANAGER:REPORTING.CLUSTER.QUEUE for the first

instance and REPORTING.CL3.QUEUE.MANAGER:REPORTING.CLUSTER.QUEUE for the second instance.

Configuring WSA

Follow the steps in this section to configure either the WSA Receiver or the WSA Sender.

1 On the Start menu, navigate to the Kofax Reporting group and start either WSA Receiver

Configuration or WSA Sender Configuration.

2 Do one of the following:

▪ For HTTP transport, follow the steps in Configuring WSA for HTTP Transport.

▪ For message queue transport, follow the steps in Configuring WSA for Message Queue Transport.

Configuring WSA for HTTP Transport

1 Click the General Settings tab.

2 In the Transport field, select HTTP. The settings for the sender and receiver must match. 3 For the WSA Senders, in the Central URL field, specify the URL of the WSA Receiver in

the central site.

To run WSA Receivers with NLB, use the NLB IP address and port.

Note Do not enter the URL of the WSA Sender in this field.

4 Continue with the advanced parameters of WSA. See Configuring WSA Advanced Settings.

(34)

Configuration

Configuring WSA for Message Queue Transport

1 On the Configuration page, click Advanced. 2 Click the General Settings tab.

a In the Transport field, select MSMQ or IBM WebSphere MQ. The settings for the

WSA Sender and the WSA Receiver must match.

b In the MQ User field, enter the domain and user ID in the format Domain\UserId, or

enter the SID for queue access. This Windows user must have the user right "logon as service".

c In the MQ Password field, enter the password for the user. d In the Central Queue field, specify the queue. For example:

▪ IBM MQSeries: REPORTING.CLIENT.QUEUE.MANAGER:REPORTING.REMOTE.QUEUE

▪ MSMQ: DIRECT=TCP:10.20.30.40\MyQueue

3 Configure the deal letter queue to monitor messages that could not be delivered. Click

the MQ tab.

a Select Check Dead Letter Queue.

b In the Dead Letter Queue Check Interval field, specify in seconds how often the dead

letter queue should be examined.

c In the Dead Letter Queue Retries field, specify how many retries should be made for

messages in the dead letter queue.

d Select RejectMsgOnMqError to reject message when the message queue cannot be

written. If not rejected, messages are stored in the outbound status active queue. Administrators can reactivate or delete the messages. See Managing Failed Messages Manually.

4 Continue with the advanced parameters of WSA. See Configuring WSA Advanced Settings.

Configuring WSA Advanced Settings

Configure the WSA advanced settings for: ▪ Troubleshooting or configuring traces ▪ Secure communication using SSL ▪ Reactivation of failed messages ▪ WSA password protection ▪ NLB for WSA Receivers ▪ WSA storage management ▪ Performance tuning

If you do not use any of these options, skip to step 10.

1 On the Configuration page, click Advanced. 2 Click the General Settings tab.

(35)

Configuration

c The Instance Name field displays name of the WSA instance.

d For WSA Senders, in the Senders (up to 10) field, enter the number of parallel

processes responsible for sending data to the WSA Receiver. Using a higher value increases performance, but requires more system resources.

3 Click the HTTP Settings tab.

a In the Local Port field, specify the port of the local web server. The default is 25480 for

application sites and 25481 for central sites. Modify the port number if necessary to resolve port conflicts.

b In the Local IP Address field, optionally specify the IP address of the local web portal

interface. The web portal offers monitoring functions for troubleshooting.

c For WSA Senders, in the Local server name field, specify the name of the local server,

as it is known to the client applications, for example, the name by which client computers know the server.

d In the Listener Threads field, enter the maximum number of concurrent web service/

HTTP connections for this WSA instance.

e For WSA Senders, in the Proxy server field, enter the name or IP address of the central

proxy server.

f In the Proxy port field, enter the port of the proxy server. g Optionally, select SSL Active to enable secure communication.

4 If you enabled SSL, click the SSL Certificate tab and enter the configuration values. 5 To configure logging, click the Trace tab. For more information about log files, see

Managing Logs in WSA.

a In the Trace Level field, enter the trace level (0..100). Using a higher value provides

more information, but may impact performance.

b In the Message Trace Size field, enter the message-size limit to trace traffic between

components: ▪ 0 = off

▪ 1 = single line per message ▪ More than 1 = size limit in bytes

c In the Size of Trace File field, enter the maximum size of trace files in KB.

d In the Number of Trace Files field, enter the maximum number of generated trace

files. When all files are full, the system overwrites the oldest file.

e Select Append Trace to append new trace data to the existing trace file when the

application restarts.

6 Click the Store tab.

a In the Object Fill Target field, specify the target percentage for object fill storage

cleanup.

b In the Disk Fill Target field, specify the target percentage for the disk fill for storage

cleanup.

c For WSA Receivers, in the OutboxReactivate field, specify the number of minutes

(36)

Configuration

Receiver storage are reactivated so that the ETL Agent can reattempt to retrieve the messages.

Note Set this parameter to 0 to disable automatic reactivation. Operators can still

manually activate failed messages. See Managing Failed Messages Manually for more information.

7 Click the Security options tab.

a To restrict access to WSA monitor and remote configuration, in the Users field, select admin. Otherwise, select no password protection and continue at step c.

b In the Admin password field, type the password for the admin user.

c To completely disable remote configuration, select DisableRemoteConfig. WSA can

now only be configured locally.

8 Click the Load Balancing Settings tab.

a In the Load Balancer Support field, the load balancer. NLB is only available for WSA

Receivers.

▪ To disable NLB Port Control, select None. This does not disable NLB if you have configured it.

▪ To enable port control, select Win-NLB and Ext-LB. ▪ For Windows NLB, select Windows NLB.

▪ For external load balancers, select External LB.

b In the Load Balancer Port field, type the port that web service clients can use to access

load-balanced WSA Receivers.

c In the Load Balancing IP Address field, type the IP address of the local interface used

for web service access. If you have multiple network cards on your computer, you can dedicate one for web service access.

9 Click the Advanced tab.

a In the Client Config File field, specify the path and file name where WSA Sender

should save its connection information. This file is used by Kofax applications for connecting to Kofax Reporting. Only available for WSA Sender. E.g., Kofax Capture might use the following path and name:

▪ C:\ProgramData\Kofax\Capture\Config\Reporting.Client.Configuration.xml (Windows Vista, 7, 8, Windows Server 2008, 2012)

▪ C:\Documents and Settings\All Users\Application Data\Kofax\Capture\Config \Reporting.Client.Configuration.xml (Windows XP, Windows Server 2003)

10 Click Save to save the configuration data to disk. 11 Click Exit and restart service.

Configuring Enterprise Service Bus

Enterprise service bus (ESB) is one of the possible transport options for reporting data between application site and central reporting site. Refer to Transport Through a Third-Party ESB.

(37)

Configuration

integration document can be found here: <programs>\Kofax\Reporting\Integration SDK \IntegrationWithSonicESB_8.docx.

The following high-level procedure lists the main steps to perform when integrating with an ESB.

1 Prepare the Kofax Reporting WSDL file. The WSA.wsdl is part of the

Integration SDK, in the zip file ESB8_Scripts.zip. Edit the line <soap:address

location="http://172.20.148.146:9123/sonic/reporting" /> with a text editor. Type the URL that should be serviced by your ESB project.

2 Create a new ESB project and import the Kofax Reporting WSDL into ESB integration

tool.

3 Implement the Kofax Reporting web services interface on the ESB.

On the application site, the following web services must be implemented:

▪ BulkSend2 - Kofax Reporting API invokes this service to feed reporting information into ESB

▪ Ping - verifies connectivity

On the central site, the following web services must be implemented:

▪ ReceiveMessages2 - The ETL Agent invokes this service to retrieve a number of messages which are written to the staging database

▪ ConfirmMessages2 - The ETL Agent invokes this service after processing the data retrieved with ReceiveMessages2

▪ Ping - verifies connectivity

4 Configure the Kofax applications, e.g. Kofax Capture, to send their reporting data to the

URL set in step 1.

5 Configure the ETL Agent to retrieve the reporting data from the URL of the ESB in the

central site (parameter URL in the ETL Settings tab). Refer to Configuring the Central Site.

Configuring WSA Remotely

You can use Kofax Reporting - Configuration tool for remote configuration of WSA. Only a subset of parameters can be configured remotely. To access all parameters, follow the steps in

Configuring WSA.

1 Start Configuration from the Kofax Reporting group in the Windows Start menu. 2 Click Configure WSA Server in the Kofax Reporting pane.

3 In the URL field, type the URL of a WSA instance, for example http://localhost:25480.

Click Connect. If you are using NLB, specify the port of the WSA instance, not the NLB port.

4 If WSA password protection is enabled, log on using the user name admin and a

password.

5 Edit the settings as necessary. Click Advanced to display additional parameters. See the

online help for more information about the parameters.

(38)

(39)

Chapter 5 Operation and Maintenance

This chapter provides information about Kofax Reporting daily operations, including: ▪ Monitoring WSA Status

▪ Managing Failed Messages Manually

▪ Deleting old data from databases (staging databases, or warehouse databases) ▪ Managing MS SQL Databases

▪ Managing Oracle Databases

▪ Managing Log Files

Monitoring WSA Status

WSA provides a monitoring interface with the following main functions: ▪ Monitoring WSA status (for troubleshooting)

▪ Configuring WSA

▪ Viewing messages in the WSA Storage

▪ Managing Failed Messages Manually

1 On the Start menu, navigate to the Kofax Reporting group and start WSA Monitor. 2 If you enabled WSA password protection in the Configuring WSA Advanced Settings

section (Security options tab), log on as admin.

3 On the menu, click Status to display the status of WSA and its internal components and

connections for troubleshooting.

WSA Storage

Each WSA has an internal storage where it temporarily stores reporting data. The storage can be accessed using WSA Monitor.

WSA Sender storage folders:

▪ The Inbound Status > Active folder shows messages received from Kofax applications before they are delivered to the WSA Receiver. Messages from the MSMQ dead letter queue are also stored here.

▪ The Inbound Status > Processed folder shows messages delivered to WSA Receiver. Undeliverable messages are stored here if an administrator deletes them from the Inbound Status > Active folder.

Kofax Reporting. Administrator's Guide

Kofax Reporting

2.0.0

Contents

Preface

Introduction

Related Documentation

Chapter 1

Overview

Architecture

HTTP Transport

Message Queue Transport

Transport Through a Third-Party ESB

Central Site

Components

Chapter 2

System Requirements

Hardware Requirements

Supported Operating Systems

Supported Virtualization Servers

Supported Software

Supported Database Management Systems

Chapter 3

Installation

Performance Considerations

Installing the Configuration Tool

Installing WSA

Command Line Installation

Installing the ETL Agent

Installing the Kofax License Utility

Installing Database Scripts

Running MS SQL Database Installation Scripts

Running Oracle Database Installation Scripts

Installing the Integration SDK

Network Load Balancing

Installing Windows NLB on Windows Server 2008/2012

Installing Windows NLB on Windows Server 2003

Creating a New Cluster

Adding Cluster Nodes

About NLB Unavailability

Upgrading from Kofax Reporting 1.0.0

Chapter 4

Configuration

Configuring the Central Site

Configuring Advanced Settings of ETL Agent

Configuring Kofax Applications

Configuring Microsoft Message Queuing

Configuring IBM WebSphere Message Queuing

Configuring the Central Site for IBM WebSphere Message Queuing

Configuring the Application Site (with MQ Server)

Configuring the Application Site (with MQ Client)

Configuring the MQ Cluster

Configuring WSA

Configuring WSA for HTTP Transport

Configuring WSA for Message Queue Transport

Configuring WSA Advanced Settings

Configuring Enterprise Service Bus

Configuring WSA Remotely

Chapter 5

Operation and Maintenance

Monitoring WSA Status

WSA Storage