CreateValidationReport

Efterlevnad

Beskrivning

Bygger en strukturerad valideringsrapport för PDF/A och PDF/UA-1 i XML eller JSON, med ISO-klausul och statistik kopplade till varje fynd

Syntax

Delphi

Function TPDFlib.CreateValidationReport(Const InputFileName, Password: WideString; ComplianceTests, Options, ReportFormat: Integer): WideString;

Parametrar

InputFileNamePDF-filen som ska valideras
PasswordLösenordet som krävs för att öppna filen, eller en tom sträng
ComplianceTestsBitmask som väljer kontroller: 1 = PDF/A, 2 = PDF/UA-1, 0 = båda
OptionsSkickas vidare till kontrollerna; 1 stoppar vid det första fyndet i varje kontroll
ReportFormat0 = XML, 1 = JSON

Returvärden

Empty stringIndatafilen finns inte
ReportDen kompletta rapporten

Anmärkningar

När flera standarder valts parsas filen en gång och båda granskningarna delar samma läsare, säkerhetstillstånd, objektgraf och lata objektcache

Varje fynd bär regel-id, den standard som äger regeln (ISO 19005-1 eller ISO 14289-1), ett kort maskinläsbart regelnamn, den ISO-klausul regeln drivr, en allvarlighetsgrad och antalet berörda objekt. Varje kontrollelement avslutas med sitt eget resultat och sitt antal problem, och rapporten slutar med en sammanfattning som bär dokumentets omdöme, det totala antalet problem och antalet godkända och underkända kontroller

En standard som inte efterfrågades rapporteras som not-checked och inte som en godkänd kontroll, så en körning som bara täckte en standard kan inte tas för ett rent blad

Det skiljer sig från CreatePreflightReportEx, som först renderar en läsbar rapport och därefter omvandlar den texten till JSON, HTML eller CSV. Valideringsrapporten byggs från kontrollernas råutdata, så en byggpipeline kan stänga på ett regel-id eller en ISO-klausul i stället för att leta efter delfraser i en mening

Exempel

Report:= PDF.CreateValidationReport('invoice.pdf', '', 0, 0, 1);
if Pos('"result": "failed"', Report)> 0 then
  ShowMessage('the file did not pass validation');

Se även

CreateValidationPipelineReport, SaveValidationReport, CheckFileCompliance, CreatePreflightReport, CreatePreflightReportEx