# DOCAPOSTESEND

## Aperçu

L'application de workflow **DOCAPOSTESEND** vous permet d'envoyer un ou plusieurs documents à Docaposte pour signature électronique.

## Mode de fonctionnement

* L'application DOCAPOSTESEND crée une enveloppe unique et l'envoie à un ou plusieurs signataires.<br>
* Vous pouvez spécifier un ou plusieurs fichiers par action DOCAPOSTESEND. Pour ce faire, utilisez le paramètre `FILEx`, où `x` correspond au numéro de fichier (p.ex. : `FILE1`). Au moins un fichier est requis.<br>
* Vous pouvez spécifier un ou plusieurs signataires. Pour ce faire, utilisez la combinaison de `SIGNER_FIRSTNAME_LIST` ,`SIGNER_LASTNAME_LIST`et `SIGNER_EMAIL_LIST`. Vous pouvez également utiliser `SIGNER_FIRSTNAMEx` ,`SIGNER_LASTNAMEx`et `SIGNER_EMAILx`, où `x` correspond au numéro du signataire.<br>
* Vous pouvez spécifier un type de signature par destinataire. Pour ce faire, selon la méthode que vous utilisez pour spécifier les signataires (avec ou sans `_LIST`), vous pouvez utiliser `SIGNATURE_TYPE_LIST` ou `SIGNATURE_TYPEx`, où `x` correspond au numéro du signataire.\
  Valeurs possibles : `OTP`(défaut), `PAD`, `TOKEN`, `CONSENT_PROOF` ou `IDENTITY`.<br>
* Des logs d'application sont disponibles. Ceux-ci peuvent être spécifiés en définissant la valeur du paramètre `DocaposteSendLogLevel` dans le fichier `web.config` sur `0` pour désactiver la journalisation, `1` pour les logs d'erreur, `2` pour des logs d'informations ou `3` pour les logs de débogage; la valeur par défaut est `0`.

## Paramètres requis

Vous pouvez utiliser l'une des configurations suivantes : avec une liste de signataires ou avec des numéros de signataires.

### Avec une liste de signataires

<table data-header-hidden><thead><tr><th valign="top">Paramètre</th><th valign="top">Type</th><th valign="top">Direction</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><strong>Paramètre</strong></td><td valign="top"><strong>Type</strong></td><td valign="top"><strong>Direction</strong></td><td valign="top"><strong>Description</strong></td></tr><tr><td valign="top"><code>SIGNER_FIRSTNAME_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Prénoms des signataires, séparés par la valeur définie dans le paramètre <code>DATA_SEPARATOR</code></td></tr><tr><td valign="top"><code>SIGNER_LASTNAME_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Noms des signataires, séparés par la valeur définie dans le paramètre <code>DATA_SEPARATOR</code></td></tr><tr><td valign="top"><code>SIGNER_EMAIL_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Adresses email des signataires, séparées par la valeur définie dans le paramètre <code>DATA_SEPARATOR</code></td></tr><tr><td valign="top"><code>FILEx</code></td><td valign="top">FILE</td><td valign="top">IN</td><td valign="top">Fichier(s) à envoyer, où <code>x</code> correspond au numéro de fichier; vous pouvez ajouter un ou plusieurs fichiers</td></tr></tbody></table>

### Avec des numéros de signataires

<table data-header-hidden><thead><tr><th valign="top">Paramètre</th><th valign="top">Type</th><th valign="top">Direction</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><strong>Paramètre</strong></td><td valign="top"><strong>Type</strong></td><td valign="top"><strong>Direction</strong></td><td valign="top"><strong>Description</strong></td></tr><tr><td valign="top"><code>SIGNER_FIRSTNAMEx</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Prénom(s) du ou des signataires, où <code>x</code> correspond au numéro du signataire; vous pouvez ajouter un ou plusieurs signataires</td></tr><tr><td valign="top"><code>SIGNER_LASTNAMEx</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Nom(s) du ou des signataires, où <code>x</code> correspond au numéro du signataire; vous pouvez ajouter un ou plusieurs signataires</td></tr><tr><td valign="top"><code>SIGNER_EMAILx</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Adresse(s) email du ou des signataires, où <code>x</code> correspond au numéro du signataire; vous pouvez ajouter un ou plusieurs signataires</td></tr><tr><td valign="top"><code>FILEx</code></td><td valign="top">FILE</td><td valign="top">IN</td><td valign="top">Fichier(s) à envoyer, où <code>x</code> correspond au numéro de fichier; vous pouvez ajouter un ou plusieurs fichiers</td></tr></tbody></table>

## Paramètres facultatifs

### Configuration Docaposte

<table data-header-hidden><thead><tr><th valign="top">Paramètres</th><th valign="top">Type</th><th valign="top">Direction</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><strong>Paramètres</strong></td><td valign="top"><strong>Type</strong></td><td valign="top"><strong>Direction</strong></td><td valign="top"><strong>Description</strong></td></tr><tr><td valign="top"><code>DOCAPOSTE_USERNAME</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Nom d'utilisateur Docaposte<br><br>Par défaut, cette valeur provient du paramètre <code>DocaposteUsername</code> dans le fichier <code>web.config</code>.</td></tr><tr><td valign="top"><code>DOCAPOSTE_PASSWORD</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Mot de passe Docaposte<br><br>Par défaut, cette valeur provient du paramètre <code>DocapostePassword</code> dans le fichier <code>web.config</code>.</td></tr><tr><td valign="top"><code>DOCAPOSTE_HOST_SERVER</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><p>Serveur hôte Docaposte</p><p></p><p>Par défaut, cette valeur provient du paramètre <code>DocaposteHostServer</code> dans le fichier <code>web.config</code>.</p></td></tr><tr><td valign="top"><code>DOCAPOSTE_OFFER_CODE</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><p>Code de l'offre Docaposte<br></p><p>Par défaut, cette valeur provient du paramètre <code>DocaposteOfferCode</code> dans le fichier <code>web.config</code>.</p></td></tr><tr><td valign="top"><code>DOCAPOSTE_ORGANIZATIONAL_UNIT_CODE</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><p>Code de l'organisation Docaposte</p><p></p><p>Par défaut, cette valeur provient du paramètre <code>DocaposteOrganizationalUnitCode</code> dans le fichier <code>web.config</code>.</p></td></tr></tbody></table>

### Général

<table data-header-hidden><thead><tr><th valign="top">Paramètres</th><th valign="top">Type</th><th valign="top">Direction</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><strong>Paramètres</strong></td><td valign="top"><strong>Type</strong></td><td valign="top"><strong>Direction</strong></td><td valign="top"><strong>Description</strong></td></tr><tr><td valign="top"><code>DATA_SEPARATOR</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Séparateur utilisé pour séparer les contenus de <code>SIGNERS_FIRSTNAME_LIST</code>,<code>SIGNERS_LASTNAME_LIST</code>, <code>SIGNERS_EMAIL_LIST</code> et <code>SIGNER_TYPE_LIST</code><br><strong>Par défaut :</strong> <code>,</code> (virgule)</td></tr><tr><td valign="top"><code>SIGNER_TYPE_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><p>Type de signature des signataires, séparés par la valeur définie dans le paramètre <code>DATA_SEPARATOR</code><br><br><strong>Valeurs possibles :</strong></p><ul><li><code>OTP</code>(par défaut)</li><li><code>PAD</code></li><li><code>TOKEN</code></li><li><code>CONSENT_PROOF</code></li><li><code>IDENTITY</code></li></ul></td></tr><tr><td valign="top"><code>SIGNER_TYPEX</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><p>Type de signature du ou des signataire(s), où <code>x</code> correspond au numéro du signataire; vous pouvez ajouter un ou plusieurs signataires<br></p><p><strong>Valeurs possibles :</strong></p><ul><li><code>OTP</code>(par défaut)</li><li><code>PAD</code></li><li><code>TOKEN</code></li><li><code>CONSENT_PROOF</code></li><li><code>IDENTITY</code></li></ul></td></tr><tr><td valign="top"><code>CUSTOM_REFERENCE</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><p>Référence fournisseur</p><p></p><p>Le contenu de ce paramètre peut permettre au fournisseur d'identifier la transaction de son côté avec par exemple une valeur propre à son domaine métier (p.ex. : numéro de dossier client).<br><strong>Par défaut :</strong><code>WorkflowGen</code></p></td></tr><tr><td valign="top"><code>TEST_MODE</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><p>Indique si la transaction est une transaction de TEST (<code>Y</code> ou <code>N</code>)</p><p><strong>Par défaut :</strong> <code>N</code></p></td></tr><tr><td valign="top"><code>EMAIL_SUBJECT</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><p>Sujet de l'email qui sera envoyé aux signataires</p><p><strong>Par défaut :</strong> <code>Please sign the document sent from WorkflowGen</code></p></td></tr><tr><td valign="top"><code>EMAIL_FROM</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><p>Nom de domaine de l'adresse email qui sera utilisée pour l'envoi de l'email aux signataires</p><p><strong>Par défaut :</strong> <code>do-not-reply</code></p></td></tr><tr><td valign="top"><code>EMAIL_BODY</code></td><td valign="top">FILE</td><td valign="top">IN</td><td valign="top">Contenu de l'email à envoyer aux signataires (voir la section <a href="#personnalisation-du-corps-demail">Personnalisation du corps de l'email</a>) </td></tr></tbody></table>

### Paramètres de retour

<table data-header-hidden><thead><tr><th valign="top">Paramètre</th><th valign="top">Type</th><th valign="top">Direction</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><strong>Paramètre</strong></td><td valign="top"><strong>Type</strong></td><td valign="top"><strong>Direction</strong></td><td valign="top"><strong>Description</strong></td></tr><tr><td valign="top"><code>DOCAPOSTE_TRANSACTION_ID</code>`</td><td valign="top">TEXT</td><td valign="top">OUT</td><td valign="top">Contient l'ID de la transaction Docaposte; vous pouvez utiliser cet ID dans l'application de workflow <a href="application-de-workflow-docapostecheck">DOCAPOSTECHECK</a></td></tr><tr><td valign="top"><code>DOCAPOSTE_DOCUMENT_NAMES</code></td><td valign="top">TEXT</td><td valign="top">OUT</td><td valign="top">Contient les noms des documents envoyés à Docaposte; vous pouvez utiliser ces valeurs dans l'application de workflow <a href="application-de-workflow-docapostecheck">DOCAPOSTECHECK</a></td></tr></tbody></table>

### Personnalisation du corps de l'email

Il est possible de personnaliser le contenu du corps de l'email envoyé au signataire. Le modèle doit contenir la balise `<DOCAPOSTE_SIGN_URL>`, qui sera remplacée par le lien permettant au signataire d'effectuer leur signature.

**Valeur par défaut :**

```markup
<!DOCTYPE html>
<html lang=""en"" xmlns=""http://www.w3.org/1999/xhtml"">
<head>
    <meta charset=""utf-8"" />
</head>
<body>
    <p>Hello {firstname} {lastname},</p>
    <p>
        Please sign the document sent from WorkflowGen.
        <br />
        <a href=""<DOCAPOSTE_SIGN_URL>"">Click here to sign on Docaposte</a>
    </p>
    <p>Regards,</p>
    <p>WorkflowGen</p>
</body>
</html>
```

## Exemples

### Avec liste de signataires

<table data-header-hidden><thead><tr><th valign="top">Paramètre</th><th valign="top">Type</th><th valign="top">Direction</th><th valign="top">Valeur</th></tr></thead><tbody><tr><td valign="top"><strong>Paramètre</strong></td><td valign="top"><strong>Type</strong></td><td valign="top"><strong>Direction</strong></td><td valign="top"><strong>Valeur</strong></td></tr><tr><td valign="top"><code>SIGNER_FIRSTNAME_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>Jean,Bernard</code></td></tr><tr><td valign="top"><code>SIGNER_LASTNAME_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>Dupont,Martin</code></td></tr><tr><td valign="top"><code>SIGNER_EMAIL_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>jean.dupont@email.fr,bernard.martin@email.fr</code></td></tr><tr><td valign="top"><code>SIGNER_TYPE_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>PAD,OTP</code></td></tr><tr><td valign="top"><code>FILE1</code></td><td valign="top">FILE</td><td valign="top">IN</td><td valign="top"><code>contrat.pdf</code></td></tr><tr><td valign="top"><code>DOCAPOSTE_TRANSACTION_ID</code></td><td valign="top">TEXT</td><td valign="top">OUT</td><td valign="top"><code>xxxxx-xxxxx-xxxxx-xxxxx</code></td></tr><tr><td valign="top"><code>DOCAPOSTE_DOCUMENT_NAMES</code></td><td valign="top">TEXT</td><td valign="top">OUT</td><td valign="top"><code>contrat.pdf</code></td></tr></tbody></table>

### Avec numéros de signataire

<table data-header-hidden><thead><tr><th valign="top">Paramètre</th><th valign="top">Type</th><th valign="top">Direction</th><th valign="top">Valeur</th></tr></thead><tbody><tr><td valign="top"><strong>Paramètre</strong></td><td valign="top"><strong>Type</strong></td><td valign="top"><strong>Direction</strong></td><td valign="top"><strong>Valeur</strong></td></tr><tr><td valign="top"><code>SIGNER_LASTNAME1</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>Dupont</code></td></tr><tr><td valign="top"><code>SIGNER_LASTNAME2</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>Martin</code></td></tr><tr><td valign="top"><code>SIGNER_FIRSTNAME1</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>Jean</code></td></tr><tr><td valign="top"><code>SIGNER_FIRSTNAME1</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>Bernard</code></td></tr><tr><td valign="top"><code>SIGNER_EMAIL1</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>jean.dupont@email.fr</code></td></tr><tr><td valign="top"><code>SIGNER_EMAIL2</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>bernard.martin@email.fr</code></td></tr><tr><td valign="top"><code>SIGNER_TYPE1</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>PAD</code></td></tr><tr><td valign="top"><code>SIGNER_TYPE2</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>TOKEN</code></td></tr><tr><td valign="top"><code>FILE1</code></td><td valign="top">FILE</td><td valign="top">IN</td><td valign="top"><code>contrat.pdf</code></td></tr><tr><td valign="top"><code>DOCAPOSTE_TRANSACTION_ID</code></td><td valign="top">TEXT</td><td valign="top">OUT</td><td valign="top"><code>xxxxx-xxxxx-xxxxx-xxxxx</code></td></tr><tr><td valign="top"><code>DOCAPOSTE_DOCUMENT_NAMES</code></td><td valign="top">TEXT</td><td valign="top">OUT</td><td valign="top"><code>contrat.pdf</code></td></tr></tbody></table>
