XML-Richtliniendatei erstellen

In diesem Abschnitt werden die in einer XML-Richtliniendatei enthaltenen Basiselemente beschrieben. Einige dieser Elemente sind erforderlich. Fehlen sie, kann die Richtlinie nicht aktiviert werden. Es gibt aber auch optionale Elemente, die nicht fehlen sollten, weil sie wichtige Metainformationen zur Richtlinie (z. B. den Namen des Richtlinieneigners und das Datum der letzten Änderung der Richtlinie) enthalten.

Wenn Sie eine XML-Datei erstellen, die nur die in diesem Abschnitt beschriebenen Elemente enthält, können Sie diese als Vorlage für die Erstellung von XML-Richtliniendateien nutzen. Sie können aber auch die offizielle XML-Richtliniendateivorlage (template.xml) verwenden. Sie finden die Vorlage im Richtlinienpoolverzeichnis.

Standardmäßig befindet sich das Richtlinienpoolverzeichnis an folgender Position:

/etc/opt/IBM/tsamp/eez/policyPool

Wenn Sie die Vorlage verwenden möchten, kopieren Sie die Datei in Ihr Arbeitsverzeichnis und benennen Sie sie entsprechend Ihren Dateinamenskonventionen um.

Erstellen Sie die XML-Richtliniendatei in einem Editor, in dem Sie die Datei im UTF-8-Format speichern können. XML-Dateien in anderen Formaten werden vom Tool für Richtlinienprüfung zurückgewiesen.

Falls Sie für die XML-Richtliniendatei einen XML-Editor verwenden, erstellt der Editor die XML-Basisrichtlinienvorlage für Sie. Die meisten XML-Editorprogramme stellen außerdem eine Validierungsfunktion bereit, die sicherstellt, dass Ihr XML-Code dem gültigen Schema entspricht. Wenn Sie diese Funktionen verwenden möchten, müssen Sie sicherstellen, dass der XML-Editor die Position des relevanten Schemas kennt. Das Schema für die End-to-End-Automationsrichtliniendateien (EEZPolicy.xsd) ist im Richtlinienpoolverzeichnis enthalten.

Im Folgenden sehen Sie ein Beispiel für die Basiselemente, die alle Richtliniendokumente enthalten müssen. (Die erforderlichen Elemente sind fett markiert.)

<?xml version="1.0" encoding="UTF-8"?>
<AutomationPolicy version="1.0" 
    xmlns="http://www.ibm.com/TSA/Policy.xsd" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:schemaLocation="http://www.ibm.com/TSA/Policy.xsd EEZPolicy.xsd ">
      <PolicyInformation>
          <PolicyName>Sample E2E Policy</PolicyName>
          <AutomationDomainName>FriendlyE2E</AutomationDomainName>
          <PolicyToken>1.0.5</PolicyToken
          <PolicyAuthor>Michael Atkins</PolicyAuthor>
          <PolicyDescription> 
              Policy for the end-to-end automation domain FriendlyE2E.
              Last Update: 09/16/07
              Last Editor: Michael Atkins
              Change History:
              ------------------------------------------------------
              Date      Name                Description
              ------------------------------------------------------
              09/16/07  Michal Atkins       Initial Policy
              ------------------------------------------------------
          </PolicyDescription>
      </PolicyInformation>
...
</AutomationPolicy>

Die Elemente haben folgende Bedeutung:

XML-Deklaration

Die XML-Datei muss mit der folgenden XML-Deklaration und der Anweisung für die Codierung ("encoding") beginnen:

<?xml version="1.0" encoding="UTF-8"?>

Element "AutomationPolicy"

Die gesamte XML-Richtlinie muss in ein <AutomationPolicy>-Element eingeschlossen werden. Der Endtag </AutomationPolicy> muss das letzte Element der XML-Richtliniendatei sein.

Verwenden Sie in Ihrer Richtliniendatei die folgenden Deklarationen:

<AutomationPolicy version="1.0"
     xmlns="http://www.ibm.com/TSA/Policy.xsd" 
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://www.ibm.com/TSA/Policy.xsd EEZPolicy.xsd">
...
</AutomationPolicy>

Die vier Attribute des Elements "AutomationPolicy" und die zugehörigen Werte müssen exakt wie im obigen Beispiel angegeben werden. Im Folgenden finden Sie Erläuterungen der Attribute:

Version: Dies ist die für diese Richtlinie erforderliche Mindestversion von System Automation Application Manager .
xmlns: Dies ist die Namespacedeklaration.
xmlns:xsi: Dies ist das für diese XML-Richtlinie verwendete XML-Schemaformat.
xsi:schemaLocation: Dies ist das XML-Schema, das die XML-Syntax definiert. Die XML-Richtliniendatei muss diesem XML-Schema entsprechen. Das Tool für Richtlinienprüfung überprüft die Gültigkeit der XML-Datei anhand des definierten XML-Schemas, bevor Sie die Richtlinie aktivieren können.

Element "PolicyInformation" und dessen Unterelemente

Mit dem Element "PolicyInformation" und dessen Unterelementen geben Sie wichtige Informationen zur Richtlinie an.

Das Element ist erforderlich und darf nur ein einziges Mal in einer XML-Richtliniendatei vorkommen.

PolicyInformation hat drei erforderliche Unterelemente, die die Richtlinie eindeutig kennzeichnen. (Dies sind die Unterelemente "PolicyName", "AutomationDomainName" und "PolicyToken".)

Es gibt noch zwei weitere Unterelemente ("PolicyAuthor" und "PolicyDescription"), die optional sind. Die Deklaration und sorgfältige Pflege dieser Unterelemente während des Lebenszyklus einer Richtlinie vereinfacht die Pflege und Verwaltung von XML-Richtliniendateien.

Im Folgenden sehen Sie ein Beispiel für eine PolicyInformation-Definition. (Die erforderlichen Elemente sind fett markiert.)

<PolicyInformation>
             <PolicyName>Sample E2E Policy</PolicyName>
             <AutomationDomainName>FriendlyE2E</AutomationDomainName>
             <PolicyToken>1.0.1</PolicyToken>
             <PolicyAuthor>Michael Atkins</PolicyAuthor>
             <PolicyDescription> 
                 Policy for the end-to-end automation domain FriendlyE2E. 
                 Last Update: 09/16/07 
                 Last Editor: Michael Atkins
                 Change History:
                 ------------------------------------------------------
                 Date      Name                Description
                 ------------------------------------------------------
                 09/16/07  Michal Atkins  Initial Policy
                 ------------------------------------------------------
             </PolicyDescription>
</PolicyInformation>

Folgende Unterelemente des Elements "PolicyInformation" sind erforderlich:

PolicyName: Weisen Sie Ihrer Richtlinie einen aussagekräftigen Namen zu. Ein solcher Name hilft Ihnen, Zweck und Verwendung der Richtlinie ohne großen Aufwand zu bestimmen. Das gilt insbesondere, wenn Ihr Richtlinienpoolverzeichnis mehrere Richtlinien enthält und Sie die Richtlinie häufiger wechseln. Das Unterelement "PolicyName" kann bis zu 64 Zeichen lang sein.
AutomationDomainName: Dieses Unterelement enthält den Namen der End-to-End-Automationsdomäne, für die die Richtlinie verwendet wird. Der Name der Automationsdomäne wird im Konfigurationsdialog für die End-to-End-Automation (auf der Seite "Domäne" im Feld Domänenname) angegeben. Die Richtlinie kann nur aktiviert werden, wenn der Domänenname in der Richtliniendatei mit dem Domänennamen auf der Seite des Konfigurationsdialogs übereinstimmt. Das Unterelement "AutomationDomainName" kann bis zu 64 Zeichen lang sein.
Anmerkung: Im Dialogfenster für die Richtlinienaktivierung werden nur die Richtlinien angezeigt, die denselben Automationsdomänennamen wie für diesen Application Manager konfiguriert haben.
PolicyToken: Eine sorgfältige Versionssteuerung der Richtliniendateien ist wichtig, um die Änderungen verfolgen zu können. Mit dem Unterelement "PolicyToken" geben Sie die Version in der XML-Richtliniendatei an. Dieses erforderliche Element kann bis zu 64 Zeichen lang sein. Es kann sinnvoll sein, Konventionen für das Format des Richtlinientokens festzulegen.

Das Element "PolicyInformation" hat die folgenden optionalen Unterelemente:

PolicyAuthor: Mit diesem Unterelement können Sie den Autor der Richtlinie angeben. Es werden maximal 64 Zeichen unterstützt.

PolicyDescription: Dieses Unterelement kann freien Text enthalten, z. B. Kommentare, oder wie im obigen Beispiel eine Tabelle für das Änderungsprotokoll. Es werden maximal 1024 Zeichen unterstützt.

Nachdem Sie eine XML-Datei mit den zuvor beschriebenen Elementen erstellt haben, speichern Sie die Datei unter einem aussagefähigen Namen in Ihrem Arbeitsverzeichnis, bevor Sie damit beginnen, in der Datei die Ressourcen der End-to-End-Automationsdomäne zu definieren.