Configmark documentation (public knowledge base source)
Getting started
- Install Configmark from the Atlassian Marketplace. Only Jira admins can open it: Jira settings > Apps > Configmark.
- On Snapshots, click Take snapshot now. It runs in the background (about four minutes for a site with 60 spaces and 900 configuration objects); you can leave the page.
- From then on a snapshot runs every night. Change that in Settings (every night, once a week, or off).
Everything Configmark stores stays in your site's Forge storage on Atlassian. Configmark has no servers of its own.
What a snapshot holds
| Type | In the snapshot | Restore |
|---|---|---|
| Workflows | Statuses, transitions, conditions, validators, post functions, transition screens, properties | Yes. Jira refuses a version that removes a status work items still use. Deleted workflows are not recreated |
| Workflow schemes | Default workflow, workflow per work type | Yes; recreated if deleted |
| Permission schemes | Every grant | Yes; recreated if deleted |
| Notification schemes | Every notification per event | Yes; recreated if deleted |
| Security schemes | Levels and members | Compare only |
| Screens | Tabs, fields on each tab, field order | Yes; recreated if deleted |
| Screen schemes, work type screen schemes | Screen per operation, screen scheme per work type | Yes; recreated if deleted |
| Work type schemes | Work types, order, default | Yes; recreated if deleted |
| Custom fields | Name, description, contexts (spaces, work types) and options in order | Yes; a deleted field comes back only while it is in Jira's trash; field values are not in snapshots |
| Field schemes | Fields, work type limits, required, description, renderer (per work type too) | Yes; recreated if deleted |
| Field configurations and their schemes | On sites that still use them | Yes, existing ones |
| Statuses, priorities, resolutions, link types, work types, project roles | Names and descriptions (and category, color, link wording) | Yes; statuses and link types are recreated if deleted |
| Space settings | Name, description, lead, default assignee, URL, category, every scheme the space uses | Yes; team-managed spaces get name, description, lead and URL |
| Space role members | Users and groups per role | Yes (Atlassian's own atlassian-addons-project-access role is left out) |
| Boards | Filter, columns, estimation field | Compare only |
Not in snapshots: automation rules (Forge apps can't read them), work items, comments, attachments and field values, users, group membership and global permissions, quick filters and swimlanes, dashboards, and settings other apps keep in their own storage.
Compare
Pick an older and a newer snapshot, or click Snapshot now and compare to see what changed since the last snapshot. You get:
- counts per type (changed, removed, added), click one to filter;
- the list of objects, with renames ("was ...") and, where Jira's audit log has a record, who changed it and when;
- for each object, a list of what changed inside it, plus the full JSON of both versions;
- Download CSV for change reviews.
Snapshots taken on another site (imported from a file) can be compared but not restored.
Restore
- In Compare, tick the objects to put back (from the older snapshot), or open Browse on any snapshot and tick objects there. At most 25 at a time.
- Preview restore. Configmark reads each object from Jira and shows what it will change. Objects that already match, were created after the snapshot, are compare only, or are locked by Jira are listed with the reason and left alone. The list of what Configmark can't restore is always one click away.
- Type the confirmation phrase (for example
RESTORE 3 ITEMS) and click Restore. - Configmark saves the current version of every object in a Before a restore snapshot, restores them in dependency order as you (your Jira permissions apply), then reads each one again. The result says restored, partly restored (with Jira's message and what is still different), skipped or failed.
Recreated objects get new IDs. Objects restored in the same run are re-pointed at them (a screen scheme restored with its deleted screen uses the new screen). Anything else that used the old ID needs attaching again.
Options added to a field after the snapshot are disabled, not deleted, so work items keep their values.
Undo: Restore runs > Undo builds a restore from the Before a restore snapshot, with the same preview and confirmation. Objects the restore recreated are not deleted by an undo.
If you close the page during a restore, open Restore runs and click Continue.
Download and import
Download saves a snapshot as a JSON file built in your browser. Keep it with your change records. Import a downloaded file stores it as a snapshot again. Every object carries a checksum; a file that was changed is refused.
Retention and storage
- Scheduled snapshots are kept 30 days, others 365 days (both adjustable).
- Keep on a snapshot holds it until you delete it. The latest snapshot is never removed automatically.
- Over the storage limit, the oldest snapshots that are not kept are removed first.
- Unchanged objects are stored once, so a nightly snapshot of a quiet site adds very little.
- The audit log is kept 730 days by default.
After a Data Center migration
Take a snapshot right after each migration wave, before anyone starts tidying. If cleanup or a later wave breaks something, compare against that snapshot to see exactly what changed and put back the objects you need. Pair it with Prunewell, Great Work's where-used search and cleanup app, to see what uses an object before you restore or remove it.
Permissions
Only Jira admins can use Configmark. Every action re-checks the Administer Jira permission. Snapshots read configuration as the app; restores write as the admin who confirms them.
Licensing
Configmark is a paid app billed by Atlassian. Without an active subscription the app page and scheduled snapshots stop; snapshots already taken are kept.