Zum Hauptinhalt springen

Konfigurations-Priorität

Die CLI löst Konfiguration aus Kommandozeilenoptionen, YAML, Umgebungsvariablen und Defaults auf. Kommandozeilenwerte haben Priorität vor Werten aus der Mapping-Datei.

Die wichtige Regel lautet: Der am weitesten links konfigurierte Wert gewinnt. Umgebungsvariablen werden nur für Authentifizierung und API-Zieleinstellungen unterstützt.

Allgemeine Regel​

Für die meisten Check-, CSV-, Output-, PDF-, Filter- und Folder-Einstellungen:

  1. Kommandozeilenoption
  2. YAML-Mapping-Datei
  3. Eingebauter Default

Kurz gesagt:

CLI flag -> YAML (--map) -> Default

Beispiele:

  • --col-vat-id überschreibt columns.vatId.
  • --in-encoding überschreibt input.encoding.
  • --pdf aktiviert PDF, auch wenn defaults.pdf false ist.
  • --no-pdf deaktiviert PDF, auch wenn defaults.pdf true ist.
  • --no-sign deaktiviert Signierung, auch wenn defaults.sign true ist.

Empfohlene Nutzung​

Legen Sie feste Einstellungen in der YAML-Mapping-Datei ab:

  • CSV-Trennzeichen und Encoding.
  • Spaltenmapping.
  • Auswahl der Ausgabespalten.
  • PDF-Defaults.
  • Folder-Mode-Einstellungen wie Muster, Mindestalter der Datei und Duplicate Mode.

Verwenden Sie Kommandozeilenflags für einmalige Änderungen:

  • --env test
  • --base-url
  • --out
  • --dry-run
  • --force-new
  • -v oder --verbose

So bleiben automatisierte Jobs wiederholbar, während Sie Verhalten für einen bestimmten Lauf überschreiben können.

Authentifizierung​

Token-Auflösung:

  1. --token
  2. OPTIMUS_TOKEN
  3. leerer Wert

Echte API-Läufe schlagen fehl, wenn das finale Token leer ist. Dry Runs benötigen kein Token.

API-Ziel​

API-Ziel-Auflösung:

  1. --base-url
  2. OPTIMUS_BASE_URL
  3. --env
  4. OPTIMUS_ENV
  5. Produktions-URL

--env und OPTIMUS_ENV unterstützen:

  • test
  • prod

Für API-Zieleinstellungen ist die effektive Priorität:

CLI flag -> Environment variable -> Default

YAML definiert derzeit keine Token-, Umgebungs- oder Base-URL-Werte.

Prüftyp​

Prüftyp-Auflösung:

  1. --standard
  2. --qualified
  3. defaults.checkType

Der finale Wert muss Standard oder Qualified sein. Die CLI akzeptiert kleingeschriebene YAML-Werte wie standard und qualified.

Retry Duration​

Retry-Duration-Auflösung:

  1. --retry-duration
  2. defaults.retryDuration
  3. None

Akzeptierte Werte sind:

  • None
  • OneHour
  • TwoHours
  • FourHours
  • EightHours
  • TwentyFourHours

Die CLI normalisiert auch Kurzformen wie 1h, 2h, 4h, 8h und 24h.

Ausgabespalten​

Ausgabespalten-Auflösung:

  1. --out-columns
  2. output.columns
  3. Standard-Ausgabespalten

Unbekannte Ausgabespalten verursachen einen Konfigurationsfehler, sofern die Spalte nicht unter customColumns definiert ist.