Difference between revisions of "Template:OneSpan"

Revision as of 13:33, 13 September 2023

Overview

The OneSpan electronic signature integration is used within a document agreement or approval process. Users digitally sign documents to express their intent to comply with (or acknowledge the terms of) the contents of the signed document. Documents are typically generated within SmartSimple Cloud using the Special - Web Page View custom field and subsequently sent to OneSpan for the user to sign. Once all desired signatures have been collected, the document is sent back to SmartSimple Cloud.

This article will walk you through how to set up this integration and the related configuration within SmartSimple Cloud. You will need Global Administrator access as well as your own OneSpan license in order to to configure this integration.

Note: When configuring e-signatures, the same syntax is used by OneSpan, SignEasy, and Docusign vendors.

Configuration – Essentials

Creating a OneSpan Account

To use this integration, you must bring your own OneSpan license. This is done outside of SmartSimple Cloud. Learn more about OneSpan’s e-signature product at https://www.onespan.com/products/electronic-signature. Reach out directly to OneSpan to get a license and account. Once you have an account and license, follow the steps below.

Note: whitelisting of IPs may be required.

1. Log in to OneSpan. Based on your country, your login URL may be different.
2. Select “API Access” under the “Admin” option in the menu. An API Key will be automatically assigned.
3. Under “Client Apps”, click the “Add” button to generate a “Client ID” and “Client Secret”. Copy and Save both items. Note: The client secret will only appear once when first generated.
4. Depending on your setup, you may be required to whitelist specific IP addresses. More information can be found in OneSpan's quick start guides for environment URLs and IP addresses.

Setting up the Integration Key in SmartSimple Cloud

Follow the steps below to set up an integration key within SmartSimple Cloud:

1. Log in as a Global Administrator and go to Menu Icon > Global Settings > Integrations tab > Integration Key Management.
2. Click the “New Integration Key” button (plus sign)
3. Set the Type to be “OneSpan Sign”.
   Note: You are only allowed a single integration key with the Type of “OneSpan Sign”.
4. Add your “Environment URL”. The Environment URL is the URL used for authentication into your OneSpan account (Example: https://apps.e-signlive.com/). The URL may differ based on your account and location.
5. Paste the “Client ID” and “Client Secret” saved earlier into their respective fields.

Selecting the E-signature Provider

You may only use one e-signature provider at a time within SmartSimple Cloud. Select OneSpan Sign as the desired e-signature provider by doing the following:

Go to Menu Icon > Global Settings > Integrations tab > Select “OneSpan Sign” for “E-signature Provider”. Click Save.

Creating a Web Page View

After creating your OneSpan account, setting up your integration key, and choosing OneSpan as your e-signature provider, you can now configure a web page view that will be used to send a document to OneSpan for signing by following the steps below:

1. Create or edit a custom field of the type “Special - Web Page View” which will be used to generate a document and send it for signing.
2. For "HTML Template", click "SmartFields Sample Template" to insert the sample template into the field.
3. Replace the variable “@SmartFields@” with your desired content.
4. Add the desired signature tags and referenced anchor strings. See below for examples.
5. Toggle on “Enable E-signature”
6. For the setting “Failed to Complete Workflow” choose the desired workflow you wish to run in the event that the e-signature process fails to complete. Typically you will want to notify someone so they can take action.
7. Toggle on “Enable Save to Server”. This is required for the signed PDF document to be saved within SmartSimple cloud.
8. Click “Save”

Web Page View Sample Code

There are multiple ways you can configure the signing block for e-signatures. We have included code samples that can be added to a web page view custom field.

(Coming Soon)

Submitting a Document for E-signatures

Follow the instructions below to submit a document from a web page view to OneSpan.

1. Navigate to the desired “Special - Web Page View Field” on the desired record and click the button to open it.
2. Click the “E-signature” button
3. Click “Submit this document”. The status will change to “Pending”.