Smartstaff
2,363
edits
Changes
Created page with "==Configuring Global Settings== ''Note: In order to use this feature you must request your URL to be whitelisted with development. This can be requested via support ticket.''..."
==Configuring Global Settings==
''Note: In order to use this feature you must request your URL to be whitelisted with development. This can be requested via support ticket.''
1. Go to Global settings - Integrations section - Service Settings.
2. Access the option for '''Integration Key Management'''.
3. Click on New Integration Key. You will be presented with the following fields:
* Key Type: set to Adobe Acrobat Sign
* Key name: Adobe Acrobat Sign
* Application ID (#3): unique Adobe Client ID (from Adobe Acrobat Sign Account)
* Client Secret (#4): unique Client Secret (from Adobe Acrobat Sign Account)
* Authentication URL (#5): URL is generic based on your location (from Adobe Acrobat Sign Account)
:: '''To retrieve the above information from your Adobe Sign account:'''
:: 3.1. Login to your Adobe Account
:: 3.2. Go to Account
:: 3.3. To retrieve Client ID and Client Secret:
::: - in Account tab - Adobe Sign API - API Applications (fig. 1)<br />- click on the API Applications record (fig. 1)<br />- click on the link '''Configure OAuth for Application '''(fig. 2)'''<br />'''- copy the Client ID for Application ID (#3)<br />- copy the Client Secret for Client Secret (#4)<br />- make sure Redirect URI included the link for your instance, e.g. https://smart.smartsimple.com/OAuthsp/callback.jsp or https://abcfoundation.smartsimple.com/OAuthsp/callback.jsp<br />- select "self" for the "Enabled Scopes" section, ie. user_login: '''self''', agreement_read: '''self''', agreement_write: '''self''', agreement_send: '''self'''
:: (fig. 1)[[File:adobesecret1.png|thumb|none|800px|Adobe Account Setup.]]
:: (fig. 2)[[File:adobesecret2.png|thumb|none|300px|Adobe Account Setup.]]
:: 3.4. To retrieve Authentication URL:
::: - in Account tab - Account Settings - Account Setup (fig. 3)<br />- check Hostname, e.g. na2.echosign.com or eu1.echosign.com (fig. 3)<br />- use this to construct the Authentication URL (#5), ** only take the region portion, ie. na1, na2, eu1 etc:<br />e.g. Adobe Sign Hostname = '''eu1'''.adobesign.com --> Authentication URL = '''secure.eu1'''.adobesign.com/public/oauth<br />e.g. Adobe Sign Hostname = '''na2'''.documents.adobe.com--> Authentication URL = '''secure.na2'''.adobesign.com/public/oauth <br />(eg. https://secure.adobesign.com/public/oauth or https://secure.na2.adobesign.com/public/oauth or https://secure.eu1.adobesign.com/public/oauth, etc.)
::: NOTE: For some Adobe Sign accounts, the version has to be added to the Authentication URL, if you see an error as "use_oauth_v2_apis" during authentication process, append /v2 to the Authentication URL (eg. https://secure.adobesign.com/public/oauth/v2 or https://secure.na2.adobesign.com/public/oauth/v2 or https://secure.eu1.adobesign.com/public/oauth/v2)
:: (fig. 3)[[File:Adobe2.png|thumb|none|500px|Adobe Account Setup.]]
4. Click Save.<br />
5. Go to Global settings - Integrations section - Service Settings. The '''Online Signature Provider''' section allows you to select the e-signature partners, select '''Adobe Acrobat Sign'''.<br />
6. Click Save, after page refreshes, under '''Online Signature provider''', click '''Verify Adobe Acrobat Sign Access'''.<br />
7. A popup will be launched, enter your login details for the relevant Adobe Account and authorize access for SmartSimple.
==Configuring the Web Page View==
On the {{WPV}} where you wish to enable signing, enable the following two settings:
1) Online Signature: This will enable a new button on the {{WPV}} called "Online Signature"
: [[Image:Signority-PDFOptions.png|link=]]
2) Store-To value: Determines where the finalized PDF document will be stored in the system.
: [[Image:Signority-ValueStoresTo.png|link=]]
==Signature Tag Parameters==
The signature tag is used to define the contact details and signing order for the signee.
* <nowiki>{{_es_:sender:title}} </nowiki>- name of the sender. Will be the name associated with the Adobe Acrobat Sign account configured in the Global Settings.
* <nowiki>{{_es_:signer1:signatureblock}} </nowiki> - may be used for defining one signature line placement in conjunction with syntax for defining the signee using variable syntax <!--signature @Signee Email@;@Signee Firstname@;@Signee Lastname@;1-->
* <nowiki>{{_es_:signer~Index~:signature}}</nowiki> - will automatically add all the signees signatures from the contact list to the web page view
* <nowiki>{{_es_:signer~Index~:signatureblock}}</nowiki> - will automatically add all the signees signatures from the contact list to the web page view
* <nowiki>{{_es_:signer~Index~:initials}} </nowiki>- will automatically add all the signees initials from the contact list to the web page view
* <nowiki>{{_es_:signer~Index~:company}} </nowiki>- will automatically add all the signees Company from the contact list to the web page view
* <nowiki>{{_es_:signer~Index~:fullname}}</nowiki> - will automatically add all the signees from the contact list to the web page view
* <nowiki>{{_es_:signer~Index~:optsignature}} </nowiki> - will automatically add all the signees from the contact list to the web page view as optional signatures
* <nowiki>{{_es_: signer~Index~:optinitials}}</nowiki>:- will automatically add all the signees initials from the contact list to the web page view
* <nowiki>{{ _es_: signer~Index~:date}}</nowiki>:- will automatically add all the signees' date of signature
* <nowiki>{{ _es_: signer~Index~:digitalsignature}}</nowiki>:- will automatically add all the signees digital signatures from the contact list to the web page view (clients are required to set up the Digital Signatures setting in their Adobe Sign account - Account - Digital Signatures)
==Signee Email Subject and Body and Other details==
The signees are sent an email which contains a link to view and sign the document. The custom details of the email can be configured with tags added on the {{WPV}}. Variables and text can be used.
{| class="wikitable"
|-
||
<nowiki><!--SignatureEmailSubject System No: @opportunityid@--></nowiki>
<nowiki><!--SignatureEmailBody Please sign for record #: @opportunityid@--></nowiki>
<nowiki><!--SignatureCC abc123@smartsimple.com abc456@smartsimple.com--></nowiki>
<nowiki><!--SignatureLocale fr_FR--></nowiki>
<nowiki><!--SignatureExpiryDays 7--></nowiki>
<nowiki><!--SignatureFlow P--></nowiki>
|}
The SignatureExpiryDays tag represents the number of days that remain before the document expires on Adobe Acrobat Sign. If not configured, SmartSimple will expire it after 30 days.
The SignatureFlow tag is used in conjunction [[List Syntax]] for contacts and with the signature tags to define the signing order:
* Parallel: <nowiki><!--SignatureFlow P--> </nowiki>
* Sequencial: <nowiki><!--SignatureFlow S--></nowiki>
==HTML Examples==
Syntax to configure WPV for Adobe Acrobat Sign is based on the same syntax as Signority except for specific Signature Tag Parameters that Adobe Acrobat Sign required. For more examples, please refer to the [[Signority Configuration]].
===Single Signature===
For single signatures, you can reference custom fields which contain the email, first name and last name of the signee.
In the example below, the recipient has been added as a {{UTA}} contact with the [[UTA role]] of "Signee."
{| class="wikitable"
|-
||
<nowiki><!--signature @contact.Signee.email@;@contact.Signee.firstname@;@contact.Signee.lastname@;1--></nowiki><br />
<nowiki><br /></nowiki><nowiki>{{_es_:signer:signatureblock}}</nowiki><nowiki><br /></nowiki><br />Name : @contact.Signee.fullname@<nowiki><br /></nowiki> <br />Title : @contact.Signee.title@ <nowiki><br /></nowiki>
|}
You can also hard code the parameters, if there is a contact that will always be signing the document.
{| class="wikitable"
|-
||
<nowiki><!--signature support@smartsimple.com;SmartSimple;Support;1--></nowiki><br /><nowiki><br /></nowiki><nowiki>{{_es_:signer:signatureblock}}</nowiki><nowiki><br /></nowiki><br />Name : SmartSimple Support<nowiki><br /></nowiki> <br />Title : Support <nowiki><br /></nowiki>
|}
===Multiple Signatures===
Use the [[List Syntax]] for contacts in conjunction with the Adobe Signature Tag Parameters.
====Sequential Signatures====
The order of the signees is determined by the order they appear on the {{WPV}}. If sorting by anything other than by signing number, such as by name, leave the sequence parameter blank as the system will automatically assign a number once submitted.
The following example pulls all contacts attached to the {{l1}} with a [[role ID]] of 10991 or 10992, and sorts the contacts by the value of [[Role Based Custom Fields|UTA role field]] 1359726.
{| class="wikitable"
|-
||
[#(?object=contact;criteria=(roleid='10991' or roleid='10992');orderby=tbl_1359726.valuestr)<br />
<nowiki><!--signature ~email~;~firstname~;~lastname~;~Index~--></nowiki>
<nowiki><br /></nowiki><nowiki>{{_es_:signer~Index~:signature}}</nowiki><nowiki><br /></nowiki><br />
<br />Initials : <nowiki>{{_es_: signer~Index~::optinitials}}</nowiki><nowiki><br /></nowiki><br />Name : ~firstname~ ~lastname~<nowiki><br /></nowiki><br />Title : ~title~<nowiki><br /></nowiki><br />#]
|}
[[Category:Integration]]
[[Category:External Services]]
[[Category: e-Signature]]
''Note: In order to use this feature you must request your URL to be whitelisted with development. This can be requested via support ticket.''
1. Go to Global settings - Integrations section - Service Settings.
2. Access the option for '''Integration Key Management'''.
3. Click on New Integration Key. You will be presented with the following fields:
* Key Type: set to Adobe Acrobat Sign
* Key name: Adobe Acrobat Sign
* Application ID (#3): unique Adobe Client ID (from Adobe Acrobat Sign Account)
* Client Secret (#4): unique Client Secret (from Adobe Acrobat Sign Account)
* Authentication URL (#5): URL is generic based on your location (from Adobe Acrobat Sign Account)
:: '''To retrieve the above information from your Adobe Sign account:'''
:: 3.1. Login to your Adobe Account
:: 3.2. Go to Account
:: 3.3. To retrieve Client ID and Client Secret:
::: - in Account tab - Adobe Sign API - API Applications (fig. 1)<br />- click on the API Applications record (fig. 1)<br />- click on the link '''Configure OAuth for Application '''(fig. 2)'''<br />'''- copy the Client ID for Application ID (#3)<br />- copy the Client Secret for Client Secret (#4)<br />- make sure Redirect URI included the link for your instance, e.g. https://smart.smartsimple.com/OAuthsp/callback.jsp or https://abcfoundation.smartsimple.com/OAuthsp/callback.jsp<br />- select "self" for the "Enabled Scopes" section, ie. user_login: '''self''', agreement_read: '''self''', agreement_write: '''self''', agreement_send: '''self'''
:: (fig. 1)[[File:adobesecret1.png|thumb|none|800px|Adobe Account Setup.]]
:: (fig. 2)[[File:adobesecret2.png|thumb|none|300px|Adobe Account Setup.]]
:: 3.4. To retrieve Authentication URL:
::: - in Account tab - Account Settings - Account Setup (fig. 3)<br />- check Hostname, e.g. na2.echosign.com or eu1.echosign.com (fig. 3)<br />- use this to construct the Authentication URL (#5), ** only take the region portion, ie. na1, na2, eu1 etc:<br />e.g. Adobe Sign Hostname = '''eu1'''.adobesign.com --> Authentication URL = '''secure.eu1'''.adobesign.com/public/oauth<br />e.g. Adobe Sign Hostname = '''na2'''.documents.adobe.com--> Authentication URL = '''secure.na2'''.adobesign.com/public/oauth <br />(eg. https://secure.adobesign.com/public/oauth or https://secure.na2.adobesign.com/public/oauth or https://secure.eu1.adobesign.com/public/oauth, etc.)
::: NOTE: For some Adobe Sign accounts, the version has to be added to the Authentication URL, if you see an error as "use_oauth_v2_apis" during authentication process, append /v2 to the Authentication URL (eg. https://secure.adobesign.com/public/oauth/v2 or https://secure.na2.adobesign.com/public/oauth/v2 or https://secure.eu1.adobesign.com/public/oauth/v2)
:: (fig. 3)[[File:Adobe2.png|thumb|none|500px|Adobe Account Setup.]]
4. Click Save.<br />
5. Go to Global settings - Integrations section - Service Settings. The '''Online Signature Provider''' section allows you to select the e-signature partners, select '''Adobe Acrobat Sign'''.<br />
6. Click Save, after page refreshes, under '''Online Signature provider''', click '''Verify Adobe Acrobat Sign Access'''.<br />
7. A popup will be launched, enter your login details for the relevant Adobe Account and authorize access for SmartSimple.
==Configuring the Web Page View==
On the {{WPV}} where you wish to enable signing, enable the following two settings:
1) Online Signature: This will enable a new button on the {{WPV}} called "Online Signature"
: [[Image:Signority-PDFOptions.png|link=]]
2) Store-To value: Determines where the finalized PDF document will be stored in the system.
: [[Image:Signority-ValueStoresTo.png|link=]]
==Signature Tag Parameters==
The signature tag is used to define the contact details and signing order for the signee.
* <nowiki>{{_es_:sender:title}} </nowiki>- name of the sender. Will be the name associated with the Adobe Acrobat Sign account configured in the Global Settings.
* <nowiki>{{_es_:signer1:signatureblock}} </nowiki> - may be used for defining one signature line placement in conjunction with syntax for defining the signee using variable syntax <!--signature @Signee Email@;@Signee Firstname@;@Signee Lastname@;1-->
* <nowiki>{{_es_:signer~Index~:signature}}</nowiki> - will automatically add all the signees signatures from the contact list to the web page view
* <nowiki>{{_es_:signer~Index~:signatureblock}}</nowiki> - will automatically add all the signees signatures from the contact list to the web page view
* <nowiki>{{_es_:signer~Index~:initials}} </nowiki>- will automatically add all the signees initials from the contact list to the web page view
* <nowiki>{{_es_:signer~Index~:company}} </nowiki>- will automatically add all the signees Company from the contact list to the web page view
* <nowiki>{{_es_:signer~Index~:fullname}}</nowiki> - will automatically add all the signees from the contact list to the web page view
* <nowiki>{{_es_:signer~Index~:optsignature}} </nowiki> - will automatically add all the signees from the contact list to the web page view as optional signatures
* <nowiki>{{_es_: signer~Index~:optinitials}}</nowiki>:- will automatically add all the signees initials from the contact list to the web page view
* <nowiki>{{ _es_: signer~Index~:date}}</nowiki>:- will automatically add all the signees' date of signature
* <nowiki>{{ _es_: signer~Index~:digitalsignature}}</nowiki>:- will automatically add all the signees digital signatures from the contact list to the web page view (clients are required to set up the Digital Signatures setting in their Adobe Sign account - Account - Digital Signatures)
==Signee Email Subject and Body and Other details==
The signees are sent an email which contains a link to view and sign the document. The custom details of the email can be configured with tags added on the {{WPV}}. Variables and text can be used.
{| class="wikitable"
|-
||
<nowiki><!--SignatureEmailSubject System No: @opportunityid@--></nowiki>
<nowiki><!--SignatureEmailBody Please sign for record #: @opportunityid@--></nowiki>
<nowiki><!--SignatureCC abc123@smartsimple.com abc456@smartsimple.com--></nowiki>
<nowiki><!--SignatureLocale fr_FR--></nowiki>
<nowiki><!--SignatureExpiryDays 7--></nowiki>
<nowiki><!--SignatureFlow P--></nowiki>
|}
The SignatureExpiryDays tag represents the number of days that remain before the document expires on Adobe Acrobat Sign. If not configured, SmartSimple will expire it after 30 days.
The SignatureFlow tag is used in conjunction [[List Syntax]] for contacts and with the signature tags to define the signing order:
* Parallel: <nowiki><!--SignatureFlow P--> </nowiki>
* Sequencial: <nowiki><!--SignatureFlow S--></nowiki>
==HTML Examples==
Syntax to configure WPV for Adobe Acrobat Sign is based on the same syntax as Signority except for specific Signature Tag Parameters that Adobe Acrobat Sign required. For more examples, please refer to the [[Signority Configuration]].
===Single Signature===
For single signatures, you can reference custom fields which contain the email, first name and last name of the signee.
In the example below, the recipient has been added as a {{UTA}} contact with the [[UTA role]] of "Signee."
{| class="wikitable"
|-
||
<nowiki><!--signature @contact.Signee.email@;@contact.Signee.firstname@;@contact.Signee.lastname@;1--></nowiki><br />
<nowiki><br /></nowiki><nowiki>{{_es_:signer:signatureblock}}</nowiki><nowiki><br /></nowiki><br />Name : @contact.Signee.fullname@<nowiki><br /></nowiki> <br />Title : @contact.Signee.title@ <nowiki><br /></nowiki>
|}
You can also hard code the parameters, if there is a contact that will always be signing the document.
{| class="wikitable"
|-
||
<nowiki><!--signature support@smartsimple.com;SmartSimple;Support;1--></nowiki><br /><nowiki><br /></nowiki><nowiki>{{_es_:signer:signatureblock}}</nowiki><nowiki><br /></nowiki><br />Name : SmartSimple Support<nowiki><br /></nowiki> <br />Title : Support <nowiki><br /></nowiki>
|}
===Multiple Signatures===
Use the [[List Syntax]] for contacts in conjunction with the Adobe Signature Tag Parameters.
====Sequential Signatures====
The order of the signees is determined by the order they appear on the {{WPV}}. If sorting by anything other than by signing number, such as by name, leave the sequence parameter blank as the system will automatically assign a number once submitted.
The following example pulls all contacts attached to the {{l1}} with a [[role ID]] of 10991 or 10992, and sorts the contacts by the value of [[Role Based Custom Fields|UTA role field]] 1359726.
{| class="wikitable"
|-
||
[#(?object=contact;criteria=(roleid='10991' or roleid='10992');orderby=tbl_1359726.valuestr)<br />
<nowiki><!--signature ~email~;~firstname~;~lastname~;~Index~--></nowiki>
<nowiki><br /></nowiki><nowiki>{{_es_:signer~Index~:signature}}</nowiki><nowiki><br /></nowiki><br />
<br />Initials : <nowiki>{{_es_: signer~Index~::optinitials}}</nowiki><nowiki><br /></nowiki><br />Name : ~firstname~ ~lastname~<nowiki><br /></nowiki><br />Title : ~title~<nowiki><br /></nowiki><br />#]
|}
[[Category:Integration]]
[[Category:External Services]]
[[Category: e-Signature]]