The explanation, on the screen that needs it

DALP 3.2 links terms in the Console to their documentation. A book icon opens the relevant page in a new tab, so you can read a definition and return to the same task.

Console

Look it up without losing your place

A term of art on a Console screen carries a small book glyph. It opens the documentation page that defines the term, in a new tab, so the form you were filling in is still there when you come back. Sixty-one surfaces carry one, a surface being either a whole screen or a panel shared across several. Between them they hold 137 links onto 49 pages.

Console surfaces

61 carry a link

Links on them

137

Pages they reach

49

Opens in

Always a new tab

Served from

Your own instance

The gap this closesCopy Anchor Link

Documentation and the product used to be two places. You met a term on a screen, and if you did not know it, the way to find out was to leave, open the documentation, and search for a word you had just read but could not yet define.

Opening documentation in a new tab preserves the current Console page.

The connection now runs the other way. The screen knows which idea it is asking about, so it carries the link. You read the definition and return to the step you were on.

The definition stays a page rather than a popover on the term, and that is a choice about accuracy rather than about screen space. These terms carry regulatory weight, and their explanations run to worked examples and to the limits of each rule. Copying a short form of that into the interface would create a second version to keep true, and the two would drift. One text, in one place, is the version everyone reads.

Link placementCopy Anchor Link

Five shapes of link ship, and the screen's own situation picks between them rather than an author's preference:

• A term inside a sentence becomes the link, so the word you are looking at is the way to learn more.
• A panel or tile that has room gets a labelled link under its description.
• A dense table header, where there is no room for words, gets the glyph alone.
• A screen that is blocking you gets a link to the documentation section that says how to unblock it, rather than to a definition of the thing you are blocked on.
• A screen covering several ideas at once gets a link to the section that holds all of them.

All five render the same book glyph. One mark means "this opens the documentation" everywhere it appears, so you never have to work out whether a coloured word is a link to a definition or a link to another screen.

A new tab, from your own instanceCopy Anchor Link

Every one of these links opens a new tab, and that is fixed rather than a preference. These links sit on screens people reach mid-task, and a link that replaced the current page would discard whatever was being configured. A reader who wants a definition is not asking to abandon a form.

The page it opens is served by your own instance, on the same address as the Console. Nothing on the screen points at an outside host, so the links work in a private or network-restricted deployment exactly as they do anywhere else, and there is no documentation address to configure.

One consequence follows from that, and it belongs in your upgrade planning: the documentation your operators read ships with the platform, so it moves when you upgrade and not before.

Link validationCopy Anchor Link

A link to documentation that has moved is worse than no link, because it teaches people that the glyph does not work. Three checks run before any change ships:

• A Console screen can only name a destination the platform knows about. An invented name fails the build.
• Every named destination must still exist. The page must be there, and where a link points at one section of it, that section must be there too. A renamed page or a reworded heading fails the build rather than sending a reader somewhere wrong.
• The reverse also holds: a documented destination that no screen links to is reported, so the connection does not rot on either side.

Build checks validate named pages and section targets. If a link fails on a deployment, record the source screen and destination URL so an operator can check routing and documentation availability.

Availability and compatibilityCopy Anchor Link

This arrives with the upgrade to DALP 3.2. The links need no separate configuration.

Three limits worth knowing before you tell your team about it:

• The link and its label are translated into each of the four Console languages, which are English, German, Japanese, and Arabic. The documentation pages themselves are published in English only, so an operator working in German follows a German link to an English page.
• The destination of a link is fixed by the platform. A glyph cannot currently be pointed at your own internal policy documentation.
• The coverage is the 61 surfaces counted above rather than every screen. A screen that introduces no term of art carries no link, by design.

Nothing changes for an API integration. No route, request, or response shape is affected.

See everything in DALP 3.2 → · Read the concept library → · Set up compliance modules → · Understand your instance →