Envoi en masse
La fonction d’Envoi en masse permet aux utilisateurs de créer et de distribuer plusieurs transactions avec un minimum d’effort en utilisant :
- Un modèle admissible, qui sera utilisé pour créer les transactions. Un modèle est admissible s’il possède :
- Au moins un document autre que la convention de consentement
- Au moins un rôle de remplacement
- Au moins un champ de signature (pas nécessairement pour le rôle fictif)
- Un fichier CSV, qui contient des informations sur les signataires pour tous les rôles fictifs
Le reste de cette section traite de la question :
- Langues prises en charge
- Taille des fichiers et capacité de traitement
- Initier un envoi en masse
- Format d’en-tête CSV
- Exemple de fichier CSV
- Fichiers CSV contenant des caractères non ASCII
- Processus de validation
- Programmation des envois en masse
- Tutoriel vidéo
Langues prises en charge
Si la liste des langues prises en charge a été limitée, tenez compte des informations suivantes :
-
Les utilisateurs ne seront pas autorisés à générer de nouvelles transactions d'envoi en masse pour les modèles dont la langue n'est pas prise en charge.
-
L'option Envoi en masse sera masquée dans l'interface utilisateur de l'expéditeur (sur la page de liste des modèles, ainsi que sur la page Modifier le modèle).
-
Si vous tentez de déclencher un envoi en masse à partir de l'API pour un modèle dont la langue n'est pas prise en charge, vous obtiendrez une erreur.
-
Lors de la création d'une transaction ou d'un modèle à partir de l'interface utilisateur, si vous sélectionnez un modèle pouvant être envoyé en masse dans la liste déroulante dont l'une des langues n'est désormais plus prise en charge, l'option d'Envoi en masse sera là, car la nouvelle langue de transaction ou de modèle sera automatiquement réinitialisée à la langue de signature par défaut.
-
Les transactions d'envoi en masse déjà générées avec une langue qui n'est désormais plus prise en charge, seront encore traitées, mais généreront une erreur puisque la langue n'est désormais plus prise en charge.
Taille des fichiers et capacité de traitement
Notez que l'envoi en masse est soumis aux limites suivantes :
-
La taille maximale de fichier est de 8 Mo.
-
Un maximum d'environ 3000 transactions est traité par heure.
C'est pourquoi nous vous recommandons, pour un envoi en masse très important, de fractionner votre requête en lots plus petits de 1000 lignes par heure. Cela permettra d'éviter de bloquer la file d'attente des transactions pour les autres utilisateurs.
Si possible, commencez votre envoi en masse pendant le week-end. Cela réduira l'impact sur les autres utilisateurs et accélérera le traitement de vos transactions.
Initier un envoi en masse
Préalables
- La fonction d'envoi en masse doit être activée sur votre compte.
- Un modèle admissible et un fichier CSV approprié ont été créés.
Le fichier CSV doit spécifier l'ID de la méthode de signature. Cet ID est sensible à la casse. Pour la méthode de signature avec un certificat, cet ID est « personalCertificateSigning ».
Pour lancer un envoi en masse :
- Cliquez sur l'option de menu Modèles. La page Modèles s'affiche.
- Cliquez sur le nom d'un modèle admissible. Sa page apparaît.
- Dans la section Détails du modèle de cette page, cliquez sur l'icône Transactions d'envoi en masse.
Votre explorateur système s'ouvre. - Utilisez l'explorateur de votre système pour sélectionner un fichier CSV approprié. OneSpan Sign validera son format de fichier. Si le format est valide, le processus d'envoi en masse commencera.
Lorsque vous lancez un envoi groupé par message texte, les numéros de téléphone doivent respecter le format E.164. Par exemple, +44 7923 123456 en Europe, et +1 247 123 4567 en Amérique du Nord.
Format d’en-tête CSV
Cette section décrit le format d'en-tête CSV pour :
Un espace réservé
Pour les transactions comportant un seul rôle fictif, la ligne d'en-tête d'un fichier CSV doit avoir le format suivant :
{PlaceholderRoleName},FIRST_NAME,LAST_NAME,EMAIL,AUTH_TYPE,AUTH_PROMPT,AUTH_CHALLENGE,SIGNER_VERIFICATION,FieldId1,FieldId2
Notez que :
- La chaîne
{PlaceholderRoleName}
n’apparaîtra pas dans le fichier. Il s'agira plutôt du nom d'un rôle fictif. De même, les chaînesFieldId1
etFieldId2
n’apparaîtront pas dans le fichier. Au lieu de cela, il s’agira de noms d’identifiants de champs. {PlaceholderRoleName}
,FIRST_NAME
,LAST_NAME
, etEMAIL
sont des champs obligatoires. Tous les autres sont facultatifs.- Les paramètres
AUTH_TYPE
,AUTH_PROMPT
, etAUTH_CHALLENGE
sont traités par OneSpan Sign comme un seul champAUTH
unique. - Un
FieldId
est l'ID d'un champ qui appartient à un rôle fictif. Il peut être utilisé pour remplir automatiquement ce champ dans vos documents. La ligne d'en-tête peut comporter autant de ces champs que nécessaire. - Les lignes sous la ligne d'en-tête fournissent des valeurs pour les paramètres de la ligne d'en-tête. Il y a une telle ligne pour chaque transaction.
- Si vous souhaitez spécifier une méthode de vérification du signataire externe (
SIGNER_VERIFICATION
) comme le PCC ou le DIGIPASS, veuillez communiquer avec notre équipe de soutien.
Espacés réservés multiples
Si vos transactions contiennent plus d'un rôle fictif, vous devez ajouter un ensemble de champs d'en-tête pour chaque rôle supplémentaire. Tous les champs obligatoires doivent être présents pour chaque rôle fictif. Par exemple, un en-tête contenant uniquement les champs obligatoires pour deux rôles fictifs pourrait ressembler à ceci :
Placeholder1,FIRST_NAME,LAST_NAME,EMAIL,Placeholder2,FIRST_NAME,LAST_NAME,EMAIL
Le champ {PlaceholderRoleName}
définit toujours le début d'un bloc de rôles. Notez que :
- Chaque bloc de rôle doit contenir tous les champs obligatoires.
- Dans un bloc de rôles donné, l'ordre des champs n'a pas d'importance. Faites bien attention à la formulation de la phrase précédente car : (1) le champ
AUTH
a trois colonnes; (2) le champFieldId
peut avoir plusieurs paramètres et donc plusieurs colonnes.
Ainsi, le format suivant est valable, même si l'ordre des champs diffère entre ses deux blocs de rôle :
Placeholder1,EMAIL,LAST_NAME,FIRST_NAME,Placeholder2,FIRST_NAME,EMAIL,LAST_NAME
Exemple de fichier CSV
Voici un exemple de fichier CSV pour une transaction avec deux signataires :
Signer1,FIRST_NAME,LAST_NAME,EMAIL,AUTH_TYPE,AUTH_PROMPT,AUTH_CHALLENGE,AUTH_PROMPT,AUTH_CHALLENGE,SIGNER_VERIFICATION,Signer2,FIRST_NAME,LAST_NAME,EMAIL,AUTH_TYPE,AUTH_PROMPT,AUTH_CHALLENGE,AUTH_PROMPT,AUTH_CHALLENGE,CUSTOMER_ID,SIGNER_VERIFICATION
Signer1,David,Smith,[email protected],NONE,,,,,personalCertificateSigning,Signer2,Roger,Waters,[email protected],NONE,,,,133487, DIGIPASS
(1) AUTH_TYPE
se voit attribuer la valeur NONE
pour les deux signataires; (2) 133487
est le CUSTOMER_ID
.
Fichiers CSV contenant des caractères non ASCII
Si les données que vous devez mettre dans le fichier CSV contiennent des caractères non ASCII (par exemple, des caractères accentués, des caractères chinois), le fichier CSV doit être enregistré avec le codage UNICODE UTF-8.
Par défaut, Microsoft Excel enregistre les fichiers au format CSV en utilisant le codage ANSI. La procédure suivante décrit comment enregistrer des fichiers Excel au format CSV en utilisant l'encodage UNICODE.
Pour enregistrer un fichier Excel au format CSV en utilisant l'encodage UNICODE UTF-8 :
- Ouvrez le fichier dans Microsoft Excel.
- Dans le menu supérieur, cliquez sur Fichier > Enregistrer sous, et naviguez jusqu'au répertoire souhaité.
- Sélectionnez Enregistrer sous le type > CSV (Comma delimited) (*.csv).
- À côté du bouton Enregistrer, cliquez sur Outils > Options Web....
- Cliquez sur l'onglet Encodage.
- Cliquez sur Enregistrer ce document sous > Unicode (UTF-8).
- Dans la fenêtre Options Web, cliquez sur OK.
- Enregistrez le fichier.
Processus de validation
OneSpan Sign valide la ligne d’en-tête avant de valider toute autre ligne dans un fichier CSV. Si quelque chose ne va pas avec la ligne d’en-tête, un message d’erreur est envoyé. Si la ligne d’en-tête est vérifiée comme étant valide, OneSpan Sign procède à la validation des autres lignes.
Le reste de cette section traite de la validation de :
Rangée d'en-tête
OneSpan Sign vérifie cela dans la ligne d'en-tête du fichier CSV :
- Pour chaque rôle de type espace réservé dans le modèle, il existe un bloc de rôle qui contient les champs
{PlaceholderRoleName}
,FIRST_NAME
,LAST_NAME
etEMAIL
. - Chaque colonne de
FieldId
correspond à un champ qui existe pour le rôle associé.
Autres lignes
OneSpan Sign vérifie que pour chaque bloc de rôle dans chaque ligne après la ligne d'en-tête :
- Des valeurs ont été attribuées aux colonnes
FIRST_NAME
,LAST_NAME
etEMAIL
. - La valeur de chaque
FieldId
est valable. Ce que signifie « valide » dans ce contexte dépend de la façon dont vous avez configuré le champ (par exemple, vous avez peut-être attribué une longueur maximale à un champ de texte). Pour mieux comprendre les possibilités, consultez Nouveau.
Champ AUTH
AUTH_TYPE
, AUTH_PROMPT
et AUTH_CHALLENGE
constituent ensemble le champ « AUTH
» pour un bloc de rôles donné.
La valeur attribuée à AUTH_TYPE
doit être NONE
, CHALLENGE
, SSO
, ou SMS
. Le processus de validation pour AUTH_PROMPT
et AUTH_CHALLENGE
dépend de la valeur attribuée à AUTH_TYPE
comme expliqué dans la suite de cette section.
Si AUTH_TYPE = NONE
pour un Rôle particulier, OneSpan Sign n’essaie pas de valider AUTH_PROMPT
ou AUTH_CHALLENGE
pour ce rôle. C’est parce qu’ils ne sont pas utilisés (voir l’exemple de fichier CSV ci-dessus).
Si AUTH_TYPE = CHALLENGE
pour un rôle particulier, OneSpan Sign vérifie que pour ce rôle :
- Au moins une paire
AUTH_PROMPT/AUTH_CHALLENGE
a été spécifiée. - Il existe une correspondance 1:1 entre les invites et les défis (c’est-à-dire que pour chaque invite, il y a un défi, et vice versa).
OneSpan Sign lit les colonnes d’invite et de défi de gauche à droite, ce qui signifie que les deux schémas d’ordonnancement suivants sont valables :
AUTH_TYPE | AUTH_PROMPT | AUTH_CHALLENGE | AUTH_PROMPT | AUTH_CHALLENGE |
DÉFI | Question1 | Réponse1 | Question2 | Réponse 2 |
AUTH_TYPE | AUTH_PROMPT | AUTH_PROMPT | AUTH_CHALLENGE | AUTH_CHALLENGE |
DÉFI | Question1 | Question2 | Réponse1 | Réponse2 |
Les exemples ci-dessus montrent que toutes les colonnes AUTH
doivent apparaître dans l’ordre dans lequel elles sont destinées à être utilisées. Voici un autre exemple qui illustre ce concept : Réponse2, Réponse1, Question1, Question2 n’est pas un ordre valide.
Si AUTH_TYPE = SMS
pour un rôle particulier, OneSpan Sign vérifie que pour ce rôle, il y a au moins une invite. Le processus de vérification n’examinera que la première invite, qui doit être utilisée pour spécifier le numéro de téléphone auquel un message texte sera envoyé. Le processus de vérification ignore tous les autres paramètres d’invite et de défi.
Programmation des envois en masse
Les transactions d'envoi en masse sont placées dans une file d'attente. Toutes les 15 minutes, la file d'attente est vérifiée. Si de nouvelles tâches d'envoi en masse sont arrivées, elles sont traitées dans l'ordre jusqu'à ce que la file d'attente soit vide.
Tutoriel vidéo