Using Scheduler to Trigger Archiving

You can use Scheduler to trigger event archiving. However, the steps needed to complete this task will differ if the system you are running is in single process or multi-process mode.

If you attempt to trigger archiving in multi-process mode, Scheduler needs to invoke a custom Cicode function that includes the following:

Login (Username, Password);
SOEArchive()

Follow the instructions outlined in Configure Equipment for Scheduling to define new Equipment. The Equipment name can be any name specified by the user.

Follow the instructions outlined in Equipment State Properties to define the 'Trigger' and 'OFF' states for the newly added equipment.

To trigger archiving in single process mode:

Note: For archiving to succeed in single process mode you need to log in to a display client in Runtime.

1. Open the 'Trigger' Equipment State form.
2. In the Entry Action field enter the function SOEArchive(). Click OK to save.
3. Start runtime and log in to the display client.
4. Open Scheduler. The Archive Equipment branch should be displayed in the equipment hierarchy.
5. Following the instructions outlined in Add a Schedule Entry, schedule the state 'trigger' to occur.

When the time transitions for this scheduled task, SOEArchive() will be called and archiving will be triggered.

To trigger archiving in Multi Process Mode:

1. In the Cicode Editor create a custom Cicode function and save it. This Cicode function needs to include login information. For example:

FUNCTION
ArchiveMyData()
Login("Engineer","citect");
SOEArchive();
END

2. Open the 'Trigger' Equipment State form.
3. In the Entry Action field enter the name of the custom Cicode function. e.g.ArchiveMyData(). Click OK to save.
4. Open Scheduler. The Archive Equipment branch should be displayed in the equipment hierarchy.
5. Following the instructions outlined in Add a Schedule Entry, schedule the state 'trigger' to occur.

Published June 2018