Configure the archive and purge functionality - 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)

The archive and purge functionality is mainly driven from vault and database sizing. Archive is a process in which all the files attached to selected versions of documents are copied to a specified location. During the process of archiving, the physical files are moved from the vault or database to a designated location. System administrators can configure the Archive Files command with the purge option set to True or False. When the Purge option is set to True, all the archived file records and the physical files are deleted from the database.

The archive and purge functionality is limited to objects that instantiate the ISPFFileComposition interface.

Archive is available as a shortcut menu command on objects in the Desktop Client. It is also possible to create and archive saved ad hoc reports.

The archive and purge command specifies a graph definition that the user must expand on each of the selected set of objects.

The Archive Files command submits a task to the scheduler, an asynchronous process, to perform the operation.

For more information about the ArchivePurge client API, see ArchivePurge client API.

Re-archive option

To use the re-archive option, the user must specify the Re-archive argument on the Archive method, specify the number of times that the file can be re-archived, and specify the interval between each occurrence. The re-archive process archives all the new files that are attached to the documents.

Configuring the graph definition

Use a saved report to define the set of objects to be archived, or configure a graph definition. Graph definitions are created and edited in the Schema Editor. The following example shows the Method Access graph definition displayed in the Schema Editor.

This dialog box is used to add objects to, or remove objects from, the graph definition.