ResponseConfiguration

10 mois ago

m.lemaire@yoocan.fr

2 minutes

Objet générique permettant de définir quoi faire de la sortie d’un appel externe (appel Rest, création d’un contenu moteur, chargement de fichier…)

Xml

<response type=’var|xml|html|json|file|textfile|base64file’ varName=’nom de la variable de sortie’ encoding=’cas texte, encoding de la sortie’ > 
  <namespace prefix=’’>pour les XML, définitions des préfixes pour le xpath</namespace>
  <saveFile fileName=’nom du fichier’ contentType=’content type attendu pour la réponse’ extension=’extension du fichier dans le cas zip’ zip=’1 si la sortie doit être compressée’ section=’section du IFileSaver à utiliser’>
    Contenu de la configuration du IFileSaver
  </saveFile>
</data>

Explication des variables

Le fonctionnement de la réponse dépend de l’attribut type :

var : récupère la sortie en texte et met le contenu dans une variable (varName)
xml : récupère la sortie, le passe dans un XmlDocument et met le contenu dans une variable Xml. Si le contenu est du json, il est automatiquement converti.
html : récupère la sortie, le passe dans un HtmlDocument et met le contenu dans une variable Html. Si le contenu est du json, il est automatiquement converti.
json : récupère la sortie, le passe dans une variable json.
file ou textfile (identique mais fichier texte) : utilise le contenu de SaveFile pour enregistrer le contenu du fichier, puis renvoie dans varName un objet de type File.

La balise saveFile permet d’indiquer et de paramétrer le mode de sauvegarde du fichier s’il s’agit d’un fichier.

Méthodes de l’objet

Configure(XmlElement) : lance la configuration de l’objet, à utiliser dans la méthode Configure de l’IWorkflowAction.

OpenStream(WorkflowExecutionContext cont, String contentType, String otherName) : renvoie un Stream généré à partir du paramétrage, avec le contentType pour information, et le nom du fichier.

AfterStream(WorkflowExecutionContext cont) : procédure lancée à la fin pour libérer les éventuelles ressources externes.

Execute(WorkflowExecutionContext cont, Stream resp, string tracelog, String contentType, String otherName) : effectue l’action expliquée dans la partie paramétrage.