SOEArchive

Use this function to archive event journals. To use this function you need to log in with a user assigned to a role that has full privileges (privilege 1..8).

Note: When you call this function, archiving will commence according to the values defined for the Plant SCADA parameters "ArchiveAfter" and "KeepOnlineFor". For more information, see the topic Configure the Archiving Parameters in the main help.

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)

The path set for SOEArchive (for example, "C:\temp\SOEArchive").

If a path is not entered, the default archive path for the alarm server configuration will be used.

sClusterName:

Optional cluster on which to perform mounting operation. If not specified, the operation will be performed on all clusters.

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.

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

Sequence of Events (SOE) Functions