The ArchivePurge client API is used to archive files in a specified location.
|
Argument |
Description |
|---|---|
|
Parameter 1 |
GraphDef for structure |
|
Parameter 1 default |
None |
|
Parameter 1 description |
The graph definition to expand the object structure to get all the files |
|
Parameter 1 type |
String |
|
Parameter 2 |
Target location |
|
Parameter 2 default |
None |
|
Parameter 2 description |
A physical path (UNC path) to which SmartPlant Foundation archives the files. |
|
Parameter 2 type |
String |
|
Parameter 3 |
Archive |
|
Parameter 3 default |
True |
|
Parameter 3 description |
A flag indicating whether files will be archived. |
|
Parameter 3 type |
Boolean |
|
Parameter 4 |
Purge |
|
Parameter 4 default |
False |
|
Parameter 4 description |
A flag indicating whether files will be purged |
|
Parameter 4 type |
Boolean |
|
Parameter 5 |
Interval of recurring task |
|
Parameter 5 default |
None |
|
Parameter 5 description |
Interval between recurring archive or purge scheduled task. |
|
Parameter 5 type |
Integer |
|
Parameter 6 |
Number of occurrences |
|
Parameter 6 default |
None |
|
Parameter 6 description |
The maximum number of recurrences of the archive/purge task. The value should be -1 for infinite occurrences. |
|
Parameter 6 type |
Integer |
|
Parameter 7 |
Notify when completed |
|
Parameter 7 default |
True |
|
Parameter 7 description |
Indicates whether notification is required on completion of the archive or purge scheduled task. |
|
Parameter 7 type |
Boolean |
|
Parameter 8 |
Re-archive |
|
Parameter 8 default |
True |
|
Parameter 8 description |
A flag that indicates whether to re-archive previously archived file compositions. |
|
Parameter 8 type |
Boolean |
The following methods use the ArchivePurge client API to archive files.
-
ArchiveDocument
-
ArchiveReportObjects
-
ArchiveXmtlStructure