Globale Parameter verwenden

Wie kann ich globale Parameter verwenden?

Globale Parameter lassen sich über die Global Parameter Configuration definieren. Dabei können beliebige Parametergruppen mit globalen Parametern erstellt und direkt im X4 Designer verwaltet werden.

Diese lassen sich anschließend wie System-Parameter und Projekt-Parameter in den Werkzeugen des X4 Designers (Adapter Editor, Mapping Editor, Process Editor) nutzen.

Globale Parameter in Adaptern verwenden

Analog zu System- und Projekt-Parametern lassen sich auch globale Parameter mit %PARAM_Gruppe_Name% in Adapter-Konfigurationen einsetzen (siehe Anwendungsbeispiele für Parameter).

Globale Parameter in Technical Processes verwenden

Um globale Parameter in Technical Processes verwenden zu können, müssen die zu verwendenden Parameter zunächst in den aktuellen Prozess-Kontext eingelesen werden. Mit dem Adapter Global Parameter Management lassen sich globale Parameter über X4-Prozesse anlegen und zur Prozesslaufzeit verwalten. Dabei bietet der Adapter verschiedene Operationen zur Verwaltung globaler Parameter, etwa zum Hinzufügen oder Löschen, aber auch zum Import und Export von Parametern oder Parametergruppen.

Globale Parameter mit dem Global Parameter Management Adapter anlegen

Folgendes Prozessbeispiel zeigt, wie globale Parameter mit einem Mapping über den Global Parameter Management Adapter angelegt werden können. Der Technical Process liest dabei ein XML-Dokument mit Konfigurationswerten ein, transformiert es über ein Stylesheet und erstellt die Parameter über den Adapter mit der passenden Operation. Somit sind die Parameter für das Projekt und dessen Prozesse verfügbar.

Input-XML-Dokument bereitstellen

Das Input-XML-Dokument muss nach folgendem Schema aufgebaut sein:

Beispiel: Input-XML mit vordefinierten Parametern

XML

<Placeholder>
    <Group name="MyGroup">
    	<Key name="MyTargetHost" type="String">123.456.789.000</Key>
        <Key name="MyTargetPort" type="Integer">1415</Key>
        <Key name="MyTargetChannel" type="String">Dev</Key>
    </Group>
    <Group name="Thresholds">
    	<Key name="MinMessages" type="Integer">0</Key>
        <Key name="MaxMessages" type="Integer">10</Key>
    </Group>
</Placeholder>

Erläuterung:

Das Wurzelelement Placeholder kann beliebig viele Group-Elemente enthalten.
Ein Group-Element stellt jeweils eine cdar und kann beliebig viele Key-Elemente enthalten.
Das Attribute name innerhalb eines Group-Elements definiert den Namen der Parametergruppe.
Ein Key steht jeweils für einen Parameter und enthält folgende Attribute und Inhalte:
- name: Name des Parameters
- type: Parametertyp String, Boolean, Integer, Decimal oder Date (ISO-Date-Format YYYY-MM-DD )
- Wert des Parameters entsprechend dem Parametertyp

So modellieren Sie den Technical Process

Legen Sie einen neuen Technical Process über das Menü New > Technical Process an.
Ziehen Sie die Input-XML-Datei (siehe Beispiel) in den Technical Process und wählen Sie in den Eigenschaften die Operation Read.
Fügen Sie ein Stylesheet ein zur Transformation der Konfigurationsdatei (Inputdatei) auf die Input-Struktur, die der nachfolgende Adapter benötigt.
Ziehen Sie den Global Parameter Management Adapter in den Technical Process und wählen Sie die Adapter-Operation AddKeys.
Speichern Sie den Technical Process.
Führen Sie den Technical Process aus.
Die Parameter wurden nun angelegt und können sowohl in der Global Parameter Configuration als auch in der Administration-Oberfläche des X4 Control Centers eingesehen und bearbeitet werden.

Globale Parameter in XSL-Mappings verwenden

Analog zu den Projekt- und System-Platzhaltern lassen sich auch globale Parameter mit %PARAM_Gruppe_Name% in XSL-Stylesheets verwenden.

Beispiel für die Nutzung

Globale Parameter in XSL-Mappings verwenden

Folgendes Beispiel zeigt die Verwendung von globalen Parametern in Mappings. Vor ihrer Verwendung müssen die relevante Parameter im XSL-Mapping eingefügt werden.

Mapping erstellen

Das XSL-Mapping muss nach folgendem Schema aufgebaut sein. Die zu verwendenden globalen Parameter müssen zunächst im Stylesheet unter ihrem voll qualifizierten Namen deklariert werden. Anschließend lassen sie sich wie gewohnt verwenden.

Beispiel: XSL-Mapping

XML

<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="2.0">
  <xsl:output media-type="text/xml" method="xml"></xsl:output>
  <xsl:param name="PARAM_MyGroup_MyTargetHost"></xsl:param>
  <xsl:param name="PARAM_Thresholds_MinMessages"></xsl:param>
  <xsl:param name="PARAM_Thresholds_MaxMessages"></xsl:param>
  <xsl:template match="/">
    <Result>
      <MyGroup>
        <MyTargetHost><xsl:value-of select="$PARAM_MyGroup_MyTargetHost"></xsl:value-of></MyTargetHost>
      </MyGroup>
      <Thresholds>
        <MinMessages><xsl:value-of select="$PARAM_Thresholds_MinMessages"></xsl:value-of></MinMessages>
        <MaxMessages><xsl:value-of select="$PARAM_Thresholds_MaxMessages"></xsl:value-of></MaxMessages>
      </Thresholds>
    </Result>
  </xsl:template>
</xsl:stylesheet>

Technical Process modellieren

Neuen Technical Process über das Menü New > Technical Process anlegen.
Das XSL-Mapping (siehe Beispiel) in den Technical Process ziehen.
Technical Process speichern und anschließend ausführen.