Schedule and Execute Rules

Basic Time Based

The basic schedule type allows you to schedule a rule on a daily, weekly, or monthly basis.

• Frequency: Select any of the following radio-buttons to set the rule frequency:

  • Daily: The following options are available: 

    • Every Weekday (MON - FRI): Select Every Weekday (MON - FRI) to run the rule only on weekdays.

    • Every day: Select Every day to run the rule every day.

• Weekly: Select the particular day of the week the rule should be applied.

• Monthly: The following options are available when you select Monthly option:

  • On Day: Select the day of the month on which the rule must run.

  • On the: Select the number of any weekday in a month on which the rule must run.

• Start Date: Select the start date from which the rule execution starts.

• (Optional) End Date: Select the end date after which the rule execution ends.

• Rule Run Time: From the drop down menu,select the Rule run time.

  • Once - The Rule runs once only at a given time.

  • Repeat - The Rule run process repeats as per the given time interval.

• Preferred Start Time: Select the preferred start time in hours and minutes.

• Time Zone: This is set automatically depending on the Timezone selected in the Application settings > Default Time zone field. You can change the timezone to UTC.

• Rule run preference: Select how to run the rule from the following options:

  • Optimize run with other Rules: Select this option to stop other rules from running while this rule is running if they are dependent on the same objects. This option is selected by default.

  • Run independent of other Rules: Select this option to allow all other rules to run in parallel with this rule while it is running.

• Send notification email: By default, Rule success or failure messages are sent to the logged in user. However, you can add email of other users, who must be notified about Success or failure of this rule.

  • On Failure: Add email address of users who must be notified when this rule fails. You can add multiple emails separated by a comma.

On Success: Add email address of users who must be notified when this rule succeeds. You can add multiple emails separated by a comma.

• Run for historical periods: If start date provided is in the past, checking this option will run the rule from the selected start date to the present date. The number of runs is limited when the rules are run for a historical period. Refer to the following additional note - 

Note: 

When the start date in this scheduler is set to a date in the past, it will run for the historic period, and load data.

Example: If you have the rule scheduled to run daily, then you can run it for the historical period of last 200 days. In the case of a weekly schedule, it will run for a maximum of 200 weeks. This basically helps prevent a huge number of rule runs being triggered by mistake, or when you do not realize how much time it is going to take for all the runs to complete. It puts all of the other rules in queue and delays other important rule runs.

Advanced 

Using the Advanced schedule type enables you to run the rules as frequently as every two hours.

• Cron Expression: Enter the Cron expression that allow the rule runs accordingly. 
  Note: The minimum time period between rule runs is two hours.

• Timer icon: Click this icon to view the next five rule run schedules for the cron expression provided (as displayed in the image provided).

• Start Date: Select the start date for the rule runs.

• End Date: Select the end date for the rule runs (Optional).

• Time Zone: This is set automatically depending on the time zone selected in the Application settings > Default Time zone field. You can change the time zone to UTC.

• Rule run preference: Select how to run the rule from the following options:

  • Optimize run with other Rules: Select this option to stop other rules from running while this rule is running if they are dependent on the same objects. This option is selected by default.

  • Run independent of other Rules: Select this option to allow all other rules to run in parallel with this rule while it is running.

• Send notification email: By default Rule success or failure messages are sent to the logged in user. However, you can add email of other users, who must be notified about Success or failure of this rule.

  • On Failure: Add email address of users who must be notified when this rule fails. You can add multiple emails with a comma.

On Success: Add Email address of users who must be notified when this rule succeeds. You can add multiple emails separated by a comma.

Events Framework 

You can run a rule using an event from the Events Framework in Gainsight. Using the Event Schedule Type, you can run the rule using CURL command. CURL command is a handy way to trigger a rule outside of Gainsight. In a broader sense, event-based triggering of a rule enables you to integrate rules deeper with non-Gainsight services if you have developer support. Events-based triggering of a rule helps you avoid unnecessary scheduling of a rule. For example, you might have scheduled a rule to run every two hours to check if the S3 bucket has data, this rule runs every two hours adding some load to the server. In this scenario, you can trigger the rule using CURL command only when you are sure that data is present in the S3 bucket.

Limitations/Recommended Usage

• Use the events-based triggering of a rule only when it is required. For example, when you are sure that the rule has fetched data from the S3 bucket, then you can use the CURL command to trigger the rule.

• If there is a pending execution of a rule, the event-based execution request will be rejected. You can find the rejection reason in the rule’s execution history.

• For a Customer, 100 event-triggered rule executions are allowed in a day (24-hour period). The 24-hour period is between 12 am in a day to the next 12 am UTC.

Schedule Rules based on events

To use events in the Rules Schedule, you must first create a Topic and then add Events related to that topic. 

1. Navigate to Administration > Rules Engine.

2. Create and configure a Rule.

3. Go to the Schedule step.

4. In the Schedule Type list, select Event.

5. Select a Topic from the list.

6. Select an event from the list.

7. Select the Rule run preference from the following options:

   • Optimize run with other Rules: Select this option to stop other rules from running while this rule is running if they are dependent on the same objects. This option is selected by default.

   • Run independent of other Rules: Select this option to allow all other rules to run in parallel with this rule while it is running.

8. Click Schedule

S3 File 

This schedule type is applicable only if your rule has an S3 dataset. You can use this schedule type to automatically trigger a rule which has an S3 dataset, whenever a new file is uploaded to the configured S3 bucket. When you upload a new CSV file which has the same configuration as defined in S3 dataset, the S3 dataset rule is triggered automatically.

To schedule a rule based on an Event for S3 File option:

1. Navigate to Administration > Operations > Rules Engine.

2. Create and configure a Rule.

3. Navigate to the Schedule step.

4. In the Schedule Type list, select Event.

5. Select the S3 File option.

6. From the Task drop-down menu, select the S3 dataset.

7. Select the Rule run preference from the following options:

   • Optimize run with other Rules: Select this option to stop other rules from running while this rule is running if they are dependent on the same objects. This option is selected by default.

   • Run independent of other Rules: Select this option to allow all other rules to run in parallel with this rule while it is running.

8. In the Send Email Notification field, enter the email addresses of the users to be notified in case of Success or Failure of the Rule.

9. Click Schedule.