6 Expertenfragen zur VDI 2770

Eva-Maria Meier von

FAQ zur VDI 2770

Die VDI-Richtlinie 2770 liefert einen Standard für den digitalen Informations­austausch in der Prozess­industrie. Nachdem wir Ihnen im ersten Teil unserer Blogserie die Basics gezeigt haben, beantworten wir im zweiten Teil tiefergehende, komplexere Fragen. Diese Fragen sind uns begegnet, wenn wir in Kundenprojekten tiefer in die automatisierte Paketerstellung eingetaucht sind.

Eckpfeiler der VDI 2770 in Kürze

Wenn Sie den genauen Aufbau von VDI 2770 noch nicht kennen, empfehlen wir Ihnen den ersten Teil unserer Blogserie. Für Eilige fassen wir die wichtigsten Punkte hier kurz zusammen:

  • Die VDI-Richtlinie 2770 beschreibt ein Containerformat und ein Metadatenmodell zur Klassifizierung von Dokumenten.
  • Die Dokumentationscontainer beinhalten neben Dokumentcontainern die sogenannten Hauptdokumente als Inhaltsübersicht und zur Aufnahme der entsprechenden Metadaten.
  • Die Dokumentcontainer klammern die Metadaten-Datei, das Dokument selbst und optionale weitere Formatvarianten.
  • Um einen gezielten Informationszugriff zu ermöglichen, ist die Einordnung in eine von 12 Dokumentkategorien und das Herstellen eines eindeutigen Produktbezugs bindend.
  • Die Metadaten auf Dokument- und Dokumentationscontainer-Ebene werden in XML-Dateien gespeichert.
  • Die Container können verschachtelt sein. Die Verschachtelung erfolgt analog zum Produktaufbau.

Ein VDI-2770-Dokumentationscontainer, der 2 Dokumentcontainern und das Hauptdokumenten als PDF/A und XML enthält.

Das Informationsmodell der VDI 2770 – alle Metadaten im Überblick

Steigt man tiefer in das Thema „VDI 2770“ ein und fokussiert die automatisierte Erstellung, drehen sich die zu beantwortenden Fragen in der Regel um die Details des Datenmodells. Welche Metadaten gehören an welches Element? Welche Metadaten sind optional? Fast alle Expertenfragen beschäftigen sich mit dem VDI-2770-Informationsmodell. Die folgende Grafik gibt Ihnen vorab schonmal einen Überblick.

Visualisierung des VDI-2770-Informationsmodells in Anlehnung an die UML-Grafik in der Richtlinie VDI 2770 auf Seite 59

Wie sind mehrsprachige Dokumente und Sprachvarianten von Dokumenten zu behandeln?

International agierende Unternehmen verwalten ihre Produktinformationen in der Regel in mehreren Sprachen oder haben mindestens die Anforderung, sie in unterschiedlichsten Sprachen auszuliefern. VDI 2770-Pakete bilden die Sprach­abhängigkeit der Dokumente in einem entsprechenden Pflichtmetadatum ab.

Die Sprache muss für jede Dokumentversion angegeben werden. Wenn innerhalb eines Dokuments Inhalte in unterschiedlichen Sprachen vorkommen, sind alle enthaltenen Sprachen für das Dokument anzugeben. [vgl. VDI 2770, S.26]

Wenn für jede Sprache ein eigenes Dokument vorhanden ist, müssen die Metadaten vollständig für jedes Dokument (bzw. Dokumentversion) übergeben werden. Das Hauptdokument enthält in diesem Fall pro Sprachvariante eine Zeile. Das Hauptdokument selbst kann ebenfalls in mehreren Sprachen vorliegen.

Beispiel-Hauptdokument mit 5 Dokumenten. Ein Dokument enthält Inhalte in Deutsch, Englisch und Französisch. Ein anderes Dokument gibt es in jeweils einer Versionen für jede Sprachen

Übersetzungen von Dokumenten können leicht zugeordnet werden, wenn diese bidirektional über eine Beziehung (DocumentRelationship) verknüpft sind. Für die Typisierung der Beziehung gibt es die Werte „TranslationOf“ und „Affecting“.

Wie geht die VDI 2770 mit Dokumentversionen um?

Vielleicht ist Ihnen die Dokumentversion bereits im Hauptdokument in der Abbildung ins Auge gestochen. Das Datenmodell der VDI 2770 kennt neben Dokumenten auch Dokumentversionen.

Die klassifizierenden Metadaten wie die Dokumentart werden auf der Dokument-Ebene vergeben. Für jedes Dokument muss mindestens eine Dokumentversion vorhanden sein. An der Dokumentversion hängt die tatsächlich physische Datei (DigitalFile). Darüber hinaus werden folgende Metadaten an der Dokumentversion vergeben: [vgl. VDI 2770, S. 25 f.]

  • Sprache (Language)
  • Dokumentbeschreibung (DocumentDescription)
    Die Dokument­be­schrei­bung besteht aus dem Titel (Title), Schlagwörtern (KeyWords) und einer Zusammenfassung (Summary)
  • Status (LifeCycleStatus)
    Der Status kann „InReview“ oder „Released“ sein. Übergeben werden sollen die Dokumente allerdings alle im Status „Released“.
  • Seitenzahl (NumberOfPages)
  • Beteiligte Partein bzw. Organisation inkl. ihrer Rolle (Party mit Role und Organization)
  • Dokumentbeziehung (DocumentRelationship mit Type)

Wie gibt man Equipment-Id und Technische Plätze in VDI-2770-Paketen an?

Wenn Sie Berührungspunkte mit der Wartungsplanung im Anlagenbau haben, sind Ihnen die Begriffe Equipment und Technischer Platz bestimmt bekannt, denn die Begriffe stammen aus dem in der Branche weiterverbreiteten Softwaretool SAP Plant Maintenance.

Ein Equipment ist „ein individueller, körperlicher Gegenstand, der eigenständig instandzuhalten ist. Es kann in eine technische Anlage oder einen Anlagenteil eingebaut sein.“ [Quelle: SAP Help ]. Beispiele für Equipments sind Produktions­mittel, Transportmittel, Prüf- und Messmittel, Fertigungshilfsmittel, Gebäude oder PCs.

Technischer Platz bezeichnet eine „organisatorische Einheit der Logistik, die die instandzuhaltenden Objekte eines Unternehmens nach funktionalen, prozess­orientierten oder räumlichen Gesichtspunkten gliedert. Ein Technischer Platz repräsentiert den Ort, an dem eine Instandhaltungsmaßname durchzuführen ist.“ [Quelle: SAP Help ]

Die VDI 2770 enthält für Equipments und den Technischen Platz keine eindeutige Stelle. Es gibt zwar auf der Ebene des ReferencedObject zwei durch die Richtlinie vorgesehene Felder, allerdings sind die Begriffe in der Norm nicht eindeutig definiert und haben die Anforderungen aus der Praxis bisher nicht erfüllt.

Details des VDI-2770-Informatiosmodells zur Angabe des ReferencesObjects

In unseren bisherigen Projekten war die EquipmentId der instanzielle Produktbezug. Dieser kann aber nur über die ObjectId Validierungskonform abgebildet werden. Um die Werte nicht mehrfach als ObjectId und als EquipmentId eingeben zu müssen, fiel die Entscheidung darauf, einen eigenen RefType für die EquipmentId einzuführen.

Der RefType gibt an, um welchen Indentifikatortyp es sich handelt. Die Richtlinie nennt einige RefType als Beispiele, z. B. Bestellnummer, ID des Produkttyps oder ID nach DIN SPEC 91406. Die Liste ist keine geschlossene Liste (Enumeration) und kann erweitert werden [Quelle: VDI 2770, S. 59].

Für den Technischen Platz wurden ebenso verfahren, da auch dieser für bestimmte Dokumente den eineindeutigen Produktbezug darstellt.

Informationsmodell für den Produktbezug eines Hauptdokuments

Was sind Prüfsummen und wozu sind sie gut?

Mithilfe von Prüfsummen lässt sich die Integrität von Informationen überwachen. Dabei wird für die Daten eine Prüfsumme errechnet. Wird der Inhalt verändert, verändert sich auch die Prüfsumme. Vergleicht man die Werte z. B. vor und nach dem Hoch- oder Herunterladen, kann man Veränderungen feststellen. Identische Inhalte führen zu identischen Prüfsummen.

Sowohl für die Dokumentcontainer als auch für die Dokumentationscontainer können Prüfsummen berechnet werden [Quelle: VDI 2770, S. 33]. Ob unter­schiedliche Pakete identische Dokumentcontainer enthalten oder ein Dokument­container nachträglich verändert wurde, lässt sich so einfach anhand der Prüfsummen ermitteln. Die Angabe der Prüfsummen ist optional.

Prüfsummen für Dokumentationscontainer und Dokumentcontainer

Die errechneten Prüfsummen können logischerweise nicht gleichzeitig Inhalt des Pakets sein. Die Prüfsummen sind separat zu übermitteln. In welcher Form? Dazu sind laut Richtlinie Abstimmung zwischen Sender und Empfänger (also zwischen Lieferanten und Kunden) zu treffen.

PDF als obligatorische Dateiformat – aber welches genau?

Neben Fragen zum Metadatenmodell gibt es auch immer wieder Nachfragen zu den erlaubten Dateiformaten. Um einen dauerhaften, digitalen Zugriff, sprich Darstellbarkeit und Durchsuchbarkeit der Dokumente zu gewährleisten, schreibt die VDI 2770 vor, dass alle Dokumente mindestens im PDF/A-Format vorliegen müssen.

Aber PDF/A ist nicht gleich PDF/A. Es gibt unterschiedliche Versionen dieses für die Langzeitarchivierung konzipierten Formats. Die Anforderungen des Standards sind in der folgenden Tabelle gelistet. Priorität 1 ist die empfohlene und zu bevorzugende Version. [Quelle: VDI 2770, S.30 f]

Priorität PDF-Formate Erläuterung
1 PDF/A-2a,
PDF/A-3a
PDF/A-2 und PDF/A-3 basieren auf PDF 1.7, das als ISO 32000-1 normativ festgelegt ist.
2 PDF/A-1a Das Dateiformat von PDF/A-1 basiert auf PDF 1.4, welches nicht genormt ist. Das PDF/A-1-Dateiformat unterstützt keine Transparenz bei Bildern, was zur Folge hat, dass transparente Hintergründe schwarz dargestellt werden und somit die Anforderung der korrekten Darstellung gegebenenfalls nicht erfüllt wird.
Ausnahme für Zeugnisse, Zertifikate, Bescheinigungen (Kategorie 02-04) PDF/A-1b, PDF/A-2b, PDF/A-2u, PDF/A-3b, PDF/A-3u Dokumenten mit der Dokumentkategorie 02-04 Zeugnisse, Zertifikate, Bescheinigungen sind häufig eingescannte Papierdokumente. Die Inhalte sollten trotzdem durchsuchbar sein. Ggf. über separat bereitgestellten Text.
Verboten Containerfunktion von PDF/A-2 und PDF/A-3 Nicht verwenden!

Und wie erstellt man die Formate? In den gängigen Office- und DTP-Programmen können bei der PDF-Produktion unterschiedliche Optionen ausgewählt werden. Für Inhalte aus Content-Management-Systemen muss die Transformation entsprechend in der Publikationsstrecke berücksichtig werden. Tools zur Erzeugung von VDI-2770-Paketen, wie die plusmeta-Plattform, können die Konvertierung in das korrekte PDF/A-Format ebenfalls automatisch vornehmen.

Wie kann man konforme Pakete automatisiert erstellen?

Die richtigen Pakete zu packen kann von Hand ganz schön aufwendig sein. Zum Glück gibt es Tools wie plusmeta! In plusmeta unterstützt Sie Künstliche Intelligenz bei der Vergabe der richtigen Metadaten und die Pakete werden automatisiert generiert.

Wie Sie in plusmeta mit KI-Unterstützung im Handumdrehen erstellen, zeigen wir Ihnen im dritten Teil unserer Blogserie. Wenn Sie den nächsten Blogartikel nicht abwarten wollen, zeigen wir Ihnen plusmeta und die automatisiere VDI-2770-Paketgenerierung auch gerne vorab schon in einer unverbindlichen Demo.

Wir haben Ihre Frage zur VDI 2770 nicht beantwortet? Schreiben Sie uns eine E-Mail an hallo@plusmeta.de!