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

Startup Configuration Parameters

Startup Configuration Parameters

The ssa_starter startup program uses configuration settings in the [STARTER] section of the ssa.ini file.
The following table describes the parameters used by the startup service:
Parameter
Description
SERVER_CMD
The command to start the Data Vault Service. Default is ssaserver.
AGENT_CMD
The command to start the Data Vault Agent. Default is ssaagent. Do not include the -u parameter to specify a numeric ID for the agent process. The startup service assigns an agent ID.
AGENT_COUNT
The number of Data Vault Agents processes to start. Default is 2.
LOGDIR
The directory where the log files will be written. On UNIX, the daemon log is named ssa_starter. On Windows the service activities are logged by the operating system, which can be viewed through the Event Viewer.
AGENT_CONTROL
Enables (1) or disables (0) automatic restart if the Data Vault Agent fails. Default is 1.
SERVER_CONTROL
Enables (1) or disables (0) automatic restart if the Data Vault Service fails. Default is 1.
USER
UNIX only. The user ID under which all processes will be started by the ssa_starter daemon. It is usually important to set this parameter, since the default is the root user, which can cause problems. For example, if a process running as root creates a file, only another root process can access that file.
This parameter can also be set using the SSA_STARTER_USER environment variable. If both the ssa.ini file and the environment variable define the user ID, the environment variable takes precedence.
VERBOSE
The level of detail for the messages written to the log files. The following are the possible options:
  • 0 : Includes all error messages and the most important messages
  • 1 : Level 0 plus more detailed messages
  • 2 : Level 1 plus system trace information
Default is 2.
EXE[0-9]
These 10 optional parameters (EXE0, EXE1, EXE2, ..., EXE9) refer to custom commands, scripts, or executables that will run in conjunction with Data Vault Service on startup. Note that the numbering of the parameters has no relationship to the order in which they are processed. These parameters are run asynchronously, so there is no guarantee about the execution order.
The ssa_starter program reads the [STARTER] section in the ssa.ini file to determine the settings at initialization. The [STARTER] section in the ssa.ini file must specify at least the following parameters:
  • SERVER_CMD. Contains the command to start the Data Vault Service.
  • AGENT_CMD. Contains the command to start the Data Vault Agent.
The AGENT_COUNT parameter indicates the number of agents to start and must be set to a value of 1 or higher, otherwise no agent will be started.
The AUTOSTARTUP parameter must be set to 1 (enabled) in the [META] section of the ssa.ini file so that the startup service or daemon works properly. This allows the startup service to start the Data Vault repository database before the Data Vault Service. A related parameter, STARTUPCOMMAND, which defines the command line for starting the Data Vault repository database, must also be configured in the same section of the ssa.ini file. If the Data Vault repository database is not on the local machine, the STARTUPHOST parameter must specify the name of the remote computer where the Data Vault repository database is located.
If the Data Vault server shuts down unexpectedly, enabling AUTOSTARTUP might prevent it from restarting. This is because after a server shuts down unexpectedly, the child metadata process remains running, so that the port is busy.
To prevent this behavior, you can also manage the metadata server with ssa_starter and the EXE commands. If you do not enable AUTOSTARTUP, you must add the following EXE parameters in the [STARTER] section of the ssa.ini file:
For UNIX:
EXE0=fb_inet_server -m
EXE0_CONTROL=1
For Microsoft Windows:
EXE0=fb_inet_server -a
EXE0_CONTROL=1
These parameters allow ssa_starter to manage the metadata server process when the AUTOSTARTUP option is set to 0. The name of the metadata server process is
fb_inet_server.exe
. Formerly, this process, which runs on the application server, was called
ssaeng.exe
on Microsoft Windows and
ssaeng
on Linux.
On UNIX, if any changes are made in the ssa.ini file to parameters related to the Data Vault Service daemon, ssa_starter can be made to read the changes in the ssa.ini file using the ssa_starter -s command. On Windows, the service can be made to re-read the configuration by stopping, then restarting the service.

0 COMMENTS

We’d like to hear from you!