Artykuł techniczny

HotPDF Component: automated PDF preflight reports in Delphi

HotPDF to natywna biblioteka PDF VCL dla aplikacji Delphi i C++Builder, które potrzebują bezpośredniego tworzenia i edycji PDF, formularzy, adnotacji, szyfrowania, podpisów cyfrowych, czcionek Unicode, wyjścia zgodnego ze standardami i raportów preflight bez instalowania zewnętrznego runtime PDF.

Ten artykuł jest przeznaczony dla teams that need repeatable PDF intake, release gates, or customer-support diagnostics. Traktuje automated PDF preflight reports jako produkcyjną inżynierię dokumentów, a nie pojedyncze wywołanie komponentu.

Praktyczne ryzyko polega na tym, że manual visual checks are inconsistent and do not create machine-readable evidence for operators, CI jobs, or support engineers. Dlatego przepływ wymaga spisanego kontraktu, obserwowalnej diagnostyki i realistycznych plików regresyjnych.

Decyzje architektoniczne

Turn preflight into a policy service. profiles for intake, release, archive, print, and accessibility checks / severity thresholds, waiver rules, and customer-specific exceptions

  • profiles for intake, release, archive, print, and accessibility checks
  • severity thresholds, waiver rules, and customer-specific exceptions
  • report formats for humans, CI logs, dashboards, and support bundles
  • time limits, maximum file size, and quarantine behavior for damaged input

Przebieg implementacji

Classify findings before deciding pass or fail. Poniższa kolejność zachowuje czytelność przepływu pracy dla zespołów Delphi i C++Builder.

  1. identify the business purpose before selecting the preflight profile
  2. run validation in an isolated step before editing or distributing the document
  3. normalize findings into stable codes, severities, locations, and remediation hints
  4. apply waiver policy after findings are classified, not before validation
  5. store the report beside the output or ticket that depends on it

Dowody walidacji

Report fields that make findings actionable. Zachowaj te pola wraz z wynikiem lub rekordem wsparcia.

  • profile version, input hash, validator version, elapsed time, and pass or fail result
  • finding code, severity, page, object reference, and operator-facing message
  • waiver identifier, reviewer, expiry, and affected issue codes
  • machine-readable summary for CI plus an HTML or text report for support

A report is only useful when it drives a decision

Preflight automation should map low-level PDF findings to product decisions. Operators need to know what failed, why it matters, whether retry is useful, and where the affected page or object can be inspected.

Decision table for automated PDF preflight reports

A decision table keeps product ownership visible when the same workflow is reused by a desktop tool, service job, and support utility.

DecisionEngineering reasonEvidence
profiles for intake, release, archive, print, and accessibility checksidentify the business purpose before selecting the preflight profileprofile version, input hash, validator version, elapsed time, and pass or fail result
severity thresholds, waiver rules, and customer-specific exceptionsrun validation in an isolated step before editing or distributing the documentfinding code, severity, page, object reference, and operator-facing message
report formats for humans, CI logs, dashboards, and support bundlesnormalize findings into stable codes, severities, locations, and remediation hintswaiver identifier, reviewer, expiry, and affected issue codes

Notatki przeglądu inżynierskiego dla automated PDF preflight reports

Użyj tych notatek przeglądu, aby upewnić się, że funkcja wyszła poza demonstrację i da się ją obronić podczas wydania, wsparcia i eskalacji klienta.

  • Decyzja: profiles for intake, release, archive, print, and accessibility checks. Punkt nacisku implementacji: run validation in an isolated step before editing or distributing the document. Dowody akceptacji: waiver identifier, reviewer, expiry, and affected issue codes. Wyzwalacz regresji: support staff need stable issue codes rather than parser exception text
  • Decyzja: severity thresholds, waiver rules, and customer-specific exceptions. Punkt nacisku implementacji: normalize findings into stable codes, severities, locations, and remediation hints. Dowody akceptacji: machine-readable summary for CI plus an HTML or text report for support. Wyzwalacz regresji: warnings can become release blockers when the target channel changes
  • Decyzja: report formats for humans, CI logs, dashboards, and support bundles. Punkt nacisku implementacji: apply waiver policy after findings are classified, not before validation. Dowody akceptacji: profile version, input hash, validator version, elapsed time, and pass or fail result. Wyzwalacz regresji: batch preflight should limit memory and CPU per file to protect queues

Przypadki brzegowe

  • warnings can become release blockers when the target channel changes
  • batch preflight should limit memory and CPU per file to protect queues
  • repairing input before preflight can hide the original customer issue
  • support staff need stable issue codes rather than parser exception text

Delphi / C++Builder notes

HotPDF Component should sit behind a small service boundary that receives files, streams, profiles, and credentials, then returns output paths, warnings, metrics, and validation status. Important terms include preflight, validation profile, report automation, severity, waiver, CI gate.

Przykład kodu Delphi

Poniższy szkic Delphi pokazuje praktyczną granicę usługi dla tego tematu. Kontrole zasad, logowanie i walidację trzymaj poza wąskim blokiem wywołań produktu, aby przepływ pozostał testowalny.

procedure RunPreflightBatch(const InputFile, ReportFile: string);
var
  Pdf: THotPDF;
  Profile: THPDFPreflightProfile;
  Report: string;
begin
  Pdf := THotPDF.Create(nil);
  try
    Profile := Pdf.GetBuiltInPreflightProfile('strict');
    Report := Pdf.CreatePreflightReportWithProfile(InputFile, Profile);
    TFile.WriteAllText(ReportFile, Report, TEncoding.UTF8);
    RaiseIfBlockingFindings(Report);
  finally
    Pdf.Free;
  end;
end;

Lista produkcyjna

  • Uruchom przepływ pracy na pustym pliku, zwykłym pliku klienta i pliku z najgorszego scenariusza
  • Otwórz wygenerowany plik PDF w docelowej przeglądarce, walidatorze, drukarce lub aplikacji nadrzędnej
  • Zaloguj wersję produktu, wersję profilu, hash wejścia, ścieżkę wyjścia, czas wykonania i liczbę ostrzeżeń
  • Przechowuj hasła, certyfikaty, pliki tymczasowe i dane klienta zgodnie z jednoznacznymi zasadami retencji
  • Dodaj dokument regresyjny, gdy plik klienta ujawni nowy przypadek brzegowy

Dokumentacja produktu

HotPDF Component

Dodatkowe przykłady kodu

function TriagePdf(Pdf: THotPDF; const FileName: string): Boolean;
var
  Handle, Pages: Integer;
begin
  Result := False;
  Handle := Pdf.DAOpenFileReadOnly(FileName, '');
  if Handle <= 0 then
    Exit;  // structurally unreadable: quarantine, do not validate
  try
    Pages := Pdf.DAGetPageCount(Handle);
    Result := Pages > 0;
  finally
    Pdf.DACloseFile(Handle);
  end;
end;
function RunVeraPdf(const PdfFile, ReportFile: string): Cardinal;
var
  Cmd: string;
  SI: TStartupInfo;
  PI: TProcessInformation;
begin
  Cmd := Format('cmd /c verapdf.bat --format xml "%s" > "%s"',
    [PdfFile, ReportFile]);
  FillChar(SI, SizeOf(SI), 0);
  SI.cb := SizeOf(SI);
  if not CreateProcess(nil, PChar(Cmd), nil, nil, False,
      CREATE_NO_WINDOW, nil, nil, SI, PI) then
    RaiseLastOSError;
  try
    WaitForSingleObject(PI.hProcess, 120000);  // bound the wait per file
    GetExitCodeProcess(PI.hProcess, Result);
  finally
    CloseHandle(PI.hThread);
    CloseHandle(PI.hProcess);
  end;
end;