ONYX - 9.0 - Utilisation - mapSoapRunStreamFromPost
Différence entre versions
De MappingDoc
(Page créée avec « mapSoapRunStreamFromPost est une méthode du WebService "mapsoapserver.exe". ») |
(Balise : Éditeur visuel) |
||
| Ligne 1 : | Ligne 1 : | ||
| − | mapSoapRunStreamFromPost est une méthode du WebService "mapsoapserver.exe". | + | === Introduction === |
| + | mapSoapRunStreamFromPost est une méthode du WebService "mapsoapserver.exe" | ||
| + | |||
| + | Cas d'usage : | ||
| + | |||
| + | * Envoyer un fichier à Mapping pour récupérer de manière synchrone un fichier réponse (envoi d'un XML et réception d'un PDF en retour par exemple) | ||
| + | * Envoyer un fichier de grande taille à Mapping, pour un traitement asynchrone | ||
| + | |||
| + | === Utilisation === | ||
| + | |||
| + | * Contrairement à la méthode mapUploadFile, l'utilisation de mapSoapRunStreamFromPost permet d'invoquer un workflow | ||
| + | * Le contenu du fichier doit être passé directement à la place de l'enveloppe XML, tel quel (pas d'encodage en base64) | ||
| + | * Tous les paramètres <key/value> doivent être passés exclusivement dans l'URL (il n'y a pas d'enveloppe XML) | ||
| + | * Dans le workflow : | ||
| + | ** Les couples key/value sont récupérables sous forme de variables [%xxxx%] | ||
| + | ** Le fichier est identifié par [%MAP_FILE_IN%] | ||
| + | |||
| + | === Exemple d'invocation === | ||
| + | <code>curl -u mapadmin:mapadmin -X POST --data-binary "@/tmp/mon_fichier.pdf" "http://192.168.100.14:8002/cgi-bin/mapsoapserver.exe/mapSoapRunStreamFromPost?workflow=testsoap&key=macle1&value=mavaleur1&key=macle2&value<nowiki/>=mavaleur2"</code> | ||
| + | |||
| + | |||
| + | <u>Remarques</u> : | ||
| + | |||
| + | * La présence du @ dans l'option --data-binary permet de spécifier qu'il s'agit d'un fichier. | ||
| + | * Si l'un des paramètres "key" a pour valeur "'''worfklow'''", cela permet de spécifier le nom du workflow à invoquer. S'il n'est pas renseigné, c'est le workflow "root" qui est appelé. | ||
| + | * "macle1" et "mapcle2" sont 2 méta données récupérables dans le workflow. | ||
| + | |||
| + | <br /> | ||
| + | |||
| + | === Exemple de workflow === | ||
| + | |||
| + | * La variable param1 récupère le contenu de macle1 | ||
| + | * La variable param2 récupère le contenu de macle2 | ||
| + | * La boite "Print" permet d'envoyer le fichier dans la file d'attente "MON_ENTRY" | ||
| + | ** La coche "Ajouter les paramètres courants" permettent de transmettre les variables param1 et param2 avec le fichier dans la file d'attente "MON_ENTRY" | ||
| + | |||
| + | <br /> | ||
| + | [[Fichier:OX S workflow mapsoaprunstreamfrompost1.png|vignette]] | ||
| + | [[Fichier:OX S Workflow mapsoaprunstreamfrompost2.png|vignette]] | ||
| + | |||
| + | |||
| + | |||
Version du 26 mars 2019 à 14:18
Introduction
mapSoapRunStreamFromPost est une méthode du WebService "mapsoapserver.exe"
Cas d'usage :
- Envoyer un fichier à Mapping pour récupérer de manière synchrone un fichier réponse (envoi d'un XML et réception d'un PDF en retour par exemple)
- Envoyer un fichier de grande taille à Mapping, pour un traitement asynchrone
Utilisation
- Contrairement à la méthode mapUploadFile, l'utilisation de mapSoapRunStreamFromPost permet d'invoquer un workflow
- Le contenu du fichier doit être passé directement à la place de l'enveloppe XML, tel quel (pas d'encodage en base64)
- Tous les paramètres <key/value> doivent être passés exclusivement dans l'URL (il n'y a pas d'enveloppe XML)
- Dans le workflow :
- Les couples key/value sont récupérables sous forme de variables [%xxxx%]
- Le fichier est identifié par [%MAP_FILE_IN%]
Exemple d'invocation
curl -u mapadmin:mapadmin -X POST --data-binary "@/tmp/mon_fichier.pdf" "http://192.168.100.14:8002/cgi-bin/mapsoapserver.exe/mapSoapRunStreamFromPost?workflow=testsoap&key=macle1&value=mavaleur1&key=macle2&value=mavaleur2"
Remarques :
- La présence du @ dans l'option --data-binary permet de spécifier qu'il s'agit d'un fichier.
- Si l'un des paramètres "key" a pour valeur "worfklow", cela permet de spécifier le nom du workflow à invoquer. S'il n'est pas renseigné, c'est le workflow "root" qui est appelé.
- "macle1" et "mapcle2" sont 2 méta données récupérables dans le workflow.
Exemple de workflow
- La variable param1 récupère le contenu de macle1
- La variable param2 récupère le contenu de macle2
- La boite "Print" permet d'envoyer le fichier dans la file d'attente "MON_ENTRY"
- La coche "Ajouter les paramètres courants" permettent de transmettre les variables param1 et param2 avec le fichier dans la file d'attente "MON_ENTRY"
