Setting Up the Vault Server

It contains enough information to get you through the vault deployment stage during installation.

The following are supported:

•  Windows 64-bit platform
•  Vault Server (64-bit)

For more detailed information about the vault, refer to Setting Up Vault Servers and Clients.

Note: If you are using an DB2 64-bit database server, you must install DB2 32-bit client in such a way that the installation of the ENOVIA V5 code communicates with 32-bit DB2 client and not directly with 64-bit DB2.

Procedure 

1. You can start the vault server setup tool in either of two ways.
   

   If you are still in the installation procedure, and if you selected the Vault Administration configuration, the Vault Setup dialog box will appear after the PLM Database Setup step.

   Or, if the installation is finished, log on as administrator, open a Command Prompt window, go to the following installation directory:

   WindowsInstallPath\$OSDS\code\bin

   and enter the command:

   catstart -run VaultSetup

   or run the command Start > All Programs > ENOVIAV5VPM > Tools > Vault Setup V5R28

   The Vault Setup dialog box looks like this:

   

2. Because you have not yet created a vault server, click the Add... button.

   The Authentication dialog box is displayed like this:

   
    

3. Provide the vault administrator userid, password and domain name.

   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.

   Vault Identification

4. 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 service name under which the vault server is registered
   • the server 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.

   Vault administrator

   The userid of the Vault administrator you entered in the Vault Server Authentication dialog box is displayed for information purposes.

   Server hostname

   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 ENOVIAV5VPM 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 ENOVIAV5VPM server can be more easily installed separately, that is on two different server paths, which implies two different port numbers.

   Thread number

   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 workstation.

   Timeout

   Set the timeout value. 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 -1 (infinite): the server stops only when explicitly requested.

   Time zone offset

   Set the time zone offset in hours. 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.
    

5. 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.

   Database Setup

   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 used for the PLM database setup procedure, you can use that database here.

   Note that a tablespace also has to be created first before you enter this phase.

   For DB2

   The Vault Server - Database dialog box looks like this for DB2:

   

   Options Specific to DB2

   DB2 install path

   Click the ... button to select the DB2 install path. Selecting the install path automatically detects the DB2 instance, Database alias name and Database directory.

   DB2 instance

   Select the DB2 instance to be used to store the vault tables. All available DB2 alias names, remote as well as local, will appear in the selection list.

   Database alias name

   Select the database alias name for the chosen DB2 instance.

   Database directory

   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.

   For Oracle

   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 networks).

   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.

   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
   • enter the database service name in this field.

   Note about Oracle Userids

   For Oracle, do not choose userids starting with a numeric character, an error may occur. If you do, a warning message will prompt you to correct the problem.

   Options Common to Both DB2 and Oracle

   Database table owner

   Enter the database table owner. 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 owner.

   For DB2, the owner 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

   For DB2, this is a system userid used by the vault to connect to the database. For Oracle, this is a user 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.

   Password

   Enter the vault connection password.

   Database administrator

   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).

   Password

   Enter the database administrator password.

   Notes: For Oracle, both the Vault database connection user and the Database table owner 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 pool.

   Tablespaces

   Reminder: a tablespace has to be created. You can create one interactively at this stage. Note that the table space for the vault does not require a size of 8K (unlike the PLM database setup which does require a size of 8K). You can select the default tablespace, for example USERSPACE1 (or USERS on Oracle), or the tablespace created by the PLM database setup phase (if you already created the PLM database).
    

6. After filling in all the fields, click the Tablespace... button.

   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, for example on DB2:

   

   and like this, for example on Oracle:

   

   Select the tablespace and click OK, then click OK again.

   This returns you to the Vault Server - Add dialog box, for example for DB2:

   

   and on Oracle:

   

   The database type, database name and vault database connection user you just configured are now displayed next to the Database setup... button.

   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.
    

7. Click the Repositories setup... button to access the Vault Server - Repositories dialog box:

   
    

8. Click the Add... button to access the Repository - Add dialog box:

   

   Name

   Enter a name for the vault server repository.

   Path

   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.

   Tmp path

   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 list

   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, however you can maintain your choice.

   Select a directory and click the Delete... button to delete it.

   

9. Click OK to confirm, and return to a summary of your repository setup in the Repositories dialog box which looks like this:

   
    

10. Click the Close button.

    The Vault Server - Add dialog box now displays all the information you entered, and now looks like this, for example on DB2:

    

    and on Oracle:

    
     

11. Check the appropriate global vault server administration options.

    Read only

    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.

    Remove files

    Check the Remove files option to trigger file deletion on disk. When you request a deletion operation using a vault client application, 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 supported.

    Add required privileges to the current user

    If the vault is run as a user other than the vault administrator logged on, certain privileges are necessary for this user.

    Note: these privileges can be managed using the command Start  >  Control Panel  >  Administrative Tools  >  Local Security Policy. If you already set the privileges this way, the Add required privileges to the current user option will not appear.

    If these privileges have not been already set, to ensure that the privileges are set, the Add required privileges to the current user option is checked by default.

    The privileges added for the vault are:

    • Adjust memory quotas for a process
    • Replace a process level token.
       
12. 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 confirm.

    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.

    The Modify... button lets you modify an existing vault server. To do so, the current Windows session user who executes the vault setup must be the vault administrator. Otherwise, you will receive the the following error message when you click the  Modify... button:

    The Windows current session user should be the Vault Administrator in order to modify the Vault server

    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.

    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.

13. Click the Close button to exit the vault setup.

Vault Setup Log Files

The vault setup log file is located in the installation directory and is named:

SetupVault.log

How to deal with Multiple Network Domain Names

Use the full qualified name in the VaultClient.properties file on client side in order to avoid the problem of network domain name resolution. For instance, if the Vault server machine name is "reverdsy" and the network domain name is "ds.dsy", you should replace "reverdsy" in the VaultClient.properties file by "reverdsy.ds.dsy"

Vault Server Trace File on Windows

Note: the vault server trace file is generated in the %USERPROFILE% directory under the name ENOVIAVaultServer.log.

For instance, if the user used for running the vault server is XYZ on a particular domain AA, the trace file will be located in:

C:\Users\xyz.AA

Setting Up the Vault Server and Client in Batch Mode

Setting Up the Vault Server

The batch tool provides the same functions as the interactive tool, with some minor exceptions indicated below.

Windows

To perform a batch installation:

1. Select Start > Programs > Command Prompt to open a Command Prompt window.
2. Go to the following installation directory:
   
   WindowsInstallPath\$OSDS_a\code\bin
    
3. Enter the command:

catstart -run VaultServerSetupB

with the appropriate arguments.

Command Syntax

VaultServerSetupB

-connect DBConnectionUser:password -db_adm DBAdministrator:password
[-min_pool DBMinimumPoolSize] [-max_pool DBMaximumPoolSize]
-repo RepositoryName -repo_path RepositoryPath -tmp RepositoryTmpPath
-secured SecuredPath [-secured OtherSecuredPath ...]
[-repo OtherRepoName -repo_path OtherRepoPath -tmp OtherRepoTmpPath
-secured SecuredPath [-secured OtherSecuredPath ...] ...]
[-read_only true|false] [-log_removed_files true|false]
[-remove_files true|false] [-nfs_access true|false] [-add_privileges]
[-generate_settings_only [-no_check]]

(to modify
general-purpose
options)

(to add
repositories)

(to modify
existing
repositories)

(to delete
existing
repositories)

• -list: lists the vault servers
  -list VaultServerName: lists the properties of VaultServerName
  -list -a: lists the properties of all Vault servers.
• -add: creates the Vault server VaultServerName.
  
  Default values with -add:
  • thread: 2, timeout: -1, offset: 0, min_pool: 4, max_pool: 6, read_only: false,
  • log_removed_files: false, remove_files: true, nfs_access: false
  • instance: the DB2INSTANCE value in the environment file.
  • oracle_home: the ORACLE_HOME value in the environment file.
  • tns_admin: true
  • tns_path: the TNS_ADMIN value in the environment file.
    If not valued, the default value is:
    %ORACLE_HOME%\network\ADMIN.
• -modify: modifies the vault server VaultServerName. You can add, modify or delete repositories. Note: unlike in interactive mode, you cannot create repositories from scratch in batch mode so you must create them manually beforehand. You can also change general-purpose vault properties.

  Default values with -modify: the parameters keep their current values (at creation, repo_read_only is false).

• -delete: deletes the VaultServerName's catalogued entries and properties file; the data (database, repositories) are not deleted.
• -h: this help.

Vault Server Setup Batch Examples

The following commands were run on Windows in a Command Prompt window in the installation directory:

WindowsInstallPath\intel_a\code\bin

Command:

catstart -run "VaultServerSetupB.exe -add ENOVIAVaultServer -adm the:pwd -db_vendor db2 -instance DB2 -db THEDB2A8 -schema the -connect the:pwd -db_adm db2admin:db2admin -tbs USERPACE1 -repo Repo1 -repo_path C:\Temp\Repositories\Repo1 -tmp C:\Temp\Repositories\Repo1\Tmp -secured C:\Temp\Repositories\Repo1\Secured -secured C:\Temp\Repositories\Repo1\Secured2"

Output:

C:\Temp\Repositories\Repo1: directory not found.
The command failed.

The command failed because the repositories had not been created, so you must create them first using the following Windows command:

mkdir C:\Temp\Repositories\Repo1 C:\Temp\Repositories\Repo1\Tmp C:\Temp\Repositories\Repo1\Secured
C:\Temp\Repositories\Repo1\Secured2

Then, the following command was run:

catstart -run "VaultServerSetupB.exe -add ENOVIAVaultServer -adm the:pwd -db_vendor db2 -instance DB2 -db THEDB2A8 -schema the -connect the:pwd -db_adm db2admin:db2admin -tbs USERPACE1 -repo Repo1 -repo_path C:\Temp\Repositories\Repo1 -tmp C:\Temp\Repositories\Repo1\Tmp -secured C:\Temp\Repositories\Repo1\Secured -secured C:\Temp\Repositories\Repo1\Secured2"

Output:

The Tablespace parameter is not found in the following list:
USERSPACE1
The command failed.

There was a spelling mistake in the tablespace name ("USERPACE1" instead of "USERSPACE1"), so it was corrected and the command was run again:

catstart -run "VaultServerSetupB.exe -add ENOVIAVaultServer -adm the:pwd -db_vendor db2 -instance DB2 -db THEDB2A8 -schema the -connect the:pwd -db_adm db2admin:db2admin -tbs USERSPACE1 -repo Repo1 -repo_path C:\Temp\Repositories\Repo1 -tmp C:\Temp\Repositories\Repo1\Tmp -secured C:\Temp\Repositories\Repo1\Secured -secured C:\Temp\Repositories\Repo1\Secured2"

Output:

[2672: New Connection (vagu1dsy.dsy.ds,IT_daemon,*,the,pid=2808,optimised) ]
[2324: New Connection (vagu1dsy.dsy.ds,IT_daemon,*,the,pid=2808,optimised) ]
[2672: New Connection (vagu1dsy.dsy.ds,IT_daemon,*,the,pid=2808,optimised) ]
Command successful.

The vault server is created.

The following command lists the vault servers created:

catstart -run "VaultServerSetupB -list"

Output:

Current installation Vault servers:
-------------------------------------------------------------------------------
Server hostname: VAGU1DSY
-------------------------------------------------------------------------------
Vault server name | Orbix daemon port | Vault administrator
-------------------------------------------------------------------------------
ENOVIAVaultServer | 1570              | the

The following commands list the characteristics of the vault server you just created:

catstart -run "VaultServerSetupB -list ENOVIAVaultServer"

or:

catstart -run "VaultServerSetupB -list -a"

Output:

Alias name                                   ENOVIAVaultServer
Vault administrator                        the
Server hostname                           VAGU1DSY
Orbix daemon port                         1570
Threads number                            2
Time Out (minutes)                        -1
Time zone offset                           0
Database type                              DB2
Database name                             THEDB2A8
Database schema name                  THE
Database connection user               THE
Database minimum pool size             4
Database maximum pool size            6
Repositories number 1
Repositories list:
1) Repo1
    Read only            false
    Path                   C:\Temp\Repositories\Repo1
    Tmp path            C:\Temp\Repositories\Repo1\Tmp
    Secured number   2:
                             C:\Temp\Repositories\Repo1\Secured
                             C:\Temp\Repositories\Repo1\Secured2

Read only                                     false
Log removed files                           false
Remove files                                  true
Authorize NFS access                      false

The following command modifies the general-purpose properties of the vault server:

catstart -run "VaultServerSetupB.exe -modify ENOVIAVaultServer -adm domain@the:pwd -thread 8 -timeout 9 -offset -10 -min_pool 11 -max_pool 12 -read_only true -log_removed_files true -remove_files false -nfs_access true"

Output:

The command sucessful.

The following command deletes the vault server:

catstart  -run "VaultServerSetupB.exe -delete ENOVIAVaultServer -adm domain@the:pwd"

Output:

ENOVIAVaultServer is the default alias name. You can't delete it because there is no other Vault alias name to become the default alias name instead of it. The command failed.

Note: To avoid the failure of the command, please create an another vault server and then run the batch to delete an existing vault server.

The following command lists the vault servers, and the list is now empty:

catstart  -run "VaultServerSetupB.exe -list"

Output:

Current installation Vault servers:
-------------------------------------------------------------------------------
Server hostname: VAGU1DSY
-------------------------------------------------------------------------------
Vault server name | Orbix daemon port | Vault administrator
-------------------------------------------------------------------------------
ENOVIAVaultServer | 1570              | the

Setting Up the Vault Client

To perform a batch installation:

1. Log on as administrator.
2. Select Start > Programs > Command Prompt to open a Command Prompt window.
3. Go to the following installation directory
   
   WindowsInstallPath\intel_a\code\bin
    
4. Enter the command:

catstart -run VaultClientSetupB

with the appropriate arguments.

Command Syntax

VaultClientSetupB

-list
-add VaultAlias -host ServerHostname -port OrbixDaemonPort
-modify VaultAlias [-host ServerHostname] [-port OrbixDaemonPort]
-delete VaultAlias
-h

where,

• -list: lists the catalogued vault servers
  
  Example: VaultClientSetupB.exe -list

Catalogued Vault servers:
-------------------------------------------------------------------------------
Vault alias name  | Server hostname | Orbix daemon port
-------------------------------------------------------------------------------
ENOVIAVaultServer | jane2dsy        | 1570
   
• -add: catalogues the vault server VaultAliasName
• -modify: modifies the catalogued Vault server VaultAliasName in order to update the server hostname and Orbix daemon port
• -delete: deletes the VaultAliasName's catalogued entries; the VaultAliasName properties file and the data (database, repositories) are not deleted.
• -h: this help.