Use this function to archive event journals. To use this function you will need to log in with a role (e.g.Engineer) who has full privilege (privilege 1..8).
This function is a blocking function. It blocks the calling Cicode task until the operation is complete.
Syntax
INT SOEArchive(STRING Path[, STRING ClusterName])
Path: (optional)
Path set for SOEArchive e.g. "C:\temp\SOEArchive"
If the above Path is not entered the default Archive Path of Alarm Server configuration will be used.
Note: The volume where data is to be saved should be labeled. This includes any removable storage devices. If this is not the case, archiving will not succeed and a message will display on the SOE page.
sClusterName:
Optional cluster on which to perform mounting operation. If not specified, the operation will be performed on all clusters.
Return Value
0 (zero) if successful, otherwise an error code is returned.
Examples
SOEArchive(<path>, <ClusterName>) <-- Archiving specific Cluster of SOE and Summary Data to a specific location
SOEArchive("", <ClusterName>) <-- Archiving specific Cluster of SOE and Summary Data to the default Archive Path defined in Alarm Server configuration (form)
SOEArchive(<path>) <-- Archiving all Clusters of SOE and Summary Data to a specific location
SOEArchive() <-- Archiving all Clusters of SOE and Summary Data to the default Archive Path defined in Alarm Server configuration (form)
See Also
Published June 2018