Manuel des Scripts Automation Engine > Organisation fonctionnelle > Modification d'objets > EXPORT

EXPORT

Fonction de script : Exporte les objets dans un fichier XML.

Syntaxe

EXPORT(Folder, File [,Include_External_Objects])

EXPORT(Object, File [, ,Include_Referenced_Objects])

Syntaxe

Description / format

Objet

Nom du ou des objets à exporter (avec des caractères génériques).
Format : littéral de script ou variable de script

Vous pouvez utiliser les caractères génériques "*" et "?". "*" signifie n'importe quelle chaîne de caractères et "?" exactement un caractère.

Dossier Le nom du dossier (qui vient compléter les indications du chemin) que vous souhaitez exporter.
Format : littéral de script ou variable de script

Fichier

Nom du fichier avec chemin complet dans lequel les objets doivent être exportés.
Format : littéral de script ou variable de script
Include_External_Objects

Valeurs autorisées : "Y(es)" ou "N(o)"

Valeur par défaut : "N"

Si vous configurez cette valeur à "Y", les objets externes seront aussi exportés.

Ceci est uniquement important pour les dossiers. Le paramètre sera ignoré en combinaison avec d'autres types d'objets.
Include_Referenced_Objects

Valeurs autorisées : "Y(es)" ou "N(o)"

Valeur par défaut : "N"

Si vous configurez cette valeur à "Y", les objets référencés sont aussi exportés (de manière récurrente). Les objets référencés sont des objets utilisés par un objet donné, telles que les tâches dans un Workflow ou dans les PromptSets.

Non pris en charge avec les dossiers ou les caractères générique.

Les exceptions sont les objets de référence suivants, qui seront exclus lorsque vous utilisez ce paramètre et la valeur "Y":

  • Objet Login et Agents
  • Objets référencés dans les fonctions de script autres que :INC
  • Variables indiquées dans les champs d'attributs entre des accolades {VARANAME}
  • Objets référncés dans les conditions au niveau de la tâche dans un workflow
  • Objets situés dans le client de système 0000

Code retour

"0" - L'exportation a réussi.
"20693" - L'objet n'existe pas.
"21723" - Le fichier cible existe et est protégé en écriture.

Commentaires

Avec cette fonction de script, vous pouvez exporter des objets ou des structures de dossier dans un fichier XML précis. Le code retour de la fonction de script est égal à zéro si l'exportation réussit.

Quand vous exportez des structures de dossier, vous retrouverez les informations relatives à la structure du dossier en haut du fichier XML.
Au cours de l'exportation, tous les objets de dossier, et de non-dossier ainsi que les sous-dossiers et les objets liés sont inclus.

Lors de l'importation, un nouveau dossier ##INCLUDED_EXTERNALS## sera créé au même niveau que le dossier dédié sur le système cible.
Les objets liés seront stockés dans le dossier ##INCLUDED_EXTERNALS##.
Pour obtenir les détails de l'importation, vous pouvez aussi consulter les informations sur l'élément de script IMPORT.

La fonctionnalité d'importation et d'exportation n'est pas adaptée aux transports de masse ! Utilisez plutôt le conteneur Transport à cet effet.

L'instruction de script :ON_ERROR permet de définir la réaction en cas d'exportation erronée. Vous pouvez analyser l'erreur avec les fonctions de script pour le traitement des erreurs. Le traitement du script se poursuit. Toutefois, vous avez également la possibilité de l'interrompre.

Avant le processus d'exportation, le système vérifie si le fichier existe déjà. Dans ce cas, il est remplacé. S'il est protégé en écriture, l'exportation ne peut pas être exécutée.

 L'exportation échoue lorsque l'utilisateur ne possède pas le droit "Lire" (R) sur l'objet.

Vous trouverez des informations complémentaires sur le processus d'exportation dans le rapport d'activation de l'objet réalisant l'exportation.

Dans un environnement AE distribué (où les processus de travail sont exécutés sur plusieurs ordinateurs), vous ne pouvez pas déterminer l'ordinateur sur lequel l'exportation sera effectuée. Vous devez donc indiquez le chemin UNC sous Windows. Notez que le serveur doit être exécuté sous un utilisateur de domaine approprié pour accéder aux noms UNC. Si un serveur UNIX est utilisé, le chemin absolu doit être indiqué en langage UNIX. Le système de fichier doit aussi être accessible (NFS, commande mount), bien qu'il ne joue aucun rôle sur la machine où il se trouve. C'est le seul moyen de s'assurer que le fichier XML souhaité est également utilisé. 

L'instruction de script écrit toutes les transactions ouvertes du script dans la base de données AE.

Exemples

Dans l'exemple suivant, pour Windows et UNIX, tous les objets commençant par "MM.DAY" sont exportés. Le nom de l'objet et le nom du dossier sont transmis à la fonction sous forme de variable de script.

Pour Windows :

:SET &OBJECT# = "MM.DAY*"
:SET &FILE#  = "\\PC\ ae \EXPORT\ ae _export.xml"
:SET &RET#   = EXPORT(&OBJECT#,&FILE#)

Pour UNIX :

:SET &OBJECT# = "MM.DAY*"
:SET &FILE#  = "/opt/ ae /import/ ae _export.xml"
:SET &RET#    = EXPORT(&OBJECT#,&FILE#)

L'exemple suivant exporte une structure de dossier :

:SET &RET# = EXPORT ("\TESTFOLDER\EXPORT_STRUCTURE", "\\PC\ae\EXPORT\ae_export.xml", "Y")

This example exports a workflow with references:

:SET &RET# = EXPORT ("EXAMPLE_WORKFLOW", "\\PC\ae\EXPORT\ae_export.xml", ,"Y")

 

Rubriques connexes :

Elément de script Description

IMPORT

Importe des objets d'un fichier XML.

Eléments de script - Traitement des objets

Importation et exportation d'objets

Généralités sur les scripts
Eléments de script - Liste alphabétique
Eléments de script - Répartition fonctionnelle