This document will focus on how to create an Automation on Canopy Manage and the different types of Automations.

What Are They?

Automations are a set of instructions for when a specific scenario occurs, allowing it to automatically perform a pre-determined action. You can reach the Automations page by selecting the Automations icon on the right-hand-side navigation bar in Canopy Manage. Inside is a list of all existing Automations, where you will be able to create new and modify existing Automations.

Creating a New Automation

To create a new Automation select the New Automation button in the top right corner. Then select the type of Automation you wish to create.

Asset

  1. Enter a name and a description to distinguish it from other Automations. 
  2. Chose the event to trigger the Automation.
  3. Select the condition that the event must meet for the automation to run in the Configure conditions section. Use the dropdown arrows to see a list of the possible conditions.
  4. Lastly, the Configure actions gives the actions you want to perform when the trigger is activated.

Custom Actions

  1. Enter a name and a description distinguish it from other Automations.
  2. Select an event:
    • Failed – Occurs when a Custom Action fails to execute successfully
    • Started – Occurs when a Custom Action starts executing
    • Succeeded – Occurs when a Custom Action finishes executing successfully
       
  3. Once you have selected the event the Configure conditions need to be set for the Automation. Use the dropdown arrow to see a list of the Custom Actions that have previously been created for you to choose from.

  4. Lastly, the Configure Actions gives the actions you want to perform when the trigger is activated.

Dates

  1. Firstly, the Automation needs to be named and a description entered.
  2. Select an event, click on the dropdown arrow, an automation can be set to run on a specific date or on a recurring schedule.  

    **Note: When an automation is set to run on a specific date, the automation will be deleted once it has been executed successfully.**
  3. If the Automation has been set to run on a specific date, on the Configure conditions click the Select a date box and a calendar will pop up for the date selection.
  4. If the Automation has been set to run on a recurring schedule, on the Configure conditions there are multiple ways to select the conditions that the event must meet for the Automation to run.
  5. Lastly, the Configure Actions gives the actions you want to perform when the trigger is activated. You can select from Connector or Custom Action.

Probes

  1. Firstly, the Automation needs to be named and a description entered.
  2. Then select an event, click on the dropdown arrow to see a list of the events
    • Offline – Occurs when a probes connection is disconnected
    • Online – Occurs when a probe establishes a connection
    • Plugin Installed – Occurs when a plugin is installed on a probe
    • Plugin Uninstalled – Occurs when a plugin is uninstalled from a probe
    • Plugin Updated – Occurs when a plugin is updated to a different version
  3. Lastly, the Configure Actions gives the actions you want to perform when the trigger is activated. You can select from Connector or Custom Action.