ISPFVault interface - SmartPlant Foundation - IM Update 46 - 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)

This is the primary interface of the SPFVault class.

See also Security Model.

The following properties are found on this interface.

Name

Description

Set on

SPFLocal Path

Where the files are actually placed on the server

New/Update Vault form

SPFSubDirectoryProperty

The name of the property of a file or related object to be used to name subdirectories when those files or related objects are added to the vault

New/Update Vault form

SPFSubDirMaxFileCount

The maximum number of files to be stored in the vault
(0 = no limit)

New/Update Vault form

SPFSubDirCount

The number of files currently located in the directory specified in the local path

New/Update Vault form

Functionality configured on ISPFVault

The commands Edit Relationships, Copy, Terminate, Update, and Relationship Details are configured on this interface.

Notes on properties

The SPFSubDirectoryProperty property takes a string that defines a property on the file or related object that is to be used for creating sub directories under the vault. The format of this string is the same as that used for conditions.

Obj.PropertyName

Obj->RelDef_[12|21].PropertyName

Examples for subdirectories based on document type (SPFSubDirectoryProperty) are:

For a file attached to a document version:

Obj->SPFFileComposition_12->SPFRevisionVersions_21->SPFDocumentRevisions_21-> SPFClassifiedLevel2_12.Name.

The above example is using multiple relationship navigation.

For a file attached directly to a document master (Admin document):

Obj->SPFFileComposition_12->SPFClassifiedLevel2_12.Name.

The SPFClassifiedLevel2_12 relationship gets the classification tree instead of using the SPFDocType property as this is not always populated (only when there is an enum hierarchy mapped to the classification tree).

The SPFSubDirMaxFileCount property is used to indicate a maximum number of files for a subdirectory. Subdirectories are created and named (1, 2, 3, and so forth) as the file limit is reached.

Examples of subdirectories by file count are:

SPFSubDirMaxFileCount = 10000

Results in:

.\VaultPath\1\ for the first 10000 files

.\VaultPath\2\ for files 10001 to 20000

SPFSubDirCount records the number of subdirectories currently created to prevent repeated searching of the file system for the latest one during file transfer.