Automated Scheduling

aprity supports automated scan scheduling so your Salesforce documentation stays current without manual intervention. Configure a recurring schedule and aprity will generate fresh documentation at the interval you specify.

Schedule Status Card

The scheduling interface displays a status card at the top of the screen summarizing the current configuration:

• Schedule state -- whether automated scheduling is active or inactive.
• Recurrence interval -- how frequently scans run.
• Next scheduled run -- the date and time of the upcoming scan.
• Last run -- timestamp and status of the most recent automated scan.

Configuring a Schedule

Recurrence Interval

Select how often aprity should generate documentation. Available intervals:

Interval	Description
Every day	Daily documentation refresh.
Every 7 days	Weekly scans.
Every 14 days	Bi-weekly scans.
Every 30 days	Monthly scans.

:::info Plan-Based Restrictions Not all intervals are available on every plan. Shorter intervals require higher-tier plans:

• Starter -- 30-day interval only.
• Professional -- 14-day and 30-day intervals.
• Enterprise -- all intervals including daily.

Locked intervals display a plan upgrade prompt when selected. :::

Time Selection

Configure the exact time of day for scheduled scans using the hour and minute pickers. Times are specified in UTC.

tip

Schedule scans during off-peak hours for your Salesforce org to minimize any impact on user experience. Late evening or early morning UTC is typically ideal.

Activating the Schedule

After selecting the interval and time:

1. Review the configuration in the status card preview.
2. Click Activate Schedule.
3. The status card updates to show the schedule as active with the calculated next run time.

Managing an Active Schedule

Deactivating

To pause automated scans, click Deactivate Schedule. The schedule configuration is preserved but no new scans will be triggered until you reactivate.

Modifying

To change the interval or time:

1. Deactivate the current schedule.
2. Adjust the interval or time pickers.
3. Reactivate the schedule.

The next run time recalculates based on the new configuration.

Last Run Tracking

The status card displays the result of the most recent automated scan, including:

• Completion timestamp.
• Final scan status (COMPLETED, COMPLETED_WITH_ERRORS, or FAILED).
• A link to view the full scan details in the Scans tab.

Policy Error Messaging

In certain situations, aprity cannot activate or execute a scheduled scan. Clear error messages explain the issue:

Error	Cause	Resolution
Insufficient plan	The selected interval is not available on your current plan.	Upgrade your plan or select a longer interval.
No completed scan	Scheduling requires at least one successful manual scan first.	Run a manual scan to establish a baseline configuration.
Connection expired	The Salesforce connection token has expired.	Re-authenticate the Salesforce connection in the Setup tab.

caution

If a scheduled scan fails, aprity does not automatically retry. Check the Scans tab for error details and address the underlying issue before the next scheduled run.

Best Practices

• Start with a longer interval (e.g., 30 days) and decrease it as your team's change velocity warrants more frequent updates.
• Monitor the last run status regularly to catch failures early.
• Align scheduling with your release cadence -- if your team deploys to Salesforce bi-weekly, a 14-day scan interval ensures documentation stays synchronized with changes.