Table of Contents

Search

  1. About the Data Vault Administrator Guide
  2. Introduction to the Data Vault
  3. Data Vault Service Startup and Shutdown
  4. Data Vault Configuration
  5. Data Vault SSL Setup
  6. Data Vault ODBC Setup
  7. Data Vault Administration
  8. Data Repartitioning
  9. Partial Data Vault Copy
  10. Archived Data Migration
  11. Bulk File Uploader
  12. Data Vault Administration Tool
  13. Data Vault Logs
  14. User Account Privileges
  15. ssasql Command Line Program
  16. Data Vault Audit Log
  17. Sample Configuration Files

Data Vault Administrator Guide

Data Vault Administrator Guide

SERVER Section

SERVER Section

The SERVER section of the ssa.ini file contains the configuration parameters for the Data Vault Service. It also contains configuration parameters for log files.
The following table describes the [SERVER] section startup parameters for the load balancer:
Column
Description
HOST
The name of the machine on which Data Vault Service load balancer is running.
PORT
Port number used by the ssasql command line program and other clients such as the Data Vault SQL Tool and ODBC applications to connect to the Data Vault. Default is 8500.
EXEPORT
Port number used by the Data Vault Agent and the Data Vault Administration Tool to connect to the Data Vault. Default is 8600.
The following table describes the optional parameters for the load balancer. The default value is used if the parameter is missing or empty, and there is no [COMMON] section value:
Column
Description
TEMPDIR
The directory where Data Vault Service temporary files (vfs
xxxxx
.tmp) are created.
Default value is <DataVaultServiceDirectory>/temp.
SHAREDIR
The network location where temporary files for GROUP BY and ORDER BY queries are stored. This location must be accessible to all machines that have Data Vault Agent processes running.
Default value is <DataVaultServiceDirectory>/share.
INDEXDIR
The directory where the Data Vault stores index files when you create indexes for archived tables.
Default is <DataVaultServiceDirectory>/index.
BULKLOADDIR
The directory where the compressed data files generated through bulkload operations are created.
Default is
.
(current directory).
THREADS
The number of threads used by load balancer to handle client requests.
Default. 10
Minimum. 1
Maximum. (depends on machine resources)
ROWSETBUFFER
The size of the result set row buffer (in KB). This value should be at least the size of a fetched row. If the value is set to less than the size of a fetched row, an error message will be returned. Note also that if the buffer is too large, memory errors can occur.
Default. 64
Minimum. (size of a fetched row)
Maximum. (depends on machine resources)
BLOCKFETCHBUFFER
The size of the array (in KB) for fetching multiple records when the ODBC block fetching option is enabled. Increasing the size of this buffer can often improve performance.
Default. 64
Minimum. 64
Maximum. (depends on machine resources)
ERHF
Determines how expression evaluation errors are handled for archived table queries. The options are:
  • STOP. Query execution is halted when the first error condition is encountered; an error message is returned to the client that submitted the query.
  • REJECT. The entire compressed data file record that produced the error is rejected.
  • REPLACE. Each value that generates an error is replaced with a null in the result set.
If the client application supports ODBC-level warning messages, a numerical summary of rejected or replaced values will be displayed at the end of the query results, but only in cases where the number (
n
) is greater than 0:
n
rejected rows
-or-
n
replaced values
Default is STOP.
The following table describes the optional parameters that relate to log file configuration:
Column
Description
VERBOSE
Enables (1) or disables (0) the writing of extra details to the Data Vault Service log files. These extra details include the list of Data Vault data files affected by a query (by default, this list is limited to the first 4 KB of textual data), as well as debug information.
Default. 0 (off)
Note that the verbose log can also be turned on by executing the Data Vault Service Administration console command "SET DETAILED_LOG ON."
LOGDIR
The directory where the Data Vault Service log files are stored.
Default:
.
(current directory)
LOG
Enables or disables the standard log file. The possible values are ON or ENABLE to turn on standard logging; OFF or DISABLE to turn off standard logging. By default, standard logging is enabled.
Default. ON (or ENABLE)
LOGVERBOSE
Sets the level of detail that will be written to the standard log file. The following levels are available:
0 or LOW. all errors and other important messages (the default level)
1 or HIGH. level
0
+ more detailed messages
2 or TRACE. level
1
+ tracing messages
Note that the higher the logging level, the larger the log file will be, though the log file can be limited to a particular size (LOGLIMIT_FILESIZE) or amount of time (LOGLIMIT_TIME).
Also note that level
2
produces the same information as the independent trace log (TRACELOG). This trace information is intended mainly for internal use by Informatica Global Customer Support, and may not have much practical value to end users.
Default: 0 (or LOW)
LOGLIMIT_FILESIZE
Sets the maximum size (in bytes) for the standard log file. Once the log file grows to this size, one of two possibilities will occur: either new log information will "push out" the oldest log entries, keeping the log file below or at the specified maximum size; or, if LOGLIMIT_MAXFILES is set to a value greater than
1
, a new log file will be created to store the latest log information, leaving the previous log file intact.
Setting LOGLIMIT_FILESIZE to
0
is equivalent to omitting this parameter from the ssa.ini file. The LOGLIMIT_TIME parameter will be used instead, unless that parameter is also missing, in which case the default value for LOGLIMIT_FILESIZE will be used to limit the log file.
The LOGLIMIT_FILESIZE parameter takes precedence over LOGLIMIT_TIME, so if both are set in the ssa.ini file, the log file will be limited by size rather than time period.
Default is 1048576 (1 MB).
LOGLIMIT_TIME
Sets a time limit on the standard log file. When this option is enabled, entries are added to the current log file until the timestamp interval between the first message and the latest one exceeds the amount of time specified by LOGLIMIT_TIME. At that point, a new log file is created with the most recent message to start. The old log file is left intact, though an earlier log file may be removed, depending on the LOGLIMIT_MAXFILES setting.
The possible values for LOGLIMIT_TIME parameter are the following (where
n
is a positive integer):
n
MINUTE (or
n
MINUTES)
n
HOUR (or
n
HOURS)
n
DAY (or
n
DAYS)
n
MONTH (or
n
MONTHS)
If the unit of time is not specified, it is assumed to be DAYS.
The LOGLIMIT_TIME and LOGLIMIT_FILESIZE parameters are mutually exclusive; they both set limits on the standard log file, but one constrains by time, while the other constrains by file size. If both parameters are present in the ssa.ini file, the LOGLIMIT_FILESIZE parameter takes precedence.
Default is DAYS.
LOGLIMIT_MAXFILES
Specifies the maximum number of standard log files. There are two options for limiting the standard log file: by size (LOGLIMIT_FILESIZE) and by time period (LOGLIMIT_TIME). Once the configured limit for the log file is reached, a new log file is created to store the latest messages. The old log file is not deleted, however. After the first log file has reached its limit and "rolled over", there will always be at least two log files--the current log file and the previous one--although, depending on the value for LOGLIMIT_MAXFILES, earlier log files may be deleted by the system. The LOGLIMIT_MAXFILES parameter determines the total number of log files, past and present, that will be retained.
If 0 is specified for LOGLIMIT_MAXFILES, the maximum number of log files is set to unlimited. If
1
is specified, the default (
2
) is used instead.
Default is 2.
STATLOGLIMIT_FILESIZE
Sets the maximum size of each query statistics log file in bytes. When the size limit for the current log file is reached, it is renamed, and the query statistics are written to a new log file.
Default is 1048576 (1 MB).
TRACELOG
Enables (
ON
or
ENABLE
) or disables (
OFF
or
DISABLE
) the trace log file, which contains a lot of internal diagnostic information returned by different parts of Data Vault Service. This information might not have much practical value to end users, but can be analyzed by Informatica Global Customer Support to help diagnose problems or improve the system.
By default, trace logging is enabled.
Note that when LOGVERBOSE=
2
or
TRACE
, the information written to the standard log is the same as what is written to the trace file.
Default is ON or ENABLE.
TRACELOGLIMIT_FILESIZE
Sets the maximum size (in bytes) for the trace log file. Once the log file grows to this size, one of two possibilities will occur: either new log information will "push out" the oldest log entries, keeping the log file below or at the specified maximum size; or, if TRACELOGLIMIT_MAXFILES is set to a value greater than 1, a new log file will be created to store the latest log information, leaving the previous log file intact.
Setting TRACELOGLIMIT_FILESIZE to
0
is equivalent to omitting this parameter from the ssa.ini file. The TRACELOGLIMIT_TIME parameter will be used instead, unless that parameter is also missing, in which case the default value for TRACELOGLIMIT_FILESIZE will be used to limit the trace log file.
The TRACELOGLIMIT_FILESIZE parameter takes precedence over TRACELOGLIMIT_TIME, so if both are set in the ssa.ini file, the tracelog file will be limited by size rather than time period.
Default is 1048576 (1 MB).
TRACELOGLIMIT_TIME
Sets a time limit on the trace log file. When this option is enabled, entries are added to the current trace log until the timestamp interval between the first message and the latest one exceeds the amount of time specified by TRACELOGLIMIT_TIME. At that point, a new trace log file is created with the most recent message to start. The old trace log file is left intact, though an earlier log file may be removed, depending on the TRACELOGLIMIT_MAXFILES setting.
The possible values for TRACELOGLIMIT_TIME parameter are the following (where
n
is a positive integer):
n
MINUTE (or
n
MINUTES)
n
HOUR (or
n
HOURS)
n
DAY (or
n
DAYS)
n
MONTH (or
n
MONTHS)
If the unit of time is not specified, it is assumed to be DAY(S).
The TRACELOGLIMIT_TIME and TRACELOGLIMIT_FILESIZE parameters are mutually exclusive; they both set limits on the trace log file, but one constrains by time, while the other constrains by file size. If both parameters are present in the ssa.ini file, the TRACELOGLIMIT_FILESIZE parameter takes precedence.
Default is DAY(S).
TRACELOGLIMIT_MAXFILES
Specifies the maximum number of trace log files. There are two options for limiting the trace log: by size (TRACELOGLIMIT_FILESIZE) and by time period (TRACELOGLIMIT_TIME). Once the configured limit for the trace log file is reached, a new log file is created to store the latest messages. The old trace log is not deleted, however. There are always at least two trace log files--the current trace log file and the previous one--but depending on the value for TRACELOGLIMIT_MAXFILES, earlier log files may be deleted by the system when the current trace log reaches its limit and "rolls over". The TRACELOGLIMIT_MAXFILES parameter determines the total number of trace log files, past and present, that will be retained.
If
0
is specified for TRACELOGLIMIT_MAXFILES, the maximum number of trace log files is set to unlimited. If
1
is specified, the default (
2
) is used instead.
Default is 2.
The following table describes the optional parameters that enforce Data Vault user password policies:
Column
Description
COMPLEXPASSWORD
Enables the Data Vault password complexity policy. When the parameter is enabled, the password used to access Data Vault must contain at least one upper-case letter and at least one of the following special characters:
@ # _ = , . ? ~ { }
The following values are valid for the COMPLEXPASSWORD parameter:
  • ON
  • TRUE
  • ENABLE
  • 1
If you set the parameter value anything other than ON, TRUE, ENABLE, or 1, you receive an error during server startup.
After you configure the property, restart the Data Vault server to enable the policy.
When COMPLEXPASSWORD is enabled, Data Vault returns an error message if a user tries to update their Data Vault password to one that does not contain an upper-case letter and a special character.
If you set COMPLEXPASSWORD=0, or do not give the parameter a value, then the COMPLEXPASSWORD policy is disabled and users can use passwords that do not contain any complexity control.
To change the password for the DBA user with the COMPLEXPASSWORD policy, see the chapter "User Account Privileges."
MAXNUMPASSWORDS
Enables the policy that prevents the re-use of a specified number of Data Vault passwords that have been used before. When enabled, the parameter prevents the user from setting a Data Vault password that they have used before, up to a maximum of 12 previous passwords. For example, when you set MAXNUMPASSWORDS=10, the user cannot re-use their previous ten passwords when they update their password.
Valid inputs are 0-12. If you give the parameter a value out of the 0-12 range, the user receives an error message when they update their password.
After you configure the property, restart the Data Vault server to enable the policy.
If you set MAXNUMPASSWORDS=0, or do not give the parameter a value, then the MAXNUMPASSWORDS policy is disabled and users can reuse any older password.
MINPASSWORDLENGTH
Enables the minimum password length policy. Use the parameter to specify the minimum number of characters that a user's Data Vault password must contain. When a user tries to update their password to one that has less than the number of characters specified, the Data Vault returns an error.
For example:
MINPASSWORDLENGTH=8
After you configure the property, restart the Data Vault server to enable the policy.
In this scenario, if a user creates or updates a password that has less than 8 characters, the command fails with an "invalid password" error.
If you give the parameter a value out of the 0-128 range, the Data Vault also returns an error when a user tries to update their password.
If you set MINPASSWORDLENGTH=0, or do not give the parameter a value, then the MINPASSWORDLENGTH policy is disabled and users can create or update passwords of any length, up to 128 characters.
PASSWORDEXPIRYINDAYS
Enables the policy that requires a user to change their Data Vault password after a certain number of days, for example, 90 or 180 days. When enabled, Data Vault returns a warning message upon every user login starting 10 days before the current password is set to expire. Once the password expires, a user can no longer login through any ODBC or JDBC clients and must change their password through the Data Vault SQL Tool. Alternatively, the DBA can change a password for any user.
For example:
PASSWORDEXPIRYINDAYS=10
After you configure the property, restart the Data Vault server to enable the policy.
In this scenario, since the password will expire within 10 days, the user is warned upon login that their password will expire in the remaining amount of days, hours, and minutes. They are asked to update their password.
Once the password expires, the user is prompted to change their password upon login.
If you give the parameter a value out of the 0-2,147,483,647 range, the user receives an error message upon login.
If you set PASSWORDEXPIRYINDAYS=0, or do not give the parameter a value, then the PASSWORDEXPIRYINDAYS policy is disabled and user passwords will never expire.

0 COMMENTS

We’d like to hear from you!