Skip to main content

Global

The Global settings hold what applies to the whole NomaUBL application: file system layout and environment, processing options, the server log, PDF rendering, the email server, the AI assistant, the defaults shared by the scheduled jobs, the license and the authentication. They apply whatever the source system — JD Edwards, SAP, NetSuite or a custom ERP; the few BIP-specific settings are flagged where they appear.

The editor has nine tabs: Directories, Processing, Logs, PDF, Email, AI, Job defaults, License, Authentication. In the Settings navigation each tab is an entry of its own — Directories & environment, Processing, Server log, PDF rendering, Email, AI assistant and License in Platform, Authentication in Security, Job defaults in Jobs & inbound — and opens that part only, without the row of tabs. The search box of Settings finds any field of these tabs by its label, hint or key.

The jobs themselves — polls, batch document jobs, daily digests, auto-retries, lifecycle checks, retention purge — are not set here: they are on the Scheduled jobs page.


At a glance​

Server logglobal💾 SaveDirectoriesProcessingLogsPDFEmailAIJob defaultsLicenseAuthenticationSERVER LOGServer log fileauto (stdout of the server)Log size cap (MB)100Log files kept5Log repeat window (s)600Log levelsSTATUS=WARN, API=INFO, ·=INFONine tabsone per area of the instanceServer log fileread by Diagnostics → Server logRepeat windowidentical lines counted, not writtenBuilt-in rotationcopy to .1 and truncate, 5 keptLevels per moduleMODULE=LEVEL, · = all othersSavewrites the global template

Tab 1 — Directories​

Home Directories​

FieldDescription
Application HomeRoot install directory of NomaUBL (e.g. /app/nomaubl). Resolved by the %APP_HOME% placeholder used in document paths.
Demo instanceN (default) / Y. Marks the instance as a demonstration instance: only then can it be filled with fictitious invoices — see Demo corpus. Never on a customer instance.
EnvironmentShort environment name (e.g. demo, PD). Resolves the %ENV% placeholder used in document paths (rtf, xsl, ublXslt) so the same template can target multiple environments. The name is also shown as a badge right of the application title and in the browser tab.
Theme colourColour picker, next to the environment. Replaces the accent blue of the whole interface — title, environment badge, primary buttons, links, focus rings — so each environment is told apart at a glance. Badge and colour are served by a public endpoint, so the login page already carries them. Blank keeps the default blue.
Process HomeWorking directory used by NomaUBL during processing (e.g. /app/nomaubl/process).

The path fields — Process Home, the directories below and the Server log file of the Logs tab — carry the insert placeholder button { }: it lists %APP_HOME%, %ENV% and %PROCESS_HOME% and inserts the one picked at the cursor.

When Demo instance is Y, the tab also shows a Demo corpus block that fills or resets the demonstration data as a background job — see Demo corpus.

File Paths​

FieldDescription
Input DirectoryWhere new documents to process are dropped (XML spools, attachments…).
Process DirectoryWhere in-flight files live during processing.
Temp DirectoryScratch space for temporary artefacts.
Single Output DirOutput directory for documents processed in single mode.
Bursting DirectoryOutput directory for documents produced by bursting mode (one file per invoice).
Errors DirectoryWhere a file that fails processing is moved. During a directory run, moving the failed file aside stops a repeated scan from retrying the same file endlessly. Leave it blank to keep the file in place (the previous behaviour).

Tab 2 — Processing​

XSL Paths​

FieldDescription
XDO ConfigPath to the BI Publisher xdo.cfg configuration file used during PDF generation.

Options​

FieldValuesDescription
Update DBY / NWhen Y, processing runs persist their results to the database. Set to N only for dry runs / debugging.
Max threads(blank = all cores)Caps how many invoices are processed at once. An XML-spool template can process its whole input folder in a single parallel pass — much faster on a folder of thousands of single-invoice files, and used the same way by a scheduled scan, an on-demand run and the command-line batch. Each file stays its own unit (name, source archive and traceability kept) and one file's failure doesn't stop the others. Set a value to keep headroom for other services on a shared host; leave it blank to use every available core. UBL templates and per-job (BIP) processing are unaffected. It also bounds the bulk reprocess, which runs one batch per template.
debugProfileY / NWhen Y, every processing run writes per-step timing rows to F564237 covering each pipeline stage: header parsing, lines parsing, validation, UBL emit, PA send. The rows surface on the Tech Dashboard — the Live process events tail flags them with their step name, and the Template processing time widget breaks the average down by stage. Leave at N in production; flip to Y for the duration of a batch run when triaging a slow pipeline. Disable once the slow stage is identified — the extra rows inflate F564237 quickly under load.
Advanced

The Ghostscript group is folded under Advanced at the bottom of the tab.

Ghostscript​

FieldDescription
GS CommandFull Ghostscript command line used for PDF post-processing (e.g. gs -dBATCH ...). Multi-line values are accepted.

Tab 3 — Logs​

Server log​

FieldDefaultDescription
Server log file(blank = automatic)File read by the Server log view. Blank = the file the launcher redirects the server output to (nomaubl-<env>.log); set it when the server runs under another launcher.
Log size cap (MB)100Above this size the live log is copied to .1 and truncated in place, the older copies being shifted. The launcher keeps writing to the same file. 0 = never rotate.
Log files kept5Rotated copies kept next to the log.
Log repeat window (s)600A WARN or ERROR line identical to one written within this window is counted, not written; one summary line follows with the count. 0 = off.
Log levels(blank = everything)Minimum level per module — DEBUG, INFO, WARN, ERROR — as MODULE=LEVEL pairs separated by commas; * stands for all other modules (e.g. STATUS=WARN, API=INFO, *=INFO).

The rotation, the repeat suppression and the levels apply in server mode only; a command-line run writes to its own output. For a PA code missing from the status catalogue or an invoice unknown to NomaUBL, the status poll writes no warning per event: the run ends with one line per code, with its count and a sample invoice, and the unmapped codes are listed by the configuration check of the Tech dashboard.


Tab 4 — PDF​

PDF​

FieldDescription
Logo pathPath to the company logo drawn at the top of the supplier block when a PDF template has Show logo on (see PDF Templates). Accepts the path variables %APP_HOME%, %ENV%, %PROCESS_HOME%, %KCO%, %DOC%, %DCT% and any {{token}} from the invoice catalogue — e.g. %APP_HOME%/logos/{{kco}}.png, so each company resolves to its own logo. A { } button opens a searchable token list. PNG, JPG and GIF are supported.
Logo offset X (pt)Horizontal shift of the logo, in points, to absorb whitespace baked into the source image. Default 0.
Logo width (pt) / Logo height (pt)Box the logo is scaled to fit, in points: ratio kept, enlarged when the image is smaller; one dimension alone lets the other follow the image. Blank = the previous cap of 200 × 80 points, without enlarging. The visual builder preview uses the same size as the produced PDF.

Tab 5 — Email​

Configures the outbound mail server NomaUBL uses to send notifications and document deliveries by email.

SMTP Server​

FieldDescription
HostSMTP host (e.g. smtp.example.com).
PortSMTP port (typically 587 for STARTTLS, 465 for implicit SSL, 25 plain).
TLS (STARTTLS)Y / N — upgrade the connection to TLS via STARTTLS.
SSLY / N — open the connection in implicit SSL mode (rare in modern SMTP, mutually exclusive with STARTTLS).

SMTP Credentials​

FieldDescription
UsernameSMTP authentication user.
PasswordSMTP authentication password.

Sender​

FieldDescription
From addressDefault From: address on outbound mail (e.g. facturation@example.com).

Tab 6 — AI​

Settings of the in-app AI assistant.

Anthropic AI​

FieldDescription
API KeyAnthropic API key. Without a valid key, the assistant panel is disabled.
ModelModel used unless the panel picks another one. Default Sonnet 5.5; Opus, Fable and Haiku are also offered.
Max output tokensLength cap of one answer, from 1024 to 32000 (default 8192).

Documentation​

FieldDescription
Sourcellms (default): the documentation file is downloaded and searched on this server. sitemap: the model fetches the pages itself (previous behaviour).
llms-full.txt URLEnglish pages (default https://docs.nomana-it.fr/llms-full.txt). Refreshed every 6 hours; a URL, a local path or a file: URL. If it cannot be reached at start, the copy bundled in the application is used.
llms-full.fr.txt URLFrench pages, used when the interface is in French (default https://docs.nomana-it.fr/llms-full.fr.txt, also used when the field is blank). When the French file cannot be loaded, the assistant falls back to the English pages.
SectionPart of the file to index (its # === … === header, e.g. NomaUBL). Blank = the whole file.

Playbooks​

FieldDescription
Custom playbooksDiagnostic procedures the assistant loads on demand, one per ## name heading. A built-in name — refused-invoice, missing-invoice, ereporting-error, status-not-updated — replaces the built-in procedure.

Assistant behaviour​

FieldDescription
System PromptOptional prompt prepended to every chat. Empty = the built-in NomaUBL prompt.
Allowed Doc Domains / Docs Sitemap URL / Docs Path PrefixSitemap mode only: domains the model may fetch, sitemap address (cached 6 hours), prefix of the entries kept.
Custom ToolsRead-only tools on this instance's data offered to the model (invoices, errors, history, dashboards, server log, settings with secrets masked).

The TLS / corporate proxy group (custom truststore path and password, Disable TLS validation for a short diagnosis only) is folded under Advanced.


Tab 7 — Job defaults​

Settings shared by the background jobs. The jobs themselves — intervals, daily times, batch document jobs, digests, auto-retries and lifecycle checks — are managed on Synchronization → Scheduled jobs; saving there reloads the schedules at once.

Quiet window​

FieldDescription
Quiet window from / to (HH:mm)A daily window during which both PA pollers (import poll and status retrieval) skip their runs automatically — set it over a send campaign so per-invoice import polls don't pile up while the PA is integrating the batch. May cross midnight; leave both empty to disable. It applies without a restart and shows on the Tech Dashboard's Scheduler card, highlighted while active.

Bulk Send​

Defaults for every bulk send to the PA — Send all waiting and Resend all on the Tech Dashboard, the invoice-list bulk resend, and the -send-waiting CLI. Each nightly Auto-Retry routine can override them on its own row.

FieldDescription
Parallel workers(default 4) How many invoices are sent to the PA at the same time. Set 1 for sequential sending.
Delay per worker (ms)(default 100) Pause each worker waits between two calls, to stay inside the PA's rate budget.

Retention​

Database rows kept per store by the daily Retention purge job. Off by default: nothing is deleted until a number of days is set, except the notifications, which keep their 90 days, so an upgrade deletes nothing by itself. The server log file is bounded separately (Tab 3).

FieldDefaultDescription
Processing log (days)0Per-file START / END / error rows of the runtime log (F564237). Empty or 0 = keep forever; suggested 180.
Step timings (days)0Per-step timing rows written by debugProfile (F564237). Suggested 30.
Job runs (days)0Run rows of the scheduled jobs (F564237). Suggested 90.
Validation errors of finished invoices (days)0Errors (F564236) of invoices in a terminal status (completed, deposited, refused…). Suggested 365.
Notifications (days)90Inbox notifications (F564253). Empty = 90 days; 0 = keep forever.

Before setting a value, the Count only button of the Retention purge job (or java -jar nomaubl.jar -purge <configFile> --dry-run) reports what each store would lose with the saved values.

BIP print queue​

FieldDescription
BIP job hostsOne high-water mark per JDE execution host (RJRPDEXHST). The mark tracks each host by job completion time, not by job number — a job number is assigned at submission, so a long-running job that finishes after a shorter, higher-numbered one could otherwise fall below the mark and never be fetched. The completion date is shown next to the job number for each host, and is editable. Add each host with its starting number (the first batch after an upgrade fills the date automatically), or click Retrieve last job # per host to seed them all from the current maximum; from then on they advance after each job, so an interrupted batch resumes exactly where it stopped. Only listed hosts are scanned. (BIP / JDE-specific.)
BIP Lookback (days)Date floor on the BIP scan. 0 = no floor — every job after the watermark is eligible. N > 0 = only jobs updated in the last N days. Handy on a first install or after a long gap, to skip years of history rather than walking the whole queue. Applies to the manual scan, the scheduled batch and the nomaubl -fetch-all command. (BIP / JDE-specific.)

Tab 8 — License​

License​

FieldDescription
License KeyFull NomaUBL license key. Without a valid key, the Navigation, Synchronisation and UBL menus are disabled — only Configuration remains accessible.

Tab 9 — Authentication​

Authentication​

FieldDescription
Enable AuthenticationY / N — turn on password-based user login. When N, NomaUBL runs without a login wall (typically dev / on-prem behind a corporate VPN).
Auth Modeinternal / oidc / both — drives the login screen. internal (default) keeps the local username + password form. oidc switches to a single-sign-on button only. both shows the SSO button above the local form, so operators with a database account can still sign in if the IdP is unavailable. Pair with the OIDC template to configure the SSO side.
Session Timeout (minutes)How long an authenticated user session remains valid. Default 480 (8 hours).
Self-service password reset

With Auth Mode = internal (or both), the login screen exposes a Forgot password? link. The user is prompted for both username and email; if they match an active account, a one-shot link valid 60 minutes is sent to the email on file. The link lands on a dedicated page that lets the user choose a new password.

Requires SMTP configured under Tab 5 — Email. Tokens are persisted in F564255 (see Database tables) and expire after a single use.


Tips & best practices​

  • Set Environment and Theme colour. The %ENV% placeholder lets one configuration roll forward from demo to PD without editing every path, and a distinct colour per environment avoids working on production by mistake.
  • Bound the server log before going live. The defaults (100 MB, 5 copies) suit most servers; add STATUS=WARN to the levels when the status poll is verbose.
  • Turn the retention on once the volumes are known. Start with the suggested values, run Count only, then enable the purge job.
  • License gates the runtime. If the Navigation, Synchronization and UBL menus disappear, check the License Key first.
  • Point the assistant at the French pages for French-speaking users: fill llms-full.fr.txt URL.