Skip to content

Document CMDB status IDs and constants - #1361

Open
ljuergenliemke wants to merge 2 commits into
mainfrom
docs/1236-cmdb-status-ids-and-constants
Open

Document CMDB status IDs and constants#1361
ljuergenliemke wants to merge 2 commits into
mainfrom
docs/1236-cmdb-status-ids-and-constants

Conversation

@ljuergenliemke

Copy link
Copy Markdown
Contributor

Fixes #1236

Problem

The CMDB status article explains how to manage statuses, but it never lists the numeric IDs or the C__CMDB_STATUS__* constants. Anyone who has to address a status from the API, an import or another interface had to log into a running instance and look them up first.

Change

Adds an "IDs and constants" section to both the EN and DE article:

  • A table of the 14 delivered statuses: ID, constant, default title.
  • A note that in operation, inoperative, i-doit Status and Template are reserved for internal use and are returned with editable: false.
  • A pointer to cmdb.status.read for reading the complete per-installation list including custom statuses, plus a "See also" entry.

Verification

Every value was verified against i-doit 38, three independent ways:

  1. cmdb.status.read on a live instance, called once per language so the EN and DE default titles are the ones i-doit actually ships (not hand translations).
  2. Shipped seed data in setup/sql/idoit_data.sql, which contains the same ID to constant to color mapping for all 14 rows. This confirms the IDs are delivered defaults, not artefacts of the test instance.
  3. Source (isys_module_system_settings), which is where the editable: false behaviour for IN_OPERATION and INOPERATIVE comes from, on top of the DB flag for IDOIT_STATUS and IDOIT_STATUS_TEMPLATE.

Both tables were then diffed programmatically against the live API response: exact match, 14/14 rows, in both languages. All relative links in the two files resolve to existing pages.

One thing to look at

I also corrected the example status names in the intro of both articles, because they listed titles i-doit does not ship and would have contradicted the new table on the same page:

  • DE: "Gespeichert" to "Gelagert"
  • EN: "Defective" to "defect", "Out of operation" to "inoperative" (and lower-cased the examples to match the shipped titles)

Happy to drop that part if you would rather keep the intro untouched.

Not included

The EN article references the DE screenshot (assets/images/de/...). That is the separate #1321 screenshot topic, so I left it alone here.

The CMDB status article described how to manage statuses but never named
the numeric IDs or the C__CMDB_STATUS__* constants, so anyone addressing a
status from the API, an import or another interface had to look them up in
a running instance first.

Add an "IDs and constants" section to the EN and DE article with a table of
the 14 delivered statuses (ID, constant, default title), a note that the
four internally reserved statuses are returned with editable: false, and a
pointer to cmdb.status.read for reading the per-installation list including
custom statuses.

Values verified three ways against i-doit 38: cmdb.status.read (once per
language for the titles), the shipped seed data in setup/sql/idoit_data.sql
(same ID to constant to color mapping), and the editable handling in
isys_module_system_settings.

Also corrects the example status names in the intro of both articles, which
listed titles i-doit does not ship ("Gespeichert" instead of "Gelagert",
"Defective"/"Out of operation" instead of "defect"/"inoperative").

Fixes #1236

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@ljuergenliemke
ljuergenliemke requested a review from a team as a code owner July 31, 2026 13:12
@ljuergenliemke ljuergenliemke self-assigned this Jul 31, 2026
@ljuergenliemke ljuergenliemke linked an issue Jul 31, 2026 that may be closed by this pull request
The EN article embedded the German screenshot
(assets/images/de/administration/verwaltung/vordefinierte-inhalte/...),
so the English page rendered a German UI. An English screenshot of the same
page already exists in the tree at
overrides/assets/images/en/system-administration/administration/predefined-content/cmdb-status/1-cs.png
and was simply never referenced.

Same class of fix as PR #1313 and issue #1321; doing it here already since
this article has an EN image available.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@ljuergenliemke

Copy link
Copy Markdown
Contributor Author

Follow-up: the EN screenshot is now fixed here as well, rather than waiting for #1321.

The EN article embedded the German screenshot (assets/images/de/administration/verwaltung/vordefinierte-inhalte/...), so the English page rendered a German UI. An English screenshot of the same page already existed in the tree and was simply never referenced:

overrides/assets/images/en/system-administration/administration/predefined-content/cmdb-status/1-cs.png

So no new screenshot was needed, only the reference. Verified on a local render: the page and the image both return HTTP 200 and the emitted tag now points at assets/images/en/....

Side note for #1321: this article was in the easy category because an EN image existed. 348 EN articles still reference assets/images/de/, only some of which have an EN counterpart available.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC IMPROVE] Document CMDB-Status IDs and Constants

1 participant