Initiate Archiving with the SOEArchive() Cicode Function

System Model > Alarms > Archive the Alarms History > Initiate Archiving with a Cicode Function

Initiate Archiving with a Cicode Function

You can manually trigger event data archiving with the Cicode function SOEArchive().

Note: You need to be logged in as a user that can run Cicode to initiate archiving with the SOEArchive() function.

When you call the function, archiving will commence according to the values defined for the "ArchiveAfter" and "KeepOnlineFor" parameters (see Configure the Archiving Parameters).

If required, you can use the function's Path attribute to specify a destination for the archived data. If no path is specified, the data will be archived to the location defined in the Archive Path property on the associated alarm server (see Specify a Destination for Archived Events).

Note: If you use this method to archive your event data, you will need to regularly call the SOEArchive() function to avoid data becoming inaccessible. For example, if the "ArchiveAfter" parameter is set to 1 week, and KeepOnlineFor is set to 2 weeks, you will need to manually trigger archiving after every eight days to confirm that all data is captured.