Log File Management Tool Options

This chapter describes the configuration options used to configure the Log File Management Tool (LFMT) Server Application object and its Host object.

Important

Select the [+] under each section name to display the options that are configured in that section.

LFMT Server Host Options

This section contains options used to configure the LFMT Server Host. Unless otherwise stated, all configuration options are set in the Annex tab of the LFMT Server Host object.

lfmt Section

The options in this section correspond to the host application on which log collection is desired, not to the LFMT server application.

This section must be called lfmt.

[+] lfmt

rsync_nic

Default Value: No default value
Valid Values: A valid host name
Changes Take Effect: After restart

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

LFMT Server Options

This section contains options used to configure the LFMT Server. Unless otherwise stated, all configuration options are set on the Options tab of the LFMT Server object.

app_config Section

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

[+] app_config

absolute_cls_folder_path

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

Specifies the path 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.

disable_ftp

Default Value: No default value
Valid Values: true or false
Changes Take Effect: After restart of LFMT Application

Specifies whether to disable FTP.

lfm_zip_chunk

Default Value: No default value
Valid Values: Any numeric value representing the size of the chunks in MB.
Changes Take Effect: After restart of LFMT Application

Specifies the maximum size, in MB, that the LFMT package zip files should be before the file splits.

pk_location

Default Value: No default Value
Valid Values: The location of the GAX startup user's private key.
Changes Take Effect: After restart of GAX/LFMT Application.

Specifies the location of the GAX startup user's private key. Ex. /home/genesys/.ssh/id_rsa

retention_period

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

Specifies the number of days that the files are stored in CLS before being they are deleted permanently. Decimal numbers are supported, for example, 1.5 indicates one day and 12 hours.

unix_user_account

Default Value: Administrator
Valid Values: Any user account.
Changes Take Effect: After restart of LFMT Application

Specifies the domain user account used by LFMT for RSYNC transfers to Windows hosts.

windows_user_account

Default Value:Root
Valid Values: Any user account
Changes Take Effect: After restart of LFMT Application

Specifies the domain user account used by LFMT for RSYNC transfers to Unix hosts.

cfg_srv_n Section

The options in this section identify the configuration details of the configuration server (cfg_srv_1) that LFMT connects to.

[+] cfg_srv_n

backuphostip

Default value: No default Value
Valid Values: The IP address of the backup Configuration Server application.
Changes Take Effect: After restart of GAX/LFMT Application.

Specifies the IP address of the backup Configuration Server.

backuphostport

Default value: No default Value
Valid Values: The connection port of the backup Configuration Server application.
Changes Take Effect: After restart of GAX/LFMT Application.

Specifies the connection port of the backup Configuration Server.

default_app

Default value: No default Value
Valid Values: The default application name
Changes Take Effect: After restart of LFMT Application

Specifies the default application name for the configuration server.

hostip

Default value: No default Value
Valid Values: The IP address of the configuration server application name.
Changes Take Effect: After restart of LFMT Application

Specifies the host IP address of the configuration server.

hostname

Default value: No default Value
Valid Values: The host name of the configuration server
Changes Take Effect: After restart of LFMT Application

Specifies the host name for the configuration server.

password

Default value: No default Value
Valid Values: The valid password required to connect to configuration server
Changes Take Effect: After restart of LFMT Application

Specifies the password credentials required to connect to configuration server.

port

Default value: No default Value
Valid Values: Any integer
Changes Take Effect: After restart of LFMT Application

Specifies the port number for the configuration server.

username

Default Value: No default Value
Valid Values: A valid username required to connect to configuration server
Changes Take Effect: After restart of LFMT Application

Specifies the username required to connect to configuration server.

Important

In the case of multiple configuration servers, create multiple cfg_srv_x sections as described in Provisioning the LFMT Application.

dbprops Section

The options in this section identify the properties of the LFMT database.
This section must be called dbprops.

[+] dbprops

driver

Default Value: org.postgresql.Driver
Valid Values: oracle.jdbc.driver.OracleDriver, org.postgresql.Driver, com.microsoft.sqlserver.jdbc.SQLServerDriver
Changes Take Effect: After restart of LFMT Application

Specifies the class of the JDBC driver for the DBMS where the LFMT database is set up.

password

Default Value: No default value
Valid Values: Valid password
Changes Take Effect: After restart of LFMT Application

Specifies the password for the account that has read/write access to the LFMT database.

url

Default Value: No default value
Valid Values: Valid URL
Changes Take Effect: After restart of LFMT Application

Specifies the URL of the LFMT database. For example, jdbc:oracle:thin:@127.0.0.1:1521:lfmt for Oracle, jdbc:postgresql://localhost:5432/lfmt for PostgreSQL, or jdbc:sqlserver://localhost:1433;databaseName=lfmt for MSSQL.

username

Default Value: No default value
Valid Values: Valid username (case sensitive)
Changes Take Effect: After restart of LFMT Application

Specifies the username of the account that has read/write access to the LFMT database.

dialect

Default Value: org.hibernate.dialect.PostgreSQLDialect
Valid Values: org.hibernate.dialect.Oracle10gDialect, org.hibernate.dialect.PostgreSQLDialect, or ,org.hibernate.dialect.SQLServerDialect
Changes Take Effect: After restart of LFMT Application

Specifies the hibernate dialect configuration of PostgreSQL.

schema

Default Value: public
Valid Value: valid schema values
Example: dbo for MSSQL, public for PostgreSQL, schema name is same as username for Oracle
Changes Take Effect: After restart of LFMT Application

Specifies the configuration of the database schema.

ftp Section

The options in this section are used to configure the FTP settings for sending files by FTP.

This section must be called ftp.

[+] ftp

host

Default Value: No default value
Valid Values: Valid SMTP host address
Changes Take Effect: After restart of LFMT Application

Specifies the host of the default FTP server.

port

Default Value: No default value
Valid Values: Valid port number, must be an integer
Changes Take Effect: After restart of LFMT Application

Specifies the default port of the FTP server.

username

Default Value: No default value
Valid Values: Valid username
Changes Take Effect: After restart of LFMT Application

Specifies the username of the FTP server.

password

Default Value: No default value
Valid Values: Valid password
Changes Take Effect: After restart of LFMT Application

Specifies the password of the FTP server.

regexes Section

The options in this section are used to specify the regular expressions used to index and scrub the log files. More than one regular expression can be specified, but each must have its own name. For regular expressions guidelines, see Regular Expressions.

This section must be called regexes.

[+] regexes

<regular expression name>

Default Value: No default value
Valid Values: Any valid regular expression
Changes Take Effect: After restart of LFMT Application

Specifies a regular expression used to index or scrub files. This option defines one regular expression; use this option as many times as required for multiple sites, specifying a new name each time.

Important

Genesys recommends that you use simple regular expressions instead of complex ones, as complex expressions could affect the performance of the indexer. The regular expressions must be defined as Key-Value pairs on a single line in the log file.

smtp Section

The options in this section are used to configure the SMTP settings for sending LFMT notification emails.

This section must be called smtp.

[+] smtp

from

Default Value: No default value
Valid Values: Valid email address
Changes Take Effect: After restart of LFMT Application

Specifies the email address from which the LFMT notification emails will be sent.

host

Default Value: No default value
Valid Values: Valid SMTP host address
Changes Take Effect: After restart of LFMT Application

Specifies the host to which to connect to send LFMT notification emails.

password

Default Value: No default value
Valid Values: Valid password
Changes Take Effect: After restart of LFMT Application

Specifies the password of the account through which LFMT notification emails will be sent.

port

Default Value: No default value
Valid Values: Valid port number, must be an integer
Changes Take Effect: After restart of LFMT Application

Specifies the port to be used for connecting to the SMTP server.

username

Default Value: No default value
Valid Values: Valid username
Changes Take Effect: After restart of LFMT Application

Specifies the username of the account through which LFMT notification emails will be sent.

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.

[+] thread_setting

max_queue

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

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 Application.

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 Application

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