OneSpan Sign for Pegasystems
Pegasystems fournit une plateforme de premier plan for customer engagement and digital-pocess automation. Propulsée par une automatisation avancée en matière d'IA et de robotique, cette plate-forme permet d'obtenir des résultats commerciaux révolutionnaires avec des logiciels à faible code / sans code. Les logiciels Pegasystem’s, adaptatifs et architecturés en nuage, permettent de déployer rapidement et de modifier facilement les applications pour répondre aux besoins stratégiques des entreprises. Pegasystems est le leader en logiciels pour l'engagement des clients et l'excellence opérationnelle.
OneSpan est un leader mondial de la sécurité des identités numériques, de la sécurité des transactions, de l'intégration des clients et de la productivité des entreprises. OneSpan est le fondement essentiel de la fourniture de solutions de sécurité et de signature électronique de premier plan. Ces solutions protègent les personnes, les appareils et les transactions contre la fraude, offrant une sécurité solide comme le roc et une expérience client sans friction. Cela permet même aux entreprises les plus réglementées de mener une transformation numérique audacieuse et d'offrir des interactions numériques puissantes avec leurs clients.
Le produit appelé OneSpan Sign fournit une plateforme complète de signature électronique pour le Web, comprenant la préparation, la distribution, la révision, la signature et le téléchargement de documents.
OneSpan Sign for Pegasystems est un connecteur qui vous permet d'envoyer et de signer en toute sécurité des documents "prêts à l'emploi" et d'intégrer pleinement les signatures électroniques dans vos applications Web et mobiles internes, orientées client et partenaires. Plus précisément, il permet à vos utilisateurs de lancer un flux de travail pour préparer et signer des documents à partir de n'importe quel processus personnalisé ou application stratégique prête à l'emploi Pegasystems . OneSpan Sign étant entièrement intégré à la plateforme Pegasystems, l'expérience de l'utilisateur est très intuitive.
Toutes les fonctions de OneSpan Sign ne sont pas prises en charge par une intégration avec ce connecteur. Cependant, la plupart sinon la totalité des fonctions prises en charge par cette intégration se trouvent dans la documentation du connecteur. Pour toute question concernant une fonction spécifique, veuillez consulter nos forums. Si une fonctionnalité que vous recherchez n'est pas prise en charge, veuillez en informer votre contact commercial afin qu'une demande officielle puisse être faite.
OneSpan Sign for Pegasystems est idéal pour la signature ad hoc comme pour la signature à la demande. La solution étend le point final des efforts de numérisation de votre organisation, en donnant à vos clients, partenaires et employés de véritables processus automatisés de bout en bout avec la signature de documents sans papier.
Pour obtenir plus d'informations sur l'utilisation de la plateforme Pega, voir l'aide en ligne de Pega Community.
Ce guide aborde les sujets suivants :
- Configurer OneSpan Sign for Pegasystems
- Vérifier le statut d'une transaction
- Détails de l'API
- Spécification et récupération des valeurs des champs
Configurer OneSpan Sign for Pegasystems
Pour configurer OneSpan Sign for Pegasystems, suivez les instructions de ces sections :
- Préalables
- Téléchargement et importation du connecteur
- Ajout de jeux de règles obligatoires à votre application
- Configuration du flux d'applications
- Configuration des détails du compte OneSpan Sign dans Pegasystems
- Spécification des configurations de l'API OneSpan Sign dans Pegasystems
Préalables
Avant d'installer OneSpan Sign for Pegasystems, vous devez disposer des éléments suivants :
- Un compte OneSpan Sign. Pour obtenir un compte OneSpan Sign, communiquez avec notre équipe de soutien.
- Un compte Pega. Pour vous inscrire à un compte Pega, cliquez ici.
- Pegasystems version 7.3.1 ou supérieure
Téléchargement et importation du connecteur
Pour télécharger et importer OneSpan Sign for Pegasystems :
-
Sur la place de marché Pega, localisez et téléchargez l'application OneSpan Sign for Pegasystems. Notez l'emplacement vers lequel vous téléchargez ce fichier.
- Connectez-vous à votre système Pegasystems .
- Cliquez sur Concepteur Studio > Application > Distribution > Importer
- Sélectionnez la méthode du fichier local.
- Sélectionnez Choisir un fichier. Naviguez ensuite jusqu'au connecteur OneSpan Sign for Pegasystems que vous avez téléchargé à l'étape 1, et sélectionnez-le.
- Cliquez sur Prochain, et continuez avec le processus d'importation habituel de Pegasystem. Pour obtenir plus d'informations sur ce processus, consultez l'assistance en ligne de Pega.
Ajout de jeux de règles obligatoires à votre application
Pour ajouter le de jeux de règles obligatoires à votre application :
- Connectez-vous à votre système Pegasystems.
- Ouvrez votre définition d'application en cliquant sur Application > Définition.
- Dans la section Jeux de règles d'application, cliquez sur Ajouter un jeu de règles.
- Ajoutez les jeux de règles suivants à la liste des jeux de règles de votre application :
- OneSpan:01-01
- OSpanInt:01-01
Configuration du flux d'applications
Une fois que vous avez ajouté les jeux de règles requis à votre système Pegasystems, vous devriez être en mesure de voir le flux OS_SigningProcess dans la classe de travail.
Utilisez la barre de recherche en haut de l'écran pour rechercher et ouvrir OS_SigningProcess.
Pour utiliser ce flux prédéfini, vous devez l'appeler à l'aide de Subprocess Smart Shape.
Vous devez personnaliser ceci Data Transform OS_pyPrepareNew Package dans la classe de travail de votre application en fonction de vos besoins.
Utilisez le OS_Package Property de la classe Travail. Cette page sera transmise comme référence d'entrée à la taille intelligente de 'Create Esign Package.
Configuration des détails du compte OneSpan Sign dans Pegasystems
Pour permettre à votre compte OneSpan Sign de fonctionner avec votre compte Pegasystems :
- Connectez-vous à votre compte Pegasystems .
- À l'aide de la barre de recherche, en haut de l'écran, recherchez et ouvrez OS_LoadApplicationSettings.
- À l'aide de la liste déroulante du bouton Enregistrer, cliquez sur Enregistrer sous dans votre jeu de règles.
- Localisez la cible OS_APIKey. Ensuite, en utilisant le format suivant, modifiez la colonne source pour qu'elle pointe vers votre compte OneSpan Sign :
"BASIC" + <"OneSpan Sign Account API Key">
Pour savoir comment trouver votre clé API OneSpan Sign, consultez Gérer l'accès aux API et les notifications d'événements.
- Localisez la cible OS_EndPointUR. Changez ensuite la colonne source pour qu'elle pointe vers l'URL de votre point de terminaison de l'API OneSpan Sign — p. ex. : https://sandbox.esignlive.com/api/packages
Pour obtenir une réponse de OneSpan Sign dès la fin d'une transaction :
- Connectez-vous à votre compte Pegasystems .
- Dans la barre de recherche du Concepteur Studio, saisissez Ospan Events.
- Ouvrez la règle REST du service, et copiez l'URL du point de terminaison du service.
- Naviguez vers l'URL suivante : https://sandbox.esignlive.com/a/admin/integration
- Collez l'URL du point d'arrivée de la règle de repos du service que vous avez copié ci-dessus dans la zone de texte URL de rappel.
- Saisissez la clé de rappel suivante : T25lU3BhblNlcnZpY2VVc2VyOnJ1bGVz
- Dans la section Sélectionner les événements, activez l'événement Transaction complétée.
- Cliquez sur Enregistrer.
Spécification des configurations de l'API OneSpan Sign dans Pegasystems
Pour effectuer toutes les configurations souhaitées de l'API OneSpan Sign au sein de Pegasystems :
- Connectez-vous à votre compte Pegasystems .
- Dans la barre de recherche du Concepteur Studio, saisissez OS_CreateESignPackage. Il utilise les appels API suivants OneSpan Sign :
- Créer l'API du paquet de signature électronique — Détermine si une transaction peut être créée sans qu'un document y soit attaché.
- Cloner le paquet API — Clone une transaction ou un modèle existant.
- API de téléversement de documents — Permet le téléversement d'un seul document à la fois. Si vous avez plusieurs documents, vous pouvez mettre en boucle cet appel pour chaque document.
- Définir les valeurs des champs API — Définit les valeurs par défaut des champs d'une transaction à partir des données de Pegasystems ou du flux de travail de l'application. Vous pouvez également placer des balises directement dans un document. Vous pouvez utiliser cet appel d'API séparément, ou vous pouvez ajouter les valeurs des champs d'un document dans l'API de téléversement de documents.
- Extraction — Définit la méthode d'extraction à utiliser (par exemple, l'extraction de balises de texte).
- API de calendrier des rappels — Envoie des rappels aux signataires qu'une transaction attend leur signature.
- Définir la visibilité du document — Masque les documents aux signataires individuels.
- Envoyer la transaction — Envoie une transaction.
Vérifier le statut d'une transaction
Pour vérifier le statut d'une transaction :
- Utilisez l'appel API Vérifier la mise à jour du statut de l'API.
L'appel d'API OS_CheckForStatusUpdate utilise les appels d'API suivants :
- Obtenir des informations sur le paquet — Récupère les détails de la transaction, tels que les métadonnées complètes de la transaction (données utiles JSON).
- Télécharger la pièce jointe — Télécharge les pièces jointes que les signataires ont pu ajouter.
- Télécharger le résumé des preuves — Télécharge le journal d'une transaction particulière.
- Télécharger les documents signés — Télécharge tous les documents signés qui sont associés à la transaction.
- Récupérer les valeurs des champs — Récupère les valeurs des champs dans les documents de la transaction.
Le reste de cette section traite des sujets suivants :
Configuration des contrôles de statut
Dans certaines situations, par exemple lors d'une panne de réseau, OneSpan Sign peut ne pas être en mesure d'atteindre Pegasystems. Cependant, vous pouvez configurer le système pour qu'il vérifie les mises à jour de statut d'une transaction particulière à un rythme d'intervalle prédéfini. Une fois le réseau à nouveau connecté, ces mises à jour de statut sont envoyées.
Pour configurer de tels contrôles de statut :
- Utilisez l'appel API OS_WaitTimeInterval.
Le paramètre de système dynamique qui spécifie l'intervalle (en minutes) est OS_WaitTimeInterval. L'intervalle recommandé est de 12 heures (= 720 minutes).
Le flux de processus pour les mises à jour de statut
Les mises à jour de statut de OneSpan Sign sont envoyées à Pegasystems dans les scénarios suivants :
- Scénario 1 : La mise à jour du statut est parvenue à Pegasystems. Dans ce cas :
- Le statut mis à jour peut être Complété, Décliné ou En attente.
- Lorsque le statut entrant d'une transaction est Complété, le système télécharge les documents signés, le résumé des preuves et les pièces jointes de la transaction.
- Scénario 2 : La mise à jour du statut ne parvient pas à Pegasystems (par exemple, en raison d'un problème de réseau). Dans ce cas :
- Le système attendra le temps spécifié dans le DSS OS_WaitTimeInterval.
- Une fois cet intervalle de temps écoulé, le système vérifie s'il y a une mise à jour du statut de la transaction. Là encore, le statut mis à jour peut être Complété, Décliné ou En attente.
- Si le système renvoie un statut de transaction en attente, le système attendra à nouveau pendant le temps spécifié dans DSS OS_WaitTimeInterval.
- Si le système renvoie un statut de transaction de type Décliné, le flux de processus se termine, mais sans téléchargement de documents ou de pièces jointes.
- Si le système renvoie le statut de transaction Complété, le système télécharge les documents signés, le résumé des preuves et les pièces jointes de la transaction.
.
Détails de l'API
Le tableau suivant fournit des informations sur tous les appels de l'API OneSpan Sign for Pegasystems.
|
API |
Activité |
Demande DT |
Réponse DT |
|---|---|---|---|
|
Création de l'API du paquet ESign |
OS_CreateESignPackageAPI |
OS_NewPkgRequestPOST |
Pas de réponse spécifique DT |
|
Cloner un paquet/un modèle |
OS_ClonePackage |
OS_ClonePackageRequestPOST |
Pas de réponse spécifique DT |
|
Téléverser le document |
OS_UploadSingleDocumentAPI (en anglais) |
OS_UploadDocuments |
OS_SingleDocResponsePOST |
|
API pour le calendrier des rappels |
OS_SetReminderSchedule |
OS_PackageReminderRequestPOST |
Pas de réponse spécifique DT |
|
API de visibilité des documents |
OS_SetDocumentVisibility |
OS_SetDocVisibilityRequest (en anglais) |
Pas de réponse spécifique DT |
|
Envoi de transaction |
OS_SendTransaction |
Pas de demande spécifique DT |
Pas de réponse spécifique DT |
|
Obtenir des informations sur le paquet API |
OS_RetrievePackageInformation (en anglais) |
OS_RetrievePackageInformationRequest GET (Demande d'informations sur les paquets) |
OS_RetrievePackageInformationR esponseGET |
|
Obtenir le statut du paquet |
OS_PackageSigningStatus (connecteur) |
OS_PackageSigningStatusRequestGET |
Pas de réponse spécifique DT |
|
Télécharger les pièces jointes |
OS_DownloadAttachment |
OS_DownloadAttachmentRequestGET (en anglais) |
Pas de réponse spécifique DT |
|
Télécharger le résumé des preuves |
OS_RetrieveEvidenceSummary (Résumé des preuves) |
OS_RetrieveEvidenceSummaryRequest GET (Requête de récupération des preuves) |
Pas de réponse spécifique DT |
|
Télécharger les documents signés |
OS_RetrievePDFDocument (en anglais) |
OS_RetrievePDFDocumentRequestGET (Requête de récupération de documents PDF) |
Pas de réponse spécifique DT |
|
Définir les valeurs des champs |
OS_UpdateFieldsOf Document |
OS_UpdateFieldsRe questPOST |
Pas de réponse spécifique DT |
|
Récupérer les valeurs des champs |
OS_GetDocumentFieldValues (en anglais) |
OS_RetrieveFieldValuesRequestGET (en anglais) |
OS_RetrieveFieldValuesResponse GET |
Spécification et récupération des valeurs des champs
Pour spécifier les valeurs des champs pour une transaction :
- Personnalisez l'appel API OS_UpdateFieldsRequestPOST Data Transform. Cette fonction est appelée après le téléversement d'un document vers une transaction.
Pour récupérer toutes les valeurs des champs d'une transaction :
- Personnaliser l'appel API Data Transform OS_RetrieveFieldValuesResponseGET. Cette fonction est appelée lorsqu'une transaction est terminée.
OS_NewPkgRequestPOST
|
Nom de la propriété |
Exemples de valeurs |
Description |
|
|---|---|---|---|
|
|
Propriétés relatives au paquet | ||
|
OS_Package |
OS_autocomplete |
vrai/faux |
Détermine si le document doit être examiné avant la finalisation |
|
OS_description |
Description du paquet à partir du backend |
Description du paquet |
|
|
OS_emailMessage |
Paquet de messages électroniques à partir du backend |
Message à envoyer dans le courriel |
|
|
OS_email |
Adresse électronique de l'expéditeur |
||
|
OS_firstName |
Exemple |
Prénom de l'expéditeur |
|
|
OS_lastName |
Test |
Nom de famille de l'expéditeur |
|
|
OS_language |
en |
Language du paquet. Il doit s'agir de l'une des valeurs suivantes : en, fr, da, de, es, el, it, nl, pt,ru, zh-cn, zh-tw, ja, ko |
|
|
OS_name |
Nom de paquet défini dans le backend |
Nom du paquet |
|
|
OS_due |
20181019 |
Date d'expiration du paquet |
|
|
OS_status |
ENVOYÉ/ÉBAUCHE |
Statut du paquet. Il doit s'agir de l'une des valeurs suivantes : ÉBAUCHE, ENVOYÉ, COMPLÉTÉ, ARCHIVÉ, DÉCLINÉ, REFUSÉ, EXPIRÉ |
|
|
OS_type |
PACKAGE |
Type de paquet. Il doit s'agir de l'une des valeurs suivantes : PACKAGE, TEMPLATE, LAYOUT |
|
|
OS_visibility |
COMPTE/EXPÉDITEUR |
Visibilité du paquet |
|
|
OS_roles |
Liste des rôles ayant accès au paquet |
||
|
OS_id |
Rôle1 |
Saisissez la chaîne de caractères sans caractères spéciaux |
|
|
OS_name |
Rôle1 |
Saisissez le nom du rôle |
|
|
OS_index |
1 |
Spécifiez une valeur entière si vous voulez définir l'ordre de signature |
|
|
OS_signers |
Liste des signataires disponibles pour un rôle particulier dans ce paquet |
||
|
OS_email |
Adresse courriel du signataire |
||
|
OS_firstName |
Test |
Prénom du signataire |
|
|
OS_id |
TM |
Saisissez la valeur sans caractères spéciaux. |
|
|
OS_title |
M. |
Titre du signataire |
|
|
OS_company |
OneSpan |
Entreprise du signataire |
|
|
OS_lastName |
courriel |
Nom de famille du signataire |
|
|
OS_auth |
Méthode d'authentification à appliquer avant la signature du document |
||
|
OS_ scheme |
AUCUN |
Ce schéma doit être l'une des valeurs suivantes : NONE, PROVIDER, CHALLENGE, SMS, SSO, KBA |
|
|
OS_challenges |
Ceci doit être configuré lorsque le "schéma d'authentification" est SMS ou Q&A |
||
|
OS_ question |
Quel est le nom de votre animal de compagnie? |
Question à poser avant la signature du document. |
|
|
OS_answer |
XXX |
Réponse à la question |
|
|
OS_maskInput |
vrai/faux |
Détermine si la réponse saisie par le signataire sera masquée ou visible. |
|
|
OS_delivery |
Remise du document signé |
||
|
OS_email |
vrai/faux |
Détermine si le document doit être envoyé par courriel après la signature. |
|
|
OS_settings |
Paramètres de niveau paquet |
||
|
OS_ceremony.OS_ inPerson |
vrai/faux |
Détermine si le paquet requiert une signature en personne. |
|
|
OS_Package |
Propriétés relatives au paquet |
||
|
OS_packageId |
XXXXXXXX |
ID du paquet |
|
|
OS_autocomplete |
vrai/faux |
Détermine si le document doit être examiné avant la finalisation. |
|
|
OS_description |
Description du paquet à partir du backend |
Description du paquet |
|
|
OS_emailMessage |
Paquet de messages électroniques à partir du backend |
Message à envoyer dans le courriel. |
|
|
OS_email |
Adresse électronique de l'expéditeur |
||
|
OS_firstName |
Exemple |
Prénom de l'expéditeur |
|
|
OS_lastName |
Test |
Nom de famille de l'expéditeur |
|
|
OS_language |
en |
Langue du paquet Il doit s'agir de l'une des valeurs suivantes : en, fr, da, de, es, el, it, nl, pt,ru, zh-cn, zh-tw, ja, ko |
|
|
OS_name |
Nom du paquet défini dans le backend |
Nom du paquet |
|
|
OS_due |
20181019 |
Date d'expiration du paquet |
|
|
OS_status |
ENVOYÉ/ÉBAUCHE |
Statut du paquet. Il doit s'agir de l'une des valeurs suivantes : ÉBAUCHE, ENVOYÉ, COMPLÉTÉ, ARCHIVÉ, DÉCLINÉ, REFUSÉ, EXPIRÉ |
|
|
OS_type |
PACKAGE |
Type de paquet. Il doit s'agir de l'une des valeurs suivantes : PACKAGE, TEMPLATE, LAYOUT |
|
|
OS_roles |
Liste des rôles ayant accès au paquet |
||
|
OS_id |
Rôle1 |
Saisissez la chaîne de caractères sans caractères spéciaux |
|
|
OS_name |
Rôle1 |
Nom du rôle |
|
|
OS_index |
1 |
Spécifiez une valeur entière si vous voulez configurer un ordre de signature. | |
|
OS_signers |
Liste des signataires disponibles pour un rôle particulier dans ce paquet |
||
|
OS_email |
Adresse courriel du signataire |
||
|
OS_firstName |
Test |
Prénom du signataire |
|
|
OS_id |
TM |
Saisissez la valeur sans caractères spéciaux. | |
|
OS_title |
M. |
Titre du signataire |
|
|
OS_company |
OneSpan |
Entreprise du signataire | |
|
OS_lastName |
courriel |
Nom de famille du signataire |
|
|
OS_auth |
Méthode d'authentification à appliquer avant la signature du document |
||
|
OS_scheme |
NONE |
Ce schéma doit être l'une des valeurs suivantes : NONE, PROVIDER, CHALLENGE, SMS, SSO, KBA |
|
|
OS_challenges |
Ceci doit être configuré lorsque le "schéma d'authentification" est SMS ou Q&A |
||
|
OS_question |
Quel est le nom de votre animal de compagnie? |
Question à poser avant la signature du document. |
|
|
OS_answer |
XXX |
Réponse à la question |
|
|
OS_maskInput |
vrai/faux |
Détermine si la réponse saisie par le signataire sera masquée ou visible. |
|
|
OS_delivery |
Remise du document signé |
||
|
OS_email |
vrai/faux |
Détermine si le document doit être envoyé par courriel après la signature. |
|
|
OS_settings |
Paramètres de niveau paquet |
||
|
OS_ceremony.OS_inPerson |
vrai/faux |
Détermine si le paquet requiert une signature en personne. | |
|
Documents OS_Package.OS_ |
Propriétés relatives au document |
||
|
OS_id |
Accord NDAA |
ID du document |
|
|
OS_name |
Accord NDAA |
Nom du document |
|
|
OS_description |
Accord de non-divulgation pour les employés |
Description du document |
|
|
OS_extract |
vrai/faux |
Valeur booléenne |
|
|
OS_approvals |
Approbation / Détails du rôle |
||
|
OS_id |
Rôle1 |
ID du rôle à partir de la création du paquet |
|
|
OS_name |
Rôle1 |
Nom du rôle à partir de la création du paquet |
|
|
OS_role |
Rôle1 |
Rôle à partir de la création du paquet |
|
|
OS_fields |
Détails relatifs aux champs |
||
|
OS_id |
myLabelField |
ID du champ |
|
|
OS_height |
50 |
Alignement de la hauteur |
|
|
OS_left |
100 |
Alignement à gauche |
|
|
OS_name |
SIGNATURE |
Nom du champ |
|
|
OS_page |
0 |
Page |
|
|
OS_ subtype |
FULLNAME |
Sous-type du champ. Il peut s'agir de l'une des valeurs suivantes : FULLNAME, INITIALS, CAPTURE, LABEL, TEXTFIELD, TEXTAREA, CHECKBOX, DATE, RADIO, LIST, QRCODE, CUSTOMFIELD, SEAL, MOBILE_CAPTURE, RAW_CAPTURE, DATEPICKER |
|
|
OS_top |
900 |
Alignement en haut |
|
|
OS_type |
SIGNATURE |
Type de champ |
|
|
OS_width |
200 |
Alignement de la largeur |
|
|
OS_id |
myLabelField |
ID du champ |
|
|
OS_height |
50 |
Alignement de la hauteur |
|
|
OS_left |
100 |
Alignement à gauche |
|
|
OS_Package |
Propriétés relatives aux intervalles |
||
|
OS_ packageId |
XXXXXXXX |
Identifiant unique du paquet |
|
|
OS_intervalInDays |
0 |
Heure d'intervalle pour le calendrier de rappels |
|
|
OS_repetitionsCount |
5 |
Le nombre de répétitions |
|
|
OS_startInDaysDelay |
1 |
L'heure à laquelle le prochain rappel est prévu pour renvoyer le paquet |
|
|
OS_Package. |
Détails du document |
||
|
OS_packageId |
XXXX |
Identifiant unique d'un paquet eSignLive |
|
|
OS_documentId |
XXXX |
ID du document |
|
|
OS_approvalId |
XXXX |
ID d'approbation |
|
|
OS_FieldID |
XXXX |
ID du champ |
|
|
OS_fields |
Détails relatifs aux champs |
||
|
OS_id |
myLabelField |
ID du champ |
|
|
OS_height |
50 |
Alignement de la hauteur |
|
|
OS_left |
100 |
Alignement à gauche |
|
|
OS_name |
SIGNATURE |
Nom du champ |
|
|
OS_page |
0 |
Page |
|
|
OS_ subtype |
FULLNAME |
Sous-type du champ. Il peut s'agir de l'une des valeurs suivantes : FULLNAME, INITIALS, CAPTURE, LABEL, TEXTFIELD, TEXTAREA, CHECKBOX, DATE, RADIO, LIST, QRCODE, CUSTOMFIELD, SEAL, MOBILE_CAPTURE, RAW_CAPTURE, DATEPICKER |
|
|
OS_top |
900 |
Alignement en haut |
|
|
OS_type |
SIGNATURE |
Type de champ |
|
|
OS_width |
200 |
Alignement de la largeur |
|