XML Generate-Anweisung

Funktion

Die XML GENERATE-Anweisung konvertiert Daten in ein XML-Dokument.

Format

---

XML GENERATE datenname-1

        FROM datenname-1

       [COUNT IN datenname-3]

  [ON EXCEPTION unbedingte-anweisung-1]

  [NOT ON EXCEPTION unbedingte-anweisung-2]

  [END-XML]

---

Syntaxregeln

1. datenname-1 ist für das generierte XML-Dokument als Ausgabeoperand festgelegt.

2. Die Gruppe oder das Basisdatenelement datenname-2 wird in das XML-Dokument konvertiert.

3. datenname-3 enthält die Anzahl der generierten XML-Zeichen.
4. Die Operanden datenname-1, datenname-2 und datenname-3 dürfen sich nicht überlappen.

Allgemeine Regeln

1. Das Datenfeld datenname-1 muss groß genug sein, damit er das generierte XML-Dokument enthalten kann und kann eines der folgenden Elemente referenzieren:
   • ein Datenelement oder eine Gruppe der Kategorie alphanumerisch;
   • ein Datenelement oder eine Gruppe der Kategorie national.
   Wenn der Inhalt von bezeichner-1 während der Ausführung der XML PARSE-Anweisung geändert wird, ist das weitere Verhalten undefiniert.
2. datenname-2 darf nicht mit der RENAMES-Klausel beschrieben sein.
   Die folgenden durch datenname-2 spezifizierten Datenfelder werden von der XML GENERATE-Anweisung ignoriert:
   • Jedes unbenannte oder FILLER-Datenfeld oder einem solchen untergeordnete Datenfeld.
   • Jedes mit USAGE POINTER, PROGRAM-POINTER oder OBJECT REFERENCE definierte Datenfeld.
   • Jedes datenname-2 untergeordnete Datenfeld, dessen Datenerklärung die REDEFINES-Klausel enthält oder einem solchen Datenfeld untergeordnet ist.
   • Jedes datenname-2 untergeordnete Datenfeld, dessen Datenerklärung die RENAMES-Klausel enthält.
   • Jedes datenname-2 untergeordnete Datenfeld, das innerhalb der direkt übergeordneten Gruppe einen nicht eindeutigen Namen auf gleichem Level hat oder einem solchen Datetenfeld untergeordnet ist.
   • Jede datenname-2 untergeordnete Gruppe, die nicht mindestens ein elementares Datenfeld der Kategorien alphabetisch, alphanumerisch, numerisch, national oder Index enthält.
3.  datenname-3 muss ein ganzzahliges Datenelement sein und enthält nach Ausführung der XML GENERATE-Anweisung die Anzahl der Zeichen des generierten XML-Dokuments.

4. Nach der Ausführung der XML GENERATE-Anweisung enthält das Sonderregister XML-CODE entweder null, was eine erfolgreich Durchführung bedeutet oder einen Ausnahmecode der ungleich null ist..

   XML-CODE	Beschreibung
   0	Das Empfangsfeld enthält das erfolgreich generierte XML-Dokument. Das COUNT [IN] Datenfeld enthält die Anzahl der Zeichen im generierten XML-Dokument.
   400	sofortige Beendigung der Anweisung mit 'Fehler'
   2999	sofortige Beendigung der Anweisung mit 'Fehler

5. Wenn während der Generierung des Dokuments ein Fehler auftritt (XML-CODE <> 0), wird unbedingte-anweisung-1, falls angegeben, ausgeführt und zum Ende der XML GENERATE-Anweisung verzweigt.
6. Wenn die Generierung des Dokuments ohne Fehler beendet wird (XML-CODE = 0), wird unbedingte-anweisung-2, falls angegeben, ausgeführt und zum Ende der XML GENERATE-Anweisung verzweigt.
7. Beim Erstellen des XML-Dokuments befolgt XML GENERATE folgende Regeln:
• Der Inhalt jedes nicht ignorierten elementaren Datenfeldes von datenname-2 wird in ein abdruckbares Format konvertiert. Nachgestellte Leerzeichen und führende Nullen werden eliminiert.
• Alle übrigen Instanzen der fünf Sonderzeichen & (kaufmännisches Und-Zeichen), ’ (Apostroph), > (größer als), < (kleiner als), und “ (Anführungsstriche) werden in die äquivalente XML-Referenz ’&amp;’, ’&apos;’, ’&gt;’, ’&lt;’ bzw. ’&quot;’ konvertiert.
• Der transformierte Inhalt wird als Zeichenelementinhalt in das XML-Markup eingefügt.
• Die XML-Elementnamen werden von der Definition von datenname-2 und diesem untergeordneten Datennamen abgeleitet. Die Namen von Gruppenfeldern werden in die übergeordneten XML-Namen übernommen.
• Wenn datenname-1 national ist, werden alle nicht nationalen Daten in das nationale (UTF16) Format konvertiert und umgekehrt, wenn datenname-1 nicht national ist werden alle nationalen Daten in das alphanumerische Format (EBCDIC) konvertiert.