Smartstaff
2,107
edits
Changes
m
To use this integration, you must bring your own OneSpan license. This is done outside of SmartSimple Cloud. Learn more about OneSpan’s e# Navigate to the desired '''Special -signature product at https://wwwWeb Page View''' field on the desired record and open it.onespan.com/products/electronic# Click the '''E-signature. Reach out directly ''' button# Click '''Submit this document''' to send the document to OneSpan . The status will change to get a license and account. Once you have an account and license, follow the steps below“Pending”.
Note==Configuration – Advanced=====Mandatory OneSpan Tags===The following tags are mandatory in order to configure contact details and signature placement: whitelisting of IPs may be required.
# Log {| class="wikitable"|-||'''Function'''||'''Tag Format'''||'''Example'''||'''Notes'''|-||Assigns a name to the document that needs an e-signature||<pre><!--SignatureName Document Name--></pre>||<pre><!--SignatureName Grant Agreement--></pre>||The name of the document declared here will appear in various locations.|-||Populates the subject of the email sent to https:requested signees||<pre><!--SignatureEmailSubject Place email subject text here--></pre>||<pre><!--SignatureEmailSubject A Document Requires Your Signature--></wwwpre>||Currently must be included but is not used.onespan|-||Defines the anchor string of the signature block||<pre><!--SignatureBlock Anchor String--></pre>||<pre><!--SignatureBlock SignHere --></pre>||The signature block will appear wherever the SignatureBlock anchor text is placed.com/ Make sure you have a text string that matches the anchor string in this document. Based on your countryYou can also fine tune the placement by adding ;;0;;-50;;250;;75;; the values correspond with left position, your login URL may be differenttop position, width and height.# Select “API Access” under |-||Defines the date string for the “Admin” option date stamp||<pre><!--DateSigned String--></pre>||<pre><!--DateSigned DateSigned --></pre>||Needs to be included in the menuHTML. An API Key will |-||Defines metadata for the target signature||<pre><!--signature Email;SIGNER;FirstName;LastName;Index;Company--></pre>||<pre><!--signature youremail@example.com;SIGNER;John;Smith;1;ABC Company Name, Inc.--></pre>||This tag should be automatically assignedplaced before the SignatureBlock anchor tag in the HTML.# Under “Client Apps”, click |-||Adds a multiple line text field inside OneSpan||<pre><!--FieldBlock Anchor String;;0;;10;;250;;120;;TEXTAREA --></pre>||<pre><!--FieldBlock fieldCTA;;0;;10;;250;;120;;TEXTAREA --></pre>||If you add a multiple line text field it will appear to the “Add” button signer while they are signing in OneSpan. The signer may add text to generate a “Client ID” and “Client Secret”. Copy the documents using this field and Save both items. Note: The client secret that text will only appear once when first generatedbe saved in the PDF.# Depending on your setupIf you create a new PDF, you may be required to whitelist specific IP addresses. More that information can will not be found in [https://communityretained outside the original PDF that was generated.onespan.com/documentation/onespan|-||Adds a single line text field inside OneSpan||<pre><!--sign/guides/quickFieldBlock Anchor String;;0;;10;;250;;40;;TEXTFIELD -start-guides></developer/environmentpre>||<pre><!--urlsFieldBlock fieldCTF;;0;;10;;250;;40;;TEXTFIELD-ip-addresses ></pre>||If you add a single line text field, it will appear to the signer while they are signing in OneSpan's quick start guides for environment URLs . The signer may add text to the documents using this field and IP addresses]that text will only be saved in the PDF. If you create a new PDF, that information will not be retained outside the original PDF that was generated.|}
→Mandatory OneSpan Tags
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.
==Configuration – Essentials=====Creating a OneSpan Account===To use this integration, you must bring your own OneSpan license. This is done outside of SmartSimple Cloud. Reach out directly to OneSpan to get a licensed account and learn more about [https://www.onespan.com/products/electronic-signature their products]. Once you have an account and license, follow the steps below: # Log in to [https://www.onespan.com OneSpan]. Based on your country, your login URL may be different.# Select “API Access” under the “Admin” option in the menu. An API key will be automatically assigned.# Under “Client Apps”, click the “Add” button to generate a “Client ID” and “Client Secret”. Be sure to copy and save both items as these codes will only appear once when first generated. <u>'''Note:'''</u> Depending on your setup, you may be required to whitelist specific IP addresses. More information can be found in [https://community.onespan.com/documentation/onespan-sign/guides/quick-start-guides/developer/environment-urls-ip-addresses 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: # Log in as a '''Global Administrator''' and go to '''Menu Icon''' > '''Global Settings''' > '''Integrations''' tab > '''Integration Key Management'''.# Click the '''New Integration Key''' button represented by the plus sign.# Set the '''Type''' to be “OneSpan Sign”. <br /> <u>'''Note:''' When configuring </u> You are only allowed a single integration key with the '''Type''' of “OneSpan Sign”.# Add your '''Environment URL'''. This refers to the URL used for authentication into your OneSpan account (Example: https://apps.e-signatures, signlive.com). The URL may differ based on your account and location.# 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 same syntax is used desired e-signature provider by following the steps below: # 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 OneSpanaccount, SignEasysetting up your integration key, and Docusign vendorschoosing 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: # Create or edit a '''Special - Web Page View''' custom field. This field will be used to generate a document and send it for signing.# For '''HTML Template''', click "SmartFields Sample Template" link to insert the sample template into the field.# Replace the variable “@SmartFields@” with your desired content. See the [[#Web Page View Sample Code|Web Page View Sample Code]] section below for examples. # Toggle on '''Enable E-signature'''.# For '''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.# Toggle on '''Enable Save to Server'''. This is required for the signed PDF document to be saved within SmartSimple Cloud.# 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. ====Example: Using Hard Code====Replace the variable “@SmartFields@” in the webpage view custom field with the following sample code: '''[[:File:onespan-hardcode-sample.zip|Download Hard Code Sample]].''' [[File:onespan-hardcode.png|thumb|none|alt=Sample code with hardcoded information|800px|Sample code using hardcoded information for signers]] ====Example: Using Variables====Replace the variable “@SmartFields@” with the following sample code: '''[[:File:onespan-variables-sample.zip|Download Variables Sample]]''' [[File:onespan-variable.png|thumb|none|alt=Sample code using variables|800px|Sample code using variables for signees]] ====Example: Using List Syntax====Replace the variable “@SmartFields@” with the following sample code: '''[[:File:onespan-listsyntax-sample.zip|Download List Syntax Sample]]'''
'''Note:''' In order to use the list syntax you are expected to create a role and attach signers to the record in that role.
[[File:onespan-list-snytax.png|thumb|none|alt=Sample code using list syntax|800px|Sample code using list syntax for signees]]
== Configuration – Essentials ==Example: Using List Syntax with Input Fields====Replace the variable “@SmartFields@” with the following sample code: [[:File:onespan-listsyntax-fields-sample.zip|Download List Syntax with Fields Sample]]
'''Note:''' In order to use the list syntax you are expected to create a role and attach signers to the record in that role. Also note, any data entered into these fields that appear to the signer inside OneSpan will only be visible in the original PDF.
[[File:onespan-list-snytax-fields.png|thumb|none|alt===Creating a OneSpan Account===Sample code using list syntax with fields|800px|Sample code using list syntax with input fields for signees]]
===Submitting a Document for E-signatures===
Follow the instructions below to submit a document from a web page view to OneSpan.
