Artículo técnico

¿Qué partes de PDF/A necesitan un XMP extension schema?

Un número de factura de ERP añadido al XMP de un archivo PDF/A-2b se lleva un hallazgo de propiedad no declarada, y en cambio el mismo paquete en un archivo PDF/A-4 conforma. Las partes 1 a 3 exigen una descripción pdfaExtension:schemas para toda propiedad personalizada y la parte 4 no, así que el validador PDF/A de PDFium Component para Delphi lee pdfaid:part antes de elegir un juego de reglas

Flujo de decisión de PDFium Component para Delphi leyendo pdfaid:part para elegir comprobaciones de extension schema bajo las partes 1 a 3 de PDF/A y reglas a nivel de paquete bajo PDF/A-4
el validador lee primero pdfaid:part, así que un paquete que reclama la parte 4 se salta los cuatro hallazgos de extension schema que las partes 1 a 3 levantan en PDFium Component para Delphi

¿Qué exigen las partes 1 a 3 de PDF/A a una propiedad personalizada?

Una descripción de su espacio de nombres, más una línea en esa descripción que nombre la propiedad. El ISO 19005-1 §6.7.2 permite propiedades XMP solo de los esquemas predefinidos o de extension schemas que cumplan el §6.7.8, que quiere cada descripción en el mismo flujo de metadatos; el ISO 19005-2 §6.6.2.3.1 arrastra la regla a las partes 2 y 3. Una descripción no es un permiso en blanco. Nombra propiedades una por una vía pdfaProperty:name, así que un paquete que describe inv:InvoiceNumber y además escribe inv:DueDate falla en la segunda. PDFium Component informa estos casos bajo cuatro valores de TPdfAValidationIssue, un hallazgo por fallo: un prefijo renombrado, por ejemplo, produce solo el hallazgo de prefijo

Valor de issueSe informa cuandoCláusula
pvaiMissingExtensionSchemaHay un espacio de nombres no predefinido en uso y el paquete no tiene contenedor pdfaExtension:schemas19005-1 §6.7.8, 19005-2 §6.6.2.3.1
pvaiXmpPropertyUndeclaredEl contenedor existe pero ninguna descripción en él nombra la propiedad19005-1 §6.7.2, 19005-2 §6.6.2.3.1
pvaiExtensionSchemaPrefixUn espacio de nombres de descripción está ligado a un prefijo distinto del requerido19005-1 §6.7.8, 19005-2 §6.6.2.3.2
pvaiExtensionSchemaEntryMissingUna descripción omite un campo que su tabla lista19005-1 §6.7.8, 19005-2 §6.6.2.3.3

Cuál de los dos primeros recibas depende del productor. Muchos writers de PDF/A ya describen el esquema de identificación pdfaid en un contenedor, SaveAsPdfA de PDFium Component incluido, así que un campo añadido después aterriza junto a un contenedor que no tiene entrada para él. La rutina de abajo imprime solo los hallazgos de extension schema. Esperado: un archivo PDF/A-2b escrito por SaveAsPdfA imprime pac2b y pvaiXmpPropertyUndeclared, un paquete de parte 1 o 2 sin contenedor imprime pvaiMissingExtensionSchema, y un archivo PDF/A-4 imprime solo su línea de conformidad

uses
  System.SysUtils, System.Classes, System.TypInfo,
  PDFium, FPdfPdfa, FPdfXmp;

const
  InvoiceNs = 'http://ns.example.com/invoice/1.0/';
  ExtensionIssues: TPdfAValidationIssues = [pvaiMissingExtensionSchema,
    pvaiXmpPropertyUndeclared, pvaiExtensionSchemaPrefix,
    pvaiExtensionSchemaEntryMissing];

procedure PrintExtensionIssues(Source: TStream);
var
  Res: TPdfAValidationResult;
  Issue: TPdfAValidationIssue;
begin
  Res := ValidatePdfAComplianceEx(Source, TPdfAValidationOptions.Default);
  Writeln(GetEnumName(TypeInfo(TPdfAConformance), Ord(Res.Conformance)));
  for Issue in Res.Issues * ExtensionIssues do
    Writeln('  ', GetEnumName(TypeInfo(TPdfAValidationIssue), Ord(Issue)));
end;

procedure ProbeCustomProperty(const FileName: string);
var
  Pdf: TPdf;
  Packet: TPdfXmpPacket;
  Output: TMemoryStream;
begin
  Output := TMemoryStream.Create;
  try
    Pdf := TPdf.Create(nil);
    try
      Pdf.FileName := FileName;
      Pdf.Active := True;
      Packet := Pdf.ReadXmpPacket;
      if Packet = nil then
        raise Exception.CreateFmt('%s has no XMP packet', [FileName]);
      try
        Packet.SetSimpleValue(InvoiceNs, 'inv', 'InvoiceNumber', 'INV-2026-0412');
        if not Pdf.SaveAsWithXmpPacket(Output, Packet) then
          raise Exception.Create('Saving the edited packet failed');
      finally
        Packet.Free;
      end;
    finally
      Pdf.Free;
    end;
    Output.Position := 0;
    PrintExtensionIssues(Output);
  finally
    Output.Free;
  end;
end;

El conjunto predefinido se movió entre XMP 2004 e ISO 16684-1

La parte 1 y la parte 2 discrepan sobre qué significa predefinido. El ISO 19005-1 §6.7.2 apunta a la XMP Specification de enero de 2004, el ISO 19005-2 §6.6.2.3.1 al ISO 16684-1, cuya lista es más larga. El hueco se ve en archivos cotidianos vía crs (ajustes de Camera Raw), aux (datos EXIF adicionales) y xmpDM (medios dinámicos), que el TechNote 0008 del PDF/A Competence Center pone a pie de página como nuevas en la especificación XMP 2005. Una propiedad crs:AutoBrightness o xmpDM:videoColorSpace necesita descripción bajo la parte 1 y es predefinida desde la parte 2. El corpus público de veraPDF tiene archivos de fallos PDF/A-1b que añaden una de esas propiedades y nada más, mientras que el constructor de archivos de test de la propia veraPDF escribe una pista de camera-raw o de medios dinámicos en sus archivos PDF/A-2b, así que un comprobador ciego al número de parte se equivoca con uno de los dos lados. Las declaraciones también se movieron: photoshop:SupplementalCategories es Text en 2004 y un bag de Text en el ISO 16684-1, así que la forma bag falla en PDF/A-1 y es correcta en PDF/A-2

El atajo contrario también falla. Llamar extensión a todo lo que esté fuera de las diez tablas de esquemas del TechNote 0008 marcaría las estructuras sType y el espacio de nombres qualifier Identifier que las entradas ordinarias de xmpMM:History usan, y el TechNote 0008 permite esos URI en PDF/A-1. PDFium Component lee la parte desde pdfaid:part: un paquete de parte 1 sin bloque de descripción que usa crs, aux o xmpDM recibe pvaiMissingExtensionSchema, un paquete de parte 2 no recibe hallazgo de extension schema. Para salida PDF/A-1, quita las propiedades de camera-raw y de medios dinámicos que nadie aguas abajo lee. Una descripción completa de crs llega a docenas de entradas, cada una una oportunidad de hallazgo de entrada ausente

Prefijos requeridos y el # final en los URI de esquema

Los espacios de nombres XML normalmente dejan al writer elegir cualquier prefijo. El §6.7.8 quita esa libertad para el vocabulario de descripción, dando a cada estructura un URI y un prefijo requerido: pdfaSchema, pdfaProperty, pdfaType para un tipo de valor y pdfaField para un campo de uno; el ISO 19005-2 §6.6.2.3.2 reitera los cuatro. Ligar http://www.aiim.org/pdfa/ns/property# a nonpdfaProperty es XML equivalente y aun así falla, y los archivos del corpus veraPDF para esta cláusula mantienen todos los URI correctos y renombran un prefijo. Tu propio esquema es otra cosa: pdfaSchema:prefix registra un prefijo preferido, así que inv es una recomendación. Mantenlo igual al prefijo que el paquete ligue en cualquier caso

Anatomía de los cuatro vocabularios de extension schema de PDF/A mostrando prefijos requeridos, URI de esquema y campos obligatorios, con la normalización del hash final que PDFium Component aplica en Delphi
cada vocabulario de descripción lleva un URI y un prefijo requerido, y el componente quita un # final a ambos lados antes de comparar URI de espacios de nombres

Los URI tienen una rareza. La prosa del ISO 19005-1 §6.7.8 imprime http://www.aiim.org/pdfa/ns/schema sin # final, mientras que sus tablas y los archivos conformes terminan el URI con uno, así que una comparación estricta contra la prosa no coincide con nada. PDFium Component quita un # final a ambos lados antes de comparar. Escribe la forma con #, y copia tu propio espacio de nombres en pdfaSchema:namespaceURI carácter por carácter. La frase de cierre del ISO 19005-2 §6.6.2.3.2 quiere después cada campo que las tablas del §6.6.2.3.3 listan, y un hueco se informa como pvaiExtensionSchemaEntryMissing:

  • Schema (pdfaSchema): schema, namespaceURI y prefix, más las listas property y valueType, que un esquema sin nada que declarar puede omitir
  • Property (pdfaProperty): name, valueType, category y description, donde category es internal o external
  • Value type (pdfaType): type, namespaceURI, prefix, description y field, requeridos porque un tipo de valor personalizado es una estructura
  • Field (pdfaField): name, valueType y description

¿Cómo se deletrea una entrada estructurada en RDF/XML?

De tres maneras cualesquiera, mientras el elemento siga siendo una estructura. El ISO 32000-2 §14.3.2 entrega la gramática de un flujo de metadatos al ISO 16684-1, que escribe XMP como un subconjunto de RDF/XML. La forma corta pone rdf:parseType="Resource" en el rdf:li y lista los campos debajo; la forma larga los envuelve en un rdf:Description anidado, y ambas significan la misma estructura anónima. Una tercera escritura mueve los campos de texto plano a atributos de ese rdf:Description. Solo el texto cabe ahí: pdfaSchema:property guarda una secuencia y sigue siendo un elemento. Quita rdf:parseType de un elemento de forma corta y el resultado no es RDF/XML. Un parser espera entonces texto o un elemento nodo dentro del rdf:li, toma pdfaSchema:schema por un nodo tipado, y un elemento nodo no puede albergar texto que no sea whitespace, así que el primer campo ya rompe la gramática. Una XSLT que reconstruye elementos de lista, o una plantilla que regenera el bloque desde un diccionario, puede soltar el atributo conservando cada elemento. Lee esa salida de vuelta con un parser RDF distinto del que la escribió para ver el daño

Tres escrituras RDF/XML legales de una entrada de extension schema de PDF/A, y la rotura de gramática cuando se quita rdf:parseType, tal como PDFium Component las conserva en Delphi
la forma corta, la forma larga y la abreviatura de atributos describen la misma estructura, y quitar rdf:parseType de un elemento de forma corta rompe la gramática RDF en el primer campo
<!-- Forma corta: el esquema de factura descrito por completo -->
<rdf:li rdf:parseType="Resource">
  <pdfaSchema:schema>Invoice data from the ERP</pdfaSchema:schema>
  <pdfaSchema:namespaceURI>http://ns.example.com/invoice/1.0/</pdfaSchema:namespaceURI>
  <pdfaSchema:prefix>inv</pdfaSchema:prefix>
  <pdfaSchema:property>
    <rdf:Seq>
      <rdf:li rdf:parseType="Resource">
        <pdfaProperty:name>InvoiceNumber</pdfaProperty:name>
        <pdfaProperty:valueType>Text</pdfaProperty:valueType>
        <pdfaProperty:category>external</pdfaProperty:category>
        <pdfaProperty:description>Invoice number assigned by the ERP</pdfaProperty:description>
      </rdf:li>
    </rdf:Seq>
  </pdfaSchema:property>
</rdf:li>

<!-- Forma larga: la misma estructura como nodo anidado -->
<rdf:li>
  <rdf:Description>
    <pdfaSchema:schema>Invoice data from the ERP</pdfaSchema:schema>
    ...
  </rdf:Description>
</rdf:li>

<!-- Abreviatura de atributos: los campos de texto como atributos, la lista sigue siendo un elemento -->
<rdf:li>
  <rdf:Description pdfaSchema:schema="Invoice data from the ERP"
      pdfaSchema:namespaceURI="http://ns.example.com/invoice/1.0/"
      pdfaSchema:prefix="inv">
    <pdfaSchema:property>...</pdfaSchema:property>
  </rdf:Description>
</rdf:li>

PDFium Component conserva la escritura que llegue. Cada valor del TPdfXmpPacket que TPdf.ReadXmpPacket devuelve registra el rdf:parseType de su elemento de origen, Resource, Literal o Collection, y ToXml lo vuelve a escribir; una estructura sin registro sale con rdf:parseType="Resource". Ese writer sirve a SaveAsWithXmpPacket y a NormalizePdfAMetadata, la llamada que alinea las entradas Info con sus equivalentes XMP, y un bloque de extensión en cualquiera de las tres escrituras valida igual antes y después de un ciclo de leer y guardar. Escribe las entradas nuevas en la forma corta. Cada campo sigue siendo un elemento, lo que mantiene las ediciones uniformes, y coincide con la entrada pdfaid que SaveAsPdfA escribe

Añadir tu descripción al contenedor que ya está ahí

Fusiona la entrada nueva en el rdf:Bag existente. Un contenedor por paquete. El parser XMP de veraPDF rechaza un paquete con un segundo elemento pdfaExtension:schemas (Duplicate property or field node 'pdfaExtension:schemas'), y los fallos caen en reglas generales de metadatos. Cada propiedad necesita nombre, tipo de valor, categoría y descripción, las entradas que una factura Factur-X rellena para declarar sus propiedades fx en un extension schema. El listado empalma un elemento de forma corta antes de </rdf:Bag>, que ToXml escribe en la línea propia del contenedor. El elemento declara pdfaSchema y pdfaProperty por sí mismo, así que parsea igual donde quiera que caiga

const
  ExtensionNs = 'http://www.aiim.org/pdfa/ns/extension/';
  ContainerEnd = '</rdf:Bag></pdfaExtension:schemas>';
  TopDescriptionEnd = '</rdf:Description>'#10' </rdf:RDF>';

function InvoiceSchemaItem: string;
begin
  Result := '<rdf:li rdf:parseType="Resource"' +
    ' xmlns:pdfaSchema="http://www.aiim.org/pdfa/ns/schema#"' +
    ' xmlns:pdfaProperty="http://www.aiim.org/pdfa/ns/property#">' +
    '<pdfaSchema:schema>Invoice data from the ERP</pdfaSchema:schema>' +
    '<pdfaSchema:namespaceURI>' + InvoiceNs + '</pdfaSchema:namespaceURI>' +
    '<pdfaSchema:prefix>inv</pdfaSchema:prefix>' +
    '<pdfaSchema:property><rdf:Seq><rdf:li rdf:parseType="Resource">' +
    '<pdfaProperty:name>InvoiceNumber</pdfaProperty:name>' +
    '<pdfaProperty:valueType>Text</pdfaProperty:valueType>' +
    '<pdfaProperty:category>external</pdfaProperty:category>' +
    '<pdfaProperty:description>Invoice number assigned by the ERP' +
    '</pdfaProperty:description>' +
    '</rdf:li></rdf:Seq></pdfaSchema:property></rdf:li>';
end;

// True cuando una entrada de esquema describe Uri, sea cual sea la escritura que use
function DescribesNamespace(const V: TPdfXmpValue; const Uri: string): Boolean;
var
  Q: Integer;
begin
  for Q := 0 to High(V.Qualifiers) do      // campos como atributos en rdf:li
    if (V.Qualifiers[Q].Name = 'namespaceURI') and
       (string(V.Qualifiers[Q].Value) = Uri) then
      Exit(True);
  Result := (Pos('>' + Uri + '</', string(V.RawXml)) > 0) or    // elementos
    (Pos('namespaceURI="' + Uri + '"', string(V.RawXml)) > 0);   // atributos
end;

// Devuelve un paquete nuevo; quien llama lo libera
function WithInvoiceSchema(Packet: TPdfXmpPacket): TPdfXmpPacket;
var
  Xml: string;
  Index, J, P: Integer;
  HasContainer: Boolean;
begin
  HasContainer := Packet.TryGetProperty(ExtensionNs, 'schemas', Index);
  if HasContainer then
    for J := 0 to High(Packet.Properties[Index].Values) do
      if DescribesNamespace(Packet.Properties[Index].Values[J], InvoiceNs) then
        Exit(Packet.Clone);                // ya descrito
  Xml := Packet.ToXml;
  P := Pos(ContainerEnd, Xml);
  if P > 0 then
    Insert(InvoiceSchemaItem, Xml, P)      // unirse al bag existente
  else if HasContainer then
    raise EPdfXmpError.Create('Extension container uses an unexpected prefix')
  else
  begin
    P := Pos(TopDescriptionEnd, Xml);
    if P = 0 then
      raise EPdfXmpError.Create('Unexpected XMP packet layout');
    Insert('<pdfaExtension:schemas xmlns:pdfaExtension="' + ExtensionNs +
      '"><rdf:Bag>' + InvoiceSchemaItem + ContainerEnd + #10'  ', Xml, P);
  end;
  Result := TPdfXmpPacket.Parse(Xml);
end;

procedure TagInvoice(const SourceFile, TargetFile, InvoiceNo: string);
var
  Pdf: TPdf;
  Packet, Described: TPdfXmpPacket;
  Written: TFileStream;
begin
  Pdf := TPdf.Create(nil);
  try
    Pdf.FileName := SourceFile;
    Pdf.Active := True;
    Packet := Pdf.ReadXmpPacket;
    if Packet = nil then
      raise Exception.CreateFmt('%s has no XMP packet', [SourceFile]);
    Described := nil;
    try
      Packet.SetSimpleValue(InvoiceNs, 'inv', 'InvoiceNumber', InvoiceNo);
      Described := WithInvoiceSchema(Packet);
      if not Pdf.SaveAsWithXmpPacket(TargetFile, Described) then
        raise Exception.CreateFmt('Could not write %s', [TargetFile]);
    finally
      Described.Free;
      Packet.Free;
    end;
  finally
    Pdf.Free;
  end;
  Written := TFileStream.Create(TargetFile, fmOpenRead or fmShareDenyWrite);
  try
    PrintExtensionIssues(Written);         // del primer listado
  finally
    Written.Free;
  end;
end;

Esperado: para un origen PDF/A-1, -2 o -3 escrito por SaveAsPdfA, TagInvoice imprime la línea de conformidad y ninguno de los cuatro valores de extension schema, con la entrada de factura en forma corta junto a la de pdfaid. Una segunda ejecución deja el bag en paz sea cual sea la escritura de la entrada existente: DescribesNamespace busca en RawXml y, para atributos en un rdf:li vacío, en los qualifiers. Un contenedor bajo otro prefijo levanta una excepción, porque uno fresco sería el duplicado que veraPDF rechaza. Cuando el ERP añade una fecha de vencimiento, extiende la secuencia pdfaSchema:property existente

¿Comprueba PDF/A-4 los extension schemas en absoluto?

No. El ISO 19005-4 §6.7.2.1 conserva solo reglas a nivel de paquete: la clave Metadata del catálogo, los atributos de cabecera obsoletos bytes y encoding, XML bien formado y UTF-8. Una propiedad sin describir, una descripción bajo nonpdfaSchema y una a la que falta pdfaSchema:schema dejan todas un archivo conforme bajo el perfil PDF/A-4 de veraPDF, y PDFium Component ejecuta sus cuatro comprobaciones de extension schema solo cuando pdfaid:part es 1, 2 o 3. El esquema de identificación conserva sus reglas en todas partes. Bajo el §6.7.3 de la parte 4 su espacio de nombres debe seguir ligado a pdfaid, y su conjunto de propiedades crece por parte: part, conformance y, desde la Enmienda 1 de 2007, amd en la parte 1, corr desde el ISO 19005-2 §6.6.4 en adelante, rev en la parte 4. Un prefijo equivocado se informa como pvaiXmpIdPrefixWrong y un nombre extra como pvaiXmpIdPropertyUnknown en todas las partes

Para comparar partes sobre un mismo documento, cambia el paquete y nada más: inserta el binding del espacio de nombres dentro del XMP y borra tantos bytes de whitespace entre etiquetas, de modo que /Length, los offsets de referencias cruzadas y la cabecera %PDF-2.0 se queden donde están. Una reescritura con pypdf puede devolver un archivo PDF/A-4 con una cabecera %PDF-1.3 cuyos fallos entierren el resultado de metadatos. Para salida de producción, escribe la descripción también en los paquetes PDF/A-4: cuesta unos cientos de bytes, el validador del PDFium Component la deja en paz bajo la parte 4, y el paquete puede más tarde moverse a un entregable PDF/A-3 sin cambios