Introduction
Why use scheduled indexing:- Automated data freshness: Keep indexes up-to-date automatically as source data evolves.
- Reduced manual overhead: Eliminate the need for manual reindexing operations.
- Consistent synchronization: Maintain predictable sync schedules across multiple indexes.
- Resource optimization: Schedule updates during off-peak hours to minimize system impact.
- User-specific schedules: Each user can configure independent schedules for the same index.
Prerequisites
Before configuring scheduled indexing, ensure the following requirements are met:Successful Index Creation
Appropriate Permissions
Valid Index State
Personal Access Token
Credentials Configuration
Configure Scheduled Indexing
Access Index Actions
- Open the Indexes section: Expand the INDEXES section in the toolkit configuration page.
- Select an existing index to open its dedicated index page.

Configure Cron Expression
- Open Schedule Settings:
- If no schedule exists yet, select + Schedule.
- If a schedule already exists, select the edit icon on the schedule card.

- Choose Schedule Type:
- Builder: Visual cron builder with interactive controls.
- Cron Expression: Manual text input for a cron expression.
0 0 * * 6 (Every Saturday at midnight).- Use the visual builder to configure the schedule.
- The cron expression is generated automatically as you make selections.
- The preview updates in real time.

- Enter a cron expression directly in the text field (for example,
0 2 * * *). - Format guide shown below:
minute – hour – day (month) – month – day (week). - Select the info icon to open crontab.guru for help.
- The preview and validation update as you type.

-
Configure Credentials (if required):
- Some toolkits require credentials for scheduled indexing.
- If required, a credentials dropdown appears below the cron configuration.
- Select an existing credential configuration or create a new one.
- Available credentials are filtered by project type:
- If you are in a Private Project, only private project credentials are shown.
- If you are in a Team Project, only team project credentials are shown.

- Save Changes: Select Save to store the cron expression and credentials.

Schedule Card
The Schedule section on the index page shows the current schedule state for the selected index. When a schedule exists, the schedule card displays the following information and actions. Information about the schedule:- The human-readable schedule summary.
- The next scheduled run date.
- The selected credentials, when credentials are required.
- Edit the schedule configuration.
- Delete the schedule.
- Turn the schedule on or off.

Schedule Notifications
You receive notifications for all indexing operations (initial indexing, manual reindexing, and scheduled reindexing). Successful operations:- Icon: Green success checkmark.
- Message format:
- Initial indexing:
Index {name} is successfully created: { "indexed": X }. - Reindex (manual):
Index {name} is successfully reindexed. { "reindexed": X, "indexed": Y }. - Reindex (scheduled):
Index {name} is successfully reindexed by schedule. { "reindexed": X, "indexed": Y }.
- Initial indexing:
- Action: Select the notification to go to the index page in the Indexes section.
- Icon: Red error icon.
- Message:
Index {name} is failed. - Note: This applies to both initial indexing failures and reindexing failures.
- Action: Select the notification to view the index and check error details in the History page.
- Notifications appear in the notifications panel (bell icon in top navigation).
- Each notification shows the relative time (for example, “2 minutes ago,” “1 hour ago”).
- Selecting a notification goes directly to the specific index page in the Indexes section.
- Scheduled operations are clearly marked with “by schedule” text.

Cron Expressions
Scheduled indexing uses cron expressions to define when automatic reindexing occurs. A cron expression consists of five space-separated fields:*(asterisk): Matches any value (for example,*in the hour field means “every hour”).,(comma): Lists multiple values (for example,1,15in the day field means “1st and 15th”).-(hyphen): Defines a range (for example,9-17in the hour field means “9 AM to 5 PM”)./(slash): Specifies step values (for example,*/2in the hour field means “every two hours”).

0 0 * * * (once per day at midnight) or less frequent.
Common Schedule Patterns
The following table lists verified schedule patterns for typical reindexing scenarios:Manage Schedules
Edit schedules To modify an existing schedule:- Open Schedule Settings: Select the edit icon on the schedule card.
- Update Cron Expression: Enter the new expression in the modal.
- Validate & Save: Ensure the expression is valid, then select Save.
- No notification is shown for cron expression updates (only for enable/disable).
- Turn off the Schedule toggle on the schedule card.
- The saved cron expression and selected credentials remain attached to the schedule.
- When the schedule is turned off, the page shows a banner with the message “Schedule is turned off.”
- To resume scheduled reindexing, turn the toggle back on.

Real-Life Example: Daily GitHub Repository Indexing
Daily GitHub Repository Example
Daily GitHub Repository Example
- Toolkit: GitHub toolkit for
ProjectAlita/projectalita.github.iorepository. - Index name:
docs. - State: Successfully created and completed.
- Desired schedule: Daily at 2:00 AM (during off-peak hours).
- Go to Toolkits > select the GitHub (ProjectAlita/projectalita.github.io) toolkit.
- Open the Indexes section.
- Select the docs index from the sidebar.
- Find the Schedule section on the index page.
- Select the toggle switch to turn on scheduling.
- Confirm the success notification that the schedule was turned on.
- Select the edit icon on the schedule card.
- The Schedule Settings modal opens showing the schedule.
-
Choose a configuration method:
Option A: Builder mode:
- Select Builder schedule type (if not already selected).
- Use the builder controls to configure the schedule for daily execution at 2:00 AM.
- The cron expression
0 2 * * *is generated automatically. - Verify the preview shows the expected schedule summary.
- Select Cron Expression schedule type.
- Clear the input and enter:
0 2 * * *. - Verify the preview updates to the expected schedule summary.
- Select Save to store the schedule.
- Toggle state: Confirmed on.
- Cron expression:
0 2 * * *(verified by reopening the schedule modal). - Schedule active: Automatic reindexing occurs daily at 2:00 AM.
- The system automatically triggers a reindexing operation for the
docsindex. - The index state changes to
in_progressduring the operation. - Progress is tracked and visible in the index interface.
- Upon completion, the index state returns to
completed. - A new entry appears in the History tab with label “Reindexed” and the timestamp.
- A notification is sent:
- Success:
Index docs is successfully reindexed by schedule. { "reindexed": X, "indexed": Y }. - Failure:
Index docs is failed.
- Success:
Troubleshooting
Schedule Toggle Is Disabled
Schedule Toggle Is Disabled
Cron Expression Validation Errors
Cron Expression Validation Errors
Schedule Not Executing
Schedule Not Executing
-
Verify cron expression:
- Open Schedule Settings and check the cron expression.
- Use crontab.guru to verify the expression matches your intent.
- Ensure the expression is not in the past (for example, a specific date or time that has passed).
-
Check index state:
- Ensure the index state is
completed, notfailedorcancelled. - If the state is invalid, manually reindex and then turn on the schedule again.
- Ensure the index state is
-
Confirm toggle is turned on:
- Verify the Schedule toggle is on (blue).
- If it is off, turn it on again.
-
Review system logs (if accessible):
- Check for backend errors during scheduled execution.
- Look for quota limitations or resource constraints.
-
Time zone considerations:
- Cron expressions execute in the server time zone.
- Verify the server time zone matches your expectations.
Schedule Turned On but No Notification
Schedule Turned On but No Notification
- Reopen the Schedule Settings modal.
- Confirm the cron expression shows your updated value.
- Confirm credentials are selected (if required).
Cannot Turn On Schedule — Credentials Required
Cannot Turn On Schedule — Credentials Required
- Select the edit icon on the schedule card.
- In the Schedule Settings modal, scroll down to the credentials selector.
- Select an existing credential configuration from the dropdown (only credentials matching your project type are shown), or
- Select + Create new to create a credential configuration.
- Select Save to store the changes.
- The Schedule toggle is now turned on.
- Private project: Only private project credentials are available.
- Team project: Only team project credentials are available.
Scheduled Reindexing Fails — Token Error
Scheduled Reindexing Fails — Token Error
- Go to User Settings > Personal Access Tokens.
- Check if you have any active (non-expired) tokens.
- If all tokens are expired or no tokens exist:
- Select Generate New Token.
- Provide a token name and expiration date.
- Save the token.
- Return to the Indexes section and verify the schedule is still turned on.
- Wait for the next scheduled execution or manually trigger a reindex to test.
Limitations
Best Practices
Choose the Right Schedule
Choose the Right Schedule
-
Data change frequency: Match the schedule to how often your source data changes.
- Rapidly changing data (for example, active repositories): Daily.
- Moderately changing data (for example, documentation wikis): Weekly.
- Slowly changing data (for example, archived content): Monthly.
-
Off-peak hours: Schedule during low-usage periods.
- Early morning (for example, 2:00 AM to 5:00 AM).
- Weekends (for example, Saturday or Sunday midnight).
- Avoid business hours to prevent performance impact on users.
-
Resource considerations:
- Larger indexes take longer to reindex.
- Consider system load and concurrent operations.
- Stagger schedules for multiple indexes to avoid simultaneous heavy operations.
-
User needs vs. system load:
- Balance data freshness requirements with system resources.
- Do not schedule more frequently than necessary.
Manage Multiple Schedules
Manage Multiple Schedules
-
Stagger execution times: Avoid scheduling multiple indexes at the same time.
- Index A:
0 2 * * *(daily at 2:00 AM). - Index B:
0 4 * * *(daily at 4:00 AM). - Index C:
0 6 * * *(daily at 6:00 AM).
- Index A:
-
Group by priority:
- Critical indexes: More frequent schedules.
- Reference indexes: Less frequent schedules.
- Document your schedules: Maintain a reference document listing all configured schedules for coordination.
Monitor & Maintain
Monitor & Maintain
- Regular review: Check the History tab periodically to verify schedules are executing successfully.
- Update schedules as needed: Adjust cron expressions when data change patterns evolve.
- Remove unused schedules: Turn off schedules for indexes that are no longer actively used.
- Test before production: Validate schedule configuration with a test index before applying to production indexes.
- Create & Use Indexes — Comprehensive guide to the Indexes section and index pages.
- Indexing Overview — General indexing concepts and architecture.
- Toolkits Menu — Guide to the Toolkit menu interface.
