Unable to load a file to a vault - SmartPlant Foundation - IM Update 48 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

Problem

After configuring a vault to contain objects related to particular interface as well as to a particular configuration, when you attempt to load a document that implements a different interface, the file is not copied to the vault.

Solution

The configuration for the vault may be too restrictive to allow the file to be copied to the vault. Vaults are used to control and drive the storage of files that are brought into the system as part of document management related and other activities. Every site needs at least one vault configured to be able to store files, but you may have as many vaults as you need to segregate your files.

A vault is both a location (a folder on a server) that can be accessed by the File Service Web Applications and an object in the database to which you will relate documents with attached files you want to store in that location. The vault database object can also be related to other administrative items in the system to control when different vaults are used.

The software completely manages adding and removing files in the vault. The folder should not be exposed to or accessed directly by end users. To help prevent direct access to the files in the vault, they are given randomly generated, unique names with no relation to the actual name of the file or the document it is associated with and are compressed. Optionally, the files can also be encrypted.

Vaults can be restricted to store documents by owning group (such as Admin or Open to All), by configuration, or by document interface.

It is possible to have more than one vault related to a single interface with different conditions. It is 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 are processed for each vault as they are 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 file 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. For more information about vault replication, see Replicated vaults.

Interfaces create severe restrictions on both the vaults to which they are related and the objects that realize the interfaces. Vaults can be configured for specific classes of objects by relating the vault to an interface instantiated on the object being vaulted. This interface is not a file interface but one on the object to which the file is attached (for example, ISPFDocumentVersion or ISPFNonSectionedTransmittal).

Once an interface is related to a vault:

  • That vault is valid only for objects that instantiate that interface.

  • Objects that instantiate that interface can no longer be vaulted in any vault that is not related to an interface instantiated on that object.

For example, to force all published documents to use a vault named PlantAVault, the vault could be configured as follows:

Name

PlantAVault

Related owning groups

None

Related configurations

PlantA

Related interfaces

ISPFTEFPublishedDocVersion

Once a vault is configured for an interface of an object, that object can only go to vaults that are related to interfaces that the object instantiates. For example, if PlantA is configured as shown above, and a document is published for another plant, PlantB, but a similar vault is not configured for PlantB, the document will not be published to a vault. To publish to a vault, a PlantB vault must be configured and related to that interface.

For more information on vault configuration and a video that shows you how to create and configure a new vault, refer to Vault configuration.