Model report document (HTML, Excel, Word, PDF)
model_report_exportBuilds the Model Report plugin's 'Model report' for the open CIVIL NX model — cover, contents, materials, sections (with drawings), supports and springs, load cases, combinations and loads, nodes/elements/groups appendix, cross sections, tendons, CIVIL NX pictures, the QC checks and the data sources read — and returns it as download links: html (default), xlsx, docx and/or pdf, in English, French, German, Greek or Polish. Document details (project, client, job no., revision, author, checker, date …) go on the cover. Pictures are rendered by CIVIL NX (POST /view/CAPTURE, the user's own view is left as it is): by default the isometric model view and every figure saved in the model; choose model views, load views, saved figures and beam diagrams with images (model_report_images lists them), and the beam diagrams' legend format (exponential/fixed, decimals) there too. Otherwise reads only (GET, plus POST /post/TABLE for tendon coordinates). Runs as a job.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| images | No | Pictures CIVIL NX renders into the report. "none" for none; otherwise an object (omitted fields keep the defaults: modelViews ["iso"], savedFigures "all"). | |
| details | No | Document details printed on the cover (all optional). | |
| formats | No | ||
| language | No | Language of the check wording / the report: English, French, German, Greek, Polish. | en |
| numbering | No | Number chapters and figures. | |
| toleranceMm | No | Nodes closer than this (mm, 3D) count as coincident. | |
| outlierFactor | No | An element longer or shorter than the median length by this factor is an outlier. | |
| tendonCoordinates | No | Read the computed tendon coordinate table (needs an analysed model) when the report has tendons. |