Format-PortInvoiceValidation #
ÜBERSICHT #
Bereitet das Ergebnis von ‘Invoke-PortInvoiceValidation’ lesbar auf.
SYNTAX #
Format-PortInvoiceValidation [-Result] <PSCustomObject> [[-FileName] <string>] [-IncludeWarnings]
[[-MaxMessages] <int>] [<CommonParameters>]
BESCHREIBUNG #
‘Invoke-PortInvoiceValidation’ liefert ein Objekt, das sich gut weiterverarbeiten lässt, aber am Bildschirm unübersichtlich ist. Diese Funktion erzeugt daraus einen kurzen Bericht als Zeilen.
Die Darstellung ist bewusst knapp und zeigt Details nur dort, wo etwas schiefgegangen ist:
- Die Vorprüfung erscheint nur mit den Punkten, die nicht bestanden wurden. Bei einer sauberen Rechnung entfällt der Abschnitt.
- Fehler werden immer gezeigt, Warnungen nur mit ‘-IncludeWarnings’.
- Sehr lange Meldungslisten werden gekürzt, siehe ‘-MaxMessages’.
Die Funktion schreibt nichts in die Konsole, sondern gibt Zeichenfolgen zurück. Damit lässt sich derselbe Bericht anzeigen, protokollieren oder in eine Mail übernehmen.
PARAMETER #
-Result #
Type: PSCustomObject
Ergebnisobjekt aus ‘Invoke-PortInvoiceValidation’. Kann über die Pipeline kommen.
-FileName #
Type: string
Optionale Bezeichnung der geprüften Datei für die Kopfzeile. Fehlt sie, wird der Dateiname aus dem Ergebnis verwendet, falls die API ihn geliefert hat.
-IncludeWarnings #
Type: switch
Nimmt auch Warnungen und Hinweise in den Bericht auf.
-MaxMessages #
Type: int
Default: 20
Höchstzahl der Meldungen je Abschnitt. Standard ist 20. Wird gekürzt, weist eine Zeile auf die Zahl der ausgelassenen Meldungen hin, damit kein stillschweigend gekürzter Bericht entsteht.
AUSGABEN #
string[]
BEISPIELE #
# Kurzbericht am Bildschirm
$r = Invoke-PortInvoiceValidation -FilePath 'rechnung.xml'
Format-PortInvoiceValidation -Result $r
# Über die Pipeline, mit Warnungen
Invoke-PortInvoiceValidation -FilePath 'zugferd.pdf' |
Format-PortInvoiceValidation -IncludeWarnings
# In eine Protokolldatei schreiben
Invoke-PortInvoiceValidation -FilePath 'rechnung.xml' |
Format-PortInvoiceValidation | Out-TextFile -Path 'pruefung.txt' -Encoding UTF8
VERWANDTE LINKS #
HINWEISE #
- Gegenstück zu ‘Invoke-PortInvoiceValidation’. Die Bewertung der API ist in ‘Specification’ und ‘Recommendation’ beschrieben, die Vorprüfung in ‘PreValidation’.
- Welche Werte dort vorkommen und was sie bedeuten, steht in der öffentlichen Spezifikation der API, siehe .LINK.