Difference between revisions of "SignEasy"

From SmartWiki
Jump to: navigation, search
(Created page with "{{ Banner-UnderConstruction }} ==Configuring Global Settings== 1. Go to Global Settings - Integrations - Integration Key Management. <br /> 2. Click on '''New Integration Key...")
 
 
(2 intermediate revisions by the same user not shown)
Line 18: Line 18:
 
* You can also create an Upload field if desired, in which to store the signed PDF file. Use the Store-To Value option in the Web Page View field to point to this additional field.
 
* You can also create an Upload field if desired, in which to store the signed PDF file. Use the Store-To Value option in the Web Page View field to point to this additional field.
  
 +
6. Make sure you've created a role for your Signees, and that the intended person is added as a Contact using this role. Your Web Page View field will need to contain list syntax that specifies the roleid; this is how SmartSimple knows to whom the e-signature request should be sent.
  
 +
* for API Key and Client ID, follow [https://docs.signeasy.com/docs/generating-api-keys-for-production these instructions].
 +
 +
Tip: Within the Web Page View window, you can click the Online Signature button to view the status of the current request once it's been sent.
 +
 +
==SignEasy Tags==
 +
{| class="wikitable"
 +
|-
 +
||'''Function'''
 +
||'''Tag Format'''
 +
||'''Example'''
 +
||'''Notes'''
 +
|-
 +
||Populate the email body
 +
||
 +
<pre><!--SignatureEmailBody Place body text here.--></pre>
 +
||
 +
<pre><!--SignatureEmailBody This is a test.--></pre>
 +
||
 +
|-
 +
||Configure the CC email list
 +
||
 +
<pre><!--SignatureCC email;Name,email2;Name2--></pre>
 +
||
 +
<pre><!--SignatureCC abc@fake.com;ABC Smith,qa1@fake.com;QA1--></pre>
 +
||Emails will be copied to the list of people included here.
 +
|-
 +
||Configure the email flow for multiple signees
 +
||
 +
<pre><!--SignatureFlow Indicator--></pre>
 +
||
 +
<pre><!--SignatureFlow P--></pre>
 +
||If you specify the signature flow as P (Parallel), emails will be sent to all signees at the same time.
 +
If you specify the signature flow as S (Sequential), emails will be sent sequentially; for example: email will only be sent to the second signee after the first signee has completed signing the document, and so on. (if left out, behaviour will default to Parallel)
 +
|}
 +
 +
==Note==
 +
For SignEasy to retrieve signee emails, names etc, you will have to embed them in your HTML. They will then be used in the email sent to signees. For example:
 +
 +
<pre>  [#(?object=contact;criteria=roleid='12527';orderby=firstname) <!--SignatureFlow P--><!--signature ~email~;SIGNER;~firstname~;~lastname~;~Index~;~companyname~-->#]</pre>
 +
 +
If you have 3 signees assigned to the Level 1, the HTML in your Web Page View will be embedded with the info for all three:
 +
 +
<pre>
 +
<!--signature ttest@smartsimple.com;SIGNER;Tony;Test;1;SmartSimple Software -->
 +
<!--signature fake@smartsimple.com;SIGNER;Fake;Man;2;Fake Co. -->
 +
<!--signature fake2@smartsimple.com;SIGNER;Fake2;Mann;3;Fake2 Co. -->
 +
</pre>
  
 
[[Category:Integration]]
 
[[Category:Integration]]
 
[[Category:External Services]]
 
[[Category:External Services]]
 
[[Category: e-Signature]]
 
[[Category: e-Signature]]

Latest revision as of 15:04, 9 September 2019


Construction warning.png Please note that this page is currently under construction. There is more information to come.

Configuring Global Settings

1. Go to Global Settings - Integrations - Integration Key Management.
2. Click on New Integration Key. You will be presented with the following fields:

  • Key Type: SignEasy
  • Key name: set to SignEasy
  • API Key**:
  • Client ID**: unique code for the client (see below for a description of where these are found)

3. Back in SmartSimple, Click Save once both values have been entered.
4. On the Integrations tab, look for the Online Signature Provider section, and select SignEasy. You will then need to click the button labeled "Activate SignEasy Access". Once you've saved, the text next to the button should read: SignEasy Access: Enabled.
5. Configure your Web Page View field and use the tags outlined below to incorporate SignEasy functions with your SmartSimple data. Make sure these two field options are enabled:

  • Online Signature: This will enable a new button in the Web Page View called "Online Signature".
  • Enable Save to Server: This will allow a copy of the signed PDF document to be saved within SmartSimple.
  • You can also create an Upload field if desired, in which to store the signed PDF file. Use the Store-To Value option in the Web Page View field to point to this additional field.

6. Make sure you've created a role for your Signees, and that the intended person is added as a Contact using this role. Your Web Page View field will need to contain list syntax that specifies the roleid; this is how SmartSimple knows to whom the e-signature request should be sent.

Tip: Within the Web Page View window, you can click the Online Signature button to view the status of the current request once it's been sent.

SignEasy Tags

Function Tag Format Example Notes
Populate the email body
<!--SignatureEmailBody Place body text here.-->
<!--SignatureEmailBody This is a test.-->
Configure the CC email list
<!--SignatureCC email;Name,email2;Name2-->
<!--SignatureCC abc@fake.com;ABC Smith,qa1@fake.com;QA1-->
Emails will be copied to the list of people included here.
Configure the email flow for multiple signees
<!--SignatureFlow Indicator-->
<!--SignatureFlow P-->
If you specify the signature flow as P (Parallel), emails will be sent to all signees at the same time.

If you specify the signature flow as S (Sequential), emails will be sent sequentially; for example: email will only be sent to the second signee after the first signee has completed signing the document, and so on. (if left out, behaviour will default to Parallel)

Note

For SignEasy to retrieve signee emails, names etc, you will have to embed them in your HTML. They will then be used in the email sent to signees. For example:

  [#(?object=contact;criteria=roleid='12527';orderby=firstname) <!--SignatureFlow P--><!--signature ~email~;SIGNER;~firstname~;~lastname~;~Index~;~companyname~-->#]

If you have 3 signees assigned to the Level 1, the HTML in your Web Page View will be embedded with the info for all three:

<!--signature ttest@smartsimple.com;SIGNER;Tony;Test;1;SmartSimple Software -->
<!--signature fake@smartsimple.com;SIGNER;Fake;Man;2;Fake Co. -->
<!--signature fake2@smartsimple.com;SIGNER;Fake2;Mann;3;Fake2 Co. -->