Schedule a source update

This is for:

Developer System Administrator

There are three update operations you can use to keep your source content up to date. When you have the required privileges, you can schedule refreshes and rescans. Schedules let you choose a frequency and a time at which Coveo automatically launches the desired update operation for a source. Rebuilds, on the other hand, can only be launched manually.

For an optimal search experience, the search results of your Coveo-powered search interface should display the latest changes that were made to the content in your repository. Refresh and rescan operations ensure that the searchable content is up to date. For a great user experience, changes in your repository must be searchable and displayed in your search interface shortly after they’ve been saved.

Leading practices

  • Aim for an update schedule that keeps the indexed content up to date with your repository while minimizing the impact on server resources. An ideal update schedule is coherent with the rate at which your source content changes and avoids unnecessary connections between Coveo and the server hosting your content.

  • If your source indexes content from a repository with API call restrictions (for example, a cloud repository), schedule sources updates that optimally consume the available API calls.

  • Schedule update operations during off-peak hours to minimize performance impact on users.

  • Turn off source update schedules for unused or test sources, or sources with permanently static content.

  • Select a refresh frequency that reflects the rate at which items are added, modified, and deleted in the source. In other words, sources whose content changes often should be refreshed every day or hour. If your content doesn’t change frequently, increase the refresh time interval to optimize resource consumption.

    Examples

    • For a Jira Software Cloud source where multiple issues, comments, and attachments are added every hour, schedule a refresh every 15 minutes to make these changes searchable as soon as possible.

    • For a relatively stable Web source where only a few pages are added, modified, or deleted each week, schedule a daily refresh during off-peak hours.

  • Schedule a rescan as a safeguard, that is, to index any change that hasn’t been caught by refresh operations due to limitations. Rescans and refresh operations don’t run simultaneously (except for SharePoint Online parallel refreshes). Since a scheduled rescan operation has precedence over a refresh, but a refresh updates existing content more efficiently, overuse of long rescans can actually have a negative impact on content freshness. Typically, a weekly rescan is sufficient.

  • In sources where the refresh feature isn’t available or is limited, schedule a rescan once or a few times a day, depending on the content rate of change.

Schedule a source update

  1. On the Sources (platform-ca | platform-eu | platform-au) page, click the desired source, and then click More > Manage Schedules in the Action bar.

  2. In the Schedule a Source Update panel, enable the desired update operations schedules.

  3. For each enabled update schedule, enter the desired frequency.

  4. Click Update Schedule.

Required privileges

Actions Service Domain Required access level

View sources, view source update schedules, and subscribe to source notifications

Content

Fields

View

Sources

Organization

Organization

Edit sources, edit source update schedules, and view the View Metadata page

Content

Fields

Edit

Sources

Content

Source metadata

View

Organization

Organization