read_data_module
Read one S1000D data module as structured information instead of raw XML, including body blocks, references, verification status, and product applicability.
Instructions
Read one data module as structure, not XML: identification and status (DMC, issue, language, title, BREX ref, QA, DM-level applicability), the body as a tree of blocks (sections, paragraphs, lists, tables, figures with ICN, warnings/cautions/notes, numbered steps, requirements; processes and fault isolation too), the references it makes, and ALWAYS a "verification" status (XSD by default). Applicability of each block is evaluated for the given product (applicable / notApplicable / undetermined); without a product, only display texts are returned — assert expressions are never returned.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dmc | No | DMC of the data module to read from the CSDB (e.g. "S1000DBIKE-AAA-D00-00-00-00AA-041A-A"; "DMC-" prefix optional). Alternative to path/xml. | |
| xml | No | The document as an XML string (alternative to path; max 5 MB). | |
| path | No | File path of the document. | |
| verify | No | How much to verify before reading: "schema" (default) runs XSD validation only; "full" also checks BREX along the brexDmRef chain and resolves references; "none" skips verification (reported as not-run). | schema |
| product | No | The product to evaluate applicability for. attributes: ACT productAttribute id → value (e.g. {"model": "Brook trekker", "version": "Mk9"}); conditions: CCT cond id → value. Omit to get "undetermined" with display texts only. Use describe_applicability to learn the available ids and values. | |
| section | No | Which part to return (default all). | all |
| csdbDirs | No | Extra CSDB folders to search (in addition to S1000D_CSDB_DIR) for data modules by DMC, referenced objects, ACT/CCT/PCT and BREX. | |
| maxNodes | No | Cap on body nodes returned (default 5000). | |
| omitNotApplicable | No | Drop blocks that are notApplicable for the given product (default false: keep them, marked). The number dropped is reported. |