Paramétrage connecteur Lex Persona

Fichier de configuration

• chemin du fichier : /custom/mem_courrier/modules/visa/xml/remoteSignatoryBooks.xml

    <signatoryBook>
        <id>lexPersona</id>

        <tokenAPI></tokenAPI>
        <url>https://test.lex-persona.com</url>
        <userId></userId>
        <consentPage>OTP Mail</consentPage>
        <approvalConsentPage>Validation</approvalConsentPage>
        <signatureProfileId>sip_DCnjUERyhGdfS</signatureProfileId>
<sendApproval>Y</sendApproval>
        <sendAnnotation>Y</sendAnnotation>
        <groupApproval>Y</groupApproval
        <groupSignatory>Y</groupSignatory>
        <externalIdMandatory>Y</externalIdMandatory>
        <templateId>wtm_8DWn4NgkeNY1i9</templateId>
<maxInvites>5</maxInvites>
        <getComments>Y</getComments>
        <addCC>Y</addCC>
        <notifiedEventsCC>
            <recipientRefused>N</recipientRefused>
            <recipientFinished>Y</recipientFinished>
<workflowStarted>Y</workflowStarted>
            <workflowStopped>Y</workflowStopped>
            <workflowFinished>Y</workflowFinished>
            <workflowFinishedDownloadLink>N</workflowFinishedDownloadLink>
        </notifiedEventsCC>
        <notifiedEventsOwner>
            <recipientRefused>Y</recipientRefused>
            <recipientFinished>Y</recipientFinished>
            <workflowStarted>Y</workflowStarted>
            <workflowStopped>Y</workflowStopped>
            <workflowFinished>N</workflowFinished>
            <workflowFinishedDownloadLink>N</workflowFinishedDownloadLink>
        </notifiedEventsOwner>
</signatoryBook>

Le fichier XML fournit des paramètres de configuration essentiels pour activer la connexion avec le parapheur lexPersona. Voici une explication détaillée des éléments de configuration.

• id : Identifiant technique. (NE PAS MODIFIER).

• tokenAPI : correspond au jeton d’API LexPersona permettant l’authentification auprès du

  service LexPersona. À noter que le jeton d’API hérite des droits de l’utilisateur qui l’a créé.

• url : Url du parapheur.

• userId : L’identifiant de l’administrateur fonctionnel, qui correspond à l’utilisateur propriétaire des workflows créés.

• consentPage : Ce paramètre défini le mode d’authentification (c’est à dire la page de consentement par défaut pour les signataires) . Il est toutefois possible de préciser un mode d’authentification particulier pour un utilisateur donné en renseignant le champ JSON ”preferences” lié à l’utilisateur dans MEM (par le biais de l’API) avec le nom de la page de consentement souhaitée (par exemple on peut alimenter la clé ”consentPage” dans ce JSON par une des valeurs suivantes : ”OTP Mail”, ”Signature locale”, ”OTP SMS”, etc.). C’est donc ce mode qui sera pris en compte pour cet utilisateur (si il est spécifié) plutôt que le mode par défaut.

Exemple d’appel à l’API pour provisionner ces informations :

PUT https://demo.memcourrier.com/dist/index.html

{
    "firstname" : "Léa",
    "lastname" : "Marchand",
"preferences" : {"consentPage": "OTP Mail"},
    "external_id" : {"LexPersona": "xAz1qsljqxEdm1n3"},
    "mail" : "[e-mail]"
}

Attention il faut renseigner pour chaque mise à jour de l’utilisateur les informations suivantes : nom, prénom et mail sinon on perd la valeur associée (route utilisée également par le front de MEM).

• approvalConsentPage : La page de consentement pour les viseurs.

• signatureProfileId : Le profil de signature à utiliser pour signer le document.

• sendApproval : Ce paramètre permet d’activer ou non l’envoi des viseurs de MEM vers Lex Persona plutôt que les signataires uniquement.

• sendAnnotation : Ce paramètre permet d’activer ou non l’envoi des annotations depuis MEM vers Lex Persona (si renseignées dans la modale du connecteur).

• groupApproval : Ce paramètre détermine si les viseurs doivent être regroupés en une seule étape (c’est à dire qu’ils pourront tous viser simultanément) ou si chaque viseur doit avoir sa propre étape distincte (dans ce cas elle sera bloquante et l’ordre aura donc une importance).

• groupSignatory : Ce paramètre regroupe les signataires en une seule étape, ce qui signifie qu’ils sont invités à signer simultanément, sans ordre défini.

• externalIdMandatory : Ce paramètre détermine quelle information est utilisée pour vérifier l’existence de l’utilisateur dans Lex Persona. Si il est à ”Y” alors il faut renseigner une clé ”lexPersonaId” dans le champ JSON external-id de l’utilisateur dans MEM. Elle sera est utilisée pour vérifier si cette clé existe dans Lex Persona. Si ce n’est pas le cas, il ne sera pas possible de transmettre les documents dans le parapheur puisque l’utilisateur renseigné dans MEM n’aura pas d'équivalent dans Lex Persona. Si il est à ”N” alors c’est l’adresse mail de l’utilisateur qui sera utilisée pour vérifier si il y a un utilisateur correspondant dans Lex Persona.

• workflowTemplateId : L’identifiant du modèle de workflow. Si il n’est pas précisé, aucun modèle ne sera utilisé.

• maxInvites : Le nombre maximum d’invitations possibles dans le workflow qui va être créé lorsqu’aucun modèle n’a été précisé (valeurs possibles : 0-99).

• getComments : Ce paramètre contrôle l’activation ou la désactivation de la récupération des commentaires publics depuis Lex Persona vers MEM.

• addCC : Ce paramètre permet d’ajouter le rédacteur du courrier en CC du worflow.

• notifiedEventsCC : Ces paramètres définissent l’activation ou non des notifications d’évènements pour l’observateur des workflows (qui correspond au rédacteur de MEM). Valeurs possibles : Y/N.

  – recipientRefused : Invitation refusée. – recipientFinished : Invitation traitée. – workflowStarted : Parapheur démarré. – workflowStopped : Parapheur arrêté. – workflowFinished : Parapheur terminé. – workflowFinishedDownloadLink : lien de téléchargement des documents signés