Document catalogue
Every document BooleX reads, where it lives, its index state and summary, and questions about one document.
The Documents button in the top bar opens the document catalogue, for every signed-in user. It lists every document BooleX can cite: those read in place from the site's document sources and those imported with the import commands (REQ-ASST-152).
Documents are read where the site keeps them. For a file share, BooleX keeps a catalogue entry and a search index per document, never a copy of the file (see Documents and work orders).
The catalogue
Documents are grouped by source (a file share by its label; imported documents under Imported) and by folder. Filter by Source and Folder at the top. For each document:
| Column | What it shows |
|---|---|
| Document | Its title and document ID; open it for its overview |
| Type | FDS, O&M, P&ID, C&E, electrical, datasheet, procedure or other |
| Revision | The revision cited. A document read from a share that changes gets a new revision, W and the first 8 hex digits of its content hash |
| Assets | The assets the document covers, from the manifest or from asset tags found in its text |
| Index state | Indexed, Indexed by OCR (a scan), No text found, or Failed to index with the reason |
| Summary | A short summary in which every statement cites the document's own pages; No summary yet until one is made |
A source that cannot be reached right now (a share that is not mounted, a server that is down) is marked Source unreachable. Its documents stay searchable and citable from their index (REQ-ASST-150).
Summaries are written by the configured model when a document is indexed, and checked like every answer: a statement is kept only if each page it cites belongs to that document (REQ-ASST-153).
A document's overview
Open a document to see its type, assets, index state, Location (where it lives, and whether that source can be reached now), its summary and its Sections or pages (REQ-ASST-155).
Ask about this document
Under Ask about this document, type a question and press Ask. The answer comes from that document only: the model may read only its pages, and every statement cites the page or section it comes from. A statement that cites nothing, or anything outside the document, is removed. When the document does not answer the question, BooleX says so: This document does not answer the question. (REQ-ASST-154). The question and answer are recorded in the audit log like every answer. It needs a configured model.
In the source viewer
A doc:// citation of a document read in place opens in the source viewer as usual, and also shows where the document lives. When its source cannot be reached, the viewer says so and shows the indexed excerpt, or the cached page image where the site has turned the page cache on (page_cache in Site configuration). When the cited version has changed on the share since it was cited, the viewer opens the current version, labelled as changed since cited (REQ-ASST-151). Documents can come from a file share, SharePoint Server, SharePoint Online, OneDrive or Google Drive. Location links to the document in its library. The cloud libraries are read only where the site's deployment profile allows them: see Connect a document share.
Drawings, the P&ID and the code
Ask the Assistant about the installation and it answers from the imported electrical drawing sets, the P&ID and the code, citing each sheet and code element:
| Ask | What you get |
|---|---|
| "What feeds P-101?" | The items upstream and downstream of it on the P&ID, in the flow direction, through in-line valves, up to 4 items away, with the piping line between each pair, and the instruments on it with their PLC tags (REQ-ASST-176, REQ-ASST-177). Off-page connectors (drain, water, steam) end a branch. |
| "Where does XV-105 appear?" | Every electrical drawing device and page, P&ID item, label on a drawing, and the code elements that read or write its tags (REQ-ASST-179). |
| "Are the drawings for XV-105 current?" | For each sheet that shows it: its revision date, and any later change found: a code import that changed an element using its tags, a work order whose action changed hardware or wiring, or an I/O address where the code and the drawing differ (REQ-ASST-181). |
| "Where do the drawings and the code disagree?" | Code tags with an I/O address that no electrical drawing shows, drawn I/O that no code tag uses, P&ID valves, pumps and instruments with no PLC tag, and addresses on which two drawing sets disagree (REQ-ASST-184, REQ-ASST-185). Add an asset to narrow it. |
How a drawing item is matched to the code: by the asset in the site tag list, by the tag name with case and hyphens ignored (QT-101 is QT101), or by a tag name that starts with the item and an underscore (XV-105 is XV105_Open, XV105_ZSO, XV105_ZSC) (REQ-ASST-180).
A sheet with a later change is called possibly out of date, never out of date: only a check in the field confirms what is installed (REQ-ASST-182). A sheet whose title block has no revision date is reported as not datable (REQ-ASST-183). The flow direction comes from a DEXPI P&ID; a P&ID imported without one lists its connections as connected, not upstream or downstream (REQ-ASST-178).
The Drawings and documents agent of the focused-agent team uses these tools when agents are switched on (experimental, off by default; see How a diagnosis is made).