Product documentation

A clear workflow health check, from first scan to export.

Workflow Linter is designed for self-service Jira administration. Start with an on-demand scan, review evidence, resolve or suppress findings, and let scheduled scans keep the report current.

01

Quick start

  1. In Jira, open the Settings gear, then choose Marketplace apps. Some Jira navigation versions may label this Apps.
  2. Select Workflow Linter in the left sidebar. Use the ordinary entry, not a DEV entry if one exists on your test site.
  3. Choose Run first scan, or Scan again if a report exists.
  4. Check Last successful scan, then review a finding's evidence and suggested remediation.
Administrator access required

Use a Jira Cloud site you are authorized to administer and follow your organization's app-approval process. If Marketplace's Manage button takes you to central Connected apps administration, return to Jira to open the scanner.

New to the app? Follow the 10-minute evaluation below.

A 10-minute evaluation

Find out whether the report gives you useful evidence for reviewing a workflow. Allow about 10 minutes once the app is installed; approvals, installation, and scan time may take longer. You do not need to change a workflow or send us your report.

Before you start

Review current pricing, evaluation terms, and permissions on the Marketplace listing. Have an authorized administrator install the app if needed. If it is already installed, use that installation rather than starting another trial. Do not install on a client site without permission.

No approved site yet? Try the no-login demo. It uses synthetic data, not your workflows. The app reads workflow structure and stores a bounded report and finding preferences; it does not change workflow definitions or test business intent, permissions, validators, or compliance.

Minutes 0–2: run a scan

Follow Quick start, wait for the result, and check Last successful scan. If the scan fails or is disabled, stop and note the visible error. An inactive license or missing administrator access needs resolving first. An older retained report is not proof that the new scan succeeded.

Minutes 2–4: check coverage

Review workflow and severity counts. Look for Workflow limit reached or Stored report is bounded warnings. A bounded report is not complete coverage of every workflow or finding. A score of 100 does not certify correctness, security, or compliance; a lower score alone does not prove a defect.

Minutes 4–7: review one finding

Start with a critical or high-severity finding if present, otherwise choose one relevant to a workflow you understand. Read its rule ID, confidence, Evidence, and Suggested remediation. Compare it with the configuration in Jira without editing the workflow.

  • Does the evidence describe the configuration accurately?
  • Is this a genuine concern, an intentional design choice, or inconclusive?
  • Does the report make the next review step clearer?

A heuristic is a prompt to review intent, not a proven defect. Do not change a workflow just to improve its score. Leave findings unchanged for this evaluation; Suppress intentional exception saves a report preference, not a workflow fix. If there are no findings, record that the current ruleset found none, check coverage warnings, and continue.

Minutes 7–9: save a report

Follow the manual CSV or JSON export steps below. Confirm the saved file contains report data. Keep it in an approved location; it is not a full workflow backup.

Minute 9–10: tell us whether it helped

Email support@workflowlinter.com with a few short answers:

  • Which steps did you complete: scan, finding review, or local export?
  • Was the report useful, unclear, or not useful, and why?
  • Was one finding actionable, intentional, or inconclusive, or were there no findings?
  • What would stop you paying for this at the current Marketplace price?
  • Where did you get stuck, if anywhere?

Plain-language feedback is enough. Please do not attach reports, client data, workflow names, screenshots, credentials, or tokens. Summarize errors without sensitive details. No purchase, testimonial, or meeting is required.

02

Scanning

The app discovers global and project workflows with Jira Cloud REST v3 workflow search, then reads complete transition graphs through Jira's bulk workflow endpoint. The same deterministic analysis service powers on-demand and weekly scheduled scans.

  • Ordinary rate limits and temporary Jira failures are retried automatically.
  • The latest successful result remains available when a refresh fails.
  • Diagnostics classify failures without exposing raw Jira response bodies.
03

Understanding findings

Each finding includes severity, confidence, workflow context, exact evidence, impact, and remediation guidance. Factual findings identify structural defects. Heuristic findings identify designs that deserve administrator review.

Intentional designs can be suppressed without changing Jira. Suppression identifiers remain stable for the same workflow, rule, subject, and evidence.

04

Rule catalog

IDSeverityConfidenceDetects
WL001CriticalFactualNo initial transition
WL002HighHeuristicMultiple initial transitions
WL003CriticalFactualMissing transition target
WL004CriticalFactualDirected transition without a source
WL005CriticalFactualMissing transition source
WL006MediumFactualDeprecated status still present
WL007HighFactualStatus unreachable from the initial path
WL008HighFactualReachable non-Done dead end
WL009HighFactualReachable status with no path to Done
WL010HighHeuristicWorkflow has no Done-category status
WL011MediumHeuristicGlobal transition to Done exposes no validator metadata
WL012MediumHeuristicGlobal transitions dominate the workflow
WL013MediumHeuristicSame transition name leads to different targets
WL014Medium or HighHeuristicElevated status or transition complexity

Every result includes a stable ID and practical remediation. Heuristics are intentionally labeled and can be suppressed.

05

Exports

CSV contains finding rows; JSON contains the structured report and completeness metadata. Export detail can be bounded by storage, so check coverage warnings. Neither format is a full workflow definition or backup.

  1. Select View CSV export or View JSON export.
  2. Click inside the Report text field.
  3. Select all with Ctrl+A on Windows or Command+A on Mac, then copy.
  4. Paste into a plain-text editor and save as UTF-8 with a .csv or .json extension. Check that the editor has not appended .txt.
  5. Confirm the file contains the report, not the instructions. Select Close to return to the app.

This is manual copy/save, not an automatic download. Store reports only in approved locations and share them only with authorized people.

06

Safety limits

  • Up to 1,000 workflows across 20 Jira API pages.
  • Detailed storage for the 200 highest-priority findings.
  • Up to 500 finding suppressions.
  • One bounded latest successful report rather than an accumulating history.
07

Troubleshooting

The first scan does not run

Confirm you opened Workflow Linter as a Jira administrator and retry. Open Show diagnostics for the failure class and timestamps.

A workflow or finding is missing

Check for workflow-limit or stored-report warnings. Aggregate counts remain intact even when lower-priority detail is bounded.

A finding is intentional

Use Suppress intentional exception. You can restore the finding later.

Still need help?

Email support@workflowlinter.com with the diagnostics block, approximate time, app version, and a description with sensitive tenant information removed. Never send passwords or API tokens.