Skip to main content

Triggers

Overview#

Triggers enable you to execute your automation based on specific criteria. You can run automation on an ad-hoc basis, but you can do it by configuring a particular trigger if you want to pre-plan your executions.

Trigger Types#

IntelliBuddies supports the following types of Triggers:

Trigger TypeDescription
TimeInvokes a job at particular time based on specified schedule criteria
EmailInvokes a job when a new email arrives on the specified email box and matches the specified criteria
File SystemInvokes a job when a specified file event(s) occur under the specified folder(s)

Permissions#

You can manage your automation triggers from the Triggers page inside Control Room. To access and perform operations on the Triggers page, you need to have appropriate permissions for this entity.

PermissionDescription
ViewView all Triggers and their details
Note: you need to have View access to Buddies and Processes also
EditEdit Trigger details
CreateCreate a Trigger
DeleteDelete a Trigger

Creating a Trigger#

You can create a new Trigger from Control Room > Triggers page.

  • Click on Grid-Menu > New Trigger button

Trigger Details#

  • Type in the Name for the trigger to identify easily
  • Choose a Process that you want to execute
  • Select the Trigger Type from the dropdown
  • Fill in the triggger criteria based on the type selected: Time Trigger Criteria | Email Trigger Criteria | File System Trigger Criteria
  • Optionally, specify the trigger Start Date. By default, the trigger will be initiated immediately after creation.
  • Optionally, specify the trigger Expiry Date. If specified, it will stop triggering new jobs after this date. By default, the trigger will never expire.

Execution Target#

  • In the Execution Target tab, select the specific Smart Buddy that you want to execute the process

    Note: If you select the Dynamic option, any of the available Smart Buddy will pick up the job for execution

Parameters#

Time Trigger Criteria#

You can specify your time trigger criteria by selecting the appropriate Schedule Types from the dropdown.

Schedule Types#

Schedule TypeDescription
DailyUse this schedule type to trigger a job execution on one or more specified schedule(s) daily
Specific DatesUse this schedule type to trigger a job execution on one or more specified schedule(s) on all the date(s) specified
WeeklyUse this schedule type to trigger a job on one or more specified schedule(s) on all the selected day(s) of the week
MonthlyUse this schedule type to trigger a job on one or more specified schedule(s) on all the selected day(s) of the week within the specified month(s)
RecurringUse this schedule type to trigger a job repeatedly on the specified time interval

Email Trigger Criteria#

You can specify the email trigger criteria using the following fields.

FieldDescription
Server TypeSpecify the email server type. Available Options: POP3 or IMAP
Server HostSpecify the email server hostname or URL
PortSpecify the email server listening port number
Email AddressSpecify the login email account
PasswordSpecify the login email account password
Require SSLCheck this box if the email server utilizes SSL for communication
Incoming Email Filter OptionsCheck this box if you want to specify a filter while fetching emails from the Server. You can specify Filter on the following email fields.
  • Sender: filter emails based on the sender email account
  • Subject Contains: filter emails if the subject field contains the specified text
  • Sent Since: filter emails based on the date received
Message Polling IntervalSpecify the time interval in minutes to check emails in the server

Filesystem Trigger Criteria#

You can specify the filesystem trigger criteria using the following fields.

FieldDescription
Folder To MonitorSpecify the folder to be monitored. You can either specify the local filesystem path or the network path.
For example: C:\MyMonitorFolder or \\file-server\MyMonitorFolder
FilterYou can specify the wildcard filter if you want to trigger based on certain file types only.
For example, specifying *.pdf here would trigger only when a PDF file is either Created/Modified/Deleted/Renamed under monitored folder(s)
Include SubfoldersCheck this box if you want to monitor all the nested folders under the specified Folder To Monitor
Events To MonitorCheck the required events to be monitored. You have the following options:
  • Created: Check this if you want to activate the Trigger whenever a file is created or copied or moved inside a monitored folder(s)
  • Modified: Check this if you want to activate the Trigger whenever a file inside a monitored folder(s) gets modified
  • Deleted: Check this if you want to activate the Trigger whenever a file gets deleted inside a monitored folder(s)
  • Renamed: Check this if you want to activate the Trigger whenever a file gets renamed inside a monitored folder(s)
  • Binding Email Trigger Parameters#

    Email Trigger provides runtime parameters that specify the trigger event details. These details would be necessary for the Process to handle its tasks. You can bind these runtime parameters to the corresponding input arguments of the Process. Here is the list of runtime parameters provided by Email Trigger.

    NameTypeDescription
    $Email_MessageSystem.Net.MailMessageThe email message received triggered this process. You can access details such as sender, subject, received date, body text, attachments, and any other information from this parameter.

    Binding File System Trigger Parameters#

    File System Trigger provides runtime parameters that specify the trigger event details. These details would be necessary for the Process to handle its tasks. You can bind these runtime parameters to the corresponding input arguments of the Process.

    Here is the list of runtime parameters provided by File System Trigger.

    NameTypeDescription
    $File_EventTypeSystem.IO.WatcherChangeTypesSpecifies the type of file event that triggered this process execution. It can be one of the following values
    • Created(1): The file was created
    • Changed(4): The file was modified
    • Deleted(2): The file was deleted
    • Renamed(8): The file was renamed
    $File_NameSystem.StringSpecifies the name of the file along with file extension
    $File_PathSystem.StringSpecifies the full path including the folder and file name with extension
    $File_FolderPathSystem.StringSpecifies the folder path where the file resides
    $File_ExtensionSystem.StringSpecifies the extension of the file
    $File_LengthSystem.DoubleSpecifies the size of the file
    $File_CreationTimeSystem.DateTimeSpecifies the created date and time of the file
    $File_LastWriteTimeSystem.DateTimeSpecifies the modified date and time of the file
    $File_LastAccessTimeSystem.DateTimeSpecifies the last accessed date and time of the file
    $File_IsReadOnlySystem.BooleanSpecifies whether the file is readonly or not. A value of true indicates the file is readonly.

    Updating a Trigger#

    You can update an existing trigger to change the details. You can do this from the Triggers page

    • Select a trigger to update
    • Select from Context-Menu > Edit option
    • Update the details
    • Click on Update

    Deleting a Trigger#

    • On the Triggers page, select the Trigger to be removed
    • Select from Context-Menu > Delete option
    • Confirm the operation by selecting Yes

    Note: User with the Administrator role can delete an existing Trigger

    Disabling a Trigger#

    • On the Triggers page, select the Trigger to be disabled
    • Select from Context-Menu > Edit option
    • Turn on the disabled button
    • Click on Update

    Note: Disabling a Trigger will block the execution of automation

    Note: Disabled Trigger can be enabled back by turning off the disabled button