Changes

Template:OneSpan

4,049 bytes added, 17:59, 26 September 2023
m
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.
 
'''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. 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.
===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 following the followingsteps below:
# Go to '''Menu Icon''' > '''Global Settings''' > '''Integrations''' tab > Select “OneSpan Sign” for '''E-signature Provider''' and click .# Click '''Save'''.
===Creating a Web Page View===
# 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 [[# Add the desired signature tags and referenced anchor strings. See 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 cloudCloud.
# Click '''Save'''.
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)====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]] ====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=Sample code using list syntax with fields|800px|Sample code using list syntax with input fields for signees]]
===Submitting a Document for E-signatures===
# Navigate to the desired '''Special - Web Page View''' field on the desired record and open it.
# Click the '''E-signature''' button
# Click '''Submit this document''' to submit send the document to OneSpan. The status will change to “Pending”.
==Configuration – Advanced==
===Mandatory OneSpan Tags===Use the below The following tags are mandatory in order to configure the contact details and signing order for the signees.signature placement: 
{| class="wikitable"
||'''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 requested signees
||
<pre><!--SignatureEmailSubject Place email subject text here--></pre>
||
<pre><!--SignatureEmailSubject A Document Requires Your Signature--></pre>
||Currently must be included but is not used.
|-
||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. Make sure you have a text string that matches the anchor string in this document. You can also fine tune the placement by adding ;;0;;-50;;250;;75;; the values correspond with left position, top position, width and height.
|-
||Defines the date string for the date stamp
||
<pre><!--DateSigned String--></pre>
||
<pre><!--DateSigned DateSigned --></pre>
||Needs to be included in the HTML.
|-
||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 placed before the SignatureBlock anchor tag in the HTML.
|-
||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 signer while they are signing in OneSpan. The signer may add text to the documents using this field and 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.
|-
||Adds a single line text field inside OneSpan
||
<pre><!--FieldBlock Anchor String;;0;;10;;250;;40;;TEXTFIELD --></pre>
||
<pre><!--FieldBlock fieldCTF;;0;;10;;250;;40;;TEXTFIELD--></pre>
||If you add a single line text field, it will appear to the signer while they are signing in OneSpan. The signer may add text to the documents using this field and 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.
|}
Smartstaff
2,091
edits