Business objects
11 business objects described. A business object is a thing the business names and handles, with its attributes and its lifecycle.
| Business object | Lifecycle | First line | Links |
|---|---|---|---|
| Build | started, ingested, inferred, checked, written | One run of the build pipeline on a configuration: the sources it ingested with their commits, the model and the build log it wrote, and its summary. The summary counts the entities per type, the links per method, the keyword pages published and the expressions under the threshold, the twin resources reconciled, the decisions of the lock file applied, the domains the neighbourhood suggests with their pivots, and the findings per severity and per check; the log carries the same figures, the contracts imported and every finding. The only dated part of a build is its timestamp, taken from the injected clock, so that two builds on unchanged sources are byte-identical. Next to the model and the log, a build writes one fragment per entity, the rendered note or the passages of a keyword page, and the site itself; concordance render rebuilds the site from the model and the fragments without touching a source. A build fails only according to build.fail_on, after its model, its log, its fragments and its site are written. | 229 |
| Candidate | proposed, accepted, rejected | Something the build proposes without asserting it, listed under candidates of the model for a person to settle: a recurring expression without a note, with its score, counts and contexts, which becomes a keyword page above the publication threshold; a schema an imported contract names, offered as an object without a link; a pair of resources scored as twins without reaching the merge threshold. A decision on a candidate goes to the lock file of the configuration repository, never into a source. | 69 |
| Entity | typed, linked, rendered | A node of the model: a note recognised by the type cascade, or a keyword that crossed the publication threshold without a note. An entity has an identifier derived from its source and path, a type with the origin of that decision, a title, aliases, an application, a domain, a locale, its declared attributes and its source with path, commit and last-modified date. Every entity has a page, rendered by the entity page or the keyword page. | 179 |
| Finding | raised, reported | The result of a check: a check identifier, a severity, a file and line when there is one, a message and a remediation, attached to an entity, a link or a resource. Findings go to the build log and the model; the linter prints them in text, JSON, SARIF or JUnit. The to-do page shows two of them as work lists. | 146 |
| Keyword page | discovered, published, forwarded | An entity the build creates for an expression that recurs above the publication threshold without a note: a term marked as a keyword, located on the first mention of its expression, carrying its occurrences, files and score as attributes and its passages in its fragment. It has a page at keywords/<slug>, enters the search index and the alphabetical index, and is listed on the to-do page as work to do; when a note defines the expression later, the address forwards to the note's page so that a link written to it survives. | 110 |
| Link | inferred, combined, rendered | A typed relation between two entities, carrying a confidence between 0 and 1 and at least one provenance: method, file, line, section, context. When several methods produce the same source, target and relation, the confidences combine and every provenance is kept. Links are sorted canonically by source, target and relation in the model. | 189 |
| Model | built, validated, rendered | The single serialised result of a build: the build block with the tool version, timestamp, profile fingerprint and per-source commits; every entity; every link with its provenances; every finding; the term candidates and duplicate candidates; the bounded neighbourhoods. Canonically sorted, validated by a published schema, byte-identical from one build to the next on unchanged sources. The site is rendered from it without reading the sources again, and a Cypher export is provided. | 161 |
| Neighbourhood | accumulated, ranked, displayed | The entities around an entity, in two forms the model keeps apart. The bounded neighbourhood counts, per entity, the paragraphs it shares with every other, keeps the fifty best by count then by identifier, and feeds the co-occurrence links and the accompanying words of a keyword page. The displayed neighbourhood is the list of the one-hop neighbours a page shows: both ends of every link, each with the largest confidence and the relation of its most confident link, ranked by the order the profile declares for the type of the page, then by confidence, then by identifier, and cut at the configured size. Both are computed at build and written, never in the browser. | 62 |
| Representation | read, converted, grouped | One of the files an entity is made of: its note, a slide deck, the PDF produced from it, a transcript, the contract an operation was imported from. A note alone has one; twin resources merged into one entity carry several, each with its path, its kind and, for a document, its extracted text position by position, and the page shows them one after the other. An imported operation matched by a note lists the contract as a representation next to the note's own file. | 63 |
| Resource | ingested, converted, reconciled | A file read from a source: a markdown note, a document, a slide deck, a transcript, a contract. A resource carries its path, commit and date, and, for documents, the metadata extracted by a reader, the PDF produced by a converter and the text extracted from that PDF, page by page, or the cues of a transcript with their timecodes; an office document never gives its text any other way, so that one extraction path serves every format. Twin resources of the same document are grouped into one entity with several representations when their reconciliation score is high enough. | 70 |
| Source | declared, fetched, ingested | A repository or a local folder declared in sources: of the configuration: a unique name that prefixes every identifier from it, a git URL cloned at depth 1 on its ref or a local path, its locale, its default application, whether it is a glossary, and its typing rules. The build fetches it into the pipeline cache without ever writing into it, records the commit of the ingestion in the build block of the model, and goes on without it when it cannot be reached. Every resource and every entity knows its source. | 173 |
11 business objects of 11 — pagination by twenty. The Links column counts the related pages, which brings the most central business objects of the journey to the top.