How to Schedule an Action or Notification at a Certain Time?

Required Permissions

This section requires either the Scheduler Management or Domain Admin permissions from your Domain's administrator.

Check What are the Design Tasks? to learn more about permissions to work with Design Mode and other tools.

Abstract

• Create a Scheduled Action
• Scheduled Action Types
  • Powershell Script
  • eLegere Script
  • Send Email
  • Stored Procedure
  • Python Script
  • Remote API
  • Azure Function
  • AWS Lambda
  • Refresh Storage on Connection
• Manage, Edit, and Delete Scheduled Actions
  • The Scheduler's List and Commands
  • Execution Status and Logs

Learn how to configure scheduled actions in your eLegere Domain at specific dates and times.

Designers and administrators can create scheduled actions and decide the time through the Scheduler panel.

Note

There are different kinds of scheduled actions that you can configure. Each scheduled action has its own settings, but the creation and certain options are common to every scheduled action.

Check Create a Scheduled Action to setup a Scheduled Action

The particular settings of each Scheduled Action types are discussed in Scheduled Action Types.

Create a Scheduled Action

Follow the steps below to create a Scheduled Action in the Scheduler.

Note

Step 6 changes according to the selected Scheduled Action type.

At step 6, read the paragraph Scheduled Action Types to learn how to configure the specific action type's tab settings.

1. In the Home, click on the Scheduler panel in the sidebar.

   

2. In the Scheduler panel, click on the Add Job button. The action opens the Add Job window.

   

3. The previous step opens the Add Job window.

   

   In the Add Job window, you can choose the Scheduled Action's type.

   

   (1) Choose the Scheduled Action's type

   Scheduled Actions Types

   You can configure the following Scheduled Action types:

   • Powershell Script Runs a Powershell script at a certain date and time.
   • eLegere Script Runs a eLegere Script at a certain date and time. (Check eLegere Script section to learn more about eLegere's scripting language.)
   • Send Email Sends a Email notification at a certain date and time.
   • Stored Procedure Runs a Stored Procedure directly on the eLegere database without interacting with an application at a certain date and time.
   • Python Script Runs a script written in the Python programming language at a certain date and time.
   • Remote API Sends an API request to a third-party software to execute an action or obtain data.
   • Azure Function. Launches a function from Microsoft Azure cloud computing platform.
   • AWS Lambda Launches a function from the Amazon Web Services cloud computing platform.
   • Refresh Storage Refresh the data of a Storage built on a Connection at a certain date and time.

   Read the Scheduled Action Types paragraph in this document to learn about the settings for each type.

   (2) Click on the Confirm button to create and configure the action. (Click on Cancel to abort the creation instead.) The action leads to the Scheduled Action's configuration.

4. In the Scheduled Action's settings, you can read the Scheduled Action's type on the window.

   

   Insert the required settings.

   

   • (1) Name Insert a name to identify the Scheduled Action.

   • (2) Type Choose if the scheduled action happens one time or in a recurring time.

     If happens one time, the Job tab displays only the date and time for running the Scheduled Action.

     

   • (3) Enabled Check this option to activate the Scheduled Action. (By default isn't checked.)

   • (4) Frequency Type Decide if the action runs daily, weekly or monthly.

   • (5) Recurs every Decide the action's frequency in days, weeks, and months according to point (4).

     If Weekly, choose the days to run the action.

     

     If Monthly, decides either a period in the month or a certain day. You can flag the option Last Day of the Month: sends the notification or runs the action the last day of each month.

     

   • (6) Choose the specific moment when the scheduled action runs in the day.

   • (7) Choose a Starting Date and End Date for the Scheduled Action's recurring execution.
   • (8) The window yields a brief descriptor starting from the window's settings.

5. Check Scheduled Action Types to learn how to configure the specific action type's setting. The specific action type setting is the tab between the Job tab and the Settings tab.

6. This step is optional. Turn on the toggle-switch to enable a restriction; i.e. conditions to satisfy to trigger the Scheduled Action in the configured time frame. Click on the icon to open the Formula Editor and insert a Formula specifying the conditions.

   

7. This step is optional. Decide if you need an email notification Alert after the Scheduled Action's Execution.

   

   Turning ON the Success toggle-switch enables to configure an email.

   

   • Choose a Sender email address from the list that your Admins has created.
   • Insert the Recipients addresses
   • Check Send Individually if you want to send an mail to each Recipient instead of single email with multiple recipients. (By default is unchecked. The Scheduler sends a single email with all the recipients in the To email field.)
   • Insert a Subject
   • Insert a Body

   In case of Success, the action warns the recipients of the success.

   Turning ON the Failure toggle-switch enables to configure an email.

   

   • Choose a Sender email address from the list that your Admins has created.
   • Insert the Recipients addresses
   • Check Send Individually if you want to send an mail to each Recipient instead of single email with multiple recipients. (By default is unchecked. The Scheduler sends a single email with all the recipients in the To email field.)
   • Insert a Subject
   • Insert a Body

   In case of Failure, the action warns the recipients of the success.

8. Click on the Confirm button to save the Scheduled Action's creation. (Click instead on the Cancel button to abort.)

   

Success

You have configured a Scheduled Action that runs at the specified date and time.

Scheduled Action Types

Learn how to configure the specific tab of each Scheduled Action type.

At step 6 of Create a Scheduled Action, you must configure the specific settings of the type you have selected.

Scheduled Actions Types

• Powershell Script
• eLegere Script
• Send Email
• Stored Procedure
• Python Script
• Remote API
• Azure Function
• AWS Lambda
• Refresh Storage on Connection

Powershell Script

If you have chosen the Powershell Script type, configure the following settings.

1. Insert the path to the Powershell script on the eLegere's installation.

2. Click Add Parameters button to add a couple of parameter' names and value to be passed to the script.

3. Insert the parameter's Name and Value to be passed.

Repeat steps 2 and 3 for each parameter to be passed to the script.

eLegere Script

If you have chosen the eLegere Script type, insert the eLegere Script in the Body of the eLegere Script section.

Decide also the maximum time limit for the Scheduler to wait before considering the script timed out. (By Default are 15 seconds.)

Send Email

If you have chosen the Send Email type, configure the following settings.

1. Sender Choose an email address from the list that your administrator has configured.
2. To Type the email addresses that must receive the email notifications.

3. Subject Insert a standard subject for the email notification. You can insert Formulas between [].

   Warning

   Inserting formulas either in the Subject or the Body requires enclosing the formula between two squared brackets []. Inside Subject and Body in Send Email Scheduled Actions, the Scheduler interprets formulas outside squared brackets [] as standard text and won't run them.

4. Body Insert the content of the email's notification by using the embedded editor. You can insert Formulas between [].

   Warning

   Inserting formulas either in the Subject or the Body requires enclosing the formula between two squared brackets []. Inside Subject and Body in Send Email Scheduled Actions, the Scheduler interprets formulas outside squared brackets [] as standard text and won't run them.

5. Check Send Individually if you want to send an mail to each Recipient instead of single email with multiple recipients. (By default is unchecked. The Scheduler sends a single email with all the recipients in the email's To.)

Stored Procedure

If you have chosen the Stored Procedure type, configure the following settings.

1. Insert the Stored Procedure's name on the database.
2. Click on Add Entry to add a couple of value and key for the Stored Procedure

Clicking on Add Entry inserts as couple of key and value. Insert in the line the key and the value to be passed to the Stored Procedure.

Python Script

If you have chosen the Python Script type, configure the following settings.

1. Insert the path to the Python script on the eLegere's installation.

2. Click Add Parameters button to add a couple of parameter' names and value to be passed to the script.

Repeat step 2 for each parameter the script requires.

Remote API

If you have chosen the Remote API type, configure the following settings.

1. The request method: GET or POST.

2. The URL for the HTTP request triggering the action from the API.

3. Provide the Authentication: all the keys and values that the API requires for the access.

4. Provide the Headers: all the keys and values with the metadata required to perform the action.

5. Provide the Body: all the keys and values required to perform the desired action.

Azure Function

If you have chosen the Azure Function type, configure the following settings.

1. The request method: GET or POST.

2. The URL for the HTTP request triggering the Azure Function.

3. The Auth Key is the key required to access and launch the Azure Function.

4. Provide the Body: all the keys and values required to execute the Microsoft Azure function.

AWS Lambda

If you have chosen the AWS Lambda type, configure the following settings.

1. The method of the request: GET or POST.
2. The URL of the AWS Lambda Function's endpoint.
3. The Access Key as first part of the access credentials.
4. The Secret Key as second part of the access credentials.
5. The Service executing the action on the Amazon Web Services.
6. The Region of the AWS server executing the action.
7. Provide the Body: all the keys and values that the AWS Lambda Function needs.

Refresh Storage on Connection

If you have chosen the Refresh Storage type, configure the following settings.

1. Choose:
   • Append to Existing Takes the latest changes from the Connection and add them to the Storage as new rows without changing the existing data.
   • Replace all data Replaces all the data in the Storage with the data from the Connection.
2. Choose the Storage you want to update periodically.

Manage, Edit, and Delete Scheduled Actions

Learn how to manage, edit, and delete scheduled actions in the Scheduler

Abstract

• The Scheduler's List and Commands
• Execution Status and Logs

The Scheduler's List and Commands

You can manage all the Scheduled Actions from your Domain in the Scheduler.

1. Name Reports the Scheduled Action name
2. Type Reports the Scheduled Action's type.

3. Last Execution Date Reports the latest time the Scheduled Action has run.

   Click on the Toggle date-time selector icon and choose a date and time to filter the actions for.

   

   Click on the icon next to Toggle date-time selector to remove the Last Execution Date filter.

   

4. Last Execution Status Reports if the Scheduled Action succeeded or failed during the last execution.

5. Enabled Reports if a Scheduled Action is Enabled or not. An action runs at the specified date and time if and only if is Enabled.

   You can filter the Scheduled Action by their Enabled\Disabled status by checking the box.

   

6. The column lists the commands to manage a Scheduled Action. From the left to the right:

   • Edit Opens again the Scheduled Action to change the settings.

   • Delete Deletes the Scheduled actions.

     • A window will require for confirmation. Click on Delete to delete the action or Cancel to abort the deletion.

       

   • Run Forces the Scheduled Action's execution manually outside the scheduled date and time.

   • Clone Creates a copy of the Scheduled Action.

Tip

Click on a column to order in Ascending or Descending order the Scheduled Actions according to that field.

Execution Status and Logs

If you want more info about a Scheduled Action's execution status, click on the icon next to a Scheduled Action to open the Job Details.

In the Job Details, you can read the Execution Date in descending order, the Start Time, End Time, and the Status (i.e. Success/Failure result).

Click on the Log button to access a detailed Log about a particular execution in the list.

Tip

Click on the Refresh button to update the Scheduled Action's log.