- You can start the vault server administration tool in either of two
If you are still in the installation procedure, and if you
selected the Vault Administration configuration, the Vault Setup dialog
box will appear BEFORE the enoviadbsetup step.
Or, if the installation is finished:
Log on as administrator, open a Command Prompt window, go to the
following installation directory:
C:\Program Files\Dassault Systemes\B18\intel_a\code\bin
and enter the command:
catstart -run VaultSetup
Log on as root, open a shell window, go to the following installation
where "OS" is:
and enter the command:
./catstart -run VaultSetup
The Vault Setup dialog box looks like this:
- Because you have not yet created a vault server, click the Add...
The Vault Server Authentication dialog box is displayed like this on
and like this on UNIX:
- On Windows, provide the vault administrator userid, password and
On UNIX, the domain name is not applicable.
The vault administrator can
be any operating system userid recognized on the computer on which you
are creating the vault server. This userid is the same as the userid to
which the vault server process belongs. Furthermore, the files created in
the vault by applications will be owned by this userid.
The Vault Administrator:
- must have the privileges to administrate the vault (the user must
have write authorization on the vault directories)
- must already exist as a system user.
- Click OK to continue to the Vault Server Add dialog box:
Vault Server Name
The Vault server name is the way for vault client
applications to identify a vault server. A vault client application needs
three items of information to connect to a vault server:
- the Orbix service name under which the vault server is registered
- the Orbix listening port on the remote machine where the vault
server is running
- the remote machine name.
The vault client properties file (set up when installing a vault
client) is used to provide the link between a given vault server name and
the three items of information identifying a given vault server.
The default server name is ENOVIAVaultServer, but can be customized.
The userid of the Vault administrator you entered in the
Vault Server Authentication dialog box is displayed for information
The server hostname is the name of the machine on which you
are creating the vault server.
Orbix daemon port
The Orbix daemon will listen on the specified Orbix daemon port
on the machine hosting the vault server. This value is the initial value
entered during the unload step in the installation procedure.
Warning: When attempting to install an
ENOVIA V5 VPM server and a Vault
server on the same machine, the administrator may be allowed to specify
two different port numbers for the servers. If you do so, the application
does not work afterwards. This is particularly important since the vault
server and ENOVIA V5 VPM server can be more easily installed separately, that is on
two different server paths, which implies two different port numbers.
Set the thread number, which is the number of threads
waiting for client requests. A vault server can answer several vault
client applications simultaneously. This number specifies the number of
simultaneous requests that can be processed. The default is 2.
Multi-processing capacity depends on the number of processors on the
Set the timeout value in minutes. The timeout is applied if
the vault server does not receive a request from a vault client after the
specified period of time starting when the last connection to the Vault
server was closed. The default is 900 minutes.
Time zone offset
Set the time zone offset in minutes. The server time zone
offset (in milliseconds) is used for document creation and modification
dates. For example, if you set the value to 3600000, the server time zone
is GMT+1 hour.
- Click the Database setup... button to access the Vault
Server Database dialog box, then check the DB2 or Oracle option to
specify which database you are working with, fill in the fields, and set
the desired options.
Each vault server requires its own data structure in the database.
During this step, you are going to create tables in the database to
support the vault server.
The options specific to your database are displayed.
Note that, before entering this phase, you must have already
created a database on DB2 or Oracle. If you already created a database
intended to be used for the enoviadbsetup procedure,
you can use that database here.
Note that a tablespace also has to be created first before you
enter this phase.
The Vault Server Database dialog box looks like this for DB2:
Options Specific to DB2
Select the DB2 alias name to be used to store the vault tables. All
available DB2 alias names, remote as well as local, will appear in the
DB2 home directory
The DB2 instance home directory is indicated as information only; you
cannot modify this field.
Database alias name
Select the database alias name for the chosen DB2 instance.
If the database directory of the chosen database alias is LOCAL, then
the database directory field will contain its path. If the database
directory of the chosen database alias is REMOTE, then the database
directory field will simply specify the text REMOTE.
The Vault Server Database dialog box looks like this for Oracle:
Options Specific to Oracle
Oracle home directory
Click the Browse... button and browse to select the home directory of
the Oracle installation if it is not already detected automatically.
Database service name
Oracle clients communicate with Oracle servers through service names,
which are easy-to-remember aliases for database addresses. Service names
can be resolved using various methods:
- Local Naming method: resolves service names using a local
configuration file (TNSNAMES.ORA, SQLNET.ORA, LISTENER.ORA).
- Centralized Naming method: resolves service names using
Oracle Names (highly recommended to centrally administer large Oracle
To use the Local Naming method:
- check the TNS_ADMIN option (this is the default): the path of the
default tnsnames.ora file containing the list of database service names
is highlighted, but you can click the browse button and choose the file
at a different location
- select the database service name from the pulldown list.
Note: If you don't check the above button, the Centralized
Naming method will be used.
To use the Centralized Naming method:
- uncheck the TNS_ADMIN option: the Database Service Name field
- enter the database service name in this field.
Options Common to Both DB2 and Oracle
Database schema name
Enter the database schema name. A schema is a collection of
named objects. It provides a logical classification of objects in the
database. This name is a database userid and is used as a prefix in the
name of the vault tables. For example, if you enter VPMADM, the table
name will be: VPMADM.VAULTDOCUMENT. The userid is the owner of the
database structures created. The resources created in the database for
the vault will belong to this schema (=resource owner).
For DB2, the schema name could be any database userid accepted by DB2, whereas
the connection user must exist at the operating system level.
On Oracle, you have to provide a password. This password is not
required in DB2.
Vault database connection user
This is a system userid used by the vault to connect to the database.
All connections to the database will be performed under this id (the main
interest of this specific user being for remote database connectivity,
since server authentication is being used). With a local database, it
might identical to be the vault administrator.
Enter the vault connection password.
Enter the user name of the database administrator.
The Database Administrator User:
- has the privileges to administrate the database
- creates tablespaces (spaces for the data structures that will
contain the data).
Enter the database administrator password.
Notes: The Administrator's user name and password must already
exist as a UNIX User Name and Password. Both of these entries are
For Oracle, both the Vault database connection user and the
Database administrator will have to exist as Oracle users (and
will be created as such if needed), but do not have to exist at the
operating system level.
Database minimum pool size
Minimum number of connections for the vault server database connection
Database maximum pool size
Maximum number of connections for the vault server database connection
Reminder: a tablespace has to be created first before you enter
this phase. You cannot create one interactively at this stage (unlike
during the ENOVIA database setup). Note that the table space for the
vault does not require a size of 8K (unlike the ENOVIA database setup
which does require a size of 8K). You can select the default tablespace,
for example USERSPACE1, or the tablespace created by the ENOVIA database
setup phase (if you already created the ENOVIA database). However, note
that the reverse is not true: you cannot create a vault tablespace and
use it during the ENOVIA database setup.
- After filling in all the fields, click the Tablespace...
Note: on Oracle, if you already performed a previous
installation and created a table schema, and want to reuse the same
schema, you will be prompted to reuse it. If so, click Yes. If you do not
succeed, use the Oracle Enterprise Manager Console and delete the
corresponding schema name. To delete, the schema name, you may first have
to delete the tables in the schema.
The Vault Server Tablespace dialog box looks like this:
then select the tablespace and click OK, then click OK again.
This returns you to the Vault Server Add dialog box:
The database type, database name and vault database connection user
you just configured are now displayed next to the Database setup...
Setting Up Repositories
Data is stored in the vault server repository. A vault server
repository is characterized by:
- its name
- a tmp directory: when vault client applications create new
documents, they are stored temporarily in this directory, and are
written to a secured directory when saved
- and a set of secured directories.
These directories have to be on the same file system for a specific
vault server repository to improve performance and reliability.
- Click the Repositories setup... button to access the Vault
Server Repositories dialog box:
- Click the Add... button to access the Repository Add dialog box:
Enter a name for the vault server repository.
Click the Browse... button, double-click a directory in the
list to select the repository path, then click OK. This path will contain
the tmp and secured directories. You can select an existing directory or
create a new one using the Browse... button.
If you have already created a directory used by another repository,
you cannot choose the same directory used by the other repository, either
in the same vault server or a different vault server, and either in the
same installation or in a different installation.
Click the Browse... button, double-click a directory in the
list to select the path of the temporary directory, then click OK. The
directory must already exist. You can select an existing directory or
create a new one using the Browse... button.
Secured storage occurs when the saved documents are actually committed
into the database.
The secured list displays the list of secured directories. To add a
secured directory, click the Add... button, double-click a
directory in the list to select the secured directory, then click OK. The
secured directory must already exist. You can select an existing
directory or create a new one using the Browse... button.
A warning will inform you if the selected Tmp path or Secured path is
not empty, however you can maintain your choice.
A warning will also inform you if the Repository's path contains
something else other than the Tmp path and the Secured paths: in this
case, you must choose another directory.
Select a directory and click the Delete... button to delete
- Click OK to confirm, and return to a summary of your repository
It looks like this on Windows:
and like this on UNIX:
- Click the Close button.
On Oracle, if the user names you used for the
Database schema name and Vault database connection user
exist already in the database, the following warning message appears:
The user xxx already exists in the database.
Do you want to use this user?
If so, click Yes. If it does not exist, the following message:
The user xxx doesn`t exist in the database.
Do you want to create this user now?
prompts you to create it. To do so, click Yes.
The Vault Server Add dialog box now displays all the information you
entered, and now looks like this, for example on DB2 on Windows:
and like this for example on Oracle on UNIX:
- Check the appropriate global vault server administration options at
the bottom of the dialog box.
Check the Read only option to set the entire vault to read
only mode. This is useful when the vault is full and you want users to be
able to continue to read data from the vault. Obviously, no documents can
be saved in the vault in this mode.
Check the Remove files option to trigger file deletion on
disk. When you request a deletion operation using a vault client
application (CATIA V5,
ENOVIA V5 VPM lifecycle application, etc.), a line
containing the instruction to remove the file is stored in the database:
the file itself is not removed from the vault. This option must be
checked if you want files to be physically removed. This option is
checked by default.
Log Removed Files
Check the Log removed files option to trigger the logging
of deletion operations requested by vault client applications. If you did
not check the Remove files option, your files will remain in
the vault. You can then use the log containing the list of deletion
operations as input for your own deletion batch programs.
Authorize NFS access
Check the Authorize NFS access option to ensure that the
authorization rights set for the vault directories are correctly set for
NFS access. NFS access is an alternative enabling vault client
applications to access the vault directly by the vault server. Refer to
How to Set Up File Transfer Mode
for the Vault for details about different file transfer modes
- Click OK again.
If this is the first time you are creating a vault,
you will be prompted to create the user if the database. Click Yes to do
so. If the user you declared already exists in the database, you may be
prompted to choose whether you want to use this user. If so, click OK to
You then return to the Vault Setup dialog box:
Note that you can also modify an existing vault or delete a vault
using the Modify... and Delete... buttons. You will
be prompted to log on using the Vault Server Authentication dialog box.
Modifying a Vault Server
You can edit most vault server properties. However, you cannot select
another database for your vault server: the corresponding options are
grayed out in the Database setup... dialog box.
Deleting a Vault Server
If you attempt to delete a vault server, you will be warned that the
catalogued entries for the vault server you want to delete will be
deleted, along with the associated properties file, but the associated
database and repositories will not be deleted. However, the
ENOVIAVaultServer.imp file is deleted.
If there is only one vault server, you cannot delete it. If you
attempt to do so, a warning will inform you that there must always be at
least one default vault alias name.
The characteristics of the vault server you created are displayed in
the Vault Setup dialog box.
- Click the Close button to exit the vault setup.