ONYX - 9.0 - Utilisation - mapSoapRunStreamFromPost
Différence entre versions
De MappingDoc
(Balise : Éditeur visuel) |
(Balise : Éditeur visuel) |
||
| Ligne 1 : | Ligne 1 : | ||
| − | === Introduction === | + | ===Introduction=== |
mapSoapRunStreamFromPost est une méthode du WebService "mapsoapserver.exe" | mapSoapRunStreamFromPost est une méthode du WebService "mapsoapserver.exe" | ||
Cas d'usage : | 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 à 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 | + | *Envoyer un fichier de grande taille à Mapping, pour un traitement asynchrone |
| − | === Utilisation === | + | ===Utilisation=== |
| − | * Contrairement à la méthode mapUploadFile, l'utilisation de mapSoapRunStreamFromPost permet d'invoquer un workflow | + | *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) | + | *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) | + | *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 : | + | *Dans le workflow : |
| − | ** Les couples key/value sont récupérables sous forme de variables [%xxxx%] | + | **Les couples key/value sont récupérables sous forme de variables [%xxxx%] |
| − | ** Le fichier est identifié par [%MAP_FILE_IN%] | + | **Le fichier est identifié par [%MAP_FILE_IN%] |
| − | === Exemple | + | ===Exemple de requête SOAP=== |
<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> | <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> | ||
| Ligne 22 : | Ligne 22 : | ||
<u>Remarques</u> : | <u>Remarques</u> : | ||
| − | * La présence du @ dans l'option --data-binary permet de spécifier qu'il s'agit d'un fichier. | + | *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é. | + | *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. | + | *"macle1" et "mapcle2" sont 2 méta données récupérables dans le workflow. |
| + | |||
| + | ===Exemple de workflow pour traitement asynchrone=== | ||
| + | |||
| + | *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" | ||
| + | **Le fichier transmis dans le flux du WebService est [%MAP_FILE_IN%] | ||
| + | **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 /> | <br /> | ||
| + | [[Fichier:OX S workflow mapsoaprunstreamfrompost1.png|vignette|alt=|centré|200x200px]] | ||
| + | [[Fichier:OX S Workflow mapsoaprunstreamfrompost2.png|vignette|alt=|centré|600x600px]] | ||
| + | |||
| + | |||
| − | === Exemple de workflow === | + | ===Exemple de workflow pour traitement synchrone=== |
| − | * La variable param1 récupère le contenu de macle1 | + | *La variable param1 récupère le contenu de macle1 |
| − | * La variable param2 récupère le contenu de macle2 | + | *La variable param2 récupère le contenu de macle2 |
| − | * | + | *Composition du document XML en XPS |
| − | ** | + | *Conversion du XPS en PDF |
| + | *Envoi du résultat dans la réponse de la requête SOAP | ||
<br /> | <br /> | ||
| − | [[Fichier:OX S | + | [[Fichier:OX S mapsoaprunstreamfrompost.png|centré|vignette|287x287px]] |
| − | [[Fichier:OX S | + | [[Fichier:OX S mapSoapRunStreamFromPost.png|centré|vignette|800x800px]] |
| − | + | <br /> | |
| − | |||
| − | |||
Version du 26 mars 2019 à 14:37
Sommaire
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 de requête SOAP
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 pour traitement asynchrone
- 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"
- Le fichier transmis dans le flux du WebService est [%MAP_FILE_IN%]
- 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"
Exemple de workflow pour traitement synchrone
- La variable param1 récupère le contenu de macle1
- La variable param2 récupère le contenu de macle2
- Composition du document XML en XPS
- Conversion du XPS en PDF
- Envoi du résultat dans la réponse de la requête SOAP
