Skip to content

docs(universal parser): document editing field mappings from the UI - #15583

Merged
devGregA merged 1 commit into
devfrom
docs/universal-parser-mapping-edits
Aug 10, 2026
Merged

docs(universal parser): document editing field mappings from the UI#15583
devGregA merged 1 commit into
devfrom
docs/universal-parser-mapping-edits

Conversation

@devGregA

@devGregA devGregA commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

Universal Parser field mappings can now be edited from the UI. The docs page still
described the API as the only way to do it, so this updates the section to cover both.

What the page now says:

  • Where the screen is — Import → Universal Parser in the sidebar, then "Edit Field
    Mappings" from the menu on the parser's row.
  • Why it opens by asking for a scan file. This is the part most likely to surprise
    someone: it is not the file the parser was created with. Nothing is retained from that
    one, so the available fields have to be read from a current sample. The page says so
    plainly, and explains what it means when saved mappings cannot be found in the sample
    you upload — they are not pre-selected, and they are dropped if you save.
  • What the impact step shows before anything is applied: whether the edit is
    presentation-only or identity-relevant, which fields are changing split by whether they
    reach identity, and how many findings exist under the parser's scan type. An
    identity-relevant edit requires ticking a confirmation; a presentation-only one does not,
    which is what keeps the confirmation meaningful.
  • The permission split, which the page did not previously cover: editing mappings
    requires Universal Parser Edit, while seeing the parsers only requires Universal Parser
    View. A user who can see your parsers cannot necessarily change how they read a file.
  • The Django admin caveat, extended: the impact step now reports when a parser's
    mappings were previously changed without being recorded, and warns that findings imported
    before that change have no previous generation to match from — something a later edit
    cannot recover.

The existing API instructions are unchanged; the "check before you make it" section just
notes that the UI performs the same impact call as its third step.

Docs-only change — one file, no code touched.

Validated locally with a Hugo production build pinned to the version CI uses (0.153.4
extended): 790 pages built, and the new in-page anchor resolves.

The editing section was written when the only way to do it was the API. There is
a screen now, so describe it: where it lives, why it opens by asking for a sample
file (nothing is retained from the file the parser was created with, so the
available fields have to be read from a current one), and what the impact step
shows before anything is applied.

Also states the permission split, which the page did not cover: editing mappings
needs Universal Parser Edit, while seeing the parsers only needs View.
@devGregA
devGregA requested a review from Maffooch as a code owner August 8, 2026 20:30
@devGregA devGregA added this to the 3.3.0 milestone Aug 8, 2026
@devGregA
devGregA requested a review from blakeaowens as a code owner August 8, 2026 20:30
@github-actions github-actions Bot added the docs label Aug 8, 2026
@devGregA
devGregA merged commit 3e57fed into dev Aug 10, 2026
46 checks passed
@devGregA
devGregA deleted the docs/universal-parser-mapping-edits branch August 10, 2026 03:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants