Schedules

Automating batch processing

Use a recurring Schedule to run a Flow or Agent against Records. Runtype resolves the Record target each time the Schedule runs, so a Record Type target includes Records added after you create the Schedule.

Use cases

Use a Schedule for the following workloads:

  • Enrich Records that arrive during the day.
  • Generate a weekly report from Records.
  • Archive or update old Records.
  • Refresh cached data from external sources.

Before you begin

Before you begin, create and test the Flow or Agent. Create the Records that it processes. Choose a metadata field, such as processed, to mark completed Records.

Set up batch processing

Follow these steps to create a recurring Schedule that processes Records:

  1. Open Schedules from the sidebar.
  2. Click New schedule.
  3. Select Flow or Agent, then select the Flow or Agent to run.
  4. Set Input Source to Records.
  5. In Records, select a Record type. Add filter conditions to limit the Records.
  6. In Timing, select Recurring.
  7. Review the time zone shown next to Timing, then configure the recurrence. For example, set a daily run at 2:00 AM.
  8. Click Create.

Choose a record target

A Schedule resolves its Record target each time it runs. Choose the targeting mode that matches your workload.

Use a Record Type

Use a Record Type to process every Record of that type. Records added to the type enter the target on a later run.

Use Record IDs

Use Record IDs to process a fixed set of Records. The target keeps the configured IDs, so later Records do not enter the target automatically. To configure this target through the API, pass the IDs in target.recordIds.

Use a Record Filter

Use a Record Filter to process only Records that match conditions on metadata fields. Runtype evaluates the filter each time the Schedule runs, so Records enter or leave scope as their metadata changes. Record Filters use a structured filter language with operators such as eq, contains, gt, withinLastDays, isSet, and isNotSet.

Use the following filter to target customer Records that are not processed:

1{
2  "type": "customers",
3  "where": {
4    "op": "and",
5    "conditions": [{ "field": "processed", "op": "eq", "value": false }]
6  }
7}

This filter matches Records of type customers whose processed metadata field equals false.

Mark Records as processed

Write a processed flag after successful processing so the Record Filter excludes the Record on a later run.

Follow these steps to mark each successful Record:

  1. In your Flow, add Upsert Record after the processing steps.
  2. Write processed: true to the Record metadata.
  3. Configure the Schedule’s Record Filter to exclude Records with processed: true.

Monitor batch Schedules

Follow these steps to review scheduled runs:

  1. Open Schedules.
  2. Click the Schedule row to open its details.
  3. Select Runs to review recent runs, statuses, and timings.
  4. Open a run to inspect its results.

Handle failures

If a Record fails before the Flow writes processed: true, the Record remains in the filter’s scope. The next recurring run includes the Record again.

Use these steps to investigate and retry a failed Record:

  1. Open the failed run from Runs.
  2. Open Logs and inspect the step errors.
  3. Fix the Flow or the affected Record.
  4. Click Run now to retry without waiting for the next recurring run.

Control batch costs

Each Record in a record-based Schedule creates a Flow or Agent execution. Model and tool calls contribute to usage cost. Use these practices:

  • Use a Record Filter to process only the Records that you need.
  • Choose a cadence that matches how often your data changes.
  • Use a lower-cost model for batch work when it meets your quality requirements.

Next steps

Continue with these guides: