Log File Management Tool

Deployment and User's Guide

Genesys Care/Support current

4/27/2021
Table of Contents
Log File Management Tool Deployment and User's Guide 8.5.104 4
Overview 5
Architecture 8
New in this Release 11
Downloading LFMT 13
Known Issues and Limitations 14
Migration to LFMT 8.5.104 15
Log File Management Tool Deployment Planning 17
LFMT Client - GAX Dependencies 18
LFMT Database Sizing 19
LFMT Storage and Resource Sizing 21
Log File Management Tool General Deployment 24
Prerequisites 25
Deployment of the LFMT Client 27
Deployment of the LFMT Indexer 29
Deployment of the LFMT Collector 32
Configuration of the LFMT Database 36
Initializing the DBMS 40
Deployment of Workbench Agent for LFMT 8.5.1 44
Installing Workbench Agent (Mass Deployment) for LFMT 8.5.1 49
Log File Management Tool Configuration Options 59
LFMT Host Object Configuration Options 60
LFMT GAX Configuration Options 61
LFMT Indexer Configuration Options 63
LFMT Collector Configuration Options 66
LFMT DAP Object Configuration Options 71
Workbench Agent Configuration Options (for LFMT 8.5.1) 72
Workbench Agent Host Object Configuration Options (for LFMT 8.5.102) 76
Log File Management Tool User's Guide 77
Configuration of Access Control for LFMT Users 78
Site Configuration 81
Collection Schedules 83
Force Collection 88
Indexing and Scrubbing 90
 Log File Packaging 94
Available Packages 98
LFMT Audit Information 101
Additional Information 104
Configuration of TLS Connections 105
Best Practices 109
Regular Expressions 110
Release Notes 112
Log File Management Tool Deployment and User's Guide 8.5.104

Log File Management Tool Deployment and

User's Guide 8.5.104
The Log File Management Tool (LFMT) is an intelligent, configurable log collection utility developed by Genesys
Customer Care.

Log File Management Tool Deployment and User's Guide 4

Overview

Overview
Log files are an integral part of Genesys software. They are the main sources of information when troubleshooting
application issues. The faster that relevant, accurate, and consistent log files are provided, the sooner an issue can
be resolved. Unfortunately, many problems can occur when trying to retrieve the log files necessary for
troubleshooting. Common problems include:

• The log files for the time when the problem occurred have been overwritten or otherwise lost.

• Log files delivered are not within the event time frame.

• Log files provided were created with log levels not detailed enough for the investigation.

• The set of log files provided is inaccurate or incomplete.

The Log File Management Tool utility is intended to minimize these issues, and thereby reduce the time required to
resolve customer problems.

Data Privacy

Important
The Genesys Customer Care LFMT product currently does not support access or erasure
requests for data that is stored for an extended period. In order to meet EU GDPR (European
Union General Data Protection Regulation) compliance, customers/partners should ensure that
the ‘LFMT Indexer’ application “retention_period” option is set to 30 days or less (if adherence to
EU GDPR is required).

LFMT Components
The LFMT has four main components: LFMT Client, LFMT Collector, LFMT Indexer and Workbench Agent.

LFMT Client performs the following functions:

• Deploys as a plug-in to Genesys Administrator Extension (GAX).

• Provides a graphical user interface to configure and control the LFMT solution.

• Schedule log file collections.

• Configure custom indexing on application log files.

• Configure masking of sensitive data in application log files.

Log File Management Tool Deployment and User's Guide 5

Overview

• Search, select, and download log files collected by the LFMT Collector.

Important
One LFMT Client can serve multiple LFMT Collector/LFMT Indexer pairs.

LFMT Collector performs the following functions:

• Deploys on the LFMT Server Host(s).

• Initiates scheduled and real-time collection requests by the LFMT Client

• Application hosts are queried for new or modified log files only.

• Log files are copied from application servers to the LFMT Server Host(s).

• Log files are compressed for transfer (~10:1).

• Log files are encrypted for transfer (default is AES128-cbc).

• Creates log file packages resulting from user queries in the LFMT Client.

• Masks sensitive data in log file packages created by a user in the LFMT Client.

LFMT Indexer performs the following functions:

• Deploys on the LFMT Server Host(s).

• Indexes log files collected by LFMT Collector.

• Compresses log files for reduced storage.

• Purges log files based on a user specified retention period.

Workbench Agent performs the following functions:

• Deploys on the Genesys applications’ hosts

• Receives scheduled or real-time log collection requests from the LFMT Collector
• Identifies new or modified log files to be sent to the LFMT Collector

• Log files can be compressed for transfer based on configuration (review the configuration section <name section>)

• Log files can be transferred securely or as plain text based on configuration (review the configuration section <name
section>)

Supported File Types

The type of log files that can be managed by the LFMT are:

• Application log files—*.log (including those that have been configured for circular logging)

• Application snapshot log files that can be opened for writing—*.snapshot.log.

Log File Management Tool Deployment and User's Guide 6

Overview

• Core and dump files created after an application terminates unexpectedly—core.* and dmp.*.

• Log files from third party applications configured in Configuration Server.

Important
For log files to be accessible by the LFMT, the application must be provisioned in Configuration
Server with a configuration option of all set in the [log] section. The value of this option should
be set to the absolute path of the application log files.

Log File Management Tool Deployment and User's Guide 7

Overview Architecture

Architecture
The following section describes the recommended architecture for an LFMT deployment. Although all LFMT
components can be deployed on a single host, the recommended architecture shows three hosts: the LFMT Server
Host, the LFMT Client Host, and the LFMT Database Host.

LFMT Server Host

The LFMT Server Host consists of the following components:

• Central Log Storage (CLS) repository, the central repository in which all log files for all applications using the tool are
stored.

• LFMT Collector, which collects the log files for storage in the Central Log Storage (CLS) repository and creates
packages for user downloads.

• LFMT Indexer, which monitors the CLS repository, indexes the files as they arrive at the CLS, and compresses the
CLS files for storage.

Important
LFMT Collector and LFMT Indexer must be deployed on the same host. Multiple LFMT Indexer/
Collector pairs can be deployed to service one LFMT solution. Only one LFMT Indexer/Collector
pair should be deployed on a single host.

Log File Management Tool Deployment and User's Guide 8

Overview Architecture

LFMT Client Host

The LFMT Client Host consists of the following components:

• Genesys Administrator Extensions (GAX), a web-based UI to which LFMT Client is a plug-in.

• LFMT Client, a GAX plug-in that provides the interface through which users specify the log files to retrieve, package,
and upload to a given location.

Important
LFMT Client and GAX must be deployed on the same host. Only one LFMT Client is required for
each deployed LFMT solution.

LFMT Database Host

The LFMT Database Host consists of the following components:

• LFMT Database, the central repository where all information about the copied log files is stored.

Log File Management Tool Deployment and User's Guide 9

Overview Architecture

Tip
To improve performance, the LFMT Database Host should be deployed in the same locale as the
LFMT Server Host. One LFMT Database is required for each LFMT Indexer/Collector pair.

Log File Management Tool Deployment and User's Guide 10

Overview New in this Release

New in this Release

This section describes the new functionality for each release.

Release 8.5.104
The 8.5.104 Log File Management Tool release primarily enables support for Oracle 19c. Several bug fixes and
performance improvements have also been made. Please see the Release Notes for further details.

Release 8.5.103
The 8.5.103 Log File Management Tool release primarily enables support for OpenJDK 8 and 11. Several bug fixes
and performance improvements have also been made. Please see the Release Notes for further details.

Release 8.5.102
The 8.5.102.00 Log File Management Tool release enables support for GAX 9.0.100.52 and later by using the
LFMT Client 8.5.102.00 component; for GAX versions 8.5.209 to 9.0.001.37, please use the LFMT Client
8.5.101.06 component (also included in the 8.5.102.00 LFMT package). Several bug fixes and performance
improvements have also been made. Please refer to the Release Notes for further details.

Release 8.5.101
The 8.5.101 Log File Management Tool release enables support for GAX 8.5.290.09 and later. This release also
enables audit capabilities for all configuration changes made within the Log File Management Tool. Several bug
fixes and performance improvements have also been made. Please refer to the Release Notes for further details.

Release 8.5.100
The 8.5.100 Log File Management Tool release significantly improves log file collection by moving to an agent-
based transfer. By using an agent to perform the log file transfers, the Log File Management Tool no longer

Log File Management Tool Deployment and User's Guide 11

Overview New in this Release

leverages rsync over SSH to transfer files. The transfers are now performed over a TCP/TLS connection to the
agent, which prevents the need for public-key authentication between hosts.

In addition to the moving to an agent-based transfer, the following features have been added to the 8.5.1 release:

• Removed the requirement for Cygwin to be deployed to Windows application hosts

• Support for user roles to enable/disable LFMT functionality for different user groups

• Collection from multiple log file locations for a single app

• Support for circular log file types i.e. (File.log, File.1.log, File.1.log, File.x.log)

• Internet Explorer/Edge Support

• Resolved compatibility issues with other GAX plugins

• Raise alarms for collection failures

• Overall stability improvements

Release 8.5.000.XX
• LFMT Build 8.5.000.XX requires the Java 8 Runtime Environment (JRE).

• LFMT Build 8.5.000.XX requires a new LFMT database.

• LFMT database(s) are configured using Database Access Point (DAP) configuration objects.

• LFMT Build 8.5.000.XX supports Windows 2012.

• LFMT Build 8.5.000.XX supports TLS connections to Configuration Server.

• LFMT Build 8.5.000.XX supports a distributed LFMT deployment.

• LFMT Client requires GAX 8.5.

• LFMT Client can schedule/force collections for multiple connected LFMT Collectors.
• LFMT Client can search multiple connected LFMT databases.

• LFMT Client provides ILIKE operation when filtering on custom indexes.

• LFMT Client allows setting time zone for scheduled collections.

• LFMT Client allows for the creation of custom regular expressions.

• LFMT Client displays to which applications custom regular expressions have been assigned.

• LFMT Client has new section 'Available Packages' for downloading previously created packages.

• LFMT Collector and LFMT Indexer are configured as separate applications in Configuration Server.

Log File Management Tool Deployment and User's Guide 12

Overview Downloading LFMT

Downloading LFMT
Follow these steps to download LFMT:

1. Login to My Support.

2. Click Continue to your Dashboard button.

3. On the Dashboard screen, select the Apps and Tools tile.

4. On the Apps and Tools screen, select the Log File Management Tools tile.

5. On the Genesys Care Log File Management Tool screen, click Download LFMT link.

6. On the Terms and Conditions screen, click the checkbox to accept the Terms and Conditions, and click Download.

7. On the zip screen, click Download again.

The result of the above is a locally downloaded LFMT_8.5.103.00.zip file.

Log File Management Tool Deployment and User's Guide 13

Overview Known Issues and Limitations

Known Issues and Limitations

• The LFMT Client requires the netty-3.2.3.Final.jar library in the <GAX Install Directory>/webapp/
WEB-INF/lib folder to be renamed or deleted. This is applicable for GAX versions 8.5.220.20 and earlier.

• In a multisite environment, if one or more of the databases are down, the LFMT Client does not populate panes
correctly.

• LFMT does not support changes to the GAX root URL.

Log File Management Tool Deployment and User's Guide 14

Overview Migration to LFMT 8.5.104

Migration to LFMT 8.5.104

Moving from 8.5.000.xx/8.5.100.xx to 8.5.101.xx/8.5.104.xx

LFMT Components

It is required that the LFMT Collector, Indexer and Workbench Agents are updated to 8.5.103.xx. The LFMT Client
must be at least version 8.5.101.06 or 8.5.102.02 (depending on the GAX version -- see release notes). These
components are not backwards compatible with the 8.5.101.xx/8.5.100.xx versions.

Important
After updating the LFMT Client to 8.5.101.xx/8.5.103.xx, please ensure that there is not an
"original-gax-lfmt.jar" file in the {GAXInstall}/webapp/WEB-INF/lib directory. If this file does exist,
please delete the file.

Database

Moving from LFMT 8.5.000.xx/8.5.100.xx to 8.5.101.xx/8.5.103.xx does require a schema update to the already
existing database tables. The update scripts are provided in the {CollectorInstall}/utilities/dbscripts folder. After the
scripts have been run, all data will be preserved in the existing database.

Moving from 8.5.000.xx > 8.5.100.xx

LFMT Components

It is required that all of the LFMT components are updated to 8.5.100.xx (LFMT Client, Indexer, and Collector).
These components are not backwards compatible with the 8.5.000.xx versions. The Workbench Agent release
8.5.100.xx is also required to be deployed to all application hosts. Please see the Workbench Agent deployment
guide for further information.

Database

Moving from LFMT 8.5.000.xx to 8.5.100.xx does not requires any schema changes to the already existing
database tables. The same provisioned database from LFMT 8.5.000.xx can continue to be used for LFMT
8.5.100.xx.

Log File Management Tool Deployment and User's Guide 15

Overview Migration to LFMT 8.5.104

Moving from 8.1.xxx to 8.5.xxx

LFMT 8.5.xxx encompasses major changes to the tool's design and deployment. Currently, a migration path from
LFMT 8.1.xxx to LFMT 8.5.xxx does not exist. For questions concerning how to best move to the LFMT 8.5.xxx
architecture, please contact Genesys Customer Care.

Log File Management Tool Deployment and User's Guide 16

Log File Management Tool Deployment Planning Migration to LFMT 8.5.104

Log File Management Tool Deployment Planning

This section describes how to properly size storage and system resources for an LFMT deployment.

Please note that the sizing and performance recommendations are based on tests performed in an environment of
up to 1000 agents; therefore these should be used as guidelines only. Please monitor your environment and apply
your observations and experience to the formulas presented here to extrapolate the actual sizing of your LFMT
environment.

Log File Management Tool Deployment and User's Guide 17

Log File Management Tool Deployment Planning LFMT Client - GAX Dependencies

LFMT Client - GAX Dependencies

The current version of LFMT client has some GAX version dependencies. Please refer to the table below.

LFMT 8.5 and GAX versions compatibility table:

LFMT Client Version GAX Version Requirement

8.5.103.03 9.0.100.52 and above
8.5.102.00 9.0.100.52 and above
8.5.101.06 8.5.290.09 to 9.0.001.37
8.5.101.00 - 8.5.101.05 8.5.280.07 to 8.5.290.08
8.5.100.03 8.5 up to 8.5.280.06

Log File Management Tool Deployment and User's Guide 18

Log File Management Tool Deployment Planning LFMT Database Sizing

LFMT Database Sizing

The LFMT Database is largely sized based on two tables.

• The log_file table holds the names and locations of the log files stored in CLS.

• The log_file_indexed_token table holds any custom index reference defined by the customer for specific application
types.

LFMT Database - Detailed Sizing Approach

Database sizing can be calculated using the following metrics:

• 0.50kB per log file

• 0.15kB per index

LFMT will write 1 record per log file to the LFMT database. Also, LFMT will write 1 records per index found in each
log file to the LFMT database, as per the configured indexes in the environment.

Sample LFMT Database Sizing

Assume:

• CLS Total Disk Consumption = 1TB

• CLS Total Files = 1000000

• Indexes per file = 50

Important
The above values are the equivalent to 10MB log files compressed at a 10-1 ratio.

Sample calculation:

log_file table size = 1000000*.50kB = 500MB

log_file_indexed_token table size = 1000000 * 50 * 0.15kB = 7324MB

Total DB size = 500MB + 7324MB = 7824MB = 7.7GB

Log File Management Tool Deployment and User's Guide 19

Log File Management Tool Deployment Planning LFMT Database Sizing

LFMT Database - Simplified Sizing Approach

Use the following table to estimate the DB space requirements for the LFMT Database. Average daily call volume
can be used as a reference. Note that a deployment would typically have a separate LFMT Server host per
datacenter so the sizing should represent the call volume handled by that data center.

Average Daily Calls Database Space

Less than 10k 500MB
Between 10k-30k 1GB
Between 30k-120k 30GB
Please consult with Genesys Customer Care.
Greater than 120k
(Detailed Sizing approach recommended)

Important
• The DB space utilized by LFMT is highly dependent on the number of indexes configured per file
type. When using the Simplified LFMT sizing method, we recommend you start by configuring a low
log file retention period (e.g.: 3 or 4 days) and then adjust it accordingly after data collection is
started and it is clear there is sufficient DB space to handle all the indexes, or adjust the space
accordingly.

• The maximum value for the ID is 2,147,483,647 for both the LOG_FILE and
LOG_FILE_INDEXED_TOKEN TABLES. Please periodically monitor the value of the ID in both the
tables and if it is approaching the said maximum value, the ID will need to be manually re-seeded
(via the sequence for Oracle and PostGres, and via the Identity Column for MSSQL.

Log File Management Tool Deployment and User's Guide 20

Log File Management Tool Deployment Planning LFMT Storage and Resource Sizing

LFMT Storage and Resource Sizing

The following section describes how to size hardware for the LFMT Server Host(s). For information on storage
requirements for the LFMT Client Host(s), please refer to the Genesys Administrator Extension (GAX) Deployment
Guide.

Sizing Approach
LFMT sizing can be approached in two ways:

• The Detailed Sizing procedure facilitated by the sizing table below will guide you to collect the information required to
produce a strong estimate for your LFMT sizing needs. This will allow you to factor in your expected call volumes
including peaks, your preferred log retention period, etc.

• If a more expedient LFMT sizing is preferred, the Simplified sizing can provide a guide to get you started more
quickly. However, please note:

• These are approximate, and you may need to adjust your data retention period so that your log producing rate
does not overfill the CLS central file storage.

• It is recommended that you provision the hardware in a way that is easily extendable in the future so you can
adjust it to your preferences. E.g. Perhaps your environment data generation rate only allows for 6 days of logs
stored on the default proposed storage but your company prefers a longer period, then additional storage may
need to be planned.

LFMT - Detailed Sizing Approach

The Storage requirements for LFMT consists of two parts:

• The first is the space for the host Operating System and the LFMT applications installation.
• The seconds is the CLS storage – the space used by LFMT as workspace and storage for the Log Files it collects and
manages.

For the first part, Genesys recommends that the LFMT Indexer and LFMT Collector be installed on the same drive
where the host Operating System resides. Minimum recommended storage for this drive is as follows:

• 100GB for hosts running a Linux Operating System

• 160GB for hosts running a Windows Operating System

A separate/additional drive (local to the Collector Host and not a mapped network drive) is recommended for
housing the Central Log Storage (CLS). To calculate CLS storage requirements, download and refer to the
Genesys Log File Management Tool Sizing Template.

Log File Management Tool Deployment and User's Guide 21

Log File Management Tool Deployment Planning LFMT Storage and Resource Sizing

Use the following table to estimate the Memory and CPU requirements for the LFMT Server Host(s). From the
sizing template results, average throughput for log generation, or CLS storage requirements can be used as a
reference.

CPU-Processor (Xeon-
Average Throughput Memory CLS Storage*
class 2.2 GHz or better)
Less than 2MB/s One quad-core processor 4GB to 8GB Up to 500GB
Between 2-10MB/s Two quad-core processors 8GB Up to 2.5TB
Three quad-core
Between 10-25MB/s 16GB Up to 7.5TB
processors
Between 25-50MB/s Four quad-core processors 16GB Up to 15TB
Greater than 50MB/s Please consult with Genesys Customer Care.

LFMT - Simplified Sizing Approach

The Storage requirements for LFMT consists of two parts:

• The first is the space for the host Operating System and the LFMT applications installation.

• The seconds is the CLS storage – the space used by LFMT as workspace and storage for the Log Files it collects and
manages.

For the first part, recommends that the LFMT Indexer and LFMT Collector be installed on the same drive where the
host Operating System resides. Minimum recommended storage for this drive is as follows:

• 100GB for hosts running a Linux Operating System

• 160GB for hosts running a Windows Operating System

A separate/additional drive is recommended for housing the Central Log Storage (CLS). To calculate CLS storage
requirements, refer to the table below.

Use the following table to estimate the Memory and CPU and storage requirements for the LFMT Server Host(s).
Average daily call volume can be used as a reference. Note that a deployment would typically have a separate
LFMT Server host per datacenter so the sizing should represent the call volume handled by that datacenter.

CPU-Processor (Xeon-
Average Daily Calls Memory CLS Storage*
class 2.2 GHz or better)
Less than 10k One quad-core processor 4GB to 8GB 200GB
Between 10k-30k Two quad-core processors 8GB 500GB
Three quad-core
Between 30k-120k 16GB 2TB
processors
Please consult with Genesys Customer Care. (Detailed Sizing approach
Greater than 120k
recommended)

Log File Management Tool Deployment and User's Guide 22

Log File Management Tool Deployment Planning LFMT Storage and Resource Sizing

Important
Storage is based on calculations for 7 days of log files and includes allowance for the operation of
the application. When using the Simplified LFMT sizing method, we recommend you start by
configuring a low log file retention period (e.g. 3 or 4 days) and then adjust it accordingly after data
collection is started and it is clear there is sufficient space for additional retention.

Log File Management Tool Deployment and User's Guide 23

Log File Management Tool General Deployment LFMT Storage and Resource Sizing

Log File Management Tool General Deployment

This section contains general information for the deployment, configuration, and installation of the Log File
Management Tool (LFMT). It is recommended that you are familiar with LFMT architecture and nomenclature prior
to proceeding with its installation.

Log File Management Tool Deployment and User's Guide 24

Log File Management Tool General Deployment Prerequisites

Prerequisites

Software Requirements
LFMT supports the following Operating Systems:

• Windows 2012 and 2016

• Red Hat Enterprise Linux (RHEL) and CentOS 7

LFMT supports the following database management systems:

• PostgreSQL 9.1 or later

• Oracle DBMS 11 to 19c

• Microsoft SQL Server 2005 or later

The following software must be installed before deploying the Log File Management Tool:

• Genesys Administrator Extension 8.5.x and all of its associated components.

• JRE 1.8 (or later) or OpenJDK 8 or OpenJDK 11

The LFMT Client is web-based, and is compatible with the following web browsers:

• Microsoft Edge X or later

Important
LFMT supports Microsoft Edge since 8.5.100.03. Please refer to LFMT Client

• Microsoft Internet Explorer 9 or later

• Mozilla Firefox 17.0.1 or later

• Google Chrome 24.0.1312.52 or later

Genesys Engage Requirements

LFMT integrates to Genesys Engage Configuration Server, Solution Control Server and Message Server 8.5
Versions.

Log File Management Tool Deployment and User's Guide 25

Log File Management Tool General Deployment Prerequisites

Network and Security Requirements

1. Ensure all hostnames in the environment can be resolved by DNS from the LFMT Server Host(s).

2. Open the following internal ports between the LFMT Server Host and the Genesys application servers.

a. Port 22 for SSH - Required for LFMT ongoing operation

b. Port 135 for WMI - Required only during LFMT installation and configuration (Windows only)

3. Ensure the following access ports are available for LFMT operation.

a. The DBMS access port (Required if the DBMS is located on a different host than LFMT Indexer):

• PostgreSQL - default: Port 5432

• Oracle - default: Port 1521

• MSSQL- default: Port 1433

b. The GAX configuration port (default: Port 8080)

4. (Optional) Open the following external ports for the LFMT (S)FTP/S operation.

a. Ports 20 and 21

5. (Optional) Assign dedicated NICs on each Genesys application server for LFMT operation.

6. (Optional) To enable Log File Retrieval services, configure ports 80 & 443 for outbound TCP access.

Log File Management Tool Deployment and User's Guide 26

Log File Management Tool General Deployment Deployment of the LFMT Client

Deployment of the LFMT Client

This section describes how to deploy and configure the LFMT Client software.

Important
LFMT Client places plug-in files in the <GAX Installation Directory>\webapp\WEB-INF\lib folder.
This folder is created the first time GAX is started. Please ensure GAX has been started at least
once prior to the installation of the LFMT Client.

Installing the LFMT Client

The following directories in the LFMT Client distributable contain the LFMT installation packages:

• For Linux, /linux/bX/ip.

• For Windows, \windows\bX\ip.

Installing the LFMT Client on Linux

1. In the directory to which the LFMT Client installation package was copied, execute the install.sh script.

2. Enter the location to the GAX installation directory.

3. Enter the Destination Folder for the LFMT Client installation.

4. Ensure the .jar files in the <LFMT Client Install Directory> have been copied to <GAX Installation
Directory>/webapps/WEB-INF/lib.

Installing the LFMT Client on Windows

1. In the directory to which the LFMT Client installation package was copied, double-click setup.exe to start the
installation.

a. On the Welcome screen, click Next.

b. Enter the Destination Folder for the LFMT Client installation and click Next.

c. On the Ready to Install screen, click Next.

d. On the Installation Complete screen, click Finish.

5. Ensure the .jar files in the <LFMT Client Install Directory> have been copied to <GAX Installation
Directory>\webapps\WEB-INF\lib.

Log File Management Tool Deployment and User's Guide 27

Log File Management Tool General Deployment Deployment of the LFMT Client

Configuring GAX for use with the LFMT Client

1. Log into GAX, and navigate to Configuration Manager.

2. From the Environment section, select Applications.

3. In the Applications section, select the GAX Application to be configured for use with the LFMT Client.

4. In the Application Properties pane, select the Ports tab.

5. In the Ports tab, add the following listening ports.

a. messaging = <an open port on the GAX host>

b. ftmessaging = <an open port on the GAX host>

6. Navigate to the Application Options tab.

7. Add and configure the following section and options in the GAX configuration object.

a. Add the section lfmt.

b. (Optional) Configure the following LFMT FTP options:

ftp_host, ftp_port, ftp_user, ftp_pwd.

Tip
For more information on the GAX LFMT configuration options, please refer to the LFMT GAX Configuration Options section.

8. Select the Save button to save changes to the application.

9. Restart GAX.

Log File Management Tool Deployment and User's Guide 28

Log File Management Tool General Deployment Deployment of the LFMT Indexer

Deployment of the LFMT Indexer

This section describes how to deploy and configure the LFMT Indexer software.

Provisioning the LFMT Indexer

The following directories in the LFMT Indexer distributable contain the LFMT Indexer templates:

• For Linux, /templates.

• For Windows, \templates.

Provisioning the LFMT Indexer in Genesys Adminstrator Extension 9.0

1. Log into GAX, and navigate to Configuration Manager.

2. From the Environment section, select Application Templates.

3. In the Application Templates section, select New.

4. In the New Properties pane, select Import Application Template.

5. In the Import Application Template dialog, click the Choose File file button and navigate to the LFMT
Indexer .apd template. Select the template, and click the OK button to confirm the template import.

6. In the New Properties pane, select the Save button to save the new application template.

7. Once the application template has been imported, navigate to Configuration Manager.

8. From the Environment section, select Applications.

9. In the Applications section, select New.

10. In the New Properties pane, complete the following:

a. In the General tab, enter a name for the LFMT Indexer application in the Name field,.

b. Click on the Template field and navigate to the application template created above.

c. In the Working Directory field, enter "." .

d. In the Command Line field, enter "." .

e. Click on the Host field and navigate to the host where LFMT Indexer will be installed.

f. In the Application Options tab, review and configure the LFMT Indexer options.

Tip

Log File Management Tool Deployment and User's Guide 29

Log File Management Tool General Deployment Deployment of the LFMT Indexer

For more information on the LFMT Indexer configuration options, please refer to the LFMT Indexer Configuration Options
section.

g. In the Ports tab, add the following listening ports:

i. default = <an open port on the LFMT Indexer host>

h. Select the Save button to save the new application.

Installing the LFMT Indexer

The following directories in the LFMT Indexer distributable contain the LFMT installation packages:

• For Linux, /linux/bX/ip.

• For Windows, \windows\bX\ip.

Installing the LFMT Indexer on Linux

1. In the directory to which the LFMT Indexer installation package was copied, execute the install.sh script.

2. When prompted, confirm the host name of the computer on which LFMT Indexer is to be installed.

3. When prompted, specify the host and port to the Configuration Server associated with this LFMT Indexer.

4. When prompted, specify the username and password to access the Configuration Server.

5. When prompted, specify the host and port to the Backup Configuration Server associated with this LFMT Indexer.

6. When prompted, select the LFMT Indexer Application object you configured in “Provisioning the LFMT Indexer” from
the list of applications and click Next.

7. Enter the Destination Folder for the LFMT Indexer installation.

Installing the LFMT Indexer on Windows

1. In the directory to which the LFMT Indexer installation package was copied, double-click setup.exe to start the
installation.

2. On the Welcome screen, click Next.

3. When prompted, specify the connection parameters to the Configuration Server associated with this LFMT Indexer and
click Next.

4. When prompted, select the LFMT Indexer Application object you configured in “Provisioning the LFMT Indexer” from
the list of applications and click Next.

5. Enter the Destination Folder for the LFMT Indexer installation and click Next.

6. (Optional) Enter the Host name and Port of the Backup Configuration Server associated with this LFMT Indexer and
click Next.

Log File Management Tool Deployment and User's Guide 30

Log File Management Tool General Deployment Deployment of the LFMT Indexer

7. On the Ready to Install screen, click Install.

8. On the Installation Complete screen, click Finish.

Verifying the LFMT Indexer installation

After completing the installation of the LFMT Indexer, its configuration should be verified through the GAX interface.

1. Log into GAX, and navigate to Configuration Manager.

2. From the Environment section, select Applications.

3. In the Applications section, locate and open the LFMT Indexer application.

4. In the General tab, verify that the following parameters have been updated by the installation process.

• Working Directory: The LFMT Indexer installation path

• Command Line: indexer_startup.bat or ./indexer_startup.sh

• Command Line Arguments: -app <LFMT Indexer Application Name> -host <Configuration Server
Host> -port <Configuration Server Port> -backuphost <Backup Configuration Server Host> -
backupport <Backup Configuration Server Port>

Important
The backuphost and backupport options are optional. These options are read from the
Command Line Arguments field of the LFMT Indexer object only.

Log File Management Tool Deployment and User's Guide 31

Log File Management Tool General Deployment Deployment of the LFMT Collector

Deployment of the LFMT Collector

This section describes how to deploy and configure the LFMT Collector software.

Important
LFMT Collector must be installed on the same host as LFMT Indexer.

Provisioning the LFMT Collector

The following directories in the LFMT Collector distributable contain the LFMT Collector templates:

• For Linux, /templates.

• For Windows, \templates.

Provisioning the LFMT Collector in Genesys Adminstrator Extension 9.0

1. Log into GAX, and navigate to Configuration Manager.

2. From the Environment section, select Application Templates.

3. In the Application Templates section, select New.

4. In the New Properties pane, select Import Application Template.

5. In the Import Application Template dialog, click the Choose File button and navigate to the
LFMT_Collector.apd template. Select the template and keep the template name as “LFMT_Collector”. If the name is
not "LFMT_Collector", please change the name to "LFMT_Collector". This is important for the agents to identify the
collector applications within the environment. Click the OK button to confirm the template import.

6. In the New Properties pane, select the Save button to save the new application template.

7. Once the application template has been imported, navigate to Configuration Manager.

8. From the Environment section, select Applications.

9. In the Applications section, select New.

10. In the New Properties pane, complete the following:

a. In the General tab, enter a name for the LFMT Collector application in the Name field,.

b. Click on the Template field and navigate to the application template created above.

c. In the Working Directory field, enter "." .

d. In the Command Line field, enter "." .

Log File Management Tool Deployment and User's Guide 32

Log File Management Tool General Deployment Deployment of the LFMT Collector

e. Click on the Host field and navigate to the host where LFMT Collector will be installed.

f. In the Application Options tab, review and configure the LFMT Collector options.

Tip
For more information on the LFMT Collector configuration options, please refer to the LFMT Collector Configuration
Options section.

g. In the Ports tab, add the following listening ports:

i. default = <an open port on the LFMT Collector host>

ii. ftmessaging = <an open port on the LFMT Collector host>

iii. sftmessaging = <an open port on the LFMT Collector host>

h. Select the Save button to save the new application.

Installing the LFMT Collector

The following directories in the LFMT Collector distributable contain the LFMT installation packages:

• For Linux, /linux/bX/ip.

• For Windows, \windows\bX\ip.

Installing the LFMT Collector on Linux

1. In the directory to which the LFMT Collector installation package was copied, execute the install.sh script.

2. When prompted, confirm the host name of the computer on which LFMT Collector is to be installed.

3. When prompted, specify the host and port to the Configuration Server associated with this LFMT Collector.

4. When prompted, specify the username and password to access the Configuration Server.

5. When prompted, specify the host and port to the Backup Configuration Server associated with this LFMT Collector.

6. When prompted, select the LFMT Collector Application object you configured in “Provisioning the LFMT Collector” from
the list of applications and click Next.

7. Enter the Destination Folder for the LFMT Collector installation.

Installing the LFMT Collector on Windows

1. In the directory to which the LFMT Collector installation package was copied, double-click setup.exe to start the
installation.
2. On the Welcome screen, click Next.

Log File Management Tool Deployment and User's Guide 33

Log File Management Tool General Deployment Deployment of the LFMT Collector

3. When prompted, specify the connection parameters to the Configuration Server associated with this LFMT Collector
and click Next.

4. When prompted, select the LFMT Indexer Application object you configured in “Provisioning the LFMT Collector” from
the list of applications and click Next.

5. Enter the Destination Folder for the LFMT Collector installation and click Next.

6. (Optional) Enter the Host name and Port of the Backup Configuration Server associated with this LFMT Collector and
click Next.

7. On the Ready to Install screen, click Install.

8. On the Installation Complete screen, click Finish.

Configuring GAX for use with the LFMT Collector

1. Log into GAX, and navigate to Configuration Manager.

2. From the Environment section, select Applications.

3. In the Applications section, select the GAX Application configured for use with the LFMT Client.

4. In the Application Properties pane, select the Connections tab.

5. In the Connections tab, add a connection to the LFMT Collector GAX will control.

Important
A single GAX may have connections to more than one LFMT Collector instances.

6. Select the Save button to save changes to the application.

7. Restart GAX.

Verifying the LFMT Collector installation

After completing the installation of the LFMT Collector, its configuration should be verified through the GAX
interface.

1. Log into GAX, and navigate to Configuration Manager.

2. From the Environment section, select Applications.

3. In the Applications section, locate and open the LFMT Collector application.

4. In the General tab, verify that the following parameters have been updated by the installation process.

• Working Directory: The LFMT Collector installation path

Log File Management Tool Deployment and User's Guide 34

Log File Management Tool General Deployment Deployment of the LFMT Collector

• Command Line: collector_startup.bat or ./collector_startup.sh

• Command Line Arguments: -app <LFMT Collector Application Name> -host <Configuration Server
Host> -port <Configuration Server Port> -backuphost <Backup Configuration Server Host> -
backupport <Backup Configuration Server Port>

Important
The backuphost and backupport options are optional. These options are read from the
Command Line Arguments field of the LFMT Collector object only.

Log File Management Tool Deployment and User's Guide 35

Log File Management Tool General Deployment Configuration of the LFMT Database

Configuration of the LFMT Database

For each LFMT Indexer/Collector pair, a LFMT database is required. This section describes how to initialize a LFMT
Database. The configuration of a Database Access Point (DAP) for a LFMT Database is also covered.

Important
The LFMT Database is not the GAX Database. The GAX database is still required for proper GAX
functionality.

Initializing the LFMT Database

1. Navigate to the <LFMT Collector Install Directory>\utilities\dbscripts directory.

2. Locate the LFMT Database initialization script that corresponds to your DBMS. The following table lists database types
and their corresponding script names.

DBMS Script
PostgreSQL lfmdb_8.5XX.XX_postgres.sql
Oracle lfmdb_8.5XX.XX_ora.sql
Microsoft SQL lfmdb_8.5XX.XX_mssql.sql

3. In your DBMS interface, load and execute the initialization script that corresponds to your DBMS.

Provisioning a Database Access Point for the LFMT Database

1. Log into GAX, and navigate to Configuration Manager.

2. From the Environment section, select Application Templates and click New .

3. In the Application Templates section, enter a name for the DAP Template in the Name text field.

4. Choose Database Access Point as the template type from the Type dropdown.

5. Enter 8.5 for the DAP version in the Version text field.

6. Select the Save button to save the new application template.

7. Once the application template has been created, navigate to Configuration Manager.

8. From the Environment section, select Applications.

9. In the Applications section, select New.

10. In the New Properties pane, select the General tab. Complete the following:

Log File Management Tool Deployment and User's Guide 36

Log File Management Tool General Deployment Configuration of the LFMT Database

a. In the General tab, enter a name for the LFMT DAP in the Name field.

b. Click on the Template field and navigate to the application template created above.

c. Click on the Host field and navigate to the host where LFMT Database resides.

d. Choose JDBC as the connection type from the Connection Type dropdown.

e. Choose Any as the case conversion type from the Case Conversion dropdown.

f. Choose Main as the role from the Role dropdown.

g. Choose False as the role from the Debug dropdown.

h. Enter 15 for the DB timeout in the JDBC Query Timeout text field.

i. Choose your DBMS type from the DBMS Type dropdown.

j. Enter the LFMT Database name in the Database Name text field.

k. Enter the LFMT Database username in the Username text field.

l. Enter the LFMT Database user password in the User Password text field.

11. Select the Ports tab. Complete the following:

a. Set the value of the default communication port to the listening port of your DBMS. Default ports are listed
below:

• For PostgreSQL the default listening port is 5432.

• For Oracle the default listening port is 1521.

• For MSSQL the default listening port is 1433.

12. Select the Application Options tab. Review and configure the LFMT DAP options.

a. Create the section lfmt.

b. Create the option site.

c. Set the value of the site option to a unique identifier for the LFMT Database.

Important
Ensure that the site option for each LFMT DAP in the LFMT solution is different.

Tip
For more information on the LFMT DAP configuration options, please refer to the LFMT DAP
Configuration Options section.

Log File Management Tool Deployment and User's Guide 37

Log File Management Tool General Deployment Configuration of the LFMT Database

Configuring connections to the LFMT Database

The LFMT Database stores information accessed by the LFMT Client (GAX), the LFMT Indexer, and the LFMT
Collector. To that, each application requires a connection the LFMT DAP. This section describes how to configure
connections to the LFMT database.

Configuring GAX for use with the LFMT Database

1. Log into GAX, and navigate to Configuration Manager.

2. From the Environment section, select Applications.

3. In the Applications section, select the GAX Application configured for use with the LFMT Client.

4. In the Application Properties pane, select the Connections tab.

5. In the Connections tab, add a connection to the LFMT DAP to which GAX will connect.

Important
A single GAX may have connections to more than one LFMT DAP instances.

6. Select the Save button to save changes to the application.

7. Restart GAX.

Configuring LFMT Indexer for use with the LFMT Database

1. Log into GAX, and navigate to Configuration Manager.

2. From the Environment section, select Applications.

3. In the Applications section, select the LFMT Indexer that will access the LFMT Database.

4. In the Application Properties pane, select the Connections tab.

5. In the Connections tab, add a connection to the LFMT DAP to which LFMT Indexer will connect.

Important
A LFMT Indexer may have only one connection to a LFMT DAP instance.

6. Select the Save button to save changes to the application.

7. Restart LFMT Indexer.

Log File Management Tool Deployment and User's Guide 38

Log File Management Tool General Deployment Configuration of the LFMT Database

Configuring LFMT Collector for use with the LFMT Database

1. Log into GAX, and navigate to Configuration Manager.

2. From the Environment section, select Applications.

3. In the Applications section, select the LFMT Collector that will access the LFMT Database.

4. In the Application Properties pane, select the Connections tab.

5. In the Connections tab, add a connection to the LFMT DAP to which LFMT Collector will connect.

Important
A LFMT Collector may have only one connection to a LFMT DAP instance.

6. Select the Save button to save changes to the application.

7. Restart LFMT Collector.

Log File Management Tool Deployment and User's Guide 39

Log File Management Tool General Deployment Initializing the DBMS

Initializing the DBMS

This section describes the how to create and initialize the LFMT database:

• On Linux

• On Windows

On Linux

Setting up the Genesys Adminstrator database

Purpose: To create and initialize the data model (the database structure) for the LFMT Database.

Prerequisites

• The DBMS is installed, and the service is running.

PostgreSQL

1. If the postgres user is not already created, create it now by entering the following commands at the prompt, and
press Enter after each command:

adduser postgres
su -postgres

2. Navigate to the postgresql folder.

3. Create the database called lfm by entering the following command at the prompt:

./bin/createdb lfm

and press Enter.

Warning
The database name of lfm is chosen in this procedure for simplicity, and is used throughout these instructions. You do not
have to use lfm, but if you choose to use a different name, be careful to use the correct name in subsequent steps. This
name is case sensitive

4. Locate the PostgreSQL intitialization script lfmdb_XXXXX_postgres.sql from <LFMT Server Install
Directory>/utilities/dbscripts directory.

5. Enter the command ./bin/psql -d lfm, and press Enter. This creates the tables required in the LFMT Database.

6. Initialize the LFMT database, as follows:

Log File Management Tool Deployment and User's Guide 40

Log File Management Tool General Deployment Initializing the DBMS

a. For PostgreSQL, enter the command \i <LFMT Server Install Directory>/utilities/dbscripts/

lfmdb_XXXXX_postgres.sql.

b. Confirm that the script has executed without errors or warnings.

Oracle

1. Refer to the Oracle documentation to install the Oracle Database Management System on the host machine that
corresponds to the Host that you want to create the Database that will be used by LFMT.

2. Use the following SQL commands to create the users and ensure that they do not have excessive permissions:

1. create user <username> identified by <password>;

2. grant connect, resource to <username>;

3. Initialize the database by executing the following script: lfmdb_XXXXX_ora.sql , available in the following folder:
<LFMT Server Install Directory>/utilities/dbscripts/

4. invoke SQLPLUS, and type @<LFMT Server Install Directory>/utilities/dbscripts/lfmdb_XXXXX_ora.sql.

Microsoft SQL

1. Refer to the MSSQL documentation to install the MSSQL Database Management System on the host machine that
corresponds to the Host that you want to create the Database that will be used by LFMT.

2. Initialize the database by executing the following script:

lfmdb_XXXXX_mssql.sql , available in the following folder:

<LFMT Server Install Directory>/utilities/dbscripts/

On Windows

Setting up the Genesys Adminstrator database

Purpose: To create the data model (the database structure) for the LFMT Database and initialize it with base
operational data. Base operational data includes the known log file types that will be retrieved by LFMT, and the
associated tokens to be targeted for indexing or scrubbing for each log type.

Prerequisites

• The DBMS is installed, and the service is running.

PostgreSQL

1. Create a new database called lfm, as follows:

a. From the Windows Start menu, navigate to All Programs > PostgreSQL and select pgAdmin III.

b. In the Object browser, navigate to Server Groups > Servers and double-click PostgreSQL v.<version
number> <local host>:<default port>, providing your particular version, host, and port information.

Log File Management Tool Deployment and User's Guide 41

Log File Management Tool General Deployment Initializing the DBMS

c. Enter the password for the user postgres.

d. Right-click Databases and select New Database.

e. Enter the name lfm and leave the other fields blank.

f. Click OK. A new database called lfm is created.

7. In a separate text editor, open the lfmdb_XXXXX_postgres.sql file found in the <LFMT Server Install
Directory>\utilities\dbsripts directory.

8. Right-click lfm and select Create Script.

9. Initialize the LFMT database as follows:

a. For PostgreSQL:

i. Copy the contents of the lfmdb_XXXXX_postgres.sql file and paste it into the SQL script editor.

ii. Select Query > Execute.

iii. Confirm that the script has executed without errors or warnings, and that the database has been
successfully initialized with the correct data model.

iv. When prompted to save the script, click No.

Important
• The database name is case-sensitive.

• In the line, change only the IP address, port, and database name information.

• To connect to a remote database, you must modify the pg_hba.conf file, located in the data
directory of your PostgreSQL installation. Open the file in a text editor, and add the following line at
the end of the file: host all all 0.0.0.0/0 trust.

• You must also ensure that the value of listen_addresses contained in the postgresql.conf
file contains the IP Address of any host connecting to the LFMT database.

• Ensure that the firewall allows this connection.

• More information can be gathered from http://www.postgresql.org/docs/8.2/static/

auth-pg-hba-conf.html.

Oracle

1. Refer to the Oracle documentation to install the Oracle Database Management System on the host machine that
corresponds to the Host that you want to create the Database that will be used by LFMT.

2. Use the following SQL commands to create the users and ensure that they do not have excessive permissions:

1. create user <username> identified by <password>;

2. grant connect, resource to <username>;

Log File Management Tool Deployment and User's Guide 42

Log File Management Tool General Deployment Initializing the DBMS

3. Initialize the database by executing the following script: lfmdb_XXXXX_ora.sql , available in the following folder:
<LFMT Server Install Directory>\utilities\dbscripts\

4. invoke SQLPLUS, and type @<LFMT Server Install Directory>\utilities\dbscripts\lfmdb_XXXXX_ora.sql.

Microsoft SQL

1. Refer to the MSSQL documentation to install the MSSQL Database Management System on the host machine that
corresponds to the Host that you want to create the Database that will be used by LFMT.

2. Initialize the database by executing the following script:

lfmdb_XXXXX_mssql.sql , available in the following folder:

<LFMT Server Install Directory>/utilities/dbscripts/

Log File Management Tool Deployment and User's Guide 43

Log File Management Tool General Deployment Deployment of Workbench Agent for LFMT 8.5.1

Deployment of Workbench Agent for LFMT 8.5.1

Tip
Before working with Workbench Agent, please refer to the Software Requirements section.

Important
Workbench Agent (WBAgent) must be installed on all the hosts running Genesys Platform
applications from which you want to collect log files. When a new WBAgent is deployed to the
environment, or when any configuration changes are made to an WBAgent, the LFMT Collector
must be restarted for the changes to be accepted by the LFMT.

The following directories in the Workbench installation package contain the Workbench Agent templates:

• For Linux: /templates

• For Windows: \templates

Important
The Workbench Agent can be deployed manually or by using the Agent Mass Deployer. The Mass
Deployer is included within the utilities directory found inside the LFMT Collector working directory.
If you use the Mass Deployer, you do not need to provision the Workbench Agent application in
GAX, as this will be done automatically during the deployment process. Please see the
“Deployment of Workbench Agent for LFMT 8.5.1” section for further details..

Provisioning the Workbench Agent

1. Log into GAX, and navigate to Configuration Manager.

2. In the Environment section, select Application Templates.

3. In the Application Templates section, select New.

4. In the New Properties pane, select Import Application Template.

5. In the Import Application Template dialog, click the Choose File button and navigate to the CC_Agent.apd
template. Select the template and keep the template name as “CC_Agent”. If the name is not "CC_Agent", please
change the name to "CC_Agent". This is important for the Collector to identify the agents within the environment. Click
the OK button to confirm the template import.

Log File Management Tool Deployment and User's Guide 44

Log File Management Tool General Deployment Deployment of Workbench Agent for LFMT 8.5.1

6. In the New Properties pane, click Save to save the new application template.

7. Once the application template has been imported, navigate to Configuration Manager.

8. In the Environment section, select Applications.

9. In the Applications section, select New.

10. In the New Properties pane, complete the following (some of these are temporary values and will be updated once the
actual Workbench Agent software has been installed on the desired host)::

a. In the General tab, enter a name for the Workbench Agent application in the Name field.

b. Click on the Template field and navigate to the application template created above.

c. In the Working Directory field, enter "."

d. In the Command Line field, enter "." .

e. Click on the Host field and navigate to the host where Workbench Agent will be installed.

f. In the Application Options tab, review and configure the Workbench Agent options.

Tip
For more information on the Workbench Agent configuration options, please refer to the
Workbench
Agent Configuration Options section

g. In the Ports tab, add the following listening ports: default = <an open port on the Workbench Agent host>
(select whether this should be a Secured port or an Unsecured port)

h. In the Permissions tab, grant the SYSTEM account (or the defined “Login As” account) full control

i. Select the Save button to save the new application

Important
If the “default” port identified above is selected to be Secured, the LFMT Collector(s) will
communicate with this Agent using TLS, otherwise, the communication will be Non-TLS.

Installing the Workbench Agent

The following directories in the Workbench Agent component contain the installation packages:

• For Linux, /linux/bX/ip

• For Windows, \windows\bX\ip

Log File Management Tool Deployment and User's Guide 45

Log File Management Tool General Deployment Deployment of Workbench Agent for LFMT 8.5.1

Installing the Workbench Agent on Linux

1. In the directory to which the LFMT Agent installation package was copied, execute the install.sh script.

2. On the Welcome screen, press Enter to continue.

3. Read the Genesys Terms and Conditions, and enter Y to accept.

4. Enter the Workbench Server application name (i.e. "Workbench_Server") defined in GAX (Configuration Server) and
click Next.

Important
Workbench Server is optional; please enter "Workbench_Server" to progress if Workbench is
not deployed.

5. Enter the Host name and Port of the Primary Configuration Server.

6. Enter the destination folder where the Workbench Agent application will be installed, and click Next.

7. After the installation completes, go to the Workbench Agent installation directory and start the Workbench Agent by
running the command wbagent_startup.sh -host <cfghost> -port <cfgport> -app <wbAgentapp> where:

a. <cfghost> is the IP address of the Configuration Server

b. <cfgport> is the port used to connect to the Configuration Server

c. <wbAgentapp> is the name of the Workbench Agent application you created

Installing the Workbench Agent on Windows

1. In the directory to which the Workbench Agent installation package was copied, double-click setup.exe to start the
installation.

2. On the Welcome screen, press Enter to continue.

3. Read the Genesys Terms and Conditions, and enter Y to accept.

4. Enter the Workbench Server application name (i.e. "Workbench_Server") defined in GAX (Configuration Server) and
click Next.

Important
Workbench Server is optional; please enter "Workbench_Server" to progress if Workbench is
not deployed.

5. Enter the Host name and Port of the Primary Configuration Server.

6. Enter the destination folder where the Workbench Agent application will be installed, and click Next.
7. After the installation completes, go to the Workbench Agent installation directory and start the Workbench Agent by
running the command startServer.bat

Log File Management Tool Deployment and User's Guide 46

Log File Management Tool General Deployment Deployment of Workbench Agent for LFMT 8.5.1

Important
You can also use GAX to start and stop the Workbench Agent.

Configuring LFMT Collector for use with the Workbench Agent

1. LFMT Collectors automatically identify any agents configured in your environment, but port information requires to be
updated based on the type of communication between the LFMT Collector and the associated Workbench Agent

2. Log into GAX, and navigate to Configuration Manager

3. From the Environment section, select Applications

4. In the Applications section, select the LFMT Collector application

5. In the Ports tab, add if not already present

*ftmessaging = <an open port on the LFMT Collector host> (this port will be used by agents that will transf
*sftmessaging = <an open port on the LFMT Collector host> (this port will be used by agents that will encry

6. Select the Save button to save changes to the application

Important
• Ensure that the ftmessaging port is identified as an “Unsecured” port in its properties

• Ensure that the sftmessaging port is identified as a “Secured” port in its properties

7. Repeat the above steps for all LFMT Collector applications in your environment.

Verifying the Workbench Agent installation

After completing the installation of the Workbench Agent, its configuration should be verified through the GAX
interface.

1. Log into GAX, and navigate to Configuration Manager

2. From the Environment section, select Applications

3. In the Applications section, locate and open the Workbench Agent application

4. In the General tab, verify that the following parameters have been updated by the installation process.

*Working Directory: The Workbench Agent installation path

*Command Line: agent_startup.bat or ./agent_startup.sh
*Command Line Arguments: -app <Workbench Agent Application Name> -host <Configuration Server Host> -por

Log File Management Tool Deployment and User's Guide 47

Log File Management Tool General Deployment Deployment of Workbench Agent for LFMT 8.5.1

Important
The backuphost and backupport options are optional. These options are read from the Command Line
Arguments field of the Workbench Agent object only.

Log File Management Tool Deployment and User's Guide 48

Log File Management Tool General Deployment Installing Workbench Agent (Mass Deployment) for LFMT 8.5.1

Installing Workbench Agent (Mass Deployment)

for LFMT 8.5.1
The Mass Deployer allows the installation of the Workbench Agent to multiple hosts. It includes the following
elements:

Mass Deployer Central Host The server where the mass deployer will be executed. It connects to the Remote
hosts via different protocols depending on the Remote Host operating system. It requires a configuration file that
provides credentials and connection details about the remote hosts.

Remote Hosts The hosts where the Workbench agent will be deployed. The agent will be extracted in the working
directory specified in the Mass Deployer configuration file.

Configuration Server The properties of Remote hosts are retrieved from this server, including their IP address in
order to connect to them. Every Workbench Agent deployed in Remote Hosts is provisioned in this Configuration
Server.

Log File Management Tool Deployment and User's Guide 49

Log File Management Tool General Deployment Installing Workbench Agent (Mass Deployment) for LFMT 8.5.1

Prerequisites
Software Requirements The Central and Remote hosts should have one of the following operating systems:

Windows

• Windows Server 2008 R2

• Windows Server 2012

Linux

• Red Hat Enterprise Linux (RHEL) 6 or later

Log File Management Tool Deployment and User's Guide 50

Log File Management Tool General Deployment Installing Workbench Agent (Mass Deployment) for LFMT 8.5.1

Important
• If the central host is a Linux host it will only be able to mass deploy the agent to Linux Remote hosts.

• If the central host is a Windows host, it can mass deploy to other Windows and Linux Remote hosts.

• If a Workbench Agent is already deployed to a remote host, the agent must be uninstalled prior to
running the Mass Deployer. This is a limitation that will be addressed in a future release.

Before using the Mass Deployer, the following software must be installed in the central and remote hosts:

• Java™ Platform Standard Edition Runtime Environment 8, 64-bit (JRE™ 8)

• If using a Windows Server, make sure that Powershell is enabled. The Mass Deployer requires Powershell v2.0 or a
later version.

Communication Requirements

Linux Mass Deployer Central Host:

• The central host should be able to reach the Linux remote hosts using SSH.

Linux Remote hosts:

• The remote hosts where the agent will be deployed should be able to receive SSH connections from the Mass
Deployer Host. An SSH Server (e.g. OpenSSH) should be enabled. Commands and files will be sent using SSH and
SFTP respectively.

Windows Mass Deployer Central Host:

• Powershell should be enabled. The Mass Deployer requires v2.0 or a later version.

• The remote hosts should be included in the Trusted Hosts List of the central host in order to correctly connect to them
using Powershell Remoting (Windows Remote Management – WinRM).

• The Mass Deployer will try to temporarily modify the trusted host list in order to connect to the remote hosts. To do
this, the Mass Deployer should be executed from a command prompt with administrative privileges. Otherwise,
the Mass Deployer will continue to execute, but the trusted host list should be modified by the user before starting
the Mass Deployer.

• You can use the following command replacing the “*” with the list of remote host IP addresses. The “*” would
indicate that all hosts are trusted.

Set-Item WSMan:\localhost\Client\TrustedHosts -Value "*" –Force

Windows Remote Hosts:

• Powershell should be enabled, v2.0 or later is required.

• The remote hosts should be able to receive remote Powershell commands. The WinRM service should be enabled to
allow this remote access. A way of enabling it is running the following command from Powershell with administrative
privileges:

• Enable-PSRemoting –Force

Log File Management Tool Deployment and User's Guide 51

Log File Management Tool General Deployment Installing Workbench Agent (Mass Deployment) for LFMT 8.5.1

• This will start or restart the WinRM service and create the listener to accept requests from any IP address.

• The Mass Deployer will copy the Installation Package and extract it in a folder called “tmp_install” inside the provided
working directory. If it doesn’t exist, the Mass Deployer will try to create it.

Execute the following command in Powershell on the central host to ensure that WinRM remoting is properly
configured in a remote host and is accepting requests:

Test-WSMan -ComputerName <Remote Host IP address>

It should print an output similar to:

• wsmid: http://schemas.dmtf.org/wbem/wsman/identity/1/wsmanidentity.xsd

• ProtocolVersion: http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd

• ProductVendor: Microsoft Corporation

• ProductVersion: OS: 0.0.0 SP: 0.0 Stack: 3.0

The “Stack” version will change depending on the remote host WinRM service.

Installing the Mass Deployer

The Mass Deployment software is available in the Utilities folder of the Collector installation directory, post
installation of the Collector.

For Example: C:\Program Files\GCTI\collector\LFMT_Collector_8.5.100.05_Alt\utilities\agent_mass_deployer

The working directory of the Mass Deployer in the central host should have the following structure:

/<Mass Deployer working directory>

Mass Deployer-x.x.xxx.xx.jar
/deployments Stores the silent install configuration files for each remote host where the agent is deplo
/silent install
genesys silent.ini A template for the silent install configuration file.
config.json The Mass Deployer configuration file. See “Configuring the Mass Deployer” for details a
WB Agentg x.x.xxxx.xx.zip The agent ZIP distribution
/lib Directory with the Mass Deployer runtime dependencies

Configuring the Mass Deployer

The configuration of the Mass Deployer is stored in a JSON file used by the tool at runtime.

The configuration file has the following sections:

{ “config_server” : CfgServer,

“app_template_name” : <string>,

Log File Management Tool Deployment and User's Guide 52

Log File Management Tool General Deployment Installing Workbench Agent (Mass Deployment) for LFMT 8.5.1

“app_name_prefix” : <string>,

“app_parent_folder” : <string>,

“deployments”:Deployments,

“agent” : <string>,

“linux_ip_path” : <string>,

“windows_ip_path” : <string>,

“wb_server_app” : <string>,

“global_listening_ports” : GlobalListeningPorts,

“global_options” : GlobalOptions,

“windows_global_options” : WindowsGlobalOptions,

“linux_global_options” : LinuxGlobalOptions }

CfgServer section:

Includes the connection parameters required to interact with the Configuration Server.

Required: Yes

{ "ip_addr": <string>

"port" : <number>,

"username" : <string>,

"password" : <string>,

"app_client_name" : <string> }

• ip_addr - The IP address of the Configuration Server

• port - The port where the Configuration Server is listening

• username -The username used to connect to Configuration Server

• password -The password of the associated username

• app_client_name - The Application object used to connect to Configuration Server

app_template_name The name of the Workbench Agent Application Template. This template will be used to
provision all agents. Required: If provisioning to Configuration Server.

Log File Management Tool Deployment and User's Guide 53

Log File Management Tool General Deployment Installing Workbench Agent (Mass Deployment) for LFMT 8.5.1

app_name_prefix The prefix that will be used to name the new Workbench Agent Applications that will be
provisioned. The name of the Application will be <app_name_prefix><Remote Host name> Required: If provisioning
to Configuration Server.

app_parent_folder The folder where the application object will be stored in Configuration Server. If this folder
doesn’t exist, the Mass Deployer will try to create it. If not provided the application will be created in the root of the
Applications section. Required: No

Deployments section:

Includes the properties of the hosts where the Agent will be deployed. It is a list with one object per deployment.

Required: Yes

[ { "cfg_server_host_name": <string>

"username" : <string>,

"password" : <string>,

" working_dir" : <string>

}, . . . ]

• cfg_server_host_name - The name of the remote host as it appears in Configuration Server

• username - The username used to connect to the remote host using SSH or a Powershell Remote session.

• password - The password of the username

• working_dir - The directory where the agent will be extracted and from where it will be executed

NOTE: Make sure that each host in Configuration Server has an Operating System in the “OS Version” property.
This is used by the Mass Deployer to decide how to connect to the remote host.

agent

Path to the Workbench Agent distribution. If deploying from Windows, the path should have double backslashes (\\).
For example: /home/genesys/WBAgent_8.5.000.31.zip.

Required: If deploying to remote hosts.

linux_ip_path

Relative path to the Linux installation package directory inside the agent package. For example: /IPs/
WBAgent_UNIX_8.5.000.31/linux/b1/ip.

Required: If deploying to remote hosts.

windows_ip_path

Log File Management Tool Deployment and User's Guide 54

Log File Management Tool General Deployment Installing Workbench Agent (Mass Deployment) for LFMT 8.5.1

Relative path to the Windows installation package directory inside the agent package. It requires double
blackslashes. For example: \\IPs\\WBAgent_Windows_8.5.000.31\\windows\\b1\\ip.

Required: If deploying to remote hosts.

wb_server_app

Name of the Workbench Server application that will interact with the Agent being deployed/provisioned, as it
appears in Configuration Server. This is used during the installation of the Workbench Agent.

Required: If deploying to remote hosts.

GlobalListeningPorts section:

The list of listening ports that will be used when provisioning the Workbench Agents in Configuration Server. Each
port is a JSON Object with an ID and a value.

Required: If provisioning to Configuration Server.

[ { "ID": <string>

"value" : <number>

}]

• ID - A unique identification for each port

• value - The listening port number

GlobalOptions section:

A JSON object with the options that will be assigned to the Workbench Agents being provisioned. Options are
grouped by sections and all values should be strings.

Required: If provisioning to Configuration Server.

{ <section_name_1> :

{ <option_name_1>: <option_value_1>,

<option_name_2>: <option_value_2>,

… <option_name_n>: <option_value_n>

}, <section_name_2> :

{ <option_name_1>: <option_value_1>,

… <option_name_n>: <option_value_n>

}, …, <section_name_n> :

Log File Management Tool Deployment and User's Guide 55

Log File Management Tool General Deployment Installing Workbench Agent (Mass Deployment) for LFMT 8.5.1

{ <option_name_1>: <option_value_1>,

… <option_name_n>: <option_value_n>

}}

For example, these options:

• Option: log/all – Value: C:\logs\workbench_logs

• Option: log/expire – Value: 20

• Option: general/customer_name – Value: default

Would be configured as follows:

{ “log” :

{ “all”: “C:\\logs\\workbench_logs”,

“expire”: “20” }, “general” : { “customer_name”: “default” } }

WindowsGlobalOptions section:

A JSON object with the options that will be assigned to the Workbench Agents if being provisioned to a Windows
host. The structure of this JSON object is the same as the one described in the GlobalOptions section. If the same
property is set in both the GlobalOptions and the WindowsGlobalOptions section, the latter will be used.

Required: No.

LinuxGlobalOptions section:

A JSON object with the options that will be assigned to the Workbench Agents if being provisioned to a Linux host.
The structure of this JSON object is the same as the one described in the GlobalOptions section. If the same
property is set in both the GlobalOptions and the LinuxGlobalOptions section, the latter will be used.

Required: No.

Executing the Mass Deployer

Run the Mass Deployer by executing the following command from the directory where the executable was placed:

java -jar <MassDeployer-x.x.xxx.xx.jar> , followed by these arguments:

Short argument: -c

Long argument: --cfgFile

Mandatory: Yes

Log File Management Tool Deployment and User's Guide 56

Log File Management Tool General Deployment Installing Workbench Agent (Mass Deployment) for LFMT 8.5.1

Valid Values: A path to a valid configuration JSON file

Description: Path to the Mass Deployment Configuration file

Short argument: -m

Long argument: --mode

Mandatory: Yes

Valid Values: provision, deploy, provision_deploy

Description: Mass Deployment mode.

*provision: Connects to configuration server and provisions the Agent apps in the
configuration file.

*deploy: Copies the agent to the remote hosts and installs it.

*provision_deploy: Provisions the agent apps in Configuration server and then installs
the agents on the remote hosts.

Short argument: -e

Long argument: --failOnError

Mandatory: No

Description: Cancels the execution if one of the deployments fail. If not included, the
mass deployer will continue deploying to other hosts even if one of the previous
deployments failed.

Short argument: -o

Long argument: --overwriteApps

Mandatory: No

Description: Overwrites the Config Server Apps if they are already provisioned. If not
included, the mass deployer will fail if an application previously existed.

Log File Management Tool Deployment and User's Guide 57

Log File Management Tool General Deployment Installing Workbench Agent (Mass Deployment) for LFMT 8.5.1

Examples: java –jar MassDeployer-x.x.xxx.xx.jar –c /home/genesys/MD/config.json –m provision_deploy

java –jar MassDeployer-x.x.xxx.xx.jar –c C:\Users\genesys\MD\config.json –m provision –e –o

java –jar MassDeployer-x.x.xxx.xx.jar –-cfgFile /home/genesys/MD/config.json –m provision_deploy --failOnError

Be aware that:

• The Mass Deployer executes the installer of the Workbench Agent in silent mode.

• This version of the Mass Deployer will not monitor the outcome of the silent installation. This has to be done by
checking the genesys_install_result.log file that is generated in the working directory of the Agent App.

Important
• As a known issue, the Mass Deployer might not work properly if there are disconnected Network
drives in the central host. Try removing these network drives before running the Mass Deployer. If
you see an error message similar to: “Attempting to perform the InitializeDefaultDrives operation on
the 'FileSystem' provider failed” when opening a new Powershell terminal, then the Mass Deployer
will not behave appropriately.

• It has also been observed in some occasions that power shell processes will remain active after the
Mass Deployer has finished executing. Please check the running applications after finishing
deployment and manually clean-up any open power shell processes

Log File Management Tool Deployment and User's Guide 58

Log File Management Tool Configuration Options Installing Workbench Agent (Mass Deployment) for LFMT 8.5.1

Log File Management Tool Configuration Options

This section describes the configuration options used to configure the Log File Management Tool (LFMT).

Log File Management Tool Deployment and User's Guide 59

Log File Management Tool Configuration Options LFMT Host Object Configuration Options

LFMT Host Object Configuration Options

This section contains options used to configure the hosts to which LFMT Collector will connect. Unless otherwise
stated, all configuration options are set using GAX in the Options tab of the Host object.

lfmt Section
The options in this section correspond to the host object to which LFMT Collector will connect.

This section must be called lfmt.

nic

Default Value: No default value

Valid Values: A valid host name
Changes Take Effect: At the next execution LFMT Collector.

Specifies the hostname/IP of the Network Interface Card (NIC). Use this option if you are using a dedicated network
interface for file transfer from this host.

Log File Management Tool Deployment and User's Guide 60

Log File Management Tool Configuration Options LFMT GAX Configuration Options

LFMT GAX Configuration Options

This section contains options used to configure the GAX for use with LFMT. Unless otherwise stated, all
configuration options are set using GAX in the Application Options tab of the GAX object.

lfmt Section
This section contains options for general configuration of the application.

This section must be called lfmt.

use_lfm_extension
Default Value: false
Valid Values: true or false
Changes Take Effect: After restart of GAX.

If set to true, the created log file package(s) will use the .lfm extension else .zip extension is used.

ftp_host
Default Value: No default value
Valid Values: Valid (S)FTP/S IP/hostname address
Changes Take Effect: After restart of GAX.

Specifies the IP/hostname of the default (S)FTP/S server.

ftp_port
Default Value: No default value
Valid Values: Valid (S)FTP/S port number, must be an integer
Changes Take Effect: After restart of GAX.

Specifies the default port of the (S)FTP/S server.

ftp_pwd
Default Value: No default value
Valid Values: Valid (S)FTP/S password
Changes Take Effect: After restart of GAX.

Specifies the password of the (S)FTP/S server.

Log File Management Tool Deployment and User's Guide 61

Log File Management Tool Configuration Options LFMT GAX Configuration Options

ftp_user
Default Value: No default value
Valid Values: Valid (S)FTP/S username
Changes Take Effect: After restart of GAX.

Specifies the username of the (S)FTP/S server.

Log File Management Tool Deployment and User's Guide 62

Log File Management Tool Configuration Options LFMT Indexer Configuration Options

LFMT Indexer Configuration Options

This section contains options used to configure the LFMT Indexer. Unless otherwise stated, all configuration options
are set using GAX in the Application Options tab of the LFMT Indexer object.

app_config Section
This section contains options for general configuration of the application.

This section must be called app_config.

app_type
Default Value: indexer
Valid Values: indexer
Changes Take Effect: After restart of LFMT Indexer.

Specifies the type of Generic Genesys Server this application represents.

cls_location
Default Value: No default value
Valid Values: Valid path through the system (i.e. "C:\CLS")
Changes Take Effect: After restart of LFMT Indexer.

Specifies the path (local to Collector Host and not a mapped network drive) through the system to the folder or
directory where the CLS is located. RSYNC will transfer files to this location. For example, C:/GCTI/CLS.

retention_period
Default Value: 3
Valid Values: Any positive integer
Changes Take Effect: After restart of LFMT Indexer.

Specifies the number of days that the unmodified files are stored in CLS before being they are deleted permanently.
This value should be greater than or equal to the value of the LFMT Collector collection_period option.

log Section
This section contains all options relating to creating, viewing, and otherwise using the Centralized Log facility in
Genesys software.

Log File Management Tool Deployment and User's Guide 63

 Log File Management Tool Configuration Options LFMT Indexer Configuration Options

This section must be called log.

all
Default value: No default value
Valid Values: [filename]
Changes Take Effect: After restart of LFMT Indexer.

Specifies the file location to which the application sends all log events.

expire
Default value: 10
Valid Values: [number] Specify a number from 1–1000.
Changes Take Effect: After restart of LFMT Indexer.

Determines how many log files are kept before they are deleted.

segment
Default value: 5000
Valid Values: [number] - Specify a value in kilobytes.
Changes Take Effect: After restart of LFMT Indexer.

Determines the rollover size of the log files.

verbose
Default value: all
Valid Values:

• all - All log events are printed.

• trace - All log events are printed.

• debug - DEBUG, INFO, WARN, FATAL, and ERROR log events are printed.

• info - INFO, WARN, FATAL, and ERROR log events are printed.

• warn - WARN, FATAL, and ERROR log events are printed.

• error - FATAL and ERROR log events are printed.

• fatal - Only FATAL log events are printed.

• off - No log events are printed.

Changes Take Effect: After restart of LFMT Indexer.

Specifies the host IP address of the configuration server.

Log File Management Tool Deployment and User's Guide 64

Log File Management Tool Configuration Options LFMT Indexer Configuration Options

thread_setting Section
This section defines the number of threads required for the indexed to process files in parallel.

This section must be called thread_setting.

max_queue
Default value: 40
Valid Values: Any integer
Changes Take Effect: After restart of LFMT Indexer.

Specifies the number of files to keep in the queue when all the threads are busy before the indexer starts
generating exceptions.

max_threads
Default value: 40
Valid Values: Any integer
Changes Take Effect: After restart of LFMT Indexer.

Specifies the maximum number of threads required to process the files in parallel.

min_threads
Default value: 20
Valid Values: Any integer
Changes Take Effect: After restart of LFMT Indexer.

Specifies the minimum number of threads required to process files in parallel.

Log File Management Tool Deployment and User's Guide 65

Log File Management Tool Configuration Options LFMT Collector Configuration Options

LFMT Collector Configuration Options

This section contains options used to configure the LFMT Collector. Unless otherwise stated, all configuration
options are set with GAX in the Application Options tab of the LFMT Collector object.

app_config Section
This section contains options for general configuration of the application.

This section must be called app_config.

app_type
Default Value: collector
Valid Values: collector
Changes Take Effect: After restart of LFMT Collector.

Specifies the type of Generic Genesys Server this application represents.

cls_location
Default Value: No default value
Valid Values: Valid path through the system (i.e. "C:\CLS")
Changes Take Effect: After restart of LFMT Collector.

Specifies the path (local to the Collector Host and not a mapped network drive) through the system to the folder or
directory where the CLS is located. The Workbench Agent will transfer files to this location. For example,
C:/GCTI/CLS.

collection_period
Default Value: 3
Valid Values: Any positive integer
Changes Take Effect: After restart of LFMT Collector.

Specifies the maximum number of historical days that LFMT Collector will attempt to collect log files. This value
should less than or equal to the value of the LFMT Indexer retention_period option.

collection_timeout_mins
Default Value: 2
Valid Values: Any positive integer
Changes Take Effect: After restart of LFMT Collector.

Log File Management Tool Deployment and User's Guide 66

Log File Management Tool Configuration Options LFMT Collector Configuration Options

This option controls the length of time in minutes for which a transfer should be cancelled if the global collection
request has not fully completed. For example, if 5 applications are selected in a collection request (scheduled or
manual), the logs from all 5 of these applications must be fully transferred to the LFMT host before this time-out
period elapses.

file_transfer_timeout
Default Value: 5
Valid Values: Any positive integer
Changes Take Effect: After restart of LFMT Collector.

This option controls when the connection between the collector and the workbench agent is terminated because of
timeout conditions. If terminated prematurely, the transfer of files from agent(s) will be terminated and not all files
may be transferred.

max_disk_utilization
Default Value: 85
Valid Values: Any positive integer
Changes Take Effect: After restart of LFMT Collector.

Specifies the maximum percentage of HDD space that will be utilized for storing log files in the CLS. The default
value 85 indicates that, up to 85% of the HDD space will be used. After reaching this threshold, further transfers will
not be executed.

package_location
Default Value: No default value
Valid Values: Valid path through the system (network)
Changes Take Effect: After restart of LFMT Collector.

Specifies the path through the system to the folder or directory where the LFMT Collector packages will be created.

package_retention
Default Value: 2
Valid Values: Any positive integer
Changes Take Effect: After restart of LFMT Collector.

Specifies the number days that LFMT Collector will keeps log file packages created from the LFMT Client before
deletion.

server_max_connections
Default Value: 1024
Valid Values: Any positive integer greater than 0.
Changes Take Effect: After restart of LFMT Collector.

Identifies the total number of connections allowed from all LFMT agents to transfer files.

Log File Management Tool Deployment and User's Guide 67

 Log File Management Tool Configuration Options LFMT Collector Configuration Options

tmp_folder_location
Default Value: OS temp folder (if no option configured)
Valid Values: Valid path through the system (network)
Changes Take Effect: After restart of LFMT Collector.

Specifies the path through the system to the folder or directory where the temporary files for LFMT are to be
located. For example, C:/GCTI/Collector_tmp.

log Section
This section contains all options relating to creating, viewing, and otherwise using the Centralized Log facility in
Genesys software.

This section must be called log.

all
Default value: No default value
Valid Values: [filename]
Changes Take Effect: After restart of LFMT Indexer.

Specifies the file location to which the application sends all log events.

expire
Default value: 10
Valid Values: [number] Specify a number from 1–1000.
Changes Take Effect: After restart of LFMT Indexer.

Determines how many log files are kept before they are deleted.

segment
Default value: 5000
Valid Values: [number] - Specify a value in kilobytes.
Changes Take Effect: After restart of LFMT Indexer.

Determines the rollover size of the log files.

verbose
Default value: all
Valid Values:

• all - All log events are printed.

• trace - All log events are printed.

Log File Management Tool Deployment and User's Guide 68

 Log File Management Tool Configuration Options LFMT Collector Configuration Options

• debug - DEBUG, INFO, WARN, FATAL, and ERROR log events are printed.

• info - INFO, WARN, FATAL, and ERROR log events are printed.

• warn - WARN, FATAL, and ERROR log events are printed.

• error - FATAL and ERROR log events are printed.

• fatal - Only FATAL log events are printed.

• off - No log events are printed.

Changes Take Effect: After restart of LFMT Indexer.

Specifies the host IP address of the configuration server.

security Section
This section contains all options relating to securing communication between the LFMT Collector and the
Workbench Agent. The section is optional and is required only if the communication between the Workbench and
the LFMT Collector has to be secured. This section must be called security.

mutual_tls
Default value: None
Valid Values: true,false
Changes Take Effect: After restart of LFMT Collector.
Indicates whether mutual TLS is enabled for messaging and file transfer.

provider
Default value: None
Valid Values: JKS,
Changes Take Effect: After restart of LFMT Collector.
The key provider.

protocol
Default value: None
Valid Values: TLSv1.2
Changes Take Effect: After restart of LFMT Collector.
Identifies the protocol to be used for the SSL communication between the LFMT Collector and the LFMT Agent.

enabled_ciphers
Default value: None
Valid Values: TLS_RSA_WITH_AES_128_CBC_SHA
Changes Take Effect: After restart of LFMT Collector.
Identifies the cipher suite to be used for TLS communication between the LFMT Collector and LFMT Agent.

Log File Management Tool Deployment and User's Guide 69

Log File Management Tool Configuration Options LFMT Collector Configuration Options

security.keystore Section
The security.keystore section of the LFMT Collector application options is used to identify the keystore properties
through which LFMT Collector will load the necessary keys for secure communications.
This section must be called security.keystore.

path
Default value: No default value
Valid Values: A file path to the keystore located on the host. Note: The security certificates must be generated
using the SHA-2 secure hash algorithm.
Changes Take Effect: After restart of LFMT Collector.
Identifies the path to the local keystore to be used by LFMT Agent to load the necessary keys.

password
Default value: No default value
Valid Values: A valid password associated with the keystore defined in the path option of the security.keystore
section
Changes Take Effect: After restart of LFMT Collector.
The password to be used by LFMT Agent to access the keystore.

security.truststore Section
The security.truststore section of the LFMT Collector application options is used to identify the truststore properties
through which LFMT Collector will load the necessary certificates for secure communications.
This section must be called security.truststore.

path
Default value: No default value
Valid Values: A file path to the truststore located on the host. Note: The security certificates must be generated
using the SHA-2 secure hash algorithm.
Changes Take Effect: After restart of LFMT Collector.
Identifies the path to the truststore to be used by LFMT Collector to load the necessary certificates.

password
Default value: No default value
Valid Values: A valid password associated with the truststore identified in the path option of the security.truststore
section
Changes Take Effect: After restart of LFMT Collector.
The password to be used by LFMT Collector to access the truststore.

Log File Management Tool Deployment and User's Guide 70

Log File Management Tool Configuration Options LFMT DAP Object Configuration Options

LFMT DAP Object Configuration Options

This section contains options used to configure the DAP to which LFMT Client/Indexer/Collector will use to connect
to an LFMT Database. Unless otherwise stated, all configuration options are set with GAX in the Application
Options tab of the DAP object.

lfmt Section
The options in this section correspond to the DAP to which LFMT Client/Indexer/Collector will use to connect to an
LFMT Database.

This section must be called lfmt.

site

Default Value: No default value

Valid Values: A unique identifier for the site where an LFMT Indexer/Collector pair resides.
Changes Take Effect: After a restart of the LFMT Client (GAX), LFMT Indexer, and LFMT Collector (all must be
restarted).

Names the site where an LFMT Indexer/Collector pair resides. Used during configuration of LFMT in the Site
Configuration Tab of the LFMT Client.

use_oracle_service (optional)

Default Value: False

Valid Values: True, False.
Changes Take Effect: After a restart of the LFMT Client (GAX), LFMT Indexer, and LFMT Collector (all must be
restarted).

Indicates that an Oracle database connection is to be made using a service name rather than an SID. The name of
the service is indicated by the “Database Name” property of the Database Access Point.

Log File Management Tool Deployment and User's Guide 71

Log File Management Tool Configuration Options Workbench Agent Configuration Options (for LFMT 8.5.1)

Workbench Agent Configuration Options (for

LFMT 8.5.1)
This section contains options used to configure the Workbench Agent. Unless otherwise stated, all configuration
options are set using GAX in the Application Options tab of the LFMT Agent object.

app_config Section
This section contains options for general configuration of the application. This section must be called app_config.

agent_max_open_requests
Default Value: 4096
Valid Values: Any positive integer greater than 0 and a power of 2. (i.e 1024, 2048, 4096 etc.)
Changes Take Effect: After restart of Workbench Agent.
Identifies the maximum number of open requests accepted into the connection pool of the workbench agent.

agent_max_outgoing_connections
Default Value: 4
Valid Values: Any positive integer greater than 0
Changes Take Effect: After restart of Workbench Agent.
Identifies the maximum number of concurrent outgoing connections from the workbench agent.

agent_max_pipelining_limit
Default Value: 1
Valid Values: Any positive integer greater than 0
Changes Take Effect: After restart of Workbench Agent.
Identifies the maximum number of requests that are accepted (and dispatched to the collector) on one single
connection before the first request is completed.

security Section
This section contains all options relating to securing communication between the LFMT Collector and the
Workbench Agent. The section is optional and is required only if the communication between the LFMT Collector
and the Workbench Agent has to be secured. This section must be called security.

Log File Management Tool Deployment and User's Guide 72

Log File Management Tool Configuration Options Workbench Agent Configuration Options (for LFMT 8.5.1)

mutual_tls
Default value: None
Valid Values: true,false
Changes Take Effect: After restart of Workbench Agent.
Indicates whether mutual TLS is enabled for messaging and file transfer.

provider
Default value: None
Valid Values: JKS
Changes Take Effect: After restart of Workbench Agent.
The key provider.

protocol
Default value: None
Valid Values: TLSv1.2
Changes Take Effect: After restart of Workbench Agent.
Identifies the protocol to be used for the SSL communication between the LFMT Collector and the Workbench
Agent.

enabled_ciphers
Default value: None
Valid Values: TLS_RSA_WITH_AES_128_CBC_SHA
Changes Take Effect: After restart of Workbench Agent.
Identifies the cipher to be used for SSL communication between the LFMT Collector and Workbench Agent.

security.keystore Section
The security.keystore section of the Workbench Agent application options is used to identify the keystore properties
through which Workbench Agent will load the necessary keys for secure communications. This section must be
called security.keystore.

path
Default value: No default value
Valid Values: A file path to the keystore located on the host
Changes Take Effect: After restart of Workbench Agent.
Identifies the path to the local keystore to be used by Workbench Agent to load the necessary keys.

password
Default value: No default value
Valid Values: A valid password associated with the keystore defined in the path option of the security.keystore

Log File Management Tool Deployment and User's Guide 73

Log File Management Tool Configuration Options Workbench Agent Configuration Options (for LFMT 8.5.1)

section
Changes Take Effect: After restart of Workbench Agent.
The password to be used by Workbench Agent to access the keystore.

security.truststore Section
The security.truststore section of the Workbench Agent application options is used to identify the truststore
properties through which Workbench Agent will load the necessary certificates for secure communications. This
section must be called security.truststore.

path
Default value: No default value
Valid Values: A file path to the truststore located on the host
Changes Take Effect: After restart of Workbench Agent.
Identifies the path to the truststore to be used by Workbench Agent to load the necessary certificates.

password
Default value: No default value
Valid Values: A valid password associated with the truststore identified in the path option of the security.truststore
section
Changes Take Effect: After restart of Workbench Agent.
The password to be used by Workbench Agent to access the truststore.

log Section
This section contains all options relating to creating, viewing, and otherwise using the Centralized Log facility in
Genesys software. This section must be called log.

all
Default value: No default value
Valid Values: [filename]
Changes Take Effect: After restart of Workbench Agent.
Specifies the file location to which the application sends all log events.

expire
Default value: 10
Valid Values: [number] Specify a number from 1–1000.
Changes Take Effect: After restart of Workbench Agent.
Determines how many log files are kept before they are deleted.

Log File Management Tool Deployment and User's Guide 74

Log File Management Tool Configuration Options Workbench Agent Configuration Options (for LFMT 8.5.1)

segment
Default value: 5000
Valid Values: [number] - Specify a value in kilobytes.
Changes Take Effect: After restart of Workbench Agent.
Determines the rollover size of the log files.

verbose
Default value: all
Valid Values:

• all - All log events are printed.

• trace - All log events are printed.

• debug - DEBUG, INFO, WARN, FATAL, and ERROR log events are printed.

• info - INFO, WARN, FATAL, and ERROR log events are printed.

• warn - WARN, FATAL, and ERROR log events are printed.

• error - FATAL and ERROR log events are printed.

• fatal - Only FATAL log events are printed.

• off - No log events are printed.

Changes Take Effect: After restart of Workbench Agent.

Specifies the host IP address of the configuration server.

Log File Management Tool Deployment and User's Guide 75

Log File Management Tool Configuration Workbench Agent Host Object Configuration Options (for LFMT
Options 8.5.102)

Workbench Agent Host Object Configuration

Options (for LFMT 8.5.102)
This page contains options used to configure the host objects to which LFMT Collector will connect. This assumes
that the Workbench Agent is running on this host. Unless otherwise stated, all configuration options are set using
GAX in the Options tab of the Host object.

lfmt Section
This section must be called lfmt.

nic (optional)

Default Value: No default value

Valid Values: A valid network address (IP or Host) for a specific Network Interface
Changes Take Effect: After restart of the Collector and the Workbench Agent that is located on this host.

This option is configured on the Host object where the Workbench Agent is located. If the Host has a secondary
NIC dedicated for transfer of log files from the Host (using the Workbench Agent), the user can specify the same
here through this value.

Log File Management Tool Deployment and User's Guide 76

Log File Management Tool User's Guide Workbench Agent Host Object Configuration Options (for LFMT 8.5.102)

Log File Management Tool User's Guide

Once the all LFMT components have been successfully deployed, users can utilize the sections provided by the
LFMT Client to configure and control the solution. To access the LFMT Client, in a web browser, navigate to the
GAX application enabled with the LFMT Client plugin.

http://<GAX Host IP>:<GAX Port>/gax

Access to the LFMT Client will be available on both the main page and in the upper toolbar. The feature access will
be dictated by the role defined for the user of LFMT. To set the role of a given user, please see the Configuration of
Access Control for LFMT Users section.

Log File Management Tool Deployment and User's Guide 77

Log File Management Tool User's Guide Configuration of Access Control for LFMT Users

Configuration of Access Control for LFMT Users

This section describes where and how to configure role privileges to restrict/grant access to LFMT functionalities.

Role-based access control using Genesys Administration (GA)

Use these steps to enable Role-based access control in Genesys Administrator.

1. Login to GA, and select the Provisioning tab.

2. Select Environment > Application Templates in the left navigation menu.

3. Select the Genesys Administration Extension template and click Edit.

4. Click Import Metadata to import the metadata for the LFMT client application template.

5. Click Add on the “choose metadata XML file to import” dialog.

6. Select the lfmt-gax-template-metadata.xml file and click Open. The file is uploaded.

7. Click Save in the top menu to save the metadata.

8. Select Roles in the left navigation menu.

9. Click New and add a name for this role, such as LFMTTest.

10. Select the Role Privileges tab. In the Add/Remove Product section, scroll to the entry for the current Genesys
Administrator Extension – LFMT Plug-in release (such as Genesys Administrator Extension – LFMT Plug-in
8.1.3000.00) and select it. A new section called “Genensys Administrator Extension – LFMT Plug-in ” is added.

The following role privileges can be allowed/denied for the role configuration:

* Available log packages

* Collection schedules

* Create Collection Schedules

* Delete Collection Schedules

* Force log collection

* Indexing and scrubbing configurations

* Log file packaging

* Site configuration

Log File Management Tool Deployment and User's Guide 78

Log File Management Tool User's Guide Configuration of Access Control for LFMT Users

* Start scheduled collections

* Stop scheduled collections

1. Click Save in the top menu.

2. In the Roles tab, select the LFMTTest role and click Edit.

3. In the Configuration tab, expand the Members section and click Add, to add this LFMTTest role to the desired user
profiles.

4. In the list of user names, select one or more users and click Ok.

5. The selected users will be displayed in the Members list as enabled for this LFMTTest role.

6. Click Save in the top menu to save the member assignments to this role.

Role-based access control using Genesys Administration Extension

(GAX)
1. Log into GAX, and navigate to Configuration Manager.

2. From the Environment section, select Applications.

3. In the Accounts section, locate and open the Roles option.

4. Click New and add a name for this role, such as LFMTTest.

5. Go to Assigned Privileges section and look for gax-lfmt folder.

The following role privileges can be allowed/denied for the role configuration:

* Available log packages

* Collection schedules

* Create Collection Schedules

* Delete Collection Schedules

* Force log collection

* Indexing and scrubbing configurations

* Log file packaging

* Site configuration

Log File Management Tool Deployment and User's Guide 79

Log File Management Tool User's Guide Configuration of Access Control for LFMT Users

* Start scheduled collections

*Stop scheduled collections

1. After selecting the privileges click Apply button.

2. Go to Role Members section and add the users that are going to have the LFMTTest role

Log File Management Tool Deployment and User's Guide 80

Log File Management Tool User's Guide Site Configuration

Site Configuration
This section describes how to associate a specific group of hosts or application to a Site. For each Site, a separate
LFMT Indexer/Collector must exist. It is recommended that all Site hosts/applications reside in the same
geographical location.

Associating hosts or applications to a Site

1. In Genesys Administrator Extension, from the LFMT menu, select Site Configuration.

2. Choose a Site from the drop-down list.

3. Select the checkboxes beside the hosts/applications you would like to assign to the Site.

4. Click the Save button.

Log File Management Tool Deployment and User's Guide 81

Log File Management Tool User's Guide Site Configuration

If a host or application does not appear in the Site Configuration list, ensure the following requirements are
met:

• The missing application has the [log] section configured with the option all in its configuration.

• The user logged into GAX has READ permissions on the missing host/application.

Important
Only hosts/applications assigned to a site appear for lists in other LFMT Client sections.

Log File Management Tool Deployment and User's Guide 82

Log File Management Tool User's Guide Collection Schedules

Collection Schedules
This section describes to configure log file collection schedules for LFMT Collector.

Adding a LFMT Collection Schedule

1. In Genesys Administrator Extension, from the LFMT menu, select Collection Schedules.

2. Click the button in the Collection Schedules pane. The New Collection Schedule pane will
appear.

3. Select the desired applications for the new LFMT Collector schedule.

4. Provide the name, start time, time zone, collector interval (in minutes), and exception time for the new LFMT Collector
schedule.

Log File Management Tool Deployment and User's Guide 83

Log File Management Tool User's Guide Collection Schedules

Log File Management Tool Deployment and User's Guide 84

Log File Management Tool User's Guide Collection Schedules

5. Select the button to save the new LFMT Collector schedule.

Editing a LFMT Collection Schedule

1. In Genesys Administrator Extension, from the LFMT menu, select Collection Schedules.

2. Click on the text of the LFMT Collector schedule in the Collection Schedules pane. The Edit Collection
Schedule pane will appear.

3. Add/remove the desired applications from the LFMT Collector schedule as desired.

4. Edit the name, start time, time zone, collector interval (in minutes), and exception time for the LFMT Collector schedule
as desired.

Log File Management Tool Deployment and User's Guide 85

Log File Management Tool User's Guide Collection Schedules

Log File Management Tool Deployment and User's Guide 86

Log File Management Tool User's Guide Collection Schedules

5. Select the button to save changes to the LFMT Collector schedule.

Deleting a LFMT Collection Schedule

1. In Genesys Administrator Extension, from the LFMT menu, select Collection Schedules.

2. Select the checkbox associated with the LFMT Collector schedule in the Collection Schedules pane.

3. Click the button to delete the schedule.

Enabling and disabling a LFMT Collection Schedule

1. To enable the LFMT Collector schedule, select the checkbox associated with schedule, and click the
button.

2. To disable the LFMT Collector schedule, select the checkbox associated with schedule, and click the
button.

Log File Management Tool Deployment and User's Guide 87

Log File Management Tool User's Guide Force Collection

Force Collection
This section describes how to initiate a real-time log file collection by LFMT Collector.

Forcing a collection of log files for specific applications

1. In Genesys Administrator Extension, from the LFMT menu, select Force Collection.

2. Select the hosts/applications for which the log files are to be collected.

3. Click the Collect button to start the collection.

Log File Management Tool Deployment and User's Guide 88

Log File Management Tool User's Guide Force Collection

Important
Genesys recommends that users be aware of the possible network bandwidth consumption when
using the Force Collection method of updating the CLS.

Log File Management Tool Deployment and User's Guide 89

Log File Management Tool User's Guide Indexing and Scrubbing

Indexing and Scrubbing

LFMT uses user-defined regular expressions for both log file indexing and log file scrubbing. This section describes
how to manage these regular expressions.

Adding a Regular Expression for Indexing and Scrubbing

1. In Genesys Administrator Extension, from the LFMT menu, select Indexing and Scrubbing.

Important

Log File Management Tool Deployment and User's Guide 90

Log File Management Tool User's Guide Indexing and Scrubbing

If a regular expression exists for multiple sites with the same Name, Type, and Expression, it
will appear as one entry in the Indexing and Scrubbing table.

2. Select the Add button to create a new regular expression. The Add Regular Expression panel will appear.

3. In the Add Regular Expression panel provide the Name and Regular Expression in the provided text fields.

4. Choose whether the new regular expression will by used for indexing or scrubbing using the Type radio buttons.

5. Choose the site for which the new regular expression will apply from the Site drop-down box.
6. Check the application types and/or applications to which the new regular expression will apply from the provided list.

7. Select the Save button to save the new regular expression.

Log File Management Tool Deployment and User's Guide 91

Log File Management Tool User's Guide Indexing and Scrubbing

Editing a Regular Expression

1. In Genesys Administrator Extension, from the LFMT menu, select Indexing and Scrubbing.

2. Double-click on the regular expression Name in the Indexing and Scrubbing table. The Edit Regular
Expression panel will appear.

3. In the Edit Regular Expression panel change the Regular Expression, Type, and Site as desired.

4. Change the application types and/or applications to which the regular expression will apply from the provided list.

5. Select the Save button to save changes to the regular expression.

Log File Management Tool Deployment and User's Guide 92

Log File Management Tool User's Guide Indexing and Scrubbing

Deleting a Regular Expression

1. In Genesys Administrator Extension, from the LFMT menu, select Indexing and Scrubbing.

2. Select the checkbox beside the regular expression in the Indexing and Scrubbing table.

3. Select the Delete button to delete the selected regular expression(s).

Log File Management Tool Deployment and User's Guide 93

Log File Management Tool User's Guide Log File Packaging

Log File Packaging

This section describes how to search, select, and build log file packages from files in Central Log Storage.

Creating Log Packages

1. In Genesys Administrator Extension, from the LFMT menu, select Log File Packaging.

2. Build a query using dates and/or custom-defined indexes.

Log File Management Tool Deployment and User's Guide 94

Log File Management Tool User's Guide Log File Packaging

Tip
The ILIKE option allows users to search with SQL type wildcards.

Important
It is possible to search using multiple custom-defined indexes by selecting the AND or OR radio
button options.

3. Once the query is built, click Select Applications. The Select Applications pane becomes visible.

Log File Management Tool Deployment and User's Guide 95

Log File Management Tool User's Guide Log File Packaging

4. Select the desired applications from the Select Applications pane for which to apply the query.

5. Select the Search button to run the query against the selected applications. The Filtered Log Files will become
visible. Log files from the applications matching the query will be displayed in this pane.

6. Select the desired log files from the Filtered Log Files pane.

Log File Management Tool Deployment and User's Guide 96

Log File Management Tool User's Guide Log File Packaging

7. Click the Build Package button to generate the package build request.

8. After a package has been built, a dialog will appear with a quick-link to the Available Packages section. Download
and FTP(S)/SFTP of log file packages are available in the Available Packages section.

Log File Management Tool Deployment and User's Guide 97

Log File Management Tool User's Guide Available Packages

Available Packages
This section describes how to download and send LFMT packages built in the Log File Packaging section.

Tip
• LFMT packages have the .zip extension as of 8.5.104 release.

• If preferred, LFMT Packages can be generated with an .lfm extension instead by setting
use_lfm_extension option to true.

• The package (.zip or .lfm extension ) is a compressed file and can be extracted by applications
such as WinRAR, 7-Zip, etc.

Downloading an LFMT package

1. In Genesys Administrator Extension, from the LFMT menu, select Available Packages.

2. Review the entries in the Available Packages table.

• Packages marked as Pending are still being built by LFMT Collector.

• Packages marked as Available can be downloaded by the user.

• To view an updated status of a package, click the Refresh button.

• To view the contents of a package, double-click on the package name. The Package Contents dialog box will
appear including the filename for the package and the filter criteria used to generate the package.

Log File Management Tool Deployment and User's Guide 98

Log File Management Tool User's Guide Available Packages

3. Select the checkbox associated with desired package(s).

4. Click the Download button. The Download dialog will appear.

5. Click the hyperlink associated with the package(s) to start the download.

Log File Management Tool Deployment and User's Guide 99

Log File Management Tool User's Guide Available Packages

Important
Information about the package
Inside every LFMT package, a details.txt file is included that contains filter information about the package generation.

Example: Following is a sample extracted from a details.txt.

Created with LFMT version: 8.5.100.05_P2

Package created on: Wed Aug 22 03:28:20 ADT 2018
Name: 20180822_032820_023_ccdev-st-lfmt1.lfm
Filter Criteria: 2018-07-15, 2018-08-22
Included Files:
App:AGENT_FWK2 - File:agent_fwk2.20180720_130055_819.log.zip

Sending an LFMT package via FTP(S)/SFTP a LFMT

1. In Genesys Administrator Extension, from the LFMT menu, select Available Packages.

2. Review the entries in the Available Packages table.

3. Select the checkbox associated with desired package(s).

4. Click the Send FTP(S)/SFTP button. The FTP(S)/SFTP dialog will appear.

5. Enter the IP, port, username, and password for connection to the FTP(S)/SFTP server.

6. Click the Send Package button to send the package.

Log File Management Tool Deployment and User's Guide 100

Log File Management Tool User's Guide LFMT Audit Information

LFMT Audit Information

LFMT Audit Capability

LFMT now supports an audit capability, that will write auditing details (LOGIN, LOGOUT, ADD, DELETE, CHANGE)
to log files. This information will be made available in the GAX application logs where the LFMT Plug-in is installed.

The LFMT Audit logging can be turned on by setting a new key-value-pair in the "log" options section for the GAX
application:

Key Name: auditing ; Value = true

The above setting will cause new auditing entries to be written to the GAX logs. These new entries will be written
during the add, change or delete operation on the tables of the database used by LFMT. When needed, extract
these lines from the GAX log(s) that have LFMT_Audit, Log in user or logged out in it.

Important
Please note that the records for addition, deletion and change are JSON records and can be
processed using any standard JSON parser. Each of these JSON records also contains the key
complete_record that represents the record from the Database.

Example
Utilizing the grep command (on *nix or UnxUtils on Windows) to extract those entries from the log file
gax20180914_153236_788.log into an output text file lfmt_audit_log.txt.

egrep "LFMT_Audit|Log in user|logged out" gax20180914_153236_788.log > lfmt_audit_log.txt

This file may contain five different types of audit logs as follows:

Type - 1
Log in: This line is written to the logs when a user logs in.

2018-09-14 15:32:46,710 DEBUG: com.genesyslab.gax.core.user.LoginServiceImpl [qtp142257191-14] - [48] Log in use

This line shows that the user default logged in at 2018-09-14 15:32:46,710.

2018-09-14 15:47:03,524 DEBUG: com.genesyslab.gax.core.user.LoginServiceImpl [qtp142257191-12] - [48] Log in use

Log File Management Tool Deployment and User's Guide 101

Log File Management Tool User's Guide LFMT Audit Information

This line shows that the user ndatar logged in at 2018-09-14 15:32:46,710.

Type - 2:
Log out: This line is written to the logs when a user logs out.

2018-09-14 15:40:48,617 INFO : com.genesyslab.gax.webservice.UserController [qtp142257191-74] - [273] User defau

This line shows that the user default logged out at 2018-09-14 15:40:48,617.

2018-09-14 15:48:07,165 INFO : com.genesyslab.gax.webservice.UserController [qtp142257191-128] - [273] User ndat

This line shows that the user ndatar logged out at 2018-09-14 15:48:07,165.

Type - 3:
Added Record: This line is written to the logs when a new record is added.

2018-09-14 15:33:28,538 INFO : com.genesyslab.gax.lfmt.audit_log_util.AuditLogUtil [qtp142257191-73] - [34] {"ty

This line shows that a new record was added (mode : Added) to the table IndexToRegex at Fri Sep 14 15:33:28
ADT 2018 by the user default.

2018-09-14 15:47:39,071 INFO : com.genesyslab.gax.lfmt.audit_log_util.AuditLogUtil [qtp142257191-128] - [34] {"t

This line shows that a new record was added (mode : Added) to the table IndexToRegex at Fri Sep 14 15:47:39
ADT 2018 by the user ndatar.

Type - 4:
Changed Record: This line is written to the logs when the contents of an existing record is changed.

2018-09-14 15:36:39,319 INFO : com.genesyslab.gax.lfmt.audit_log_util.AuditLogUtil [qtp142257191-17] - [34] {"ty

"column_name":"applicationTypes"}],"timestamp":"Fri Sep 14 15:36:39 ADT 2018","mode":"Changed","username":"defau

This line shows that the entry with name asd was changed (mode : Changed) in the table IndexToRegex at Fri
Sep 14 15:36:39 ADT 2018 by the user default.

The changes were:

• Column regularExpression was changed from asd to as=df.

• Column applicationTypes was changed from ,258,147,567,994,259,956,989,1004,1003,403,351,997, to

,258,147,567,1013,916,994,259,956,989,1004,1003,403,351,997,.

2018-09-14 15:47:51,243 INFO : com.genesyslab.gax.lfmt.audit_log_util.AuditLogUtil [qtp142257191-127] - [34] {"t

This line shows that the entry with name asd was changed (mode : Changed) in the table IndexToRegex at Fri
Sep 14 15:47:51 ADT 2018 by the user ndatar.

The changes were:

• Column regularExpression was changed from a=kjkj to a=kjkj 123.

Log File Management Tool Deployment and User's Guide 102

Log File Management Tool User's Guide LFMT Audit Information

• Column applicationTypes was changed from ,1013,916, to ,258,147,567,994,259,956,989,1004,1003,403,351,997,.

Type - 5:
Deleted Record: This line is written to the logs when an existing record content is deleted.

2018-09-14 15:46:30,618 INFO : com.genesyslab.gax.lfmt.audit_log_util.AuditLogUtil [qtp142257191-117] - [34] {"t

This line shows that the entry with name ggh from the table IndexToRegex was deleted (mode : Deleted) at Fri
Sep 14 15:46:30 ADT 2018 by the user default.

2018-09-14 15:48:01,180 INFO : com.genesyslab.gax.lfmt.audit_log_util.AuditLogUtil [qtp142257191-117] - [34] {"t

This line shows that the entry with name for_testing from the table IndexToRegex was deleted (mode : Deleted) at
Fri Sep 14 15:48:01 ADT 2018 by the user ndatar.

Log File Management Tool Deployment and User's Guide 103

Additional Information LFMT Audit Information

Additional Information
This section gives additional information to administrators and users for deploying, configuring, and using the LFMT.

Log File Management Tool Deployment and User's Guide 104

Additional Information Configuration of TLS Connections

Configuration of TLS Connections

TLS Connections to Configuration Server

LFMT Indexer and LFMT Collector both support secure connections to Configuration Server's Auto-Detect port.
This section describes how to configure these secure connections. It is assumed that the person configuring the
secure connection has already become familiar with the Genesys Security Deployment Guide and configured the
Configuration Server Auto-Detect port.

Important
When creating certificates using OpenSSL as described in the Genesys Security Deployment
Guide ensure the default Secure Hash Algorithm is at minimum SHA-2. This can be done by
editing the .\ca_conf\ca.conf file created by the create_ca.sh script so default_md =
sha256 prior to creating certificates.

Important
If LFMT Indexer and LFMT Collector are to be deployed on a Linux host, ensure the private key is
in PKCS #8 format. For more information on converting keys to PKCS #8 for use with Java based
Genesys PSDK applications, refer to the Genesys Security Deployment Guide.

Installing Certificates and Certificate Authorities on the LFMT Server Host

This section describes how to install the certificates and certificate authorities used for secure connections on the
LFMT Server Host.

On Linux
1. If not already completed, install the Genesys Security on UNIX package and configure the system environment
variable LD_LIBRARY_PATH as per the Genesys Security Deployment Guide.

2. Copy the certificate, the certificate key, and the certificate authority file to a location on the LFMT Server Host.

3. Ensure the certificate, the certificate key, and the certificate authority file are readable by the user that starts LFMT
Indexer and LFMT Collector.

On Windows
1. Copy the certificate, the certificate key, and the certificate authority file to a location on the LFMT Server Host.

2. Ensure the certificate, the certificate key, and the certificate authority file are readable by the user that starts LFMT
Indexer and LFMT Collector.

Log File Management Tool Deployment and User's Guide 105

 Additional Information Configuration of TLS Connections

3. From the Windows Start menu, select Run, and then execute the mmc command to start the Microsoft Management
Console (MMC).

• The Microsoft Management Console should be opened under the user who starts LFMT Indexer and LFMT Collector.
If this is the Local System account, you will need to open the console as the Local System user. This can be done
using the PSTools psexec application with the following command:

psexec.exe –i –s mmc.exe

• PSTools can be downloaded from http://technet.microsoft.com/en-US/sysinternals.

• Select File > Add/Remove Snap-in.

• In the left pane choose Certificates. Click the Add button.

• Add a Certificates snap-in for Computer account. Click Finish.

• As above, add an additional Certificates snap-in for My user account.

• In the Computer Account snap-in right-click the Trusted Root Certification Authorities folder, and select All Tasks > Import
from the shortcut menu. This starts the Certificate Import Wizard.

• On the first Wizard page, click Next.

• On the File to Import page, browse to the certificate authority file (Ex. ca_cert.pem), and then click Next.

• On the Certificate Store page, select Place all certificates in the following store. Make sure that the Certificate store text box
is set to Trusted Root Certification Authorities. Click Next.

• Click Finish.

• In the My user account snap-in open the Certificates folder.

• Right-click the Personal folder, and select All Tasks > Import from the shortcut menu. This starts the Certificate Import
Wizard.

• On the first Wizard page, click Next.

• On the File to Import page, browse to the certificate file (Ex. collector_host.pfx). Click Next.

• On the Password page, click Next. No password is needed.

• On the Certificate Store page, select Place all certificates in the following store. Make sure that the Certificate store text box
is set to Personal. Click Next.

• Click Finish.

• Press F5 to update the MMC view.

• On the left pane, select Certificates > Personal > Certificates.

• On the right pane, locate the imported certificate in the list, and double-click it.

• In the Certificate dialog box, click the Details tab.

• To view the certificate thumbprint, select Thumbprint from the list. The thumbprint, consisting of a string of hexadecimal
digits, appears in the lower part of the dialog box. The same process can be used to view the thumbprint for the certificate
authority.

Log File Management Tool Deployment and User's Guide 106

Additional Information Configuration of TLS Connections

Provisioning LFMT Indexer/Collector for Secure Connections

This section describes how to provision LFMT Indexer/Collector for secure connections to the Auto-Detect port of
Configuration Server. Use this procedure for both simple and mutual TLS connections.

1. Log into GAX, and navigate to Configuration Manager.

2. From the Environment section, select Applications.

3. In the Applications section, locate and open the LFMT Indexer/Collector application.

4. In the General tab, specify the Auto-Detect port of the primary and backup Configuration Server for the port and
backupport arguments in the Command Line Arguments respectively.

5. In the Connections tab, select Add. Add a connection to the primary Configuration Server being sure to select the
Auto-Detect port in the Port ID drop-down.

6. In the Connections tab, select Add. Add a connection to the backup Configuration Server being sure to select the
Auto-Detect port in the Port ID drop-down.

Log File Management Tool Deployment and User's Guide 107

Additional Information Configuration of TLS Connections

7. In the General tab, specify the Certificate, Certificate Key, and the Trusted CA installed on the LFMT
Server Host.

• Certificate: For Windows this will be the thumbprint of the certificate shown in the Properties of the certificate
in MMC Certificates snap-in. For Linux, this will be the complete path to the certificate file. Ex. /home/genesys/
certs/collector_host.pem

• Certificate Key: For Windows this will be the thumbprint of the certificate shown in the Properties of the
certificate in MMC Certificates snap-in (this normally the same value as used in the Certificate field). For
Linux, this will be the complete path to the certificate key file. Ex. /home/genesys/certs/
collector_host_java_priv_key.pem

• Trusted CA: For Windows this will be the thumbprint of the Trusted Root Certificate Authority shown in the
Properties of the certificate authority in MMC Certificates snap-in. For Linux, this will be the complete path to the
certificate authority file. Ex. /home/genesys/certs/ca_cert.pem

8. Click Save to commit the changes.

Tip
As an alternative to configuring the Certificate, Certificate Key, and the Trusted CA for
the LFMT Indexer and Collector at the application level, certificates and certificate authorities can
be assigned on the LFMT Server Host Object in GAX.

Log File Management Tool Deployment and User's Guide 108

Additional Information Best Practices

Best Practices
This section lists some best practices administrators and users should review for optimal deployment, configuration,
and operation of LFMT.

• Deploy a separate LFMT Indexer/Collector pair at each datacenter if they are geographically distributed.

• Deploy each LFMT Database in a DBMS within the same local as the associated LFMT Indexer/Collector pair.

• During the initial deployment of LFMT, consider a phased approach for adding application servers to the log collection
process.

• Monitor the performance impact of LFMT on each application server during the initial deployment.

• To reduce the performance impact of log file collection set the collection interval to be twice the required log file
transfer time.

• Turn off Anti-virus checking on the LFMT Server Host(s).

• Limit the custom indexes for each application/application type. A general rule is 3 per application.

• Set up scrubbing and indexing for only those application types that are required.

• Ensure that network traffic generated by Genesys application servers has a higher priority LFMT traffic.

• Set a low quality of service (QoS) value for network traffic generated by LFMT.

• If possible, use a dedicated VLAN or LAN for LFMT traffic.

Log File Management Tool Deployment and User's Guide 109

 Additional Information Regular Expressions

Regular Expressions
This section describes how to create regular expressions used for custom indexes by LFMT Indexer and/or
sensitive data scrubbing by LFMT Collector.

Important
Genesys strongly recommends that you test the regular expressions that you want to use for
indexing and scrubbing before you define them in the LFMT Client.

Creating Regular Expressions

• LFMT regular expressions are created using Java Regular Expression protocol. In the case of both indexing and scrubbing,
regular expression groups identify the data to be indexed or scrubbed.

• Given the following regular expression:

The regular expression will attempt to match:

1. \t - A tab character.

2. AttributeCallUUID - The text AttributeCallUUID.

3. \t - A tab character.

4. ' - A single quote.

5. \S+ - A number of non-whitespace characters.

6. ' - A single quote.

• In the above expression, the () surround the \S+ so as to define it as a group.

• The text matched inside the group will be that which is indexed in the database, or scrubbed from the file.

• Applying the expression above to the following application log file as an index.

Log File Management Tool Deployment and User's Guide 110

Additional Information Regular Expressions

Creates an entry in the LFMT Database where - CallUUID = D0PIFCQ87H5MH67ITU9179MC50000VEO

Tip
Tools like Regex Coach (http://www.weitz.de/regex-coach/) can be used to test the syntax of the
regular expressions.

Log File Management Tool Deployment and User's Guide 111

Additional Information Release Notes

Release Notes
This section provides links to the LFMT Release Notes.

• LFMT Client Release Note

• LFMT Indexer Release Note

• LFMT Collector Release Note

Log File Management Tool Deployment and User's Guide 112