eLearning is available for this topic. Check it out here: HxGN SDx | Vaults.
Customers using SDx deployed in Smart Cloud do not create vaults. Vaults are created
for them by the SmartCloud Team, who also sets up the required folder location and
permissions.
Vaults can be restricted to store documents by an owning group (such as Admin or Open to All), a configuration, or a document interface.
It's possible to have more than one vault related to a single interface with different conditions. It's also possible to have a vault related to more than one interface on the same object. For example, you might have a general document vault but store contract documents in their own vault.
When files are attached to an object for the first time, the interfaces realized by the parent object's class definition are searched in sequence and the conditions processed for each vault as it is found. The first condition to return True determines the destination vault for the files. The files are transferred to this vault, and a relationship is created between the instantiated interfaces and the vault.
When any further files are attached to this object, the same vault will be used. If the object is checked out and back in, or revised, the same vault will be used for the new version or revision. If the object is copied, the vault conditions are re-evaluated, as properties affecting the conditions may have been changed.
Vault replication functionality is intended to make it faster for a remote user to
view or print files. Replicated vaults are not considered, however, when new documents
or new versions are created and files are vaulted.
-
Click System Administration > Create Vault.
-
In the New Vault dialog box, type a Name and Description for the vault.
-
Do not use numbers for the leading characters of the vault name if you will be performing batch print, PDF generation, or archive and purge operations on the files in the vault. These operations fail if the name begins with numeric characters. For example, "Vault1001" is acceptable, but "1001Vault" is not.
-
Do not use spaces in the vault name.
-
Do not start the name of the vault with the letter combination "xml."
-
-
Complete the other boxes as required.
Property
Description
Local path
Location in which the files are stored on the server. The path can be provided in any of the following three ways:
Relative path - such as ..\spf40vault. The folder is created under the File Service IIS Application folder that is configured on the computer specified in the Host box. Typically, we don't recommend using a relative path and storing files directly as part of the IIS Application. We recommend that you use an absolute path.
Absolute local path - such as F:\Vaults\ProdSiteA\Refineryx\MainVault, where the F drive can be a local disk or a mounted disk.
Absolute UNC path - such as \\CompanyFileServer\Vaults\ProdSiteA\Refineryx\MainVault.
To be used as a vault, the sharing and folder security on the share must be configured
so that that IIS Web Server has read/write access.
Sub diretory property expression
The name of the property of a file or related object used to name subdirectories when those files or related objects are added to the vault.
For performance issues, we recommend that you define a rule that controls a first
level sub-folder structure under the main vault folder. The delivered vault is configured
to create subfolders for each document type saved in that vault, so datasheets, P&IDs,
contracts, and so forth are each stored in separate subfolders.
Maximum file count
Maximum number of files to be stored in the vault. To specify no file limit, enter 0.
The number of files stored in any subfolder of the vault can grow very quickly, and that can have an impact on performance. To prevent this, you can have the system automatically create sequenced subfolders to store files. Specify the maximum number of files you want in each folder here. Once the number of files in the folder reaches this number, the system will automatically create a new subfolder and place new files in it.
Here is an example of the folder structure of a vault where files are segregated by file type and the Maximum file count is set to 300.
F:\Vaults\ProdSiteA\RefineryXXY\MainVault\Datasheet\1\(300 files)
F:\Vaults\ProdSiteA\RefineryXXY\MainVault\Datasheet\2\(300 files)
F:\Vaults\ProdSiteA\RefineryXXY\MainVault\Datasheet\3\(25 files)Once the first subfolder contained 300 files, the second subfolder was created. Once it contained 300 files, the third subfolder was created, and new files were placed in it. Once it contains 300 files, a fourth subfolder will be created and used.
-
From the Host section, search for and select the web server where the vault will be located.
This relationship is required to tell the system what server the IIS Web Service
File Service is located on. This may be the main application server, but that is not
a requirement.
-
Click Finish to create the vault.
For objects to be stored in the vault, you may need to relate an interface to the
vault for the type of object being added to the vault. For more information, see Force a class of object to a vault.