Add and Configure the Historical Events Driver

The Historical Events Driver stores historical copies of events in a separate database table. Along with copying events, the Historical Events Driver can purge the copied events from the Events table, resulting in better performance from the table. Since the purged events are copied to a different table, legacy activity can still be reported.

Add and Configure the Historical Events Driver

1. Go to Configuration > Hardware.

2. Right-click the Driver Manager in the hardware tree and select New Historical Events Driver.

3. Name the Historical Events Driver.

4. Select Driver and modify the Prune live events older than (days) field to the number of days of live events desired (as configured in the live event table). This section also allows historical events to be truncated. Define the length of time in number of months that a historical event should be saved before it is cleared from the system. For example, entering 3 in the Permanently delete historical events older than (months) field means that historical events will remain in the system for three months before it is removed.

5. Press Save and Close.

6. Right-click the driver and select Start.

Add Automatic Rules

Create Historical Event Driver commands that execute through the Automation Driver. For this example, five automatic rules will be added.

Copy Live Events

The first automation rule will be configured to copy live events.

1. Go to Configuration > Automation Rules.

2. Select Add. Name the automation rule Copy Live Events.

3. Next to Trigger, select New, then select Periodic for the trigger interval.

4. In Periodic, go to Interval and select Daily.

5. For Time of day, enter the time which the trigger should occur in 24-hour format. For this example, enter 21:00 (09:00 PM).

6. Press OK.

7. Next to Actions, select Add.

8. In Device Command, select Single, then select Choose. Select the Historical Events Driver.

9. Press OK.

10. Next to Command, select Choose, then select Start Copying Live Events.

11. Press OK, then press Save and Close.

12. Press Save and Close.

Stop Copying Live Events

The second automation rule will be configured to stop copying live events. To do this, follow the steps as outlined for the first automation rule, however the Time of day selected will be the time to stop copying live events and the Device Command will be to Stop Copying Live Events.

1. Go to Configuration > Automation Rules.

2. Select Add. Name the automation rule Stop Copying Live Events.

3. Next to Trigger, select New, then select Periodic for the trigger interval.

4. In Periodic, go to Interval and select Daily.

5. For Time of day, enter the time which the trigger should occur in 24-hour format. For this example, enter 23:00 (11:00 PM).

6. Press OK.

7. Next to Actions, select Add.

8. In Device Command, select Single, then select Choose. Select the Historical Events Driver.

9. Press OK.

10. Next to Command, select Choose, then select Stop Copying Live Events.

11. Press OK, then press Save and Close.

12. Press Save and Close.

Prune Live Events

The third automation rule will be configured to prune live events.

1. Go to Configuration > Automation Rules.

2. Select Add. Name the automation rule Prune Live Events.

3. Next to Trigger, select New, then select Periodic for the trigger interval.

4. In Periodic, go to Interval and select Daily.

5. For Time of day, enter the time which the trigger should occur in 24-hour format. For this example, enter 21:00 (09:00 PM).

6. Press OK.

7. Next to Actions, select Add.

8. In Device Command, select Single, then select Choose. Select the Historical Events Driver.

9. Press OK.

10. Next to Command, select Choose, then select Start Pruning Live Events.

11. Press OK, then press Save and Close.

12. Press Save and Close.

Stop Pruning Live Events

The fourth action will be configured to stop pruning live events. To do this, follow the steps as outlined in the previous section, however the Time of Day will be the time to stop pruning live events and the Device Command will be to Stop Pruning Live Events.

1. Go to Configuration > Automation Rules.

2. Select Add. Name the automation rule Stop Pruning Live Events.

3. Next to Trigger, select New, then select Periodic for the trigger interval.

4. In Periodic, go to Interval and select Daily.

5. For Time of day, enter the time which the trigger should occur in 24-hour format. For this example, enter 05:30 (5:30 AM).

   • Note: The trigger time must be set to stop pruning after the selected time to start pruning.

6. Press OK.

7. Next to Actions, select Add.

8. In Device Command, select Single, then select Choose. Select the Historical Events Driver.

9. Press OK.

10. Next to Command, select Choose, then select Stop Pruning Live Events.

11. Press OK, then press Save and Close.

12. Press Save and Close.

Truncate Historical Events

The final automation rule will be configured to truncate historical events.

1. Go to Configuration > Automation Rules.

2. Select Add. Name the automation rule Prune Live Events.

3. Next to Trigger, select New, then select Periodic for the trigger interval.

4. In Periodic, go to Interval and select Monthly. Define the Day of month and Time of day that the trigger should occur. For this example, select day 1, then enter 05:00 (05:00 AM):

5. Press OK.

6. Next to Actions, select Add.

7. In Device Command, select Single, then select Choose. Select the Historical Events Driver.

8. Press OK.

9. Next to Command, select Choose, then select Truncate Historical Events.

10. Press OK, then press Save and Close.

11. Press Save and Close.

To run the automation rules, go to Configuration > Hardware. Ensure that the Automation Driver is started by selecting it and viewing its status on the right side of the Hardware module. If stopped, right-click the Automation Driver and select Start.