Vault Server Parameters

The Vault Server parameter file contains the following parameters:

Instance control parameters
  • Connection.max
    This parameter specifies the maximum number of connections.
Administrator control parameters

These parameters enable you to specify whether the vault server must be controlled from the DOC module only, or whether you can control the server through other means. You must disable administrator control for security reasons.

  • ControlService.start

    This parameter is mandatory. This parameter enables or disables administrator control. The valid values are as follows:

    • True (enable)
    • False (disable)

    For example, to enable control: ControlService.start=true.

  • ControlService.password
    This parameter is mandatory if the control service is enabled. Administrator ’ s password, for example: ControlService.password=password.
  • ControlService.port
    This parameter is mandatory if the control service is enabled and is the control port for the VS. This port is not for file transfers, but for sending data flow and configuration control messages. If you start several instances of the VS, each instance must have a unique control port. To connect to this port, the administrator can use a program such as Telnet.
Service control parameters

Each instance of the VS can have several services, each of which uses a unique port.

  • Service.start
    This parameter is mandatory. This parameter specifies the number of services that the Vault Server instance must start. The number of services can be one or more. To start multiple services, list all numbers separated by a comma. For example: Service.start=1,2.
  • Service<n>
    This parameter is mandatory.
  • Start-up data for service number n

    This must be in the following format: Service<n>=<java_class>, <port>.

    Example: Service1=com.vault.server.service.VaultCommandService, 2001

    The port that is specified here is for data transfer. Each service must have a unique port. The Java class must always be the same.

Network parameters

You can change network parameters in accordance with your network configuration to increase transfer speed or reliability.

  • Packet.preferredSize
    This parameter is mandatory and specifies the number of bytes that the VS sends as one packet.
  • ServerSocket.timeout
    This parameter is mandatory and specifies the maximum amount of time (in seconds) that can pass until a service actually stops if you stop any existing services dynamically while the server runs with the use of the Administrator Control.
  • Socket.timeout
    This parameter is mandatory and specifies the amount of time (in seconds) that passes until sockets that the server opens with the client times out.
  • Service.transactionMode

    Mandatory. This check box determines whether the Vault Server must use the two-phase transaction mode, which uses temp and trash directories when running services. The valid values are as follows:

    • True: Two-phase mode.
    • False: Use only source/destination directories.

    The recommended setting is: Service.transactionMode=false

Directories parameters
  • Directory.root.temp
    This parameter is mandatory for two-phase transaction mode. This parameter specifies the name of a root directory in which the VS must create temporary directories. You must set read-write permissions for the directory.
  • Directory.root.trash
    This parameter is mandatory for two-phase transaction mode. This parameter specifies the name of a root directory in which the VS must create trash directories. You must set read-write permissions for the directory.
Logging parameters
  • Log.minimumLevel

    This parameter specifies the minimum level of messages to be logged in the log. The possible values, in ascending order of importance, are as follows:

    • DEFAULT
    • NOTICE
    • WARNING
    • ERROR
    • CRITICAL
  • Log.filename
    The name of the log file the server must use when writing to the log.