System Elements

NumFunctionServers

Specifies the number of function servers available for processing. Also, determines the number of inputs that the engine can process in parallel.

NumHotStandbyFunctionServers

Specifies the number of standby function servers.

FileSetsHotSwappingEnabled

Enables or disables dynamic switches between two filesets. Supported values are true and false. Default is true.

When enabled, hot swapping increases the maximum memory requirements.

MaxMemoryMegabytes

Specifies the maximum amount of memory available for all processes, including file preloading. The default value is 1024 MB.

1024 MB is a minimum value. Depending on your workload, you might need to set a higher value.

FunctionServerInitTimeoutSeconds

Specifies the timeout period to successful initialize all function servers. Default is 600 seconds.

FunctionServerCallTimeoutSeconds

Specifies the timeout period to successfully submit a job call to a function server. Default is 60 seconds.

LicenseFilesDirectoryPath

Specifies the directory path to the license files.

Do not rename any license key file.

FileSetsDirectoryPath

Specifies the directory path to the reference data filesets and to the

FileSetsInfo.json

file.

The

FileSetsInfo.json

file describes the current status of the filesets. Address Verification creates the

FileSetsInfo.json

file in the directory.

Address Verification reads the

FileSetsInfo.json

file each time you initialize the engine and saves the file at each initialization. Address Verification also reads and updates the file during hot-swap operations.

If the directory that the element specifies does not permit updates to the

FileSetsInfo.json

file, copy the file to a writable location. Use the

OverrideFileSetsInfoFilePath

element to identify the location of the writable file. Do not delete the original file.

OverrideFileSetsInfoFilePath

Specifies the directory path to an alternative version of the

FileSetsInfo.json

file. Create an alternative version of the file when the

FileSetsInfo.json

file that Address Verification creates by default resides in a read-only directory. When you add a path to the

OverrideFileSetsInfoFilePath

element, Address Verification reads and updates the alternative version of the file.

ExecutablesDirectoryPath

Specifies the directory path to the FunctionServer executable application.

Do not include the function server executable file name in the path.

DeleteOutdatedDataFilesAtInit

Deletes any reference data file from the

FileSetsDirectoryPath

directory that meets the following criteria:

A newer version of the file is present in the
FileSetsDirectoryPath
directory.
The newer file version is compatible with the current engine.

Default value is false. To activate the property, set the value to true.

The engine reviews the directory contents and deletes outdated files during initialization.

The engine uses the minimum engine version number in the file name to determine the age and compatibility of each file. For example, the file US_ADV_VRF_QCP_001_6_2_0.MD6 is compatible with version 6.2.0 and later engine versions. A reference data file will be incompatible with the engine if the engine version that the file name specifies is newer than the installed engine.

Do not enable

DeleteOutdatedDataFilesAtInit

if different engine versions read the

FileSetsDirectoryPath

directory. A given file may be compatible with one engine version but not with another.

In cases where the engine deletes an outdated file, it will not return an 11000 warning to indicate that the file was skipped in preference for a newer file. Instead, the engine logs an INFO-level message to indicate that it deleted the file.

Bindings

Specifies how the data verification engine uses memory when you use the Java or Microsoft. NET wrapper that Informatica provides for the engine. Use the NumLargeInternalOutputBuffers property to define the memory policy.

The NumLargeInternalOutputBuffers property specifies the number of large output buffers that the engine creates during initialization. Each output buffer is large enough for a full AVJob JSON document. The memory used by large output buffers is deducted from the total amount that the MaxMemoryMegabytes property defines. Without a large output buffer, function calls run on a relatively small amount of stack memory. If the available memory is insufficient to return all job data, the engine returns an IDVE_SC_ERR_OUTPUT_BUFFER_TOO_SMALL error code.

By default, the engine creates a single large output buffer. If you prefer to save memory, for example, if you can perform small portions of a job at a time, you can set the NumLargeInternalOutputBuffers value to zero.

The number of large output buffers can limit the number of concurrent function calls that the engine can run if the calls require a large amount of data, as each buffer is locked for the duration of the call. If all buffers are in use, any additional calls are queued. Specify multiple buffers if you intend to run multiple large jobs in separate threads.

InitializationLog Elements

FilePath

Specifies the path to the initialization log file and the log file name.

LogLevel

Specifies the minimum severity that will be logged to the initialization log file. Any event with a lower severity does not appear in the log file. The default value is Warning.

The following list identifies the values that you can set in descending order from the most severe to the least severe.

VeryCriticalError
CriticalError
Error
Warning
Info
Status

ClearAtInit

Specifies whether to clear all initialization log file contents during initialization. Supported values are true and false. The log file contents are cleared during initialization when the element is set to true. Default is true.

History

Defines the policy that the engine uses to create and manage initialization log files. The engine reads the following properties to define the log file policy:

FileSizeSoftLimitMegabytes. Specifies an optional maximum size for an initialization log file. The default value is 0, which indicates that there is no limit to the file size. If you specify a maximum file size, the verification engine reads the FileCount value and performs one of the following actions:
The engine creates a new file and stores the previous file as history on the local disk.
The engine clears the earlier contents of the current file and reuses the current file.
If the addition of a log entry breaches the file size limit, the verification engine saves the complete log entry to the current file. The engine then creates a new file or erases the earlier file contents as indicted by the FileCount value.
If you accept the default FileSizeSoftLimitMegabytes value, the engine ignores the FileCount value.
FileCount. Specifies the maximum number of log files that the verification engine stores on the local disk in addition to the current log file. The default number is 0, which indicates that the engine does not store any log files on the local disk other than the current file. The range is from 0 through 999.
You can use the FileSizeSoftLimitMegabytes value and the FileCount value to define a policy for log file creation. For example, if you set the FileSizeSoftLimitMegabytes value to 10 and accept the default FileCount value, the engine writes log information to a single file and erases all older log information when the file size reaches 10 MB.
FileNameNumberPosition. Specifies the position of the log file number in the log file name. You can set the following values:
InsertBeforeExtension. Adds the file number before the file extension, for example, IDVE_ErrorLog.001.txt.
AppendAtEnd. Adds the file number after the file extension, for example, IDVE_ErrorLog.txt.001. Append at End is the default value.
If you change the
FileNameNumberPosition
property from one value to another when the
ClearAtInit
property is set to
true
, the engine does not delete any log file named in the old format when it reinitializes.

ErrorLog Elements

FilePath

Specifies the path to the error log file and the log file name.

ClearAtInit

Specifies whether to clear all error log file contents during initialization. Supported values are true and false. The log file contents are cleared during initialization when the element is set to true. Default is true.

History

Defines the policy that the engine uses to create and manage error log files. The engine reads the following properties to define the log file policy:

FileSizeSoftLimitMegabytes. Specifies an optional maximum size for an error log file. The default value is 0, which indicates that there is no limit to the file size. If you specify a maximum file size, the verification engine reads the FileCount value and performs one of the following actions:
The engine creates a new file and stores the previous file as history on the local disk.
The engine clears the earlier contents of the current file and reuses the current file.
If the addition of a log entry breaches the file size limit, the verification engine saves the complete log entry to the current file. The engine then creates a new file or erases the earlier file contents as indicted by the FileCount value.
If you accept the default FileSizeSoftLimitMegabytes value, the engine ignores the FileCount value.
FileCount. Specifies the maximum number of log files that the verification engine stores on the local disk in addition to the current log file. The default number is 0, which indicates that the engine does not store any log files on the local disk other than the current file. The range is from 0 through 999.
You can use the FileSizeSoftLimitMegabytes value and the FileCount value to define a policy for log file creation. For example, if you set the FileSizeSoftLimitMegabytes value to 10 and accept the default FileCount value, the engine writes log information to a single file and erases all older log information when the file size reaches 10 MB.
FileNameNumberPosition. Specifies the position of the log file number in the log file name. You can set the following values:
InsertBeforeExtension. Adds the file number before the file extension, for example, IDVE_ErrorLog.001.txt.
AppendAtEnd. Adds the file number after the file extension, for example, IDVE_ErrorLog.txt.001. Append at End is the default value.
If you change the
FileNameNumberPosition
property from one value to another when the
ClearAtInit
property is set to
true
, the engine does not delete any log file named in the old format when it reinitializes.

LogInput

Specifies the quantity of input data that the error log file stores for each log entry.

You can set the following values:

CompleteInput. The error log contains complete data for the input that caused the issue.
OnlySourceID. The error log contains the source ID value of the input that caused the issue. No further data is stored.
Disabled. The error log contains an entry to state that the function server encountered an issue. No further data is stored. Default is Disabled.

InputJSONFormat

Defines the format of the data that the engine writes to the error log.

The engine uses a common set of options to configure the error log format and to configure the format of the response that it returns when you submit a function call. For more information about formatting options for the response, see Formatting the JSON Response

The following table defines the options that you can set:

Option	Values	Description
Format	Condensed	Removes all white space, such as character spaces, tabs, and line breaks.
	Structured	Formats objects and arrays with line breaks and indentations.
	Smart	Organizes smaller objects and arrays on a single line if the MaxLineLength value permits. Otherwise, organizes smaller objects and arrays with fewer line breaks. Default is Smart.
BOM	true/false	Prepends the output string with UTF-8/UTF-16 BOM, depending on the API call. Default is false.
HideDefault	true/false	Omits properties whose values are equal to their schema defaults. Default is false in the data response and true in the error log output.
OpenBraceOnSameLine	true/false	Places opening braces and brackets on the same line as the object or array name instead of the line below. Applies when the Format value is Structured or Smart. Default is true.
Indent	Tab	Specifies that each indentation level will consist of a single tab character ("\t").
	Spaces	Specifies that each indentation level will consist of a number of space characters (" "). See also IndentWidth. Default is Spaces.
IndentWidth	<integer>	Specifies the number of character spaces to use at each indentation level. Applies when the Indent value is Spaces. Default is 2.
MaxLineLength	<integer>	Line length value to use in calculation of dynamic line breaks. Applies when the Format value is Smart. Not a hard limit. Lines may be longer in deeply nested documents. Default is 80.
NewLine	Lf/CrLf (default Lf)	Specifies the character sequence for new lines. The NewLine option can either be carriage-return and line-feed (CrLf), or only line-feed (Lf). The NewLine option is not present in the IDVEConfig.json file. You can add a NewLine value as an option in a URI query string.
CompactEscape	true/false (default true)	Specifies the use of compact escape sequences such as "\t" instead of "\u0009" where possible. Default is true.
EscapeSolidus	true/false (default false)	Specifies the use of escaped forward slashes. For example, "/" becomes "\/" or "\u002F" based on the CompactEscape option.