Tool Schedules

You can schedule automations, collection extensions or engagements to run from sensor triggers under System Configuration on the Roles page.

1. Go to Configure > System Configuration > Roles.

2. Go to the Tool Schedules tab.

3. Click the + icon to create a new automation, collection extension or engagement.

Schedule an Automation

To schedule an automation, follow these steps:

1. In Tool Type, select Automation.

2. In When sensor is triggered, select a sensor.

3. In Perform Automation, select an automation.

NOTE: Depending on which sensor you choose dictates which automations display in this list.

4. In Run Mode, select one of the following. The default is Run Silently.

   • Run Silently: The sensor is triggered on the agent. The automation runs in the background with no user input. It will not affect the user experience.

   • Prompt: The sensor may interrupt the user workflow so the system opens a dialog box that prompts the user to respond yes or no if the automation will run.

     NOTE: The dialog box shows the text that you entered in the Notify Prompt field in Create Automations.

   • Notify: The sensor runs and the system opens a dialog box letting the user know that the automation will run. The user has no option to stop the automation.

   • Assist - Detected Issues: Adds Autofix to the sensor in Self-Help.

   • Self-Help: Appears only for sensors that are set up for Self-Help.

5. In Run On, select one of the following:

   • Active: Checks if the sensor is active. Evaluate sensors every 15 seconds. Active is the default.

   • When sensor activates: Checks if this is the first time this sensor has activated.

   • After sensor is active: Fires once during the first evaluation cycle after the sensor becomes inactive (transitions from active to inactive).

6. Minimum Interval: Sets the shortest time between two runs of the automation. The default is 5 minutes.

7. Execute Once: If the sensor returns multiple payload items, the automation normally runs once for each item. Setting Execute Once to Yes restricts the trigger to the first payload item only. It does not limit the automation to a single execution overall; the automation will run again whenever the Run On condition is met. The default is No.

8. Click OK.

Schedule a Collection Extension

1. On the Tool Schedules tab of the role, click the + icon. In Tool Type, select Collection Extension.

2. In When sensor is triggered, select a sensor.

3. Collection Extension: This list only displays Collection Extensions that have parameters that the sensor can provide.

4. In Run On, select one of the following:

   • Active: Checks if the sensor is active. Evaluate sensors every 15 seconds. Active is the default.

   • When sensor activates: Checks whether this is the first time this sensor has activated.

   • After sensor is active: Fires once during the first evaluation cycle after the sensor becomes inactive (transitions from active to inactive).

5. Minimum Interval: Sets the shortest time between two runs of the collection extension. The default is 5 minutes.

6. Execute Once: If the sensor returns multiple payload items, the automation normally runs once for each item. Setting Execute Once to Yes restricts the trigger to the first payload item only. It does not limit the automation to a single execution overall; the automation will run again whenever the Run On condition is met. The default is No.

7. Click OK.

Schedule an Engagement

1. On the Tool Schedules tab of the role, click the + icon. In Tool Type, select Engagement.

2. In When sensor is triggered, select a sensor.

3. Engagement: This list only displays Engagements that have parameters that the sensor can provide.

4. In Run On, select one of the following:

   • Active: Checks if the sensor is active. Evaluate sensors every 15 seconds. Active is the default.

   • When sensor activates: Checks whether this is the first time this sensor has activated.

   • After sensor is active: Fires once during the first evaluation cycle after the sensor becomes inactive (transitions from active to inactive).

5. Minimum Interval: Sets the shortest time between two runs of the engagement. The default is 5 minutes.

6. Click OK.

Restrict a Tool Schedule to Groups of Systems

To run a tool schedule only on some systems, select the Only run tool on group of systems check box and choose the groups. The check box is cleared by default. The tool schedule runs only on systems that belong to the selected groups.

This feature adds conditional logic to tool schedules, helping simplify role and configuration management, which is especially useful when different systems require different automation behaviors.

For example, you may have a single "ACME Windows 11" configuration which contains your standard roles, but need to only automate a service restart on "kiosk" machines. You can restrict that specific tool schedule to systems in the Kiosk group.

Group definitions are processed on the cloud master at least every 24 hours, or when a group definition is updated or a tool schedule is changed. Agents retrieve and update their group definitions every 4 hours.