Scan Configuration
Administration -> Scan Configuration is where a scan is defined: what to read, how hard to work Jira, and when to run.
It is a single form. The first stretch of fields is ungrouped and runs in the order you would fill it in:
- Name for the configuration.
- All accessible projects, or a list of Project keys.
- Included fields and Excluded fields.
- Include comments, and Scan attachment contents for attachment contents.
- Text mode - rendered, raw, or both.
Two headed sections follow:
- Scan engine - worker count, max issues per minute, batch size, retry attempts, and retry backoff seconds, plus Allowed scan windows (day, start, end) for the hours in which a scan may run. These are saved with the configuration, so each run records exactly what it used.
- Schedule - an optional cron expression that starts scans automatically, with a preview of the next fire times and the last and next scheduled run.
A Preview scope button sits alongside the form and asks Jira what the current scope actually covers: estimated projects, estimated issues, estimated runtime, and a sample of the project keys.
Two things are worth internalising:
- Configurations are immutable snapshots. Saving changes creates a new version rather than editing the old one, and every scan run points at the exact version it ran with. The button says Save as new version for that reason, and the resulting version is shown after saving.
- Preview scope is the cheap way to avoid an expensive mistake. Check the estimated issue count before saving a broad scope, especially with attachment scanning enabled.
See Scans configuration for the full reference of every option, its default, and its behaviour.