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. 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.

Changelog

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.

Scheduler Anatomy

The Scheduler consists of the following:

• Context bar
• Action bar
• Search bar
• List view

Context Bar

The context bar consists of the four tabs:

• Dashboards: contains a list of the scheduled dashboards deliverables.
• Schema Loads: contains a list of the scheduled schema loads. The Load Plans tab replaced Schema Loads starting the 2022.11.0 release.
• Load Plans: contains a list of load plans.
• Data Notifications: contains a list of the configured data notifications (dashboard alerts).
• Schema Notifications: contains a list of the configured schema notifications. The Notifications tab replaced Schema Notifications starting with the 2024.1.0 release.
• Notifications: contains a list of the configured load plan notifications. Available starting with 2024.1.0.

Action Bar

The action bar contains the +New button that opens the New menu. It is available when you open any tab except for the Dashboard tab.

The following are the options available on the New menu:

Search Bar

The Search bar contains a search text box that is only available on the Schema Notifications, Load Plans and Notifications tabs. For schema notifications and notifications, you can search by 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)
• More Options: Available starting with 2023.7.0 in the case of load plans only. When you select one or more load plan, the More Options menu shows the following options depending on the status of the selected load plans:
  • Activate: Activates suspended load plans in the selected plans.
  • Suspend: Suspends active load plans in the selected plans.
  • Export: Exports the selected load plans to a .zip file. This option is available starting with 2024.1.0.
  • Delete: Deletes the selected load plans. This option replaces the Delete icon that used to appear when you select multiple load plans before 2023.7.0.

List View

Dashboards list view

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

Schema Loads list view

The Schema Loads list view displays all scheduled schema load jobs that you created from the Scheduler or from the Schema tab.

Load Plans list view

The Load Plans list view displays all load plans that you have created or have access to. You can view a load plan if you have view access rights to at least one schema in the plan. Available options vary according to your access rights to the schemas in the 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.

Schema Notifications list view

The Schema Notifications list view displays all email alerts that you created for a schema. The Schema Notifications tab is not available starting with 2024.1.0.

Notifications list view

The Notifications list view displays all email alerts that you created for load plans. The Notifications tab is available starting with 2024.1.0. The Notifications list will show only notifications that you have created. However, the Super User and users with the SuperRole will have full access to all notifications.

Scheduler Actions

Using the Scheduler, you can perform the following actions:

Dashboards:

• Edit scheduled Dashboards

Schema Loads:

• Create scheduled Schema Loads
• Edit scheduled Schema Loads

Load Plans:

• Create a load plan
• View a load plan
• Edit a load plan
• View the execution plan DAG of a load plan
• Manually start the execution of a load plan
• Suspend a load plan
• Suspend one or more load plans
• Activate a load plan
• Activate one or more load plans
• Export a load plan
• Export one or more load plans
• Import one or more load plans
• Delete a load plan
• Delete one or more load plans

Data Notifications:

• Create a Data Notification
• Edit a Data Notification
• Export Data Notifications
• Import Data Notifications

Schema Notifications:

• Create a Schema Notification
• Edit Schema Notifications
• Search the list of Schema Notifications

Load Plan Notifications:

• Create a load plan notification
• Edit a load plan notification
• Search the list of load plan notifications

General actions:

• Suspend and Activate scheduled jobs
• Delete scheduled jobs
• Filter scheduled jobs

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.

Schema Loads

Create scheduled Schema Loads

You can schedule a job to load a certain schema from the Schema Manager.

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

• Open the Scheduler.

• Go to the Schema Loads tab.

• From the Action bar, select + New → Add Schema Load.

  The Add Schema Load dialog opens.

• Fill in the following options in the dialog to schedule the Schema Load job.

Edit scheduled Schema Loads

You can edit a scheduled Schema Load through the Scheduler using the following steps:

• On the Schema Loads tab, Select a scheduled Schema Load job.
  • The Edit Schema Load dialog opens.
• Edit the details of the scheduled job.
• Select Save.

Load Plans

Starting with 2023.7.0, you can activate and suspend multiple load plans. You can also activate and suspend a single plan using the plan's More Options menu that is available starting with this release.

Only the system admin or the load plan owner can edit, suspend, activate, and delete the load plan. However, the owner of a load plan can't perform these actions if the load plan includes one or more schemas that the owner no longer has edit access rights to. You can't edit or delete a load plan that is being executed; however, you can change its schedule, and suspend or activate it.

Create a load plan

You can create a load plan with 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. This feature is always enabled starting with 2023.7.0. You can add to a load plan only schemas that you own or have edit access rights to.

You can create a load plan from the Scheduler by applying the following steps in releases before 2023.7.0:

• In the navigation bar, select Scheduler.
• Go to the Load Plans tab.
• From the Action bar, select + New → Add Load Plan. The Add Load Plan dialog opens.
• Fill in the following details in the dialog to schedule the load plan.
• Select Add.

The following table shows the details of a load plan.

Create a load plan in 2023.7.0 and later

The following are the steps and details of creating a load plan starting with 2023.7.0.

• In the navigation bar, select Scheduler.
• Go to the Load Plans tab.
• From the Action bar, select + New → Add Load Plan. The New Load Plan dialog opens.
• Enter a name for the load plan and optionally enter a description.
• Specify the default load type for the schemas you will add to the load plan.
• Under Select Schema, drag one or more schemas to the Selected Schemas list.
  • To select multiple schemas, use the Command or Ctrl key while selecting the schemas. You can add a schema only once in the load plan.
  • Optionally, change the load type for each schema.
  • To remove a schema from the list, select the remove button (x icon).
• Optionally, select Set sequential loading groups to add a new group and drag schemas to it.
  • To add more groups, select New Group.
  • To remove all schemas from the group, select More Options (⋮ vertical ellipsis icon), and then select Clear All.
  • To move a schema from one group to another, drag the schema from a group to another.
  • To delete a group, select More Options (⋮ vertical ellipsis icon), and then select Delete
• Select Save.
• Under Scheduler, specify the scheduling options of the load plan, and then select Save.
  • To save the load plan without setting a schedule to run it, select Schedule later.
• Select Close.

View a load plan

You can view a load plan if you have view access rights to at least one schema in the plan. Available options vary according to your access rights to schemas in the plan.

Here are the steps to view the details of a load plan:

• On the Load Plans tab, select a load plan.
• In the Edit Load Plan dialog, review the details of the selected load plan. Starting with 2023.7.0, the included schemas appear in the Load Plan section, and if a schedule is set to run the load plan, the Scheduler part shows a summary of this load schedule.
• Select Close to exit the dialog.

Edit a load plan

Only the system admin or the load plan owner can edit the load plan. However, the owner of a load plan can't edit it if it includes one or more schemas that the owner no longer has edit access rights to. You can’t edit a completed load plan in releases before 2023.7.0. Additionally, you can't edit a load plan that is being executed; however, you can change its schedule, and suspend or activate it.

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

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

View the execution plan DAG of a load plan

You can view the execution plan of a load plan using the following steps:

• On the Load Plans tab, for the load plan you want, select Show DAG.
• In the Load Plan DAG Viewer, expand the nodes to show the included objects and processes.

For more details, refer to Tools → Load Plan DAG Viewer.

Manually start the execution of a load plan

You can manually start the execution of a load plan if you own or have Edit access to all schemas in the load plan, regardless of its schedule status: Active, Suspended, Completed, or Not Scheduled. You can't start the execution of a load plan that is already running. Manually executing a load plan does not impact the next scheduled run if exists.

To manually start the execution of a load plan:

• On the Load Plans tab, for the load plan you want, select Execute Load Plan (play button icon).

You can stop the execution of a load plan from the Schema Manager > Load Jobs. You can also review the progress and status of a load plan execution on the Load Job Details Viewer.

Suspend a load plan

Here are the steps to suspend an active load plan.

• On the Load Plans tab, do one of the following:
  • In the Scheduler column, select the Active status.
  • Hover over the active load plan, select More Options (⋮ vertical ellipsis icon), and then select Suspend.
  • Select the active load plan row, and then in the Search bar, select More Options (⋮ vertical ellipsis icon) > Suspend.
• In the Confirm Changing Status dialog, select Ok to confirm changing the status of the job.

Suspend one or more load plans

Here are the steps to suspend one or more active load plans.

• On the Load Plans tab, select the rows of the plans you want to suspend.
• In the Search bar, select More Options (⋮ vertical ellipsis icon), and then select Suspend.
• In the Confirm Changing Status dialog, select Ok to confirm changing the status of the job.

If you select load plans with different statuses, the system suspends only active plans that you can edit.

Activate a load plan

Here are the steps to activate a suspended load plan.

• On the Load Plans tab, do one of the following:
  • In the Scheduler column, select the Suspended status.
  • Hover over the suspended load plan, select More Options (⋮ vertical ellipsis icon), and then select Activate.
  • Select the suspended load plan row, and then in the Search bar, select More Options (⋮ vertical ellipsis icon) > Activate.
• In the Confirm Changing Status dialog, select Ok to confirm changing the status of the job.

Activate one or more load plans

Here are the steps to activate one or more suspended load plans.

• On the Load Plans tab, select the rows of the plans you want to activate.
• In the Search bar, select More Options (⋮ vertical ellipsis icon), and then select Activate.
• In the Confirm Changing Status dialog, select Ok to confirm changing the status of the job.

If you select load plans with different statuses, the system activates only suspended plans that you can edit.

Export a load plan

Here are the steps to export a load plan a .zip file.

• On the Load Plans tab, do one of the following:
  • Hover over the load plan you want, select More Options (⋮ vertical ellipsis icon), and then select Export.
  • Select the load plan row, and then in the Search bar, select More Options (⋮ vertical ellipsis icon) > Export.

Export one or more load plans

Here are the steps to export one or more load plans to a .zip file.

• On the Load Plans tab, select the load plans you want to export.
• In the Search bar, select More Options (⋮ vertical ellipsis icon) > Export.

Import one or more load plans

Here are the steps to import one or more load plans.

• On the Action bar, select New, and then select Import Load Plan.
• In the Import Load Plan dialog, select the Overwrite existing load plans if you want to replace existing load plans with the new ones if they share the same name.
• Drag or browse to locate the .zip file that contains the load plans you want to import.

A dialog appears showing the status of the import operation.

Importing load plans fails in the following cases:

• The imported load plan has one or more schemas that do not exist in the target tenant.
• You do not have edit access rights to all schemas in the load plan.
• The imported load plan shares the same name with an existing load plan while the Overwrite existing load plans option is not selected.

Delete a load plan

Only the system admin or the load plan owner can delete the load plan. However, the owner of a load plan can't delete it if it includes one or more schemas that the owner no longer has edit access rights to. You can't delete a load plan that is being executed. When you delete a load plan, its execution history will be maintained, and it continues to appear on the Schema Manager > Load Jobs page.

You can delete a load plan through the Scheduler using the following steps in releases before 2023.7.0.

• On the Load Plans tab, hover over the load plan you want, and then select Delete (trash can icon).
• In the dialog, select Delete.

Starting with 2023.7.0, you can follow these steps to delete a load plan.

• On the Load Plans tab, do one of the following:
  • Hover over the load plan, select More Options (⋮ vertical ellipsis icon), and then select Delete.
  • Select the load plan row, and then in the Search bar, select More Options (⋮ vertical ellipsis icon) > Delete.
• In the dialog, select Delete.

Delete one or more load plans

Here are the steps to delete one or more load plans.

• On the Load Plans tab, select the rows of the plans you want to delete.
• In the Search bar, select More Options (⋮ vertical ellipsis icon), and then select Delete.
• In the dialog, select Delete. The system deletes only plans that you can delete and as applicable according to their statuses.

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 +New → Create Notifications to open the Alert Editor.
• Define the properties of the data alert with the Alert Editor.

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.

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 + New → Create 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.

Edit a data notification

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 + New → Import 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

Schema notifications are no longer available starting with 2024.1.0 and were replaced by load plan notifications.

Create a Schema Notification

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 schema load alert:

• Open the Scheduler.
• Go to the Schema Notifications tab.
• From the Action bar, select + New → Create 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.

Edit a Schema Notification

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.

Notifications

Load plan notifications are available starting with 2024.1.0.

Create a load plan notification

You can create an email alert for a load plan that you own or have Edit access rights to. The alert that you create is triggered upon the success or failure of a load plan execution job.

You can also create email notifications for load jobs that take longer than expected, based on the load time of recent load jobs for the same load plan. This feature helps you detect delays in data refresh cycles as early as possible and act accordingly.

Perform the following steps to create a load plan notification:

• Open the Scheduler.
• Go to the Notifications tab.
• From the Action bar, select + New → Create Load Plan Notification. The Create Load Plan Notification dialog opens.
• Fill in the following options in the dialog to create a load plan notification job.
• Select Done to save the email notification.

Edit a load plan notification

You can edit a load plan notification (alert) through the Scheduler using the following steps:

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

Search the list of load plan notifications

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

To search for a scheduled load plan notification:

• Open the Scheduler, and go to the Notifications tab.
• In the search bar, enter the load plan notification job name.
  • The search result is filtered according to the keyword you entered.

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. Starting with 2023.7.0, you can save a load plan without setting a schedule. Additionally, you can suspend or activate a load plan while editing it.

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

• Dashboards
• Schema Loads
• 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.

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.

Filter scheduled jobs

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

• Dashboards
• Schema Loads
• 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.
• Not Scheduled: Indicates that you have not set a schedule for the job. This status is available only for load plans starting with 2023.7.0.

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.