Eine Dokumentvorlage definiert die Struktur, das Layout und den Inhalt eines Berichts. Die Erstellung einer gelungenen Vorlage setzt voraus,
dass die Vorlage geplant, entwickelt, getestet und gespeichert wird.
1: Voraussetzungen erfassen
Unterschiedliche
Anforderungen erfordern unterschiedliche Designs. Bestimmen Sie die geschäftlichen und praktischen Anforderungen des Dokuments, bevor Sie beginnen,
Ihre Vorlage(n) zu entwerfen.
- Datenelemente
- Es gibt verschiedene Vorlagenelemente, die verschiedene Datentypen anzeigen. Welche Informationen werden von der Person bzw. den Personen,
die das Dokument anzeigen werden, benötigt? Wenn Sie diese Frage beantwortet haben, können Sie beginnen, die Datenelemente zu bestimmen:
- Welche Vorlagenelemente zeigen diese Daten an? Wie wird das im endgültigen Dokument aussehen?
- Gibt es mehrere Möglichkeiten, die Informationen anzuzeigen? Falls ja, welche Art der Anzeige ist am besten für den Kontext geeignet,
in dem das Dokument angezeigt werden soll?
- Wie viele Daten sind notwendig? Sie könnten nicht notwendige Daten herausfiltern und so Zeit sparen, wenn Sie die Berichtsausgabe generieren.
- Ausgabetyp
- Überlegen Sie, welcher Ausgabetyp am besten dem Bedarf der Personen entspricht, die
das Dokument anzeigen werden. Die Vorlage, die Sie entwerfen, kann in verschiedenen Ausgabetypen unterschiedlich aussehen. Einige Elemente
sind für die Anzeige in einem bestimmten Format optimiert, andere werden in bestimmten Formaten nicht unterstützt. Machen Sie sich damit
vertraut, wie Vorlagenelemente in verschiedenen Ausgabeformaten angezeigt werden. Das ermöglicht Ihnen, die Elemente und Ausgabetypen,
die am besten zusammenpassen, auszuwählen.
- Eine Vorlage und viele Vorlagen - ein Vergleich
- Handelt es sich um eine Vorlage für einmaligen Gebrauch, oder können einige Teile in anderen Vorlagen wiederverwendet werden?
- Eine Vorlage: Sie können eine Vorlage verwenden, die alle unterschiedlichen Teile des Dokumentdesigns enthalten soll. Das bedeutet, dass
sich alles an einem Ort befindet und keine Zusammenfassung erforderlich ist.
- Viele Vorlagen: Sie können einen modularen Ansatz verwenden, bei dem mehrere Vorlagen erstellt werden, die Sie zu einem vollständigen Dokument
zusammenfassen können.
Sie können beispielsweise eine Vorlage für das Inhaltsverzeichnis, eine Vorlage für das vordere Deckblatt, eine Datenvorlage, eine Indexvorlage
und eine Vorlage für das hintere Deckblatt haben. Diese Vorlagen können bei der Generierung verschiedener Dokumente wiederverwendet werden.
Stellen Sie fest,
wie viele Vorlagen Sie unter diesen Voraussetzungen benötigen.
Sie können jeden Vorlagenblock in den Metadatenattributen benennen und beschreiben.
Der Namensinhalt wird in der Vorlage und der Beschreibungsinhalt im Hinweisfeld zum Vorlagenelement angezeigt.
- Kontext anzeigen
- Wie soll dieses Dokument angezeigt werden?
- Soll es gedruckt und/oder auf dem Bildschirm angezeigt werden?
- Soll es in einem integrierten Produkt ausgeführt werden?
2: Vorlage erstellen
Wenn Sie eine Vorlage erstellen möchten, können Sie Ihre Zeit mit den folgenden Methoden effizient
nutzen.
- Implementieren Sie die Gesamtstruktur der Vorlage mit einem Top-down-Ansatz. Beginnen Sie mit den Elementen, die am allgemeinsten gehalten sind,
und arbeiten Sie sich dann
schrittweise zu den Details vor.
- Validieren Sie die Datengenerierung, bevor Sie sich auf die Formatierung von Details konzentrieren.
Wenn Sie viel Zeit für die Formatierung aufwenden müssen und dann feststellen, dass Ihre Daten nicht richtig generiert werden, müssen Sie sie möglicherweise
erneut formatieren. (Details hierzu finden Sie unter "3. Vorlage testen".)
- Arbeiten Sie die Details aus, und fügen Sie schrittweise detailliertere Voraussetzungen hinzu.
Lassen Sie weniger wichtige oder schwierige Details beiseite, um sie zu einem späteren Zeitpunkt zu implementieren.
Berücksichtigen Sie - wie bei einer Kosten-/Nutzenanalyse - die Relevanz von Voraussetzungen, die schwierig zu realisieren sind.
- Denken Sie darüber nach, ob Sie Informationen mit Scripts so extrahieren können, dass sie
von Rational Publishing Engine effizient konsumiert werden können.
- Eine Vorlage kann so konzipiert sein, dass bestimmte Seitenlayouteigenschaften bereitgestellt werden, wie z. B. Seitengröße, Ausrichtung, Ränder,
Anzahl der Spalten und Stile für die Absatztypen, deren Verwendung in Dokumenten am wahrscheinlichsten ist.
- Eine Vorlage kann Folgendes enthalten:
- Dokumentstrukturelemente, z. B. Absätze, Tabellen, Listen und ein Inhaltsverzeichnis.
- Dokumentlayoutblöcke, z. B. Stammseiten, Formatvorlagen, Kopfzeilen und Fußzeilen.
- Interne und externe benutzerdefinierte Stile, z. B. Text- oder Absatzformatierung. Zur Textformatierung gehören Fettdruck,
Kursivdruck, Unterstreichen, Schriftgröße und Schriftfarbe. Die Absatzformatierung beinhaltet Randeinstellungen, Rahmen, Einrückung und
Scriptparameter im JavaScript-Format.
- Integrierter Vorlageninhalt, z. B. Abbildungen, statischer Text und Referenzen auf statische Dateien und Formatvorlagen.
- Datenelemente, z. B. Attribute, Bedingungen und dynamische Datenelemente.
- Datenextraktion in Form von Abfragen und Filtern.
- Externe Variablen, die Werte zur Laufzeit erhalten, und interne Variablen, die für Berechnungen verwendet werden. Die Erstellung
externer Variablen ist der festen Codierung von Datenquellen-URLs in Ihrer Vorlage vorzuziehen. Wenn Sie URLs fest codieren und der Servername sich ändert,
müssen Sie die URLs in jeder Vorlage aktualisieren. Mit externen Variablen können Sie die URLs zur Laufzeit überschreiben. Verwenden Sie für Vorlagen,
die in andere Produkte integriert sind, die speziellen Variablen, die von diesen Produkten erkannt werden, wenn sie Daten referenzieren.
- Starten Sie Document Studio.
- Erstellen Sie eine neue Vorlage entweder basierend auf
einer vorhandenen Vorlage oder völlig neu.
- Fügen Sie das Datenquellenschema hinzu.
- Fügen Sie Elemente hinzu.
- Formatieren Sie Elemente.
- Definieren Sie dynamischen Inhalt.
- Optional: Optimieren Sie die Daten mit Filtern,
Sortierungen oder Bedingungen.
3: Vorlage testen
- Tests werden während der Entwicklung inkrementell durchgeführt. Daher sollten Sie oft sichern und dabei eindeutige Namen verwenden. Überprüfen
Sie oft die Ausgabe, und verwenden Sie dazu einen kleinen Satz Testdaten. Fügen Sie dem Testdatensatz erst weitere Elemente hinzu, wenn
der aktuelle Testdatensatz funktioniert.
- Wenn Sie das Dokument größtenteils entwickelt haben, führen Sie Belastungstests durch, um ggf. Leistungsprobleme zu ermitteln. Verwenden Sie
das Tool "Vorschau", um den Umfang der verwendeten Daten zu begrenzen. Der generierte Bericht ist immer noch korrekt, wird jedoch schneller ausgeführt,
da der Standardwert für die maximale Anzahl von Datensätzen pro Abfrage, den
Rational Publishing Engine abruft, 10 Datensätze beträgt. Wenn Sie
Bedingungen testen, ist es möglich, dass kein Datensatz unter den ersten 10 Datensätzen mit der Bedingung übereinstimmt. Verwenden Sie in diesem Fall
das Tool "Ausführen" anstelle des Tools "Vorschau", oder ändern Sie den Wert für die Maximalanzahl der Datensätze pro Abfrage in den Vorgaben.
- Testen Sie die Vorlage in verschiedenen Ausgabeformaten. Möglicherweise kann Ihre Vorlage mit einem Ausgabetyp nicht so gut angezeigt werden
wie mit einem anderen Typ.
- Führen Sie das Prüftool aus.
- Generieren Sie eine Vorschau.
4: Vorlage speichern
- Speichern Sie die entwickelten und getesteten Vorlagen auf einem zentralen Dateiserver.
Sie können die Komponente "Zentrale Verwaltung" als Speicherposition nutzen.
- Geben Sie unbedingt ein paar Informationen in den Metadaten der Vorlage an, damit andere Benutzer wissen, wie sie die Vorlage wiederverwenden
können. Ein paar beispielhafte Daten und Informationen zur Dokumentspezifikation helfen bei der effektiven Wiederverwendung dieser Vorlagen.
Nächste Schritte
Gehen Sie wie folgt vor, nachdem Sie die Vorlage(n) erstellt und getestet haben: