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
Oracle GoldenGate Veridata Server uses virtual memory in the following ways:
- Server memory for basic operation: This is the amount of virtual memory that the Veridata server and web components need to operate. It stores object pools, database access libraries, and other information. This is typically about 200 MB.
- Sort memory: This is the memory that is used when server-side sorting is used. The virtual memory for sorting is allocated for the entire comparison, not per thread. The rows are read from the agent and submitted to be sorted. The sorting occurs in a thread that is separate from the thread that reads from the agent, and the sort may use more threads to work in parallel. After all the rows from the agent are submitted to the sort process, the server process retrieves the sorted rows from the sort for comparison.
- Row hash queue memory: This is the memory that buffers data between the agent processes, the sort process, and the server process. A comparison that uses database sorting requires a single queue each for the source and target. Each queue has a capacity of 20 MG. The memory usage by the queues is affected by the relative speed of the comparison and by the data coming from the agent. The relative speed between the two agents also affects the memory usage. A larger differential in speed increases the amount of memory that is used, because the queue needs to buffer the data.
- MOOS queue memory: This is the memory that holds potentially out-of-sync records between the initial comparison and confirmation steps of a comparison. The size of the MOOS queue is limited to 50K of records. Memory usage is also dependent on the width of each record.
- IPC buffer memory: This is the memory that is used to exchange messages between the server and the agent.
- Scratch runtime transient memory: This is virtual memory space.
The amount of memory that can be used by the sort process cannot be greater than the minimum of:
- System physical memory
- Available memory in swap
- Java boot option
-Xmxmaximum memory setting
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. This
reserved amount is controlled by the server.max_sort_memory
configuration parameter.
When a comparison is run, two buffers are allocated from the reserved sort memory. Each of these is equal to the size specified as Maximum Memory Usage (MB). To access this setting click the Edit option from the Profile Configuration screen, then Sorting Method from the Profile settings categories.
To Estimate Memory based on the Number of Concurrent Comparisons
The maximum amount of memory that can be used for any comparison is set by
the parameter server.max_comparison_sort_memory. The
-Xmx Java boot option should be set large enough to allow the
desired number of concurrent comparisons.
The maximum number of concurrent comparisons is defined by the
server.max.concurrent_comparison_threads configuration parameter.
Therefore, the maximum amount of sort memory can be as large as:
server.max_comparison_sort_memory *
server_max_comparison_threads
For example, if you set
server.max_concurrent_comparison_threads to allow 10 concurrent
comparisons and leave server.max_comparison_sort_memory set to the
default value of 100 MB, you will need 1 GB of available memory.
To Estimate the Amount of Memory Used per Row
For more information about the estimating the amount of memory used per row, see Disk and Memory Requirements for the Server Component in Installing and Configuring Oracle GoldenGate Veridata for the calculation to estimate the amount of memory used per row.
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 database.hash
Defines whether or not the data hashing is done in the database. It can be used to improve the data-fetch performance.
Syntax
database.hash = [true|false]
Default Value
false
Note:
This parameter is currently supported for the Oracle database only.Example
database.hash = false
7.4.1.2 max_lob_key_len
This parameter sets the maximum length of LOB data types that can be used as key columns in Oracle GoldenGate Veridata. A positive integer enables the use of LOB data types as key columns. Note that this feature is currently only supported for Postgres' citext datatype. A value of zero disables this feature. The parameter value is measured in bytes, and must be within the range of 1 to 8000. If the size of the data in the table exceeds the defined value, then Oracle GoldenGate Veridata throws an exception and the job fails.
Syntax
max_lob_key_len = <length_of_lob_datatypes>Default Value
0
Example
max_lob_key_len 1
7.4.1.3 server.concurrent.readers
This parameter specifies the number of reader threads for the entire server.
Syntax
server.concurrent.readers number
Example
server.concurrent.readers 0
Default Value
The maximum of 4 or one quarter of the number of available CPUs.
7.4.1.4 server.concurrent.writers
This parameter specifies the number of writer threads per sort directory.
Syntax
server.concurrent.writers number
Example
server.concurrent.writers 0
Default Value
The maximum of 4 or one quarter of the number of available CPUs.
7.4.1.5 server.convert_empty_to_null
If server.convert_empty_to_null =
false, then Oracle GoldenGate for Veridata does not consider the implicit
behaviour of compares empty (zero byte string) versus NULL (no space handling) to be
insync
If server.convert_empty_to_null =
true, then Oracle GoldenGate Veridata compares empty (zero byte string) versus
NULL (no space handling) to be insync. In this is not comparison format dependent, then one
side should be Oracle and char, varchar, nchar, nvarchar, raw, clob, nclob, and blob
datatypes of Oracle for which, this parameter is implicit. .
Syntax
server.convert_empty_to_null = [true|false]
Default
true
Example
server.convert_empty_to_null = true
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_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.8 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.9 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_buffersis set totrue, 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_buffersis set tofalse, 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 ofjava -Xmx.
Example
server.max_sort_memory 1000M
Default Value
The system calculates the default size based on the available virtual memory.
7.4.1.10 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 directorypathExample
server.memory_mapped_sort_directory directorypath/tmp27.4.1.11 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.12 server.persistence_db_type
This parameter defines the persistence database type.
Syntax
server.veridata_data database_typewhere database_type is the persistence database type. The options are:
-
ORACLE_OCI
-
MS_SQL
Default Value
ORACLE_OCI
Example
server.veridata_data MS_SQL
7.4.1.13 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
Example
server.veridata_data /veridata/reports
That means the default data directory is VERIDATA_DOMAIN_HOME/veridata/reports.
7.4.1.14 socket.timeout.mins
Syntax
socket.timeout.mins <minutes>
Default Value
0
Example
socket.timeout.mins 0
7.4.1.15 truncate_spaces_len
Use the truncate_spaces_len parameter to control the length of truncated trailing spaces in a String or Binary column. Space (U+0020) and Ideographic Space (U+3000) are the truncate targets.
This parameter also truncates the column padding character if the padding character is one of the target spaces.
If the value equals 0, then all spaces are trimmed. For example, data = "".
If the value equals 1, then at least one space gets retained. For example data = " ".
Syntax
truncate_spaces_len <number_of_trailing_spaces>
Default Value
0
Example
truncate_spaces_len 0
7.4.2 Parameters for Configuring SSL Communication
This section defines the parameters that you can use to configure SSL communication between your Oracle GoldenGate 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.3 Parameters for Veridata Command-Line Utility
This section defines the following configurable parameters for your Oracle GoldenGate 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.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.3 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.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.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= [true|false]
Default Value
falseExample
mail.smtp.connection.ssl.tls=true
7.4.6 Server Parameters for Oracle Streams Tagging
Oracle GoldenGate Veridata tags the repair transaction using Oracle Stream API. Following properties are added as server parameters to customized the tags behavior:
7.4.7 Server Parameters for Confirm Out-of-Sync Fetch Strategy
Following properties are added as server parameters to customize the tag's behavior:
7.4.7.1 coos.join.strategy
CREATE TABLE, CREATE TABLESPACE, CREATE
PRIVATE TEMPORARY TABLE, and INSERT/UPDATE/DELETE
privileges
Syntax
coos.join.strategy = nokey
Value can be nokey, always, or
never.
Description
nokey - Use COOS Join strategy only when Use all columns as Key
columns (there is no primary or unique constraint on the table) is used to select
key columns for the compare pair. All columns as key columns in the compare pair
exception XML, UDT and Lobs.
always - Use COOS Join always for COOS step.
never - Don't use COOS Join for COOS Step.
Default Value
never