XML_OPEN

Fonction de script : Ouvre un document XML en vue du traitement.

Syntaxe

XML_OPEN (DOCU, [Object Name], @Documentation )
XML_OPEN
(REPORT, [RunID], Report )
XML_OPEN (STRING, String )

Syntaxe

Description / format

Source

Origine du document XML
Format: Nom AE, littéral de script ou variable de script

Valeurs autorisées : DOCU, REPORT et STRING

DOCU : documentation structurée
REPORT : rapport d'un job SAP
STRING : XML au format d'une chaîne.

Pour les documentations structurées :

Object Name

Nom de l'objet.
Format : littéral de script ou variable de script

Ce paramètre est optionnel s'il s'agit de l'onglet de l'objet considéré.

Documentation

Nom de l'onglet de documentation commençant par "@"
Format : littéral de script ou variable de script

Pour les rapports :

RunID

Numéro d'exécution (RunID) de la tâche dont le rapport doit être ouvert.
Format : littéral de script ou variable de script

Ce paramètre est optionnel s'il s'agit du rapport de l'objet considéré.

Report

Type de rapport XML (Rapports)

Pour les chaînes de caractères :
String

Chaîne de caractères contenant le XML.
Format : variable de script ou litéral de script


Code retour

Référence du document XML

La fonction de script ouvre un document XML en vue du traitement. Il peut s'agir d'une documentation structurée ou du rapport d'un job SAP.

Pour ajouter des descriptions et des explications, vous pouvez utiliser les onglets de documentation. Vous pouvez les définir dans les variables UC_OBJECT_DOCU de chaque type d'objet. La documentation structurée constitue un type spécifique de description caractérisée par un "@" placé en tête. La documentation structurée peut être traitée avec des éléments de scripts spécifiques. 

Les rapports des jobs SAP sont enregistrés sous forme de documents XML. Pour XI_GET_CHANNEL, ils contiennent la liste des canaux de communication sélectionnés.

Le code retour de cette fonction de script est un descripteur qui réfère au document XML. Certains éléments de script utilisés pour traiter le document XML utilisent ce descripteur comme paramètre.

Vous pouvez fermer le document XML en utilisant XML_CLOSE.

Vous ne pouvez ouvrir qu'un seul document XML à la fois.

Exemples

Dans cet exemple, l'onglet Détails de l'objet MM.DAY s'ouvre pour la poursuite du traitement.

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

Cet exemple illustre l'ouverture d'un document XML avec une chaîne de caractères.

: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

Un chaîne XML incorrecte provoque une erreur d'exécution ou renvoie un code retour qui peut être lu avec sys_last_err_nr().

Voir aussi :

voiraussi

Fonctions de script pour les éléments XML