JavaScript-Code-Element hinzufügen

Verwenden Sie ein JavaScript-Code-Element für jeden Codeblock, den Sie in einer Vorlage verwenden möchten.
Einschränkung: Symbol für neues Feature Das JavaScript-Code-Element ist nur in Vorlagen der Version 2 verfügbar.

Informationen zu diesem Vorgang

JavaScript umfasst ein Spektrum von einfachen Argumenten bis hin zu komplexen Scripts.
  • Im Falle einfacher Argumente können Sie ein Script auf den Inhalt eines Elements, z. B. eines Textelements, anwenden. Klicken Sie doppelt auf das Textelement, klicken Sie auf das Register Scriptausdruck und geben Sie ein Script ein.
  • Im Fall von komplexen Scripts können Sie diese Aufgabe verwenden, um Ihr Script mit dem JavaScript-Code-Element anzuwenden.
Die Verwendung des JavaScript-Code-Elements hat gegenüber der Registerkarte "Scriptausdruck" folgende Vorteile:
  • Sie können Scripts von anderen Benutzern wiederverwenden.
  • Sie können Berechnungen zusammenfassen, ohne sich Gedanken darum machen zu müssen, in welcher Reihenfolge sie ausgeführt werden.
  • Sie können normale und komplexe Datenstrukturen, z. B. Sammlungen, erstellen und kontinuierlich erweitern.
    Tipp: Sie können beginnend mit dem Release Rational Publishing Engine Version 2.1 die Funktion, die in einem JavaScript-Code-Element definiert ist, in einem anderen JavaScript-Code oder einem Scriptausdruck aufrufen, indem Sie eine Bibliotheksscripteigenschaft im Script-Code definieren. Rufen Sie zum Definieren der Bibliotheksscripteigenschaft die Ansicht Eigenschaften des Elements JavaScript Code auf und wählen Sie das Register Spezifisch aus und aktivieren Sie das Kontrollkästchen Bibliotheksscript. Weitere Informationen zu der Bibliothekscripteigenschaft finden Sie unter JavaScript-Code-Elementeigenschaften.

Die JavaScript-Datei utils.js ist in Ihren Installationsdateien und in den vordefinierten Dateien der Komponente "Document Builder" enthalten, damit Sie einfaches JavaScript, wie z. B. den Einschluss des aktuellen Datums in der Berichtsausgabe, verwenden können.

Um eine Liste des vorhandenen JavaScript-Codes in Ihrer Vorlage anzuzeigen, müssen Sie auf Vorlage > JavaScripts überprüfen klicken. Die Ansicht "Suchen" wird geöffnet, und eine Liste der Elemente, die JavaScript verwenden, wird angezeigt. Native Filter werden in diesem Kontext nicht als JavaScript behandelt und erscheinen daher nicht in der Ergebnisliste.

Vorgehensweise

  1. Speichern Sie Ihre Vorlage, bevor Sie beginnen, mit JavaScript zu arbeiten.
  2. Wählen Sie in der Ansicht "Palette" das Element JavaScript-Code Symbol 'JavaScript-Code' aus und ziehen Sie es in den Vorlageninhaltseditor.
  3. Klicken Sie doppelt auf das JavaScript-Code-Element.
  4. Wählen Sie auf der Registerkarte "Scriptausdruck" eine Variable aus der Baumstruktur aus, auf die der JavaScript-Code angewendet werden soll.
  5. Sie haben folgende Optionen für die Eingabe des JavaScript-Codes:
    • Sie schreiben ein Script manuell in diesem Fenster.
    • Sie kopieren ein Script aus einem externen Editor und fügen es in dieses Fenster ein.
    • Klicken Sie auf Script einschließen und wählen Sie eine Datei auf Ihrem Computer, einem fernen Server oder aus der Komponente "Document Builder" aus.
  6. Optional: Wenn Sie das Script aus XHTML kopiert haben, haben Sie folgende Optionen:
    • Wählen Sie die Option XHTML-Eingabe aus, um die Bearbeitung der im Script enthaltenen XHTML-Tags zu ermöglichen.
    • Wählen Sie die Option XHTML-Eingabe ab, wenn Sie alle XHTML-Tags aus dem Script entfernen möchten.
    Wenn Sie Rich Text kopieren oder in Bedingungen verwenden möchten, müssen Sie die Option XHTML-Eingabe verwenden.
    Wichtig: Die Dokumentgenerierung scheitert bei ungültiger XHTML. Stellen Sie sicher, dass Ihre XHTML gültig ist, bevor Sie Änderungen speichern.
  7. Optional: Wenn Sie die Vorlage für eine XHTML-Ausgabe generieren möchten, haben Sie folgende Möglichkeiten:
    • Wählen Sie die Option XHTML-Ausgabe aus, um das Script zu parsen und als Rich Text zu übergeben.
    • Wählen Sie die Option XHTML-Ausgabe ab, um das Script als Klartext zu behandeln.
    Diese Auswahl gilt für alle Datenquellenattribute im Ausdruck. Klartext und XHTML können im Script nicht kombiniert verwenden.

    Wenn Sie Rich Text kopieren oder ad hoc erstellen möchten, müssen Sie die Option XHTML-Eingabe auswählen.

  8. Klicken Sie, nachdem Sie das Script eingegeben haben, auf Script testen, um den Code zu überprüfen. Enthält Ihr JavaScript Fehler, wird die Dokumentgenerierung möglicherweise nicht fehlerfrei ausgeführt.
  9. Klicken Sie auf OK, um die Änderungen zu speichern. Der Codeblock wird im Element komprimiert. Sie können den Code einblenden, um ihn im Vorlageninhaltseditor anzuzeigen.

Im JavaScript-Editor arbeiten

Verwenden Sie den JavaScript-Editor, um mithilfe von Syntaxhervorhebung und Content-Assist an Ihrem Script zu arbeiten.

Informationen zu diesem Vorgang

Die Syntaxhervorhebung gibt unter Verwendung eigener Farben und Stile an, wie der JavaScript-Quellcode wiedergegeben wird. Wenn Sie die Standardsyntaxhervorhebung ändern möchten, klicken Sie in Document Studio auf Fenster > Vorgaben > JavaScript > Editor > Syntaxhervorhebung.

Content-Assist zeigt in einem Popup-Fenster eine Liste gültiger Alternativen zum Beenden von Codezeilen an. Wenn Sie Content-Assist aktivieren möchten, drücken Sie die Tastenkombination Strg + Leerschritt.

Dies ist ein Screenshot des JavaScript-Editors.

Vorgehensweise

  1. Klicken Sie doppelt auf das JavaScript-Code-Element. Das Fenster Code für JavaScript-Code-Element eingeben wird geöffnet.
  2. Optional: Wenn Sie ein neues Script aus einer anderen Datei einschließen möchten, klicken Sie auf Script einschließen und wählen Sie eine Datei auf Ihrem Computer, auf einem fernen Server oder aus der Komponente "Document Builder" aus. Klicken Sie auf OK.

    Für Dateien, die Sie auf Ihrem Computer oder einem fernen Server ausgewählt haben, wird eine Kopie Ihres JavaScript-Codes aus der von Ihnen ausgewählten Datei im JavaScript-Editor geöffnet.

    Bei Dateien, die Sie in Document Builder ausgewählt haben, wird das Fenster Scriptreferenz verwenden geöffnet. Sie müssen angeben, ob JavaScript als Referenzlink in die Vorlage eingeschlossen werden soll:
    • Wenn Sie Ja auswählen, wird der Link zur JavaScript-Datei (.js) in einen Tag <Script> eingebettet. Der folgende Referenzlink im Beispiel wird im JavaScript-Editor hinzugefügt, und Sie dürfen ihn nicht ändern.
      <Script src= "library://api/scripts/51"></Script>
      Hinweis: Wenn Sie die Dokumentgenerierung aus der Vorlage ausführen und in der Vorlage JavaScript als Referenzlink vorhanden ist, muss Document Builder konfiguriert und es muss eine Verbindung zu Document Studio vorhanden sein. Weitere Informationen finden Sie unter Verbindung zur Komponente "Document Builder" herstellen.
    • Wenn Sie Nein auswählen, wird eine Kopie Ihres JavaScript-Codes aus der von Ihnen ausgewählten Datei im JavaScript-Editor geöffnet.
  3. Optional: Klicken Sie auf Im Editor öffnen, um das Script in einem Eclipse-JavaScript-Editor einzugeben. Das Script wird auf einer neuen Editorregisterkarte als temporäre Datei mit der Erweiterung .js geöffnet, sodass Sie das JavaScript bearbeiten und das Script über die Optionen in der Gliederungsansicht verwalten können. Nachdem Sie das Script bearbeitet haben, speichern Sie Ihre Änderungen und schließen die Registerkarte mit dem temporären JavaScript-Editor, um zum Fenster Code für JavaScript-Code-Element eingeben zurückzukehren.
  4. Klicken Sie auf Script testen, um den Code zu überprüfen.
  5. Klicken Sie auf OK, um die Änderungen zu speichern und das Fenster zu verlassen.