Skip to main content

Scheduling Aggregate Builds

You can configure aggregates to be built according to a schedule using the aggregates-creation/scheduler endpoint of the AtScale API. This enables you to schedule builds to run at convenient times, rather than immediately after catalog deployment, to save on resources and costs.

Scheduled builds are disabled by default, but can be enabled and configured on a per-model basis. You can create multiple schedules for a single model. You can also control the types of aggregates built for each model: user-defined, prediction-defined, or both.

The following sections describe how to create aggregate build schedules.

Prerequisites​

Before you can schedule aggregate builds, ensure the following requirements are met:

  • Aggregate build schedules must be enabled on the model. This is controlled by the following model configuration settings:

    • aggregates.new.build.scheduled: Enables/disables scheduled builds for the model. This must be set to true on the model you want to schedule builds for.
    • aggregates.uda.build.scheduled: Enables/disables scheduled builds for the model's user-defined aggregates (UDAs).
    • aggregates.predictionDefined.build.scheduled: Enables/disables scheduled builds for the model's prediction-defined aggregates.

    For instructions on configuring model settings, see Configuring Model Settings. For more information on the above settings, see Aggregate Settings.

  • You must have the aggregates_manage and aggregates_view realm roles assigned in the Identity Broker. For more information, see Identity Broker Default Roles.

  • You must have an API token generated. For more information, see Authentication in the AtScale API Documentation.

  • The models you want to schedule builds for must be deployed. For more information, see Deploying Catalogs.

Creating a build schedule​

You create a build schedule using the aggregates-creation/scheduler API endpoint. The schedule is defined in a format similar to Cron job time format, but with an extra field representing seconds at the beginning. For example: 0 25 06 ? * *

For more information on the aggregates-creation/scheduler endpoint, refer to the AtScale API Documentation.

Viewing build results​

When an aggregate definition or instance is scheduled, it appears on the Aggregates page with a status of Pending. For more information, see Monitoring Aggregate Usage.