Redvers COBOL XML Interface

Transkript

2 Einführung Dieses Schriftstück wurde geschrieben, um unsere bestehenden Kunden bei der Implementierung des Redvers COBOL XML Interface Zwischenrelease zu unterstützen. Dieses Zwischenrelease wird Teil des Hauptrelease 2.9 im Jahr 2013 sein. Inhalte dieses Releases: Vorab geladene Entitätsreferenzwerte ermöglicht das Laden von nutzerdefinierten Entitätsreferenzen, z.b. Umlaute. Überschreiben von Document Type Definitions Generieren von XML- Dokumenten, die auf eine applikationsspezifische externe DTD verweisen. Mehrere XML Elemente in einem Feld XML-Elementstrukturen werden aus einem COBOL-Feld generiert bzw. in ein COBOL-Feld geladen. Wie auch schon in den vorigen Releases gibt es bei R keine Änderung des Formats der Parameter beim Aufruf, und daher ist es nicht notwendig, Ihre Anwendungsprogramme zu verändern - es sei denn, Sie möchten die neuen Funktionalitäten nutzen. Sie sind nicht verpflichtet, das Release zu installieren, wenn Sie die in dieser Anleitung beschriebenen zusätzlichen Funktionalitäten nicht benötigen. Redvers Consulting wird in absehbarer Zukunft Release 2.3 bis 2.8 weiter unterstützen. Redvers Consulting Ltd Seite 2

3 Vorab geladene Entitätsreferenzwerte Hintergrund Obwohl die vordefinierten XML Entitätsreferenzen (&, <, >, &apost; und &quot) in XML vollständig unterstützt werden, trifft das auf einige nicht-englische Zeichen (Akzente, Umlaute etc.) in geringerem Maße zu. Der XML-Syntax enthält EBCDIC und ASCII-Kodierungen für diese Zeichen, aber es kann schwierig sein, von/zu EBCDIC und ASCII-Formaten zu konvertieren, oder beim Datenaustausch mit anderen Computersystemen. Es ist eine sicherere Lösung, diese Zeichen als nutzerdefinierte Entitätsreferenzen darzustellen. In den Anfangsjahren von XML konnten Document Type Definitions (DTDs) dazu verwendet werden, Entitätsreferenzen zu deklarieren, passend zu jedem XML Dokumenttyp. Die vermehrte Verwendung von Schemata hat jedoch zu einem Rückgang von Entitäten, die in DTDs deklariert werden, geführt. Das Zwischenrelease trägt der Nachfrage nach erweiterter Unterstützung von Entitätsreferenzen Rechnung, indem Logik- und Speicherarten verwendet werden, die ursprünglich für DTD-deklarierte Entitätsreferenzen entwickelt wurden. Aktivierung Flag 28 (die 28. Stelle des Aktivierungsschlüssels) muss auf E gesetzt werden, und außerdem muss mindestens eine der beiden folgenden Optionen durchgeführt werden: Entitätsdeklarationen werden in die UMV-Tabelle im DTD-header des Interface Generators bzw. Parsers eingefügt, in derselben Form, wie sie in einer DTD kodiert würden, z.b.: <!ENTITY auml 'ä'>. Anwendungsspezifische Entitätsdeklarationen werden in Kommentarzeilen am Anfang der CRD eingefügt, beginnend an Position 8, z.b.: *<!ENTITY euro ' '>. Wenn beide oben beschriebenen Optionen gleichzeitig verwendet werden, so werden die Entitätsdeklarationszeilen aus der CRD an der Stelle leerer Zeilen in der UMV-Tabelle im DTD-header hinzugefügt, beginnend vom ersten Auftreten und dann ansteigend. Nachdem die Tabelle im DTD-header durch mögliche CRD-Entitätsdeklarationen aktualisiert wurde, werden die Entitätsnamen und ihre Werte in die Entitätstabelle innerhalb der neuen Logik Vorab geladene Entitätsreferenzwerte übertragen, beginnend mit der ersten Zeile der Tabelle im DTD-header. Redvers Consulting Ltd Seite 3

4 Wenn die Entitätslogik nach Übereinstimmungen sucht, beginnend mit dem ersten Eintrag in der Entitätstabelle, überschreiben Deklarationen, die sich weiter unten in der Tabelle befinden, etwaige gleichlautende Einträge weiter oben in der Tabelle. Daher können Deklarationen in der CRD vorgenommen werden, um Deklarationen, die fest in der Tabelle im DTD-header stehen, zu überschreiben oder zu ergänzen, je nachdem, ob es Leerzeilen am Anfang oder Ende der Tabelle im DTD-header gibt. Einschränkungen Damit die Ausführungsgeschwindigkeit des Generators nicht beeinträchtigt wird, können von den XML-Generatorprogrammen nur Entitätswerte generiert werden, die aus einem einzigen Zeichen bestehen. Die Parserprogramme können, wie bisher schon, auch Entitäten parsen, die aus mehreren Zeichen bestehen, da die Entitätslogik nur dann ausgelöst wird, wenn das & -Zeichen in den XML-Daten angetroffen wird. Da die Entitätstabelle auch dafür verwendet wird, Namespace-Details zu speichern, kann es nötig werden, die Größe der Entitätstabelle im Parser zu erhöhen, indem die UMV Maximum-number-of-entities angepasst wird. Beispiel DTD Header Tabelle (Generator) ** XML DTD header records: WS-DTD-HEADERS FILLER PIC X(100) VALUE SPACE *<UMV> DTD-header > ***** FILLER PIC X(100) VALUE "<!ENTITY auml 'ä'><!entity ouml 'ö'><!entity uuml 'ü'>" *<UMV> DTD-header ************************************************ FILLER PIC X(100) VALUE "<!ENTITY Auml 'Ä'><!ENTITY Ouml 'Ö'><!ENTITY Uuml 'Ü'>" *<UMV> DTD-header ************************************************ FILLER PIC X(100) VALUE " <!ENTITY szlig 'ß'> " *<UMV> DTD-header ************************************************ FILLER PIC X(100) VALUE SPACE *<UMV> DTD-header > ***** FILLER REDEFINES WS-DTD-HEADERS WS-DTD-HEADER PIC X(100) OCCURS *<UMV> Number-of-DTD-headers > *** Redvers Consulting Ltd Seite 4

5 CRD Inhalt *<!ENTITY #223 'ß'> *<!ENTITY #x40 <!ENTITY euro ' '> 01 TV-listings. 03 channel. 05 channel-number PIC TV-program. 07 prog-name PIC X(20). Fußball Bundesliga 07 prog-time PIC 10:00 07 prog-host PIC X(20). Günther Schäfer 07 prog-cost PIC, generiert: XML Dokument <TV-listings> <channel> <channel-number>05</channel-number> <TV-program> <prog-name>fußball Bundesliga</prog-name> 10:00</prog-time> <prog-host>günther Schäfer</prog-host> <prog-cost> 80,000</prog-cost> </TV-program> </channel> </TV-listings> In obigem Beispiel wird das ß in Fußball Bundesliga in seine numerische Zeichenreferenz &#223 umgewandelt, weil die <!ENTITY #223 'ß'> Deklaration in der CRD in die erste freie (mit Space gefüllte) Zeile, die in WS-DTD-HEADER auftritt (1) übertragen wurde, womit die Entity-Zeichenreferenzdeklaration ß in der 4. WS- DTD-HEADER-Zeile überschrieben wird. Die Umlaute in Günther Schäfer werden durch die Entity-Zeichenreferenzen ü und ä aus der zweiten WS-DTD-HEADER-Zeile und werden aus den CRD-Deklarationen <!ENTITY #x40 '@'> und <!ENTITY euro ' '> erzeugt und in der 5. WS-DTD-HEADER-Zeile gespeichert. Zum Parsen von nutzerdefinierten Entitäten in einem XML-Dokument wird umgekehrt vorgegangen, es werden also Entitätsdeklarationen genutzt, die in der (in den Parsermodulen neuen) UMV-Tabelle im DTD-header kodiert wurden, ggf. in Verbindung mit anwendungsspezifischen Entitätsdeklarationen, die sich in den Kommentarzeilen am Anfang der CRD befinden. Redvers Consulting Ltd Seite 5

6 Hinweis: In diesem Beispiel wird davon ausgegangen, dass zur Abgrenzung alphanumerischer Literale Anführungszeichen verwendet werden. Wie bei allen anderen UMV's im Header sind im Falle, dass Ihr Compiler Apostrophe zur Abgenzung alphanumerischer Literale nutzt, alle Apostrophe und Anführungszeichen zu vertauschen. Redvers Consulting Ltd Seite 6

7 Überschreiben von Document Type Definitions Hintergrund Frühere Releases des Redvers COBOL XML Interface boten Unterstützung für Document Type Definitions (DTD), indem es die UMV-Tabelle im XML-Header gab, in dem externe (SYSTEM) DTDs definiert werden konnten, oder die UMV-Tabelle im DTD-Header, um Zeilen am Anfang einer DTD zu definieren, die durch einen DTD CALL aufgerufen werden zu Einzelheiten siehe den Abschnitt Der Aufruf von RCCOBXML im Generatorhandbuch. Diese beiden Lösungen setzten jedoch eine Hartkodierung von DTD-Informationen in der Working Storage des Generatormoduls voraus, was die fallweise Anpassung der DTD schwierig machte. Mit diesem Release wurde die Möglichkeit geschaffen, anwendungsspezifische externe DTD-Daten anzugeben, indem zu Beginn der CRD Kommentarzeilen eingefügt werden - genau wie die Überschreibung der XML-Deklaration ab Release 2.8 durchgeführt wird. Aktivierung Fügen Sie die Document Type Declaration in einer/mehrerer Kommentarzeile(n) am Anfang der CRD ein, wobei <!DOCTYPE in Spalte 8 beginnen muss. Das muss vor den Felddefinitionen stehen. Redvers Consulting Ltd Seite 7

8 Beispiel CRD *** Anfang der COBOL Record Definition (CRD) * Es folgt eine ueberschreibende DTD: *<!DOCTYPE TV-listings SYSTEM ' *.dtd'> TV-listings channel. generiert: XML Dokument <?xml version="1.0" encoding "UTF-8"?>  <!DOCTYPE TV-listings SYSTEM ' <TV-listings> <channel> Redvers Consulting Ltd Seite 8

9 Mehrere XML Elemente in einem Feld Hintergrund Das Redvers COBOL XML Interface generiert oder parst XML auf der Grundlage einer eins-zu-eins Beziehung zwischen in der CRD definierten COBOL-Feldern und XML- Elementen oder -Attributen. Mit Release wird die Möglichkeit eingeführt, Gruppen von XML-Elementen und -Attributen mit einem einzigen CRD-Feld zu generieren oder zu parsen. Die neue Verarbeitungslogik, die dafür geeignet ist, mit XML Mark-up innerhalb von CDATA Sections umzugehen, in Verbindung mit einer neuen überschreibenden Füllkonstante, die C heisst. Die überschreibende Füllkonstante C ist die einzige Füllkonstante, die in den Generatormodulen Verwendung findet. Diese neue Funktionalität kann sinnvoll sein, wenn ein Anwendungsprogramm den Inhalt eines bestimmten Elementes verändern muss, ohne das XML in der Umgebung anzufassen. Aktivierung Um eine Gruppe von XML-Elementen und -Attributen mit einem CRD-Feld zu verarbeiten, müssen Sie eine überschreibenden Füllkonstante, die C heisst, dem entsprechenden Eltern-CRD-Feld der XML-Gruppe hinzufügen. Beispiel: <override_name/c>. Hinweis: Wenn der COBOL-Feldname nicht überschrieben werden muss, kann statt des überschreibenden Namens auch ein SPACE verwendet werden: < /c>. Redvers Consulting Ltd Seite 9

10 Beispiel XML Eingabe <TV-listings> <broadcast-date>10/01/2012</broadcast-date> <TV-program> <prog-name>sunday Night Live</prog-name> <prog-time>10:00</prog-time> <prog-rating>8</prog-rating> </TV-program> </TV-listings> führt zu: Felder in der CRD Inhalt 01 TV-LISTINGS. 03 broadcast-date PIC 9(8) TV-PROGRAM * <TV-program/C> PIC X(200). <prog-name>sunday Night Live</prog-name><progtime>10:00</prog-time><prograting>8</prog-rating> Wenn ein Anwendungsprogramm das oben aufgeführte XML-Dokument parsen möchte, um den Inhalt von <broadcast-date> zu aktualisieren und dann das XML neu zu generieren, kann das mit dem folgenden Code bewirkt werden: Anwendungscode PERFORM CALL-RCXMLCOB UNTIL FEEDBACK CODE = MOVE TO BROADCAST-DATE PERFORM CALL-RCXMLCOB MOVE HIGH-VALUES TO TV-LISTINGS PERFORM CALL-RCXMLCOB. erzeugt: XML Dokument <TV-listings> <broadcast-date>10/08/2012</broadcast-date> <TV-program> <prog-name>sunday Night Live</prog-name> <prog-time>10:00</prog-time> <prog-rating>8</prog-rating> </TV-program> </TV-listings> Redvers Consulting Ltd Seite 10