Skip to content

History / Jira Connector Developer Guide

Revisions

  • Issue trackers: Azure DevOps connector, and the contract test it settled (#964-966) New page: Azure-DevOps-Connector-Developer-Guide, the sibling of the Jira one. Issue-Trackers gains Azure DevOps setup and the Resolved setting; the two guides that PREDICTED this work now record how it turned out. The engine guide committed to a falsifiable claim before Jira shipped: adding connector #2 must touch nothing but the provider, one registry row and its settings partial. It held, and the page now says so with the three things that did change for everyone: - settings_fields, and why it is separate from credential_fields — a dropdown among the credential boxes inherits their blanking rule and silently resets on every save; - integrationsAbsoluteUrl(), because the ticket link every connector puts in an issue was built from BASE_URL, which is a path, so it 404'd from inside any tracker and had never worked; - $target may be keyed either way — core's neutral `issue_type` or the provider's own word — because reading only one silently creates the wrong kind of work item. The Jira guide's "if you are writing the next connector" list is now marked as validated, with two of its decisions reclassified as Jira-ONLY now there is something to compare against: - relative JQL dates exist because Jira reads an absolute date in the USER's timezone. Azure DevOps honours an explicit UTC Z. Copying either across is a bug, and both are right for their own tracker; - flavour-dependent author_identity is an Atlassian quirk, not a general requirement. What IS general is that it match testConnection(). What the new page records that the code cannot say for itself: - ⚠️ which field holds the body depends on the work item TYPE. A Bug's form shows Repro Steps and not System.Description, so writing the description to the obvious field returns 200 and produces a work item that looks empty to the developer who opens it; - 🔑 five state categories, not four, and why the fifth is a per-connection SETTING rather than a mapping — plus the live vindication of "never branch on a status name": "Resolved" is category Resolved on a Bug and InProgress on a User Story, same project; - ⚠️ timePrecision=true is a query parameter, not a body field, and the tempting fix for the error it throws silently re-reads a day of comments; - ⚠️ echo suppression must use createdBy.id — the two endpoints report DIFFERENT descriptor formats for the same person, so comparing those never matches and every comment we write comes back as a developer's; - ⚠️ attachments are two steps and step one attaches the file to nothing; - ⚠️ a rejected token answers 203 with a sign-in page, not 401 with JSON. Also corrected two stale rows in the analyst page's "not there yet" table: attachments and "tell the requester when it is done" both shipped weeks ago and were still listed as missing. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

    @edmozley edmozley committed Aug 2, 2026
  • Issue trackers: document mapping (#957) Engine guide gains 7e: the precedence rule and why it is that way round, why priority has no wildcard, the narrow rejected-priority retry, the namespaced local_key, and two traps — the column is ticket_type_id not type_id, and a shared service must not assume it owns the transaction. Analyst page gains a Mapping section in plain terms, and the Jira page records that mapping needed no connector change beyond listPriorities(), which is the abstraction doing its job.

    @edmozley edmozley committed Aug 2, 2026
  • Add a Scheduled tasks page; bring the tracker dev guides current New page: Scheduled-Tasks. Ed asked for one place covering every cron job / Windows task FreeITSM needs, because "you must schedule something or comments never arrive" was buried in the Jira page. Covers all four jobs, what silently breaks without each, Windows and Linux commands, how to run one by hand, and how to tell whether they are working. Also documents what is NOT a scheduled task, so nobody goes looking for a job that does not exist or schedules the InTune workers, which the app starts itself. Notes that mail is fetched by the browser, so nothing is collected overnight with every browser closed. Windows gotchas that cost time today: /ru SYSTEM tasks are invisible to a non-elevated session, 0x41303 means "not yet run", and the escaped quoting fails if a path has spaces. Linked from Home, the sidebar, and five places in Issue-Trackers. Dev guides brought current for #954-956: assertion count 227, range #945-956, the pipeline diagram no longer shows the removed author guard, and a new note on inbound_enabled — a column that shipped in V1 with no writer, so the feature it gated could never be turned on. That is a trap worth naming for the other columns V1 shipped early.

    @edmozley edmozley committed Aug 2, 2026
  • Issue trackers: comments coming back, and the join that hid notes (#954) The engine guide gains 7d — the inbound pipeline, both echo guards, the "first poll imports nothing" rule and why the comment map row is written before the note (the unique key is what wins a race between two cron runs, not the check before it). The Jira guide gains 7: two calls rather than one per issue, why the JQL date must be relative (an absolute one is read in the Jira user's timezone, not UTC), why the ADF reader lives in the connector rather than IssueDoc, and that author_identity must match testConnection() or echo suppression silently stops working. The analyst page documents the toggle, that imported comments are always internal, and that enabling it does not bring back a backlog. Also recorded: get_notes.php inner-joined notes to their author, so 10 of 17 notes on the dev install were invisible. Both dev pages now list what forces an update, including the rules above.

    @edmozley edmozley committed Aug 2, 2026
  • Issue trackers: the analyst page, and cross-links (#945-953) The dev pair existed but the analyst page did not, so a user had no page at all. Issue-Trackers covers setup (including the API token living in the Atlassian account, not Jira), raising an issue, reading the pill, automating it with a workflow rule, and an honest 'what is not there yet' — comments coming back is named as the biggest gap rather than left to be discovered. Also: sidebar entry, and both dev pages now point at it.

    @edmozley edmozley committed Aug 2, 2026
  • Jira guide: the removed search endpoint, and real-Jira proof (#953) Cloud retired /rest/api/3/search for /search/jql; DC keeps the old one. Recorded with the lesson that generalises — a connector's correctness depends on someone else's API, so when a call starts failing, suspect the endpoint before the logic. Status banner now records that the whole journey has run against a live Jira Cloud site.

    @edmozley edmozley committed Aug 2, 2026
  • External issue trackers + Jira connector developer guides (#945-947) Two pages, split on the line that matters: the engine page is the contract every tracker must satisfy, the Jira page is the worked example. That split is the point — whoever writes the GitHub or Azure DevOps connector needs to know which decisions were forced by the contract and which were just how Jira happens to work, and both pages say so explicitly. Also cross-referenced from Multi-Tenancy-Developer-Guide: tracker connections added to the connection column of the three-meanings-of-NULL table, and the outbound twin of the membrane rule recorded next to the inbound one. Both pages carry a "keeping this page honest" section listing what must be updated in the same commit as a code change.

    @edmozley edmozley committed Aug 1, 2026