Document
A specialized database object that follows a controlled life cycle and usually has files attached. Revisable documents are composed of a document master, revision, and version.
Document master
A database object representing the revision-independent information associated with the document, such as the document title.
Document revision
A database object representing the revision-specific information associated with the document. As a document is created and revised, the new revisions are created and attached to the document master. Properties and relationships of a revision can differ from one revision of a document to the next. Only one revision can be current with only one working revision in a single configuration. Multiple revisions can be created by revising into lower configurations to isolate them until completed when they can be merged back. This is described in more detail in Concurrent Engineering Overview. Revisions are uniquely identified by a revision code that follows a revision sequence.
Document version
A database object representing the version-specific information associated with a document. Files are attached to the document version.
To work on the files, a user must check out the version. This creates a new version of the revision. When this version is checked back in, the previous version is marked as superseded but is retained to maintain a history. It is not usual to configure any properties or relationships on the version as they are only used as placeholders for the files, but it is possible.
Revision scheme
Revision scheme is a document revision sequence that is used while creating or revising a document to keep track of the various iterations of the document, which in turn reflect the various iterations of the attached files that the document manages. A revision scheme includes a number or letter to represent the major revision, a number or letter to represent the optional minor revisions, and a number that represents the version. Examples include A1 to Z9, and 1A to 9Z represent using major and minor revisions.
Major revision
Major revision is the first part of the revision scheme, which normally changes when a document undergoes a major change.
Minor revision
Minor revision is the second part of the revision scheme, which normally changes when a document undergoes an intermediate change and release. Additionally, it might be used to identify alternate working revisions before final release.
File
A special database object managing a physical file and location in the vault.
Alternate rendition generation
Alternate rendition generation is used to generate a viewable file of a different file type. Currently, PDF and other file types created by custom applications are configurable for output.
WebGL viewer file generation
WebGL viewer file generation is used to generate 2D WebGL viewer files (.vecz) for 2D drawings (.igr, .pid, .sma, .spe, .sha, and .zyq) and 3D WebGL viewer files (.binz) for Smart 3D models (.zvf and .vue) so that these files are viewable in Hexagon web-based portal applications, such SmartPlant Foundation Web Client.
Full Text Retrieval (FTR)
Full-Text Retrieval (FTR) is a separate module of SmartPlant Foundation that allows you to store, index, and search for text contained in or associated with objects managed by SmartPlant Foundation. FTR creates an inverted index (a list of the individual words with locations in the files) and uses this index at search time.
The software provides a user interface to the FTR functionality for both FTR configuration and retrieval of information where the storage and indexing of objects are automated.
Vaults
A vault is an identified directory on the network used to store the physical files associated with an object. Vaults can be related to either owning groups or configurations and optionally to object interfaces to limit their availability. Conditions are available on the relationships to determine which vault is used, such as for working or released documents.
These relationships are configured in the Desktop Client and are created in the data between an interface and a vault.
If a file object is to be stored as a file in the database rather than the vault,
the class definition of the file object must realize the ISPFDBFile interface.
Archive and purge
Vault files, database files, and their file objects can be archived. After archiving, the files and the corresponding objects are purged to control the vault and database sizes.