Publizierungsprozess
Voraussetzungen
Fundierte Kenntnisse über den vollständigen Publizierungsprozess sind für Erstellung einer funktionierenden angepassten Implementierung von wesentlicher Bedeutung. Zur Erreichung dieses Ziels benötigen Sie in der Regel die folgenden Fähigkeiten und Kenntnisse:
• Erfahrung mit der Verwaltung und Konfiguration von Arbortext Publishing Engine, einschließlich PTC Server connection zu Windchill PDMLink.
• Erfahrung im Umgang mit Arbortext Editor und mit der Entwicklung von Formatvorlagen mit Arbortext Styler
• Erfahrung mit der Entwicklung und Bereitstellung von spezialisierten Dokumenttypanwendungen für Arbortext Editor and Publishing Engine sowie mit der Verwendung des application-Verzeichnisses
• Erfahrung mit der Entwicklung von XSL-Umwandlungsformatvorlagen
• Erfahrung mit XPath-Ausdrücken
• Erfahrung mit der Verwaltung von Windchill PDMLink
• Erfahrung mit der Verwaltung von Windchill Visualization Services (WVS) und Worker-Agent
• Erfahrung im Schreiben von WVS Publizierregeln
Voraussetzungen für die Publizierung
Bevor angepasste Implementierungen durchgeführt werden können, müssen die folgenden Voraussetzungen bezüglich Installation, Setup, Konfiguration und Operation erfüllt sein:
• Arbortext Publishing Engine muss auf einem unterstützten Windows-Server installiert und konfiguriert werden.
Anweisungen zur Installation und Konfiguration von Arbortext Publishing Engine finden Sie in den Handbüchern Installing Arbortext Publishing Engine (Arbortext Publishing Engine installieren) und Configuring Arbortext Publishing Engine (Arbortext Publishing Engine konfigurieren), die Teil der Hilfe-Center-Dokumentation zu Arbortext Publishing Engine sind.
• Die Windchill WVS Verbindung zum Arbortext Publishing Engine Server muss in der Datei Windchillwvssis.properties konfiguriert werden.
Anweisungen zum Einrichten der Serververbindung von Windchill aus finden Sie im Handbuch Windchill Service Information Manager und Windchill Service Parts konfigurieren, einem Teil der Windchill Service Information Manager Dokumentation, die im Windchill Hilfe-Center und auf der PTC Site "Referenzdokumente" unter folgender Adresse zur Verfügung steht:
Wählen Sie Dokumentation durchsuchen, um auf die Links zuzugreifen.
• Auf dem Arbortext Publishing Engine Server muss die Serviceanwendung com.ptc.arbortext.service installiert und aktiviert werden. Standardmäßig befindet sie sich im application-Verzeichnis von Arbortext Publishing Engine. Die Serviceanwendung verwaltet die anfängliche Umwandlung des XML-Eingabedokuments, das für die Publizierung vorbereitet wird.
• Für den Arbortext Publishing Engine Server muss ein Dokumenttyp installiert und aktiviert sein, damit die Publizierungsausgabe verarbeitet werden kann. Standardmäßig befindet sich ein Beispiel im application-Verzeichnis von Arbortext Publishing Engine. Die als DITA-Dokumenttyp fungierende Anwendung "Technical Information" com.ptc.arbortext.techinfo ist ein funktionsfähiges Beispiel für einen derartigen Dokumenttyp, der mit Arbortext Publishing Engine verteilt wird.
• Die PTC Server connection zu Windchill muss auf dem Arbortext Publishing Engine Server konfiguriert werden, damit der Arbortext Publishing Engine Server Objekte aus Windchill abrufen kann.
Anweisungen zum Einrichten der PTC Server connection finden Sie im Handbuch Arbortext Content Management Guide, einem Teil der Dokumentation zu Arbortext Publishing Engine.
• Ein SIS-Worker muss auf Windchill PDMLink konfiguriert werden, damit WVS Publizierungsanfragen verwalten kann, die von Informationsstrukturen, Publikationsstrukturen und Teilelisten an Arbortext Publishing Engine gesendet werden.
Anweisungen zum Einrichten des SIS-Workers finden Sie im Handbuch Windchill Service Information Manager und Windchill Service Parts konfigurieren, das Teil der Dokumentation zu Windchill Service Information Manager ist.
• WVS Publizierregeln müssen auf Windchill PDMLink eingerichtet werden, damit Benutzer eine Publizierregel auswählen können und WVS die zugeordneten Publizierparameter an Arbortext Publishing Engine senden kann. Publizierregeln müssen einen aussagekräftigen Namen und eine verständliche Beschreibung haben, damit sie vom Benutzer problemlos unterschieden werden können.
Anweisungen zum Einrichten von Publizierregeln finden Sie im Handbuch Windchill Service Information Manager und Windchill Service Parts konfigurieren, einem Teil der Dokumentation zu Windchill Service Information Manager.
• In einem Serviceprodukt müssen eine Publikationsstruktur, Informationsstruktur und optional eine Teileliste definiert werden. Die allgemeine WVS Publizierung muss in Betrieb sein, bevor Publizierungsaktionen verwendet werden können.
Publizieraktionen werden im Windchill Hilfe-Center beschrieben.
• Eine publizierte Darstellung in einem angegebenen Ausgabeformat kann mit dem Menüaktionspunkt, dem Kontextmenü oder der Symbolleistenschaltfläche Darstellung publizieren erstellt werden. Der Benutzer gibt den Namen und die Beschreibung der Publikation sowie möglicherweise eine WVS Publizierregel an. Der Ausgabetyp und verschiedene Publizierparameter werden durch die WVS Publizierregel oder – im Fall von Teilelisten – durch die Wahl des Benutzers festgelegt.
• Darstellung publizieren ermöglicht das Publizieren eines Pakets für Arbortext Content Delivery. Bei der Paketpublizierung wird eine Datei erzeugt, die als Paket bezeichnet und als Eingabe für Arbortext Content Delivery verwendet wird. Das Paket wird in einem Zielverzeichnis auf dem Arbortext Publishing Engine Server gespeichert, wo es von Arbortext Content Delivery gefunden werden kann. Die Paketpublizierung gibt kein Paket an Windchill zurück, sie gibt jedoch Informationen über den Paketpubliziervorgang zurück.
• Die WVS Publizierregeldatei muss definierte SIS-Worker-Parameter aufweisen, damit die Publizierung gesteuert werden kann. Die Parameter und Beispiele werden unter
Service-Worker-Parameter erläutert.
Workflow für die Serviceinformationspublizierung
Der grundlegende Workflow der Publizierung aus einer Serviceproduktstruktur sieht folgendermaßen aus:
1. Wenn eine Publizieraktion in einer Publikationsstruktur, einer Informationsstruktur oder einer Teileliste ausgelöst wird, werden mehrere Dateien generiert, gezippt und von WVS in einer als Payload bezeichnete Datei an den Arbortext Publishing Engine Server gesendet. Die Anzahl und der Typ der Dateien sind spezifisch für die Struktur, deren Inhalt, die angegebene Ausgabe und die Publizierspezifikationen für den angeforderten Publizierjob.
2. Windchill Service Information Manager erstellt ein verallgemeinertes XML-Dokument aus der Struktur, um es an den Arbortext Publishing Engine Server zu senden.
Sie müssen dieses verallgemeinerte XML-Format verstehen, um das XML-Eingabedokument erfolgreich in ein Format transformieren zu können, das der Struktur des jeweiligen Dokumenttyps entspricht. Eine XSLT-Transformationsformatvorlage wird im Rahmen der Dienstanwendungsverarbeitung bereitgestellt. Diese XSLT-Formatvorlage wird mit einem der Parameter in der WVS Publizierregel angegeben.
3. Die Spezifikationen der WVS Publizierregel werden in eine Publizierspezifikationsdatei konvertiert, die in der Payload an den Arbortext Publishing Engine Server gesendet wird. Ihre Parameter werden während des Publizierungsprozesses angewendet.
4. Von einem XML-Eingabedokument referenzierte Objekte wie z.B. Grafiken werden als Teil der Payload an die Arbortext Publishing Engine gesendet oder können mit der PTC Server connection in Windchill PDMLink abgerufen werden. Die ausgeführte Aktion hängt von einem SIS-Worker-Parameter ab.
5. Das XML-Eingabedokument, die Publizierspezifikation und die referenzierten Objekte (falls notwendig) werden in eine Payload-Datei gezippt, die darüber hinaus eine XML-Manifestdatei zur Beschreibung des Payload-Inhalts enthält.
Die Payload wird dann als POST-Typ einer HTTP-Anforderung zur Verarbeitung an den Arbortext Publishing Engine Server gesendet; hierzu wird ein f=acl-Funktionsaufruf verwendet, der von der Serviceanwendung verarbeitet wird.
6. Die Serviceanwendung enthält XSLT-Formatvorlagen, mit denen das verallgemeinerte XML-Eingabedokument in ein Format transformiert wird, das standardmäßig dem als Beispiel verteilten DITA-Dokumenttyp, einer illustrierten Teileliste oder einem Arbortext Content Delivery Paket entspricht.
7. Auf dem Arbortext Publishing Engine Server muss ein Dokumenttyp installiert sein, der aus dem Zwischendokument der Serviceanwendung eine publizierte Ausgabe oder ein Paket erstellen kann.
Die Beispielanwendung "Technical Information" ist ein spezialisierter DITA-Dokumenttyp, der auf dem Arbortext Publishing Engine Server verteilt wird. Standardmäßig kann dieser Dokumenttyp die von der Standardserviceanwendung generierten Inhalte und Markups verarbeiten und die Ausgabe entsprechend den Publizierspezifikationen erstellen.
Die Anwendung "Technical Information" wurde als funktionierendes Dokumenttypbeispiel für das Schreiben und Publizieren von Informationen zu Wartungsoperationen und -teilen konzipiert. Jeder angepasste Dokumenttyp muss die Funktionen und die Aktionen emulieren, die in die Anwendung "Technical Information" integriert sind.
8. Nachdem die Payload vom Arbortext Publishing Engine Server empfangen wurde, wird die Anforderung an einen Arbortext Publishing Engine Unterprozess weitergeleitet und von diesem verarbeitet.
Die Publizierspezifikation muss die XSLT-Umwandlungsformatvorlage angeben, die das verallgemeinerte XML-Eingabedokument in Markup konvertiert, das dem ausgewiesenen Dokumenttyp entspricht. Die XSLT-Datei muss diesen Ausgabedokumenttyp angeben.
9. Das XML-Eingabedokument einer Publikationsstruktur, Informationsstruktur oder Teileliste wird von der Serviceanwendung in eine Zuordnungsstruktur umgewandelt. Wenn von der Struktur eine Teileliste referenziert wird, wird die Teileliste in ein separates XML-Format umgewandelt, das als Illustrated Part Description (IPD, illustrierte Teilebeschreibung) bezeichnet wird. Wenn nur eine Teileliste als Eingabe verwendet wird, wird diese in eine Publikationsstruktur-XML-Datei eingefügt, die die Teileliste referenziert; diese wird so umgewandelt, als würde sie tatsächlich von einer Publikationsstruktur referenziert.
10. Der Arbortext Publishing Engine Unterprozess wendet für den Ausgabedokumenttyp spezifische Pipeline-Filter auf das Dokument an und formatiert und publiziert die Ausgabe anschließend entsprechend der angegebenen Formatvorlage. (Hierbei wird APP verwendet, wie in der Arbortext Styler Formatvorlage angegeben.)
11. Der Arbortext Publishing Engine Server sammelt die publizierte Ausgabe (bzw. eine Fehlermeldung, falls sie stattdessen erzeugt wird), das Composer-Protokoll (in den Formaten XML und HTML), ein Manifest zum Identifizieren des Ausgabetyps, die Prozess-ID, die Transaktions-ID und den Namen des Arbortext Publishing Engine Servers sowie die IP-Adresse. Diese Dateien werden dann anschließend in eine Antwortdatei gepackt. Die Antwort-ZIP wird an den SIS-Worker zurückgegeben. Wenn die Ausgabe ein Paket ist, ist das Paket nicht in der Antwortdatei enthalten. Die Informationen über den Pfad zum Paket sind jedoch eingeschlossen. Das Paket verbleibt auf dem Arbortext Publishing Engine Server im Zielverzeichnis und wartet auf weitere Aktionen durch das Arbortext Content Delivery.
12. Der SIS-Worker sendet die zurückgegebene Antwort-ZIP an WVS.
13. WVS stellt einen Link zur ZIP mit der Darstellung von der Registerkarte Darstellungen bereit. Wenn die Darstellung ein PDF umfasst, können Sie einen Post Publish Delegate konfigurieren, um die PDF zu extrahieren und als Darstellung in Windchill PDMLink einzuchecken.