Variablen definieren und zuordnen

Beim Design einer Vorlage kann es notwendig sein, Werte zu berechnen oder Datenattribute in Kontexten verfügbar zu machen, in denen diese normalerweise nicht verfügbar sind. Für diese Situationen können Sie Variablen definieren und ihnen Werte zuordnen. Bei den Werten kann es sich um statische Daten handeln oder um Daten, die im aktuellen Kontext verfügbar sind.

Informationen zu diesem Vorgang

Variablen können als Platzhalter für die während der Ausführungszeit berechneten Daten (Variablenzuordnungen) verwendet werden, oder sie können in der Dokumentspezifikation angegeben werden. Im Gegensatz zu Datenattributen können Sie Variablen auch in Stammseiten verwenden.
Es gibt zwei Arten von Variablen:
  • Benutzerdefinierte Variablen: Benutzerdefinierte Variablen werden vom Entwickler der Vorlage definiert. Eine benutzerdefinierte Variable kann intern oder extern sein.
    • Interne benutzerdefinierte Variablen: Sie können eine Variable als interne Variable festlegen, um Berechnungen auszuführen oder um Informationen temporär zu speichern. Dies kann z. B. eine Variable sein, mit der Daten in die Stammseiten eingefügt werden. Interne Variablen werden in der Dokumentspezifikation nicht angezeigt. Daher können Sie keine Werte dafür angeben.
    • Externe benutzerdefinierte Variablen: Sie können eine Variable als externe Variable angeben, wenn Sie einen Wert dafür festlegen. Externe Variablen werden in der Dokumentspezifikation angezeigt. Weitere Informationen finden Sie unter Dokumentspezifikation erstellen.
  • RPE-Variablen (Rational Publishing Engine): RPE-Variablen sind interne Variablen, die zur Verwendung in der Dokumentvorlage verfügbar sind.
    Tabelle 1. Interne Variablen von Rational Publishing Engine
    Variable Beschreibung
    _cell_number Die Zellennummer in einer aktuellen Zeile. Ist das Element keine Zelle, ist der Wert 0. Die Variable _cell_number kann entweder in der Registerkarte "Datenausdruck" oder in der Registerkarte "Scriptausdruck" verwendet werden.
    _element_id Die Elementnummer in einer Vorlage. Sie ist intern in der Vorlage enthalten und wird für Debugging-Zwecke eingesetzt. Die Variable _element_id kann entweder in der Registerkarte "Datenausdruck" oder in der Registerkarte "Scriptausdruck" verwendet werden.
    _element_level Die rekursive Ebene eines Elements. Wenn für das Element in der Registerkarte "Daten" in der Eigenschaft für rekursive Ebene ("Recursive Level") kein Wert angegeben ist, wird der Wert auf 1 gesetzt. Die Variable _element_level kann entweder in der Registerkarte "Datenausdruck" oder in der Registerkarte "Scriptausdruck" verwendet werden.
    _row_number Die Zeilennummer in einer aktuellen Tabelle. Wenn das Element nicht in einem Zeilenelement enthalten ist, ist der Wert 0. Die Variable _row_number kann entweder in der Registerkarte "Datenausdruck" oder in der Registerkarte "Scriptausdruck" verwendet werden.
    _sessionInfo Informationen für Laufzeiteigenschaften aus der Vorlage oder Dokumentspezifikation. Wählen Sie die Variable _sessionInfo auf der Registerkarte "Scriptausdruck" aus und geben Sie das Script ein. Verwenden Sie leere Anführungszeichen ohne einen Wert dazwischen, um den Standardwert für die Eigenschaft in der Ausgabe zu generieren. Scriptbeispiele:

    _sessionInfo.getDocspecProperty("Eigenschaft", "");
    _sessionInfo.getTemplateProperty("Eigenschaft", "");
    _sessionInfo.getDatasourceProperty("Datenquellenname","Eigenschaft", "");
    _sessionInfo.getOutputProperty("Ausgabetyp","Eigenschaft", "");
    _sessionInfo.docspecVersion
    _sessionInfo.templateVersion
    _sessionInfo.engineVersion
    _sessionInfo.buildNumber

    Für getDocspecProperty können Sie die vorhandenen Eigenschaften der Dokumentspezifikation verwenden oder angepasste Metadateneigenschaften erstellen.

    _sessionLogger Für Debugging-Zwecke können Sie angepasste Informations-, Fehler-, Warn- oder Debugging-Nachrichten in der Datei TEMP\rpe\rpe.log, in der Sicht Konsole oder in der Sicht Fehler anzeigen. Die Nachrichten werden an der Position angezeigt, die in der Datei log4j.properties definiert ist.

    Standardmäßig werden Informationsnachrichten in der Sicht "Konsole" angezeigt, aber nicht in der Datei rpe.log.

    Wählen Sie die Variable _sessionLogger auf der Registerkarte "Scriptausdruck" aus und geben Sie das Script ein. Sie können Protokolleinträge mit einer der folgenden Methoden generieren:
    1. _sessionLogger.debug(Nachricht)
    2. _sessionLogger.info(Nachricht)
    3. _sessionLogger.error(Nachricht)
    4. _sessionLogger.warn(Nachricht)

    Wenn Sie den Inhalt für die Nachricht im Script festlegen, könnten Sie ein visuelles Callout wie Ihre Initialen oder Ihren Benutzernamen verwenden und mit Hilfe von Variablen aus Ihren Vorlagen aussagekräftige Nachrichten erstellen.

    _sessionUtils Diese Variable kann auf der Registerkarte "Scriptausdruck" verwendet werden, um eine Funktion für das Script mit dem Namen tidyXHTML auszuführen. Diese Variable ist nützlich, wenn Sie feststellen, dass die Ausgabe Leerraumblöcke enthält, die durch falsche XHTML-Codierung erzeugt werden. Mit der Variablen _sessionUtils wird ein Zeichenfolgeargument verarbeitet und XHTML wird bereinigt, sodass in der Ausgabe kein Leerraum angezeigt wird.

    Beispiel: _sessionUtils.tidyXHTML(Text);

    Wenn Sie die Variable _sessionUtils verwenden, wählen Sie auch die Optionen XHTML Input und XHTML Output auf der Registerkarte "Scriptausdruck" aus.
    Anmerkung: Vorlagen, die diese Variable enthalten, können in ältere Versionen von Rational Publishing Engine geladen werden, aber die Scripts können nicht ordnungsgemäß ausgewertet werden.

Vorgehensweise

  1. Klicken Sie in der Sicht Gliederung auf Variablen > Einfügen > Neue Variable. Das Fenster Neue Variable wird geöffnet.
  2. Geben Sie in den folgenden Feldern die Details zu den Variablen ein:
    1. Name: Geben Sie den Namen der Variablen ein. Der Variablenname muss gültige Java™- oder JavaScript-IDs verwenden, da Attribute in Scripts verwendet werden. Regeln für JavaScript-IDs:
      • Sie müssen mit einem Buchstaben, Unterstrich (_) oder Dollarzeichen ($) beginnen
      • Nachfolgende Zeichen können Ziffern sein (0-9)
      • Bei Buchstaben muss die Groß-/Kleinschreibung beachtet werden
      • ISO 8859-1- oder Unicode-Buchstaben, wie z. B. å oder ü, können verwendet werden
      • Unicode-Escapezeichenfolgen (\uXXXX) können als Zeichen verwendet werden
    2. Beschreibung: Geben Sie die Beschreibung für die Variable ein.
    3. Standardwert: Geben Sie den Wert für die Variable ein.
    4. Zugriff: Wählen Sie in der Liste aus, ob die Variable eine interne oder eine externe Variable ist.
      • Interne Variablen werden in der Dokumentspezifikation nicht angezeigt, daher können dafür keine Werte festgelegt werden.
      • Externe Variablen werden in der Dokumentspezifikation angezeigt, daher können Sie Werte dafür festlegen.
  3. Gehen Sie wie folgt vor, um einem Element eine Variable zuzuordnen:
    Tipp: Ordnen Sie die Variablen möglichst den Containerelementen zu. Die Variable wird auf die Elemente im Containerelement angewendet. Beispielsweise könnten Sie eine Variable in einer Tabelle verwenden, damit für jede Variable eine neue Zeile erstellt wird. Wenn Sie dem Tabellenelement eine Variable zuordnen, wird eventuell für jede Variable eine Tabelle erstellt. Manchmal werden diese aufeinanderfolgenden Tabellen zusammengefügt, aber manchmal werden sie auch als separate Tabellen angezeigt. Wenn Sie in die Tabelle ein Containerelement aufnehmen und die Zeile in das Containerelement ziehen und wenn Sie anschließend die Variable dem Containerelement zuordnen, wird eine einzelne Tabelle erstellt, die für jede Variable eine Zeile enthält.
    Tabellenelement mit einem Containerelement. Im Containerelement ist ein Zeilenelement mit drei Zellenelementen enthalten.
    1. Klicken Sie mit der rechten Maustaste auf das Element und klicken Sie auf Daten > Zuordnungen bearbeiten. Das Fenster Zuordnungseditor wird geöffnet.
    2. Klicken Sie auf Hinzufügen. Das Fenster Variable auswählen wird geöffnet.
    3. Geben Sie einen Namen für die Variable ein und klicken Sie auf OK.
    4. Klicken Sie im Fenster Zuordnungseditor auf OK.

Ergebnisse

Die ausgewählte Variable wird definiert und dem aktuellen Element zugeordnet.

Wenn Sie einem Element eine Variable zuordnen, wird neben dem Element im Vorlageninhaltseditor das folgende Symbol angezeigt: Symbol für Variablenzuordnung

Absatzelement mit Abfrage und Variablenzuordnung

Nächste Schritte

Tipp: Sie können nach einer Liste der in einem Element verwendeten Variablenzuordnungen suchen, indem Sie das Element, dem die Variable zugeordnet ist, mit der rechten Maus anklicken, und Suchen > Variablenreferenzen im Element auswählen. Die Sicht "Suchen" wird geöffnet, und eine Liste mit Variablenzuordnungen wird angezeigt. Sie können doppelt auf eine Variablenzuordnung in den Ergebnissen klicken, um sie zu bearbeiten.

Sie können nach einer Liste der in einem Element verwendeten Variablenzuordnungen, Attribute und Abfragen suchen, indem Sie ein Element mit der rechten Maustaste anklicken, und Suchen > Alle Referenzen im Element auswählen. Die Sicht "Suchen" wird geöffnet, und eine Liste wird angezeigt. Sie können doppelt auf einen Eintrag in den Ergebnissen klicken, um ihn zu bearbeiten.


Feedback