Scheduled events - User Guide - Micetro - 25.2.0

Micetro Admin Guide
ft:locale
en-US
Product name
Micetro
Version
25.2.0

The "administrator" can configure the system to run scripts on a schedule, e.g., scheduling the system to collect a list of all users that performed at least one operation that day at midnight. Micetro also offers the option for the scheduled event to repeat at a regular interval.

Scheduled events are displayed in the Scheduled events section of the Event hooks data grid, which can be accessed from the Configuration tab of the Admin page.

Adding a scheduled event

To add a scheduled event:

  1. On the Configuration tab of the Admin page, select Event hooks in the left sidebar.
  2. In the Scheduled events section, select + Add.
  3. In the dialog, enter the necessary information:
    • Enabled: Select the checkbox to enable the scheduling process for the script. (If you ever want to disable the script, you can select Edit on the Row ... menu and clear this checkbox.)
    • Script name: Select the script to use. It's assumed that the script is located in the scripts folder in the Micetro Central data folder.
    • To use ScriptRunner to give the script temporary access to the API, check the Add ScriptRunner authentication paramaters checkbox. For more information, refer to Using the ScriptRunner.
    • Run on: Either enter the date and time the script should run, or use the date/time selector to set the date and time.
    • Repeat every: If this script should repeat at a specified frequency, select the checkbox. Then, use the dropdowns to select the interval, e.g., 1 week, 1 month, etc.
  4. Select Add.

Editing and removing scheduled events

Micetro enables you to manage scheduled events as needed, e.g., if you need to modify or remove a scheduled event.

To edit a scheduled event:

  1. Navigate to Admin > Configuration > Event hooks.
  2. In the Scheduled events section, locate the event you want to edit.
  3. Use the Row … menu to selectEdit.
  4. In the dialog, make the necessary changes to the event.
  5. Select Save

To remove a scheduled event:

  1. Navigate to Admin > Configuration > Event hooks.
  2. In the Scheduled events section, locate the event.
  3. Use the Row … menu to select Remove.
  4. In the confirmation dialog, select Remove.