Write-EdiGroupSyntaxReport

EulandaXtools — Funktionsreferenz

Write-EdiGroupSyntaxReport

ÜBERSICHT

Erzeugt einen Validierungsbericht für eine EDIFACT-Nachricht basierend auf einer Segmentgruppen-Syntax.

SYNTAX

Write-EdiGroupSyntaxReport [[-SyntaxFile] <string>] [[-MessageFile] <string>] [[-MessageLines]
    <string[]>] [[-OutputFile] <string>] [-Show] [<CommonParameters>]

BESCHREIBUNG

Die Funktion 'Write-EdiGroupSyntaxReport' prüft eine EDIFACT-Nachricht, z.B. `ORDERS`, anhand einer offiziellen oder abgeleiteten Syntaxdefinition `.syntax` und erstellt daraus einen Validierungsbericht im HTML- oder PDF-Format. Alternativ kann die Ausgabe auch direkt als formatiertes Text-Tableau auf der Konsole angezeigt werden.

Die Funktion verarbeitet optional direkt EDIFACT-Dateien wie z.B. mit Segmenttrenner `'`, normalisiert Zeilenumbrüche, liest und dekodiert die UNH-Zeile zur Ermittlung von Nachrichtentyp und Syntaxversion und erzeugt eine HTML-Tabelle mit Fehlerstatus, Segmentpfad und Rohdaten.

PARAMETER

-SyntaxFile

Type: string

Pfad zur Datei mit Segmentgruppen-Syntaxinformationen im `.syntax`-Format.

-MessageFile

Type: string

Pfad zur EDIFACT-Nachricht, die geprüft werden soll, beispielsweise `ORDERS.edi`. Wird `-MessageLines` angegeben, ist dieser Parameter optional.

-MessageLines

Type: string[]

Optional: Array der bereits gesplitteten Segmente der Nachricht. Wenn nicht angegeben, wird automatisch aus `-MessageFile` gelesen und dekodiert.

-OutputFile

Type: string

Optionaler Pfad für den Bericht. Endung `.html` oder `.pdf` bestimmt das Ausgabeformat. Wird dieser nicht angegeben, so erfolgt eine reine Konsolenausgabe im Tabellenformat.

-Show

Type: switch

Zeigt den erzeugten Bericht direkt im zugehörigen Viewer beispielsweise dem Standard-PDF-Viewer oder dem Browser.

AUSGABEN

String, void

Wenn kein OutputFile angegeben ist, wird der Bericht als String ausgegeben.

BEISPIELE

Write-EdiGroupSyntaxReport -SyntaxFile `.\ORDERS.syntax` -MessageFile `.\order.edi`
Write-EdiGroupSyntaxReport -SyntaxFile `.\ORDERS.syntax` -MessageFile `.\order.edi` -OutputFile `.\report.pdf` -Show
$MessageLines = Get-EdiMessageLines -Path `.\order.edi`
Write-EdiGroupSyntaxReport -SyntaxFile `.\ORDERS.syntax` -MessageLines $MessageLines -OutputFile `.\report.html`

HINWEISE

Die Funktion verwendet intern: