Scheduler

The Scheduler module in Ambience allows you to set up jobs to automatically trigger the generation of these reports. The Scheduler module also allows you to view the status of the job, or sent an email to you, if it is being set up. The Scheduler module consists of three pages:

  • Status – Shows the status of the job triggers that have run or are currently running (shows last 200)

  • Trigger – Lists all jobs that are available for the owner

  • Calendar – Lists all constraints shared among the triggers

In the below example, a job trigger that occurs on the 10th of each month. The selected day must be a weekday and must not be a public holiday.

Calendar

The Calendar page in the Scheduler module allows you to set conditions or constraints in these calendars and apply them onto the trigger to determine when the job is to be run, such as which year, month, day and/or time, as well as the time zone. Do note that the calendar constraints may be shared and can be used by more than one trigger. Use the following steps to create a simple public holiday calendar:

  1. Click on the “Elixir Ambience” logo and select the “All Services” option in the left panel, then select “Scheduler” in the right panel

  2. The “Scheduler” page will appear.

  3. Click on the “Calendar” option in the left panel.

  4. Click on the “Add” button on the upper right corner of the “Calendar” page. The “Add Calendar” dialog box will appear.

  5. In the dialog box, key in a unique name .and click on the “OK” button to create the new calendar.

  6. The new calendar is created and will appear in the management page.

  7. To edit the calendar, click on the name of the calendar under the “Name” column.

  8. The “Scheduler / Calendar” panel will appear.

  9. In the “Properties” tab, key in and select the following:

    • “Name” field – Edit the unique name of the calendar

    • “Description” field – Key in a brief description for the calendar (optional)

    • “TimeZone” field – Selects timezone from drop-down list (optional but recommended) (in this example, select “Singapore”)

  10. In the “Constraints” tab, select the following:

    • “Calendar matches times when” field – Selects “Day of Year”

    • The next field is dependent on the above field, one or more fields may appear

  11. Click on the “Add” button in the “Constraints” tab to add a new date.

    By default, the current date is selected.

  12. Click on the “Calendar” icon and select the correct date.

  13. Repeat steps 6 and 7 until all public holidays are added.

  14. Click on the “Apply Changes” button to save the changes.

  15. Click on the “Previous” icon to return to the management page.

Repeat the above steps to create a weekday calendar that involves Monday to Friday only.

Trigger

A trigger defines the following:

  • Chain or chainset to run

  • Frequency or interval of the trigger

  • Calendars to decide when a trigger should fire at a particular month, date, day and/or time, as well as the time zone

Use the following steps to create a simple trigger:

  1. Click on the “Trigger” option in the left panel to display the list of triggers.

  2. Click on the “Add” button on the upper right corner of the page.

  3. The “Add Trigger” dialog box will appear.

  4. Key in a unique name for the trigger in the “Name” field and select the type of trigger for the “Type” field.

    There are two types of triggers:

    • ETL – Job run by ETL chain/chainset

    • Report – Job run by defining report

  5. The new trigger is created and will appear in the management page.

  6. To edit the trigger, click on the name of trigger under the “Name” column. The “Scheduler / Trigger” panel will appear.

  7. In the “Properties” tab, key in and select the following:

    • “Name” field – Key in a unique name for the calendar

    • “Description” field – Key in a brief description for the calendar (optional)

    • “TimeZone” field – Selects timezone from drop-down list (optional but recommended) (in this example, select “Singapore”)

    • “Enabled” field – Ensure this field is selected

  8. In the “Constraint” tab, select the following:

    • “Day of Week – Weekdays” – Selects “Include”

    • “Public Holiday Singapore” – Selects “Exclude”

    This will ensure only weekday and non-public holidays will trigger the job.

  9. In the “Frequency” tab, key in and select the following:

    • “Trigger Mode” field – Selects “Run Monthly”

    • “Monthly” field – Selects all months

    • “Days” field – Selects this field and key in “10”

    • “Time of Day” field – Key in “9” in the “Hour” field

  10. The last tab depends on which type of trigger is selected prior. In this case, ETL is selected.

  11. In the “ETL” tab, select the scheduler ETL that was created in Section 2.5.3 Scheduler ETL.

  12. Click on the “Apply Changes” button to save the changes.

  13. Click on the “Previous” icon to return to the management page

Next: Annex