Tools → Scheduler

About the Scheduler

The Scheduler allows you to both manage the scheduled jobs for dashboard delivery and create and manage scheduled jobs for physical schema loads or load plans, data notifications, and schema notifications.

Note

Load plans are scheduled jobs to load multiple physical schemas as well as a single physical schema. The multi-schema loading is available as a preview feature, to enable it, enable the Enable Multi-Schema Loading option in the Cluster Management Console (CMC).

Incorta sends the scheduled dashboards, data notifications (dashboard alerts), or schema notifications in an email to the recipients you specify. You can also deliver a dashboard to a Data Destination.

Important: Etc/GMT time zones

When you select a time zone for scheduled jobs, note that Etc/GMT time zones have the opposite offset of similar GMT time zones. In other words, the Etc/GMT+x is the opposite of the GMT+x:00; however, the Etc/GMT+x is the same as the GMT-x:00. For example, if the UTC time is 12:00pm, then the time in the Etc/GMT+4 and GMT-4:00 time zones will be 8:00am while the time in the Etc/GMT-4 and GMT+4:00 time zones will be 4:00pm.

Note
  • To minimize the impact of Daylight Savings Time (DST) on job start time, ensure that any scheduled job you create runs at least once before DST occurs.
  • If you have a browser window open before DST occurs, you will need to refresh the browser page to view the correct Next Run time of a scheduled job after DST occurs.

Scheduler access rights

To access the Scheduler, in the Navigation bar, select Scheduler.

All Incorta Analytics users can access the Scheduler, but not all users can create or manage scheduled jobs. Only users who created or have edit rights to a dashboard can edit a scheduled job for a dashboard delivery. The users who create or have edit rights to a schema can create and manage a scheduled schema load or a load plan.

Note

If you don't have edit rights and didn't create a schema, the +New button is disabled.

Scheduler Anatomy

The Scheduler consists of the following:

Context Bar

The context bar consists of the four tabs:

  • Dashboards: contains a list of the scheduled dashboards deliverables.
  • Load Plans: contains a list of scheduled load plans.
  • Data Notifications: contains a list of the configured data notifications (dashboard alerts).
  • Schema Notifications: contains a list of the configured schema notifications.

Action Bar

The action bar consists of:

  • +New

The +New button opens the Add New menu, which is available when you open any tab except for the Dashboard tab.

OptionDescription
Add Schema LoadAdds a new scheduled schema load job.
Add Load PlanAdds a new load plan job.
Create DataNotificationsCreates a new dashboard notification.
Import Data NotificationsImports existing .zip data notifications file(s).
Create Email NotificationsCreates a new email notification upon a schema load success, failure, interruption, or finishing with errors.
Note

The +New button isn't available on the Dashboards tab. You create a dashboard delivery scheduled job from the Content Manager.

The Search bar contains a search text box that is only available on the Schema Notifications and Load Plans tabs. For schema notifications, you can search for any part of a given job name. On the Load Plans tab, you can search by the schema name or the load plan name.

The Search bar shows:

  • The number of items in the result list
  • The number of selected items in the result list with the option (x) to deselect the items
  • Delete icon, to delete all selected items
  • Export icon, to export Data Notifications (only available on the Data Notifications tab)

List View

Dashboards list view

The Dashboards list view displays all of the scheduled delivery jobs that you created for a certain dashboard.

PropertyControlDescription
Select AllcheckboxA header control to select all scheduled jobs for dashboard delivery.
NametextThe scheduled job unique name that you entered while creating the scheduled dashboard delivery.
OwnertextThe username that created the scheduled dashboard delivery.
DashboardlinkSelect the dashboard name to navigate to the corresponding dashboard.
StatuslinkThe status of the scheduled job. When selected, a prompt is displayed to confirm if you want to suspend/activate the scheduled delivery job.
A scheduled delivery status can be one of the following:

  ●  Active
  ●  Suspended
  ●  Completed
When you create a scheduled dashboard delivery, Status is Active by default.
Status filter (funnel icon)dropdown menuA dropdown menu that contains all possible statuses of a scheduled delivery. By default, the list is filtered by the Active status.
Use this dropdown to filter the list with a certain status.
The dropdown contains two buttons:
  ●  OK - to apply the filter
  ●  Reset - to clear any filtration applied
Next RuntextThe date, time, and time zone for when a scheduled job will run.
Delete (trash icon)buttonSelect to delete the scheduled delivery.
Note

When you select the name of a scheduled dashboard delivery, it opens the Schedule dialog, where you can edit the scheduled job details.

Load Plans list view

The Load Plans list view displays all scheduled load plans that you created from the Scheduler or Schema tab.

Note

The Loader Service handles each load plan as a single load job.

PropertyControlDescription
Select AllcheckboxA header control to select all scheduled load plans.
NametextThe scheduled load plan unique name that you entered while creating it.
OwnertextThe display name of the user who created the scheduled load plan.
SchemaslinksThe names of the schemas in the load plan. If more than two schemas exist in the load plan, the names are collapsed and the number of collapsed schemas appears instead.
Select the name of the schema to navigate it, or select the number of collapsed items to view all schemas in the load plan.
StatuslinkThe status of the scheduled load plan. The status can be one of the following:
  ●  Active
  ●  Suspended
  ●  Completed
When you create a scheduled schema load, the status is Active by default.
Select the status link to change it. You can change the status from Active to Suspended and vice versa.
Status filter (funnel icon)dropdown listA dropdown list that contains all possible statuses of a scheduled load plan. By default, the list is filtered by the Active status.
Use it to filter the list according to the plan status. To clear the applied filtration, select Reset.
Next RuntextThe date, time, and time zone of the next run of the scheduled load plan.
Delete (trash icon)buttonSelect to delete the scheduled load plan.
Note

When you select the name of a scheduled load plan, it opens the Edit Load Plan dialog, where you can edit the details. You can’t edit a completed load plan.

Data Notifications list view

The Data Notifications list view displays all scheduled data alerts. With the Alert Editor, you can define a data alert. A data alert is a scheduled job that evaluates an alert condition. An alert condition is an Aggregated Table or a Listing Table insight that you create using the Analyzer. If the alert condition evaluates to True, the scheduled job for a data alert sends an email data notification to one or more users, one or more group of users, or one or more email addresses.

PropertyControlDescription
Select AllcheckboxA header control to select all scheduled data notifications.
NametextThe scheduled job unique name that you entered while creating the scheduled alert.
OwnertextThe username that created the scheduled data notifications.
TargetlinkSelect the dashboard name to navigate to the dashboard for which the scheduled alert is created.
StatuslinkThe status of the scheduled job. When you select it, a prompt is displayed to confirm if you want to change the status of the scheduled data notification.
A scheduled data notification status can be one of the following:

  ●  Active
  ●  Suspended
  ●  Completed
When you create a scheduled data notification, Status is Active by default.
Status filter (funnel icon)dropdown menuA dropdown menu that contains all possible statuses of a scheduled data notification. By default, the list is filtered by the Active status.
Select to filter the list with a certain status.
The dropdown contains two buttons:

  ●  OK - to apply the filter
  ●  Reset - to clear any filtration applied
Next RuntextThe date, time, and time zone for when a scheduled data notification is to run next.
Delete (trash icon)buttonSelect to delete the scheduled data notification.
ExportbuttonSelect to export the selected data notification to a .zip file that you can use later on to import the scheduled data notification again.
Note

When you select the name of a scheduled data notification, it opens the Alert Editor dialog, where you can edit the data alert details.

Schema Notifications list view

The Schema Notifications list view displays all email alerts that you created for a schema.

PropertyControlDescription
Select AllcheckboxA header control to select all scheduled email notifications.
NametextThe scheduled notification unique name that you entered while creating the alert.
Schema(s)textSchema(s) name(s) for which you created the email alert.
Last ModifiedtextThe date and time for when the email notification was last modified.
Edit (pen icon)buttonSelect to edit the email notification.
Delete (trash icon)buttonSelect to delete the scheduled data notification.

Scheduler Actions

Using the Scheduler, you can perform the following actions:

Dashboard

Edit scheduled Dashboards

To schedule a dashboard for delivery, use the Content Manager. For more information, refer to Schedule Delivery of the Dashboard.

You can edit a scheduled dashboard delivery job through the Scheduler using the following steps:

  • Select a scheduled Dashboard job.
  • Edit the details of the scheduled job.
  • Select Save changes.

Load Plans

Create a scheduled load plan

You can schedule a job to load one or more physical schema from the Schema Manager or the Schema Designer.

To be able to create a load plan with multiple schemas, the multi-schema loading feature must be enabled on your cluster.

You can also create a scheduled load plan from the Scheduler by applying the following steps:

  • In the navigation bar, select Scheduler.
  • Go to the Load Plans tab.
  • From the Action bar, select + NewAdd Load Plan. The Add Load Plan dialog opens.
  • Fill in the following options in the dialog to schedule the load plan.
PropertyControlDescription
Nametext boxEnter a unique name for the load plan you are creating.
Descriptiontext boxEnter a description for the load plan.
Schemas/Schemalist/ dropdown listSelect the schema or schemas that you want to schedule a job to load. The list displays the schemas that you can edit.
The Schemas list is available only when the multi-schema loading feature is enabled.
If the list contains more than 20 schemas, page controls are available to navigate the list.
Schemas > Search Schemastext boxAvailable only when the multi-schema loading feature is enabled.
Search for the schemas you want to include in the load plan.
Schemas > Default Load Typedropdown listAvailable only when the multi-schema loading feature is enabled.
Specify the default load type before selecting the required schemas. Specifying a default load type doesn’t affect the load type you specify for the selected schemas. To apply the default load type to the selected schemas, select Reset.
Schemas > select allcheckboxSelect all schemas that currently appear on the list.
  ●  If the list contains multiple pages, you select only schemas on this page.
  ●  If you search for schemas, you select the schemas that match your search.
  ●  If the search result contains multiple pages, you select the schemas on the current page.
Load Typedropdown listSelect the load type you want to perform. The types are
  ●  Full
  ●  Incremental (default)
  ●  Staging
When creating a multi-schema load plan, you can determine the load type per schema. You can also apply a specific type to all schemas.
Recur Everyincrements and dropdown listSelect the recurrence of the job by selecting an interval of minutes, hours, days, weeks, or months.
This option isn’t available when you select the No Recurrence checkbox.
No RecurrencecheckboxSelect the checkbox to schedule the job for one time only. This option is unselected by default.
Attime and time zone selectionSelect the time and time zone to run the load plan job.
Select Now to immediately run the job.
BetweencheckboxSelect the checkbox to schedule the load plan job to run within a specific period. You have to define the start time, end time, and timezone.
Everyincrements and dropdown listSelect the recurrence of the load plan job by selecting an interval of minutes or hours.
This option is available only when you select the Between checkbox.
From / OncalendarSelect the date range of the load plan job.
The field name changes to On when you select the No Recurrence checkbox.
Does not endcheckboxSelect this checkbox to disable the end date of the load plan job.
It isn't available when you select the No Recurrence checkbox.
AddbuttonSelect to save the dialog and add the scheduled job to the list.
CancelbuttonSelect to discard what you have entered and close the dialog.

Edit a scheduled load plan

To edit a load plan, you have to own all schemas in the load plan or have edit access rights to them. You can’t edit a completed load plan.

You can edit a scheduled load plan through the Scheduler using the following steps:

  • On the Load Plans tab, select a scheduled load plan. The Edit Load Plan dialog opens.
  • Edit the details of the scheduled load plan.
  • Select Save.

Data Notifications

A data notification is an email notification for a data alert. From the Scheduler, you can define and edit the properties of a data alert using the Alert Editor.

Create a data notification

From the Scheduler, you can create and edit the properties of a data alert using the Alert Editor. Here are the steps to open the Alert Editor from the Scheduler:

  • In the Navigation bar, select Scheduler.
  • In the Context bar, select the Data Notifications tab.
  • In the Action bar, select +NewCreate Notifications to open the Alert Editor.
  • Define the properties of the data alert with the Alert Editor.

Edit a data notifications

You can edit a scheduled data notification (alert) through the Scheduler using the following steps:

  • Select a scheduled alert job.
    • The Alert Editor dialog opens.
  • Edit the details of the scheduled alert.
  • Select Done.

Export Data Notifications

The Scheduler enables you to export Data Notifications you created to be able to import them later on.

You can export Data Notifications by applying the following steps:

  • To export one scheduled job:

    • Hover on or select a scheduled data notification.

    • Select the Export button.

      The Scheduler downloads a .zip file to your machine.

  • To export multiple scheduled jobs:

    • Select multiple scheduled data notifications.

    • Select the Export button.

      The Scheduler downloads a .zip file to your machine.

Import Data Notifications

The Scheduler enables you to import .zip files that contain Data Notifications. You can import Data Notifications by performing the following steps:

  • From the Action bar, select + NewImport Data Notifications.
    • The Import Alerts window opens.
  • Select Overwrite existing alerts option if you want to delete any alerts that you created before and create new ones.
  • Browse to, or drag and drop, the .zip file that contains the notifications you want to import.

Schema Notifications

Create Schema Notifications

You can create an email alert for one or multiple certain schemas. The alert that you create is triggered upon the success or failure of a schema load.

Perform the following steps to create the data alert:

  • Open the Scheduler.
  • Go to the Schema Notifications tab.
  • From the Action bar, select + NewCreate Email Notifications. The Create Email Notification dialog opens.
  • Fill in the following options in the dialog to create a schema notification job.
  • Select Done to save the email notification.
PropertyControlDescription
Notification Nametext boxEnter the name of the email notification job you are creating.
Notify uponmulti-selectSelect when you want to send the email notification. There are 4 possible values:
  ●   Success
  ●  Failure (Default)
  ●  Finishing With Error
  ●  Interruption
Select Schema(s)multi-selectSelect one or multiple schemas you want to send an alert for.
Recipientstext boxEnter the email, name, or group of recipients you want to send the email notification to.
Bodytext box(Optional) Enter the body for the email notification job you are creating.
If you didn't enter a body for the email notification, Incorta sends a body with auto-generated text that contains the sender name, the schema name, its status, and URL.

Edit Schema Notifications

You can edit a scheduled schema notification (alert) through the Scheduler using the following steps:

  • Select a scheduled alert job. The Edit Email Notification dialog opens.
  • Edit the details of the scheduled alert.
  • Select Done.

Search the list of Schema Notifications

The Scheduler enables you to search the list of Schema Notifications through the search bar available in the list view.

To search for a scheduled schema notification:

  • Open the Scheduler, and go to the Schema Notifications tab.
  • In the search bar, enter the schema notification job name.
    • The search result is displayed according to the keyword you entered.
Note

You can only search the Schema Notifications list using the schema notification job name.

General Scheduler Actions

Suspend and Activate scheduled jobs

When you suspend a scheduled job, the job will pause all future actions. You can resume the job's scheduled actions by returning the job to active. When you create a scheduled job, its status is Active by default.

You can activate or suspend a scheduled job for the following:

  • Dashboards
  • Load Plans
  • Data Notifications

The following steps show how to suspend or activate a job:

  • In the Scheduler, identify the desired scheduled job.
  • In the status column, select the current status for the scheduled job (the status will be Active or Suspended).
    • Confirm Changing Status window will appear.
  • Select Ok to confirm changing the status of the job.
Note

You can select Never Mind to cancel.

Locating Suspended Jobs

The Scheduler, by default, filters to display Active jobs only. See filter scheduled jobs to display the desired scheduled jobs based on status.

Note

Deleting a bookmark automatically suspends the related scheduled jobs. Also, changing a bookmark from public to private suspends all related dashboard scheduled jobs that other users created. However, the scheduled jobs that the bookmark owner created will run as usual.

You can't activate a dashboard delivery job that has been suspended due to deleting a bookmark or changing it to private. You have to first edit the scheduled job to remove the bookmark or select a valid one.

Delete scheduled jobs

The Scheduler enables you to delete one or multiple scheduled jobs.

To delete one scheduled job:

  • Select or hover on a scheduled job.
  • Select the Delete button (bin icon).
    • The Delete this job? confirmation window appears.
  • Confirm deleting the job by selecting Delete.

To delete multiple scheduled jobs:

  • Select multiple scheduled jobs.
  • Select the Delete button (bin icon).
    • The Delete these jobs? confirmation window appears.
  • Confirm deleting the job by selecting Delete.
Note

You can select Never Mind to cancel.

Filter scheduled jobs

You can filter the list of the scheduled jobs for the following according to their status:

  • Dashboards
  • Load Plans
  • Data Notifications

A scheduled job can have one of three statuses:

  • Active (default): Indicates that the job is active and will run according to schedule.
  • Suspended: Indicates that the job is on hold and won't run.
  • Completed: Indicates that the job was completed successfully and does have next runs.
Important

By default, the list displays the jobs with Active status only.

To filter the list of scheduled jobs, do the following:

  • Select the Status filter (funnel icon).
  • Select the status(es) you want to filter the list with.
  • Select OK.
    • The list will only display the jobs that have the status(es) you selected.
Note

You can select Reset to clear any selection and show only the jobs with Active status.

Create a Data Notification example

Assuming you created a Dashboard named Sales Insight for the SALES schema, the following is an example to create a data notification (alert) for this dashboard.

Important

You must have the email configuration set for your tenant in the CMC. Refer to the Configure Tenants guide for more information.

In this example, you will create an email alert for the Sales Insight dashboard to be sent daily to your email if the cost of the goods is less than 500.

  • Open the Scheduler and go to the Data Notifications tab.
  • Select + NewCreate Notifications.
    • The Alert Editor window opens.
  • Fill in the Name field to be: Sales Insight Alert.
  • (Optional) Add a description to this alert in the Description field.
  • Select the Type of the attachment to be HTML.
  • In the Target field, select the pen icon, and then navigate to the Sales Insight dashboard.
  • Select Tab1, and then select Add.
  • For the Condition field, select the pen icon to open the Analyzer:
    • In Data, select Add Data Set, expand the SALES schema, and then select the SALES table.
    • Drag and drop the Sales Date column to the Grouping Dimension tray.
    • Drag and drop the Cost column to the Measure tray, and change the format to Dollar.
    • Drag and drop Add Formula to the Individual Filter tray.
    • Add the following formula in the Formula Builder: SALES.SALES.COST_OF_GOODS < 500
    • Select Validate & Save.
    • Change the Column Label to be Cost less than 500.
    • Select Save.
  • Select the Start By field to be today’s date and the current time on your machine.
  • Select the Recurrence to be Daily, Every 1 day, and No End for example purposes.
  • In the Send To field, select +:
    • Add your email address.
    • Select Add.
  • Select Done.