Schedule a Process on the Data Integration Console

Contents:

Schedule a Process on the Data Integration Console

Create a new data loading schedule to automatically execute an existing data loading process at a specified time. Only one data loading process can be executed at a time. You can schedule only data loading processes that already exist. See Preparing a Data Loading Process.

Apart from schedules that are executed at a specified time, you can also create a schedule that is executed only when you run it manually: via the Data Integration Console or API (see Scheduling a Process for Manual Execution Only).

Data loading during business hours may negatively impact system performance. Frequent updates may also impact the performance of your projects. See Timing the Schedule.

Steps:

  1. From the Data Integration Console (see Accessing Data Integration Console), click Projects to open the Projects page.
  2. Click the name of the project where you want to create the schedule, and click New schedule.
  3. Select the process to execute.
  4. Select the frequency of execution:

  5. (Optional) Add additional parameters to your schedule.
    A project parameter is a name-value pair that can be passed to the process before execution begins. If the process is designed to consume it, the project parameter can be used to define variables specific to the execution. For example, you can define project parameters for customer-specific login credentials for an external data source. For more information, see Configuring Schedule Parameters.
  6. (Optional) Specify a new schedule name.
  7. Click Schedule.
    The schedule is saved and opens for your preview. The GoodData platform will execute the process as scheduled.
  8. (Optional) Click Add retry delay to set up a retry delay period for your schedule.
    When a retry delay is specified, the platform automatically re-runs the process if it fails, after the period specified in the delay has elapsed. For more information, see Configuring Automatic Retry of Failed Processes.

    If a schedule repeatedly fails, it is automatically disabled, and your project data is no longer refreshed until you fix the issue causing failure and re-enable the schedule. For more information on debugging failing schedules, see Schedule Issues.

Schedule Details and Actions

In the schedule details dialog, you can:

  • Queue a schedule. You can queue a schedule for execution at any time. However, executing the process may create issues with the data that is loaded in the project. For more information, see Running Schedules On-Demand.
  • Change the timing of the schedule. To do so, select a new interval from the Runs drop-down, and save the changes. For more information, see Timing the Schedule.
  • Add parameters. Parameters customize schedules for individual executions. For more information, see Configuring Schedule Parameters.
  • Check the history of runs over time. For more information, see schedule execution history.
  • Disable a schedule. You can temporarily disable a schedule to prevent it from running. You can enable it back any time.
  • Delete a schedule. You can delete a schedule if you do not need it anymore. Deleting a schedule does not delete the process that the schedule was created for.

Schedule Owner vs. Process Owner

In the schedule details dialog, the listed user name identifies the user under which the schedule executes. This user currently owns the schedule.

Because processes can be downloaded and redeployed at any time, the owner of the schedule can differ from the owner of the process. For example, if a process created by User A is redeployed by User B, all schedules associated with the process are now owned by User B, who will be the user under which all schedules for the process are henceforth executed.

Schedule Execution History

At the bottom of the schedule details dialog, you can review the history of the schedule executions.

Process History Details

This picture shows the last seven days of executions of the process. For each execution:

  • In the dated history bar, you can see the instances in which the process has been executed over the past seven days.
  • The icon on the left side of the screen indicates whether the process executed successfully or not.
    • A hand icon indicates an execution that was triggered manually.
  • Red text indicates that the process encountered an error and failed.

States of Schedule Executions

To review the log generated for the process run, click the icon. See Data Integration Console Process Logging.

You can also review the runtime duration of the process execution, and the start and end timestamps.

  • Successful: All of your processes should be listed in this category. Fix or disable those that are not.

  • Failed: Executions that failed to complete or that were manually stopped have been marked in red. The displayed ERROR message provides information on what caused the process to fail. To review the log for further details, click the icon. Stopped processes are categorized as errors, since the data load is incomplete. All incomplete loads are treated as errors.

    Executions that have failed may have no data updates or incomplete date updates applied to the target project. Explore and resolve failed executions as soon as possible to prevent project users from working with inaccurate data. Try to keep the count of failed executions at 0.

  • Running: Scheduled execution has begun in the platform. A time stamp indicates when the execution began and the current duration of the execution.
  • Scheduled: The process has been scheduled for execution at the appropriate time.
  • Disabled: The scheduled process has been disabled. It will not automatically run until you re-enable it. You can manually re-run disabled schedules, although there are some risks with doing so.
  • Broken schedule: Schedules whose process no longer exists are marked as broken schedules. Typically, schedules are broken if a process is redeployed under a new name. To fix the scheduled processes, select the appropriate process to run in the schedule definition.
  • Unscheduled: These processes do not have a schedule associated with them.