Verified Commit 1c89804c authored by Giovannoni Laurent's avatar Giovannoni Laurent
Browse files

init doc

parent 337d5490
......@@ -78,7 +78,7 @@ Depuis le fichier de paramétrage de la boite mail à capturer : **./modules/Ma
</process>
</MaarchWSClient>
#### Déclaration du frontal :
### Déclaration du frontal :
<!-- REST FRONTAL -->
<WS name="MaarchRestWS" type="REST" uri="http://superadmin:superadmin@127.0.0.1/MaarchCourrier/rest/" />
<!-- SOAP FRONTAL -->
......@@ -96,7 +96,7 @@ Depuis le fichier de paramétrage de la boite mail à capturer : **./modules/Ma
* **WS SSL** flag permettant d’indiquer si le frontal de webservice utilise le protocole SSL. Prend true ou false comme valeur. Utile uniquement dans le cas d’un frontal SOAP.
* **WS proxy** dans le cas d’un frontal SOAP uniquement, il faut spécifier ici l’identifiant et le mot de passe d’accès à l’application.
#### Déclaration des webservices :
### Déclaration des webservices :
<process name="MaarchRestWSProcessFromScan">
<loop xpath="/Batch/Documents/Document">
......@@ -107,7 +107,7 @@ Depuis le fichier de paramétrage de la boite mail à capturer : **./modules/Ma
* **call name** désigne le webservice à contacter.
* **call method** dans le cas du protocole REST uniquement, précise la méthode HTTP à appliquer. Peut prendre GET, POST, UPDATE ou DELETE comme valeur. Cette liste de valeurs est également dépendante des possibilités du webservice contacté.
#### Passage des paramètres aux webservices :
### Passage des paramètres aux webservices :
<argument type="entity" name="encodedFile" eval="base64_encode(file_get_contents($Element-&gt;path))"/>
<argument type="entity" name="fileFormat" attribute="extension"/>
......@@ -117,7 +117,7 @@ Depuis le fichier de paramétrage de la boite mail à capturer : **./modules/Ma
* **argument type** uniquement dans le cas d’un webservice de type REST. Définit si le paramètre est passé dans le body ou l’entête HTTP de l’appel au webservice. Peut prendre comme valeur entity (body) ou query (entête). Cette liste de valeurs est également dépendante des possibilités du webservice contacté.
* **argument attribute** permet d’aller récupérer dans le fichier XML de traitement du batch un attribut du document ou de la pièce jointe capturée.
#### Passage des valeurs des paramètres :
### Passage des valeurs des paramètres :
<argument type="entity" name="data">
<column>doc_date</column>
......@@ -134,7 +134,7 @@ Depuis le fichier de paramétrage de la boite mail à capturer : **./modules/Ma
* **value metadata** permet d’aller récupérer une valeur positionnée par un autre module (ex : MailCapture) dans le fichier XML de traitement du batch du document ou de la pièce jointe capturée.
* **value xvalue** permet d’aller récupérer via une recherche XML une valeur positionnée par un autre module (ex : MailCapture) dans le fichier XML de traitement du batch du document ou de la pièce jointe capturée.
#### Paramétrage du retour du web service :
### Paramétrage du retour du web service :
<return>
<resId metadata="resId" />
......
......@@ -173,7 +173,7 @@ Le paramétrage type pour l’envoi de scans ou de courriels dans une instance M
</process>
</MaarchWSClient>
Les éléments de paramétrage suivants sont à définir pour une instannce MaarchCourrier :
Les éléments de paramétrage suivants sont à définir pour une instance MaarchCourrier :
* **uri="http://userMaarchWS:passwordMaarchWS@maarchcourrier.ID\_INSTANCE.interieur.gouv.fr/rest/"** adresse web des webservices de l’instance MaarchCourrier ID_INSTANCE. Attention à bien respecter la structure suivante : **http://loginMaarch:passwordMaarch@nomDeDomaineInstanceMaarchCourrier**.
* **\<argument type="entity" name="status">INIT\</argument>** statut des documents arrivant dans MaarchCourrier.
A paramétrer en fonction de la clause where de la bannette de qualification des courriels.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment