Implementation Report
The Implementation report tab of the Reports page writes the documentation of the instance you are signed in to: what is configured, how each document is turned into UBL, which rules apply, who can do what. Everything is read from the configuration files and the database at the time of generation, so the report always describes the instance as it runs — whatever the source system (JD Edwards, SAP, NetSuite or a custom ERP).
Typical uses: the hand-over file of a project, the description an auditor or a tax adviser asks for, the snapshot taken before an upgrade, the reference a support team keeps next to the production instance.
Open it from Reports → Implementation report.
At a glance
| Control | Description |
|---|---|
| Language | Drop-down: French or English. Defaults to the language of the interface. Labels of settings, statuses and lists follow the language. |
| Date label (cover) | Free text printed on the cover (e.g. Go-live V2). Blank = today's date. |
| Show technical keys next to setting labels | Adds the configuration key after each label (Allow reprocess · allowReprocess). Useful for a technical reader; off by default. |
| Sections | Tick the parts to include. The first nine are ticked by default; the two appendices are optional because of their length. |
| Download PDF / Download Markdown | Generates the file and downloads it. A copy is kept in the environment's reports folder (<appHome>/<env>/reports/nomaubl-implementation-<date>-<time>.pdf or .md). |
What the report contains
| Section | Content |
|---|---|
| Context | Environment, release and standard version (XP Z12-014), generation date, application home, database type and schema, companies, number of documents, author. |
| Architecture | The flows enabled on the instance and their trigger: sending to the PA, import poll, status poll, received invoices, e-reporting, directory check, scheduled batch jobs, watched folders, JDE print queue reports, connectors per type, authentication. A flow shown as off is configured without a trigger and can still be run on demand. Then the processing chain: sources, transform, validation, archive tables, directions. |
| How it works and built-in rules | The functional guide: what every page is for (in menu order), the invoice lifecycle, the protection of deposited invoices, the rules of edit / fix buyer / resend / validate / set status / e-mail with the permission each one requires, the two reprocess modes, the status poll with the integrity and ordering checks, the review flag and notifications, and a quick reference of the platform statuses (AFNOR XP Z12-014) and of the internal 99xx stages. |
| Documents | One table of every document (source, direction, processing type, PDF template), the path variables with their value on this instance, then one subsection per document: folders, XSL and RTF files, UBL sheet, reprocess options, links to its pre-transform and UBL sheet, index fields and other settings. Then the PDF templates: documents that use each one, layout, logo, colours, sections and their options. |
| UBL transform and rules | Shared defaults (currency, specification identifier, schemes, defaults per BT), issuing companies, mapping tables and rules (transaction type, VAT category, exemption, payment means, unit of measure…), validation packs with their version and rule counts, house rules, coverage per document, then one subsection per pre-transform (renames, custom rules, drops) and per UBL sheet: profile, redefined mappings, and the full source field → BT → UBL path mapping. |
| Platform settings | E-invoicing settings (default and per company), e-reporting, directory, document types with their send and validation flags. |
| Operations | Scheduled jobs with their trigger, watched folders, notification rules with the actions they trigger, invoice actions, integrity checks, connectors with their host and authentication type. |
| Security | Authentication mode and session timeout, roles (pages, actions, companies, features, users), users with role, state and pending password change. |
| Reference data | The status catalogue (labels, PA codes, groups), every reference and custom list with its entries, the configured table names. |
| Appendix: configuration keys | Every property of every system template, secrets masked. |
| Appendix: API reference | The API document of the instance, operation by operation. |
Passwords, tokens, client secrets, API keys, URLs of connectors and instance keys appear as ••••••. The report can be handed to a third party without editing; check only that the business content (customer e-mails in notification rules, user names) may be shared.
PDF layout
The PDF follows the document conventions of the product: a cover with the environment, date, author and version; a clickable table of contents and a PDF outline; a running header and a page x / y footer; reading notes in shaded boxes; path variables (APP_HOME, ENV, PROCESS_HOME, TEMPLATE, FILE_NAME) shown as chips inside paths; see § 5.10 links between a document and its UBL sheet. The Markdown file carries the same content for a wiki or a Git repository.
Command line
The same report is available without the interface, for a scheduled snapshot or a pipeline:
java -jar nomaubl.jar -report <configFile> [--lang fr|en] [--format md|pdf] [--out <file>] \
[--date <label>] [--keys] [--sections context,architecture,...]
Defaults: the first nine sections, Markdown, French. See Command line.
Access
The tab belongs to the Reports page: grant Reports in the Navigation group on the Roles page. The API route is GET /api/reports/implementation.
Tips & best practices
- Generate it after each go-live and each upgrade. The copy kept in the
reportsfolder becomes the dated history of the configuration, next to File versions. - Keep the technical keys off for a business reader. Labels are enough for a project team; turn the keys on for the people who edit configuration files or read the API.
- Add the appendices for an audit file only. The configuration-keys and API appendices make the PDF several times longer.