Automation Engine Script-Leitfaden > Funktionelle Gliederung > Objekte lesen oder verändern > XML_OPEN

XML_OPEN

Scriptfunktion: Öffnet ein XML-Dokument für die Bearbeitung.

Syntax

XML_OPEN (DOCU, [Object Name], @Documentation)

XML_OPEN (REPORT, [RunID], Report)

XML_OPEN (STRING, String)

Syntax

Beschreibung/Format

Quelle

Herkunft des XML-Dokumentes.
Format: AE-Name, Script-Literal oder Script-Variable

Erlaubte Werte: DOCU, REPORT und STRING

DOCU - Strukturierte Dokumentation
"REPORT" - Report eines SAP-Jobs
STRING - XML in Form einer Zeichenkette.

Für strukturierte Dokumentationen

Objektname

Name des Objektes.
Format: Script-Literal oder Script-Variable

Handelt es sich um die Registerkarte des eigenen Objektes, so ist dieser Parameter optional.

Dokumentation

Name der Dokumentations-Registerkarte mit vorangestelltem "@".
Format: Script-Literal oder Script-Variable

Für Reports

RunID

Laufende Nummer (RunID) der Aufgabe, deren Report geöffnet werden soll.
Format: Script-Literal oder Script-Variable

Handelt es sich um den Report des eigenen Objekts, so ist dieser Parameter optional.

Report

Typ des XML-Reports

Für Zeichenketten  
Zeichenkette

Zeichenkette, welche das XML enthält.
Format: Script-Variable oder Script-Literal


Rückgabewert

Verweis auf das XML-Dokument

Anmerkungen

Die Scriptfunktion öffnet ein XML-Dokument für die Bearbeitung. Dabei kann es sich um eine strukturierte Dokumentation oder den Report eines SAP-Jobs handeln.

Um Objekten nähere Beschreibungen und Erklärungen hinzuzufügen, können Registerkarten zur Dokumentation verwendet werden. Diese sind in der Variable UC_OBJECT_DOCU für die einzelnen Objekttypen definiert. Eine spezielle Form der Darstellung ist die strukturierte Dokumentation, welche durch ein vorangestelltes "@" gekennzeichnet wird. Die strukturierte Dokumentation können Sie mit speziellen Script-Sprachmitteln auslesen. 

Reports von SAP-Jobs werden als XML-Dokumente abgelegt. Sie enthalten beispielsweise für XI_GET_CHANNEL eine Liste der selektierten Kommunikationskanäle.

Der Rückgabewert der Scriptfunktion ist ein Handle, ein Verweis auf das XML-Dokument. Dieser Handle wird von einigen Script-Sprachmitteln, mit denen Sie das XML-Dokument bearbeiten, als Parameter verwendet.

:XML_CLOSE schließt das XML-Dokument.

Es kann immer nur ein XML-Dokument zur gleichen Zeit geöffnet werden.

In früheren Automation Engine-Releases wurde diese Scriptfunktion XML_OPEN_DOCU in XML_OPEN umbenannt. Die alte Schreibweise wird weiterhin unterstützt.

Beispiele

In diesem Beispiel wird die Registerkarte Details des Objekts MM.DAY zur weiteren Bearbeitung geöffnet.

:SET &XMLDOCU# = XML_OPEN(DOCU,"MM.DAY", "@Details")

Dieses Beispiel öffnet ein XML-Dokument mit einer Zeichenkette.

:set &ref# xml_open('STRING','<xmlstring>')
:set &ref# = sys_last_err_nr()
:if &ret > 0
:  set &txt# = sys_last_err_ins()
!   implement error handling here
:endif

Eine falsche Zeichenkette führt entweder zu einem Laufzeitfehler oder liefert einen Rückgabewert, der mit sys_last_err_nr() gelesen werden kann.

Siehe auch:

Script-Sprachmittel Beschreibung

:XML_CLOSE

Schließt ein XML-Dokument.

Script-Sprachmittel - Objekte lesen oder verändern

Strukturierte Dokumentation

www.w3c.org/TR/xmlbase

Beispielsammlung:
Ermittlung der Fehlermeldung und -nummer

Allgemeines zum Script
Script-Sprachmittel - Alphabetische Auflistung

Script-Sprachmittel - Funktionelle Gliederung

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH