7 Oracle GoldenGate Veridata Server Configuration Parameters

Learn how to use parameters to adjust different aspects of the sort memory configuration when using server-side sorting.

This chapter includes the following sections:

7.1 Overview of the Server Memory

The amount of memory that can be used by the sort sorting process cannot be greater than:

  • The size of the memory mapped file, if using memory mapped file for sorting by setting the server.mapped_sort_buffers parameter to true in the veridata.cfg file.
  • java -Xmx memory setting, if using java heap for sorting by setting the server.mapped_sort_buffers parameter to false in veridata.cfg file.

7.2 Estimating Memory Usage

The maximum amount of memory available to Oracle GoldenGate Veridata is specified by the Java boot option -Xmx. When the server-side sorting is used, a large portion of this memory is reserved for sorting during comparisons.

The server.max_sort_memory * server.max_concurrent_comparison_threads equation of server parameter from the veridata.cfg file is used to calculate the maximum memory usage of the sorting. So, the Java -Xmx value configured should be larger than the sorting memory usage. For example, if you set server.max_concurrent_comparison_threads to allow 10 concurrent comparisons and set server.max_sort_memory to the value of 100 MB, then you need to set Java -Xmx value to at least 1 GB if using java heap for sorting.

7.3 How to Set a Parameter

To set a parameter, edit its entry in the veridata.cfg file. This file is stored in the DOMAIN_HOME/config/veridata directory within the Oracle GoldenGate Veridata Server installation directory.

Open an Oracle service request before changing these parameters.

7.4 Parameter Descriptions

This section describes the parameters that can be set in the veridata.cfg file. These parameters are grouped under the following categories:

7.4.1 Server Parameters

This section defines the following configurable parameters for your Oracle GoldenGate Veridata Server:

7.4.1.1 server.veridata_data

The directory that contains Oracle GoldenGate Veridata reports.

Syntax

server.veridata_data path

where path is a relative or absolute path for the directory where Veridata reports will be stored.

Note:

If you specify a relative path for the data directory, you need not start the path with a forward (/) or backward (\) slash. The path will be relative to the Veridata domain home directory.

Default Value

veridata/reports

That means the default data directory is VERIDATA_DOMAIN_HOME/veridata/reports.

7.4.1.2 server.persistence_db_type

This parameter defines the persistence database type.

Syntax

server.veridata_data database_type

where database_type is the persistence database type. The options are:

  • ORACLE_OCI

  • MS_SQL

Default Value

ORACLE_OCI

7.4.1.3 server.meta_session_handle_timeout

This parameter defines the meta-session handle timeout in seconds.

Syntax

server.meta_session_handle_timeout seconds

Example

server.meta_session_handle_timeout 600

Default Value

900

7.4.1.4 server.max_concurrent_jobs

This parameter specifies the maximum number of jobs that can be run simultaneously.

Syntax

server.max_concurrent_jobs number_of_jobs

Example

server.max_concurrent_jobs 200

Default Value

100

7.4.1.5 server.max_concurrent_comparison_threads

Sets the maximum number of concurrent comparisons that can be executed. You can lower this number to reduce the impact of the server on your system. When this limit is reached, no new comparisons, starts until an active comparison completes.

Syntax

server.max_concurrent_comparison_threads {default | number}
  • default : 100 threads

Example

server.max_concurrent_comparison_threads 100

Default Value

The default value is the maximum of four or the number of available CPUs.

7.4.1.6 server.mapped_sort_buffers

Indicates whether sort buffers are allocated as a memory mapped file or allocated on the JVM heap.

Syntax

server.mapped_sort_buffers [true|false]

Example

server.mapped_sort_buffers true

Default Value

The default is true. If an error occurs during initialization, Oracle GoldenGate Veridata uses the JVM heap.

7.4.1.7 server.max_sort_memory

Sets the maximum amount of sort virtual memory that is available to all running comparisons that use server-side sorting. The value of this parameter varies depending on the value of server.mapped_sort_buffers.

Syntax

server.max_sort_memory {default | number{M | m}}
default is illustrated in the follows:
  • When server.mapped_sort_buffers is set to true, the default value is 2 GB. The maximum number supposed to enter is the maximum size of the memory mapped file.
  • When server.mapped_sort_buffers is set to false, the default value is the JVM available heap size minus 200 MB, which is allocated for basic tasks. The maximum number supposed to enter is the value of java -Xmx.

Example

server.max_sort_memory 1000M

Default Value

The system calculates the default size based on the available virtual memory.

7.4.1.8 server.concurrent.writers

This parameter specifies the number of writer threads per sort directory.

Syntax

server.concurent.writers number

Example

server.concurent.writers number

Default Value

The maximum of 4 or one quarter of the number of available CPUs.

7.4.1.9 server.concurrent.readers

This parameter specifies the number of reader threads for the entire server.

Syntax

server.concurent.readers number

Example

server.concurent.readers number

Default Value

The maximum of 4 or one quarter of the number of available CPUs.

7.4.1.10 server.number_sort_threads

This parameter specifies the number of threads used to sort input buffers from the Veridata Agent.

Note:

The value of server.number_sort_threads should not be greater than the number of available processes.

Syntax

server.number_sort_threads number

Example

server.number_sort_threads number

Default Value

The maximum of 4 or one quarter of the number of available CPUs.

7.4.1.11 server.memory_mapped_sort_directory

This parameter specifies the directory path where .map files are generated. By default it uses temp directory of the operating system.

Syntax

server.memory_mapped_sort_directory directorypath

Example

server.memory_mapped_sort_directory directorypath/tmp2

7.4.2 Parameters for Configuring SSL Communication

This section defines the parameters that you can use to configure SSL communication between your Veridata Server and Veridata Agents:

7.4.2.1 server.useSsl

This parameter specifies whether SSL is enabled for communication between the Veridata Server and all Veridata Agents.

Syntax

server.useSsl [true|false]

Example

server.useSsl true

Default Value

The default value is false.

7.4.2.2 server.ssl.client.allowTrustedExpiredCertificates

If the value of this parameter is set to true, Veridata Server allows SSL communication between the agent and the server when a trusted certificate expires.

Note:

The parameter is not applicable if you are running IBM's JVM.

Syntax

server.ssl.client.allowTrustedExpiredCertificates [true|false]

Example

server.ssl.client.allowTrustedExpiredCertificates false

Default Value

The default value is true.

7.4.2.3 server.ssl.client.identitystore.keyfactory.alg.name

This parameter specifies a name for the identity store key factory algorithm used for SSL communication.

Syntax

server.ssl.client.identitystore.keyfactory.alg.name=algorithm_name

Example

server.ssl.client.identitystore.keyfactory.alg.name=IbmX509

If you are running on IBM's JVM, set the value to IbmX509.

Default Value

The default value is SunX509.

7.4.2.4 server.ssl.client.truststore.keyfactory.alg.name

This parameter specifies a name for the trust store key factory algorithm used for SSL communication.

Syntax

server.ssl.client.truststore.keyfactory.alg.name=algorithm_name

Example

server.ssl.client.truststore.keyfactory.alg.name=IbmX509

If you are running on IBM's JVM, set the value to IbmX509.

Default Value

The default value is SunX509.

7.4.2.5 server.ssl.algorithm.name

This parameter specifies algorithm used for SSL communication.

Syntax

server.ssl.algorithm.name=algorithm_name

Example

server.ssl.algorithm.name=TLS

Default Value

The default value is TLS.

7.4.3 Parameters for Veridata Command-Line Utility

This section defines the following configurable parameters for your Veridata Server:

7.4.3.1 veridata.cli.run_from_managed_server

To run the Veridata command-line utility from the Veridata Managed Server, set this parameter value to true.

Syntax

veridata.cli.run_from_managed_server [true|false]

Example

veridata.cli.run_from_managed_server false

Default Value

The default value is true.

7.4.3.2 veridata.cli.managed_server_name

This parameter specifies the name of the Veridata Managed Server.

Syntax

veridata.cli.managed_server_name server

Example

veridata.cli.managed_server_name VERIDATA_server2

Default Value

The default name of the managed server is VERIDATA_server1.

7.4.3.3 veridata.cli.server.listenAddress

This parameter specifies the listening address of the host machine for the Veridata Managed Server.

Syntax

veridata.cli.server.listenAddress host

Example

veridata.cli.server.listenAddress host.example.com

Default Value

The default name of the managed server is localhost.

7.4.3.4 veridata.cli.server.timeout.seconds

This parameter specifies the time period (in seconds) Veridata CLI should wait for the JMX Server to respond to a CLI request.

Syntax

veridata.cli.server.timeout.seconds seconds

Example

veridata.cli.server.timeout.seconds 90

Default Value

The default time-out is 60 seconds.

7.4.4 Parameters for Report File Encryption

This section defines the configurable parameters used for report file encryption:

7.4.4.1 server.encryption

When this parameter is set to true, the comparison report artifacts will be encrypted. Otherwise, the report contents will be in clear text.

Syntax

server.encryption=[true|false]

Example

server.encryption=false

Default Value

The default value is false.

7.4.4.2 server.encryption.bits

This parameter specifies the strength of the encryption algorithm. Valid values are 128, 192, and 256. If set to a value other than 128, you must install Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files.

Syntax

server.encryption.bits=[128|192|256]

Example

server.encryption.bits=128

Default Value

The default value is 128.

7.4.5 Parameters for Email Notifications and Alerts

To send email notifications, Oracle GoldenGate Veridata can connect to an outgoing Simple Mail Transfer Protocol (SMTP) server. The SMTP server needs to be configured so it does not require password credentials.

If password is required, then see mail.from.

This topic describes the parameters required for email notifications and alerts:

7.4.5.1 mail.enabled

When this parameter is set to false, the email notifications are turned off.

Syntax

mail.enabled=[true|false]

Example

mail.enabled=false

Default Value

The default value is false.

7.4.5.2 mail.alert.only

When this parameter is set to false, Oracle GoldenGate Veridata sends a notification email when a job is completed. If it is set to true, then Veridata only sends an alert email when out of sync or failure are encountered.

Syntax

mail.alert.only=[true | false]

Example

mail.alert.only=true

Default Value

The default value is true.

7.4.5.3 mail.smtp.server

Syntax

mail.smtp.server=<server_address>

Example

mail.smtp.server=smtp.host.com
7.4.5.4 mail.smtp.port

Syntax

mail.smtp.port=<port_number>

Example

mail.smtp.port=25
7.4.5.5 mail.smtp.connection.ssl.tls

The mail.smtp.connection.ssl.tls parameter is used to access mail server over SSL or TLS connection.

Syntax

mail.smtp.connection.ssl.tls=false

Default Value

The default value is false.

7.4.5.6 mail.from

This parameter is a username created on SMTP server that does not require a password authentication. If password is required, create a generic user with default password Ver!data1234 (case sensitive).

Syntax

mail.from=<email_address>

Example

mail.from=john@mail.com 
7.4.5.7 mail.to

The mail.to parameter is used to send emails to one or multiple users. Use a comma as a separator between email IDs.

Syntax

mail.to=<email_address(es)>

Example

mail.to=john@mail.com,mary@mail.com,ross@mail.com