Difference between pages "Signority Configuration" and "SsEncrypt"

From SmartWiki
(Difference between pages)
Jump to: navigation, search
 
m
 
Line 1: Line 1:
−
Before configuring a {{WPV}} for on-line signing, you will need to determine the following:
+
ssEncrypt and ssEncrypt2 can be used to dynamically generate an encrypted token when creating URLs to access other entities with SmartSimple.
−
#If you are working with a new or existing {{WPV}}
 
−
#How you are going to define the signees for the document (Contacts, other means)
 
−
#Where you are going to store the final signed document (upload field)
 
  
−
==Configuring Global Settings==
+
Tokens are created using two different encryption methods. Accordingly, either ssEncrypt or ssEncrypt2 are used, depending on which [[entity]] is involved:
  
−
[[Image:SignorityConfig1.png|border]]
+
===[[Level 1 Templates|Level 1 template]] page token===
−
 
+
<pre style="white-space: pre-wrap;  white-space: -moz-pre-wrap;  white-space: -pre-wrap;  white-space: -o-pre-wrap;  word-wrap: break-word;"><ssEncrypt>typeid,rootcompanyid</ssEncrypt></pre>
−
Go to Global settings - Connectivity section. There should be a section called '''Online Signature Settings'''.
+
===[[Level 2 Types|Level 2 template]] page token===
−
 
+
<pre style="white-space: pre-wrap;  white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><ssEncrypt>typeid,appid,rootcompanyid</ssEncrypt></pre>
−
This allows you to select the e-signature partners, which in this case would be Signority.
+
When encrypting parameters in an internet enabled level 2 template (in the url /ex/ex_Evtpage.jsp) it is recommended ssEncrypt2 be used.
−
 
+
* Instead of using 'eventid' as a parameter, use 'codedid'
−
You are then required to enter your login details for the relevant Signority Account.
+
* Instead of using 'parentids' as a parameter, use 'enparentids'
−
 
+
Unencrypted:
−
You can also complete the optional '''From Name''' field if you wish a specific From name for the Signority emails.
+
<pre style="white-space: pre-wrap;  white-space: -moz-pre-wrap;  white-space: -pre-wrap;  white-space: -o-pre-wrap; word-wrap: break-word;">
−
 
+
https://alias.smartsimple.com/ex/ex_Evtpage.jsp?token=Gw4NRhwGZVhdQhNRXxdTQlRVbFI%3D&parentids=@opportunityid@&eventid=@eventid@
−
==Configuring the Web Page View==
+
</pre>
−
On the {{WPV}} where you wish to enable signing, enable the following two settings:
+
Encrypted:
−
 
+
<pre style="white-space: pre-wrap;  white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">
−
1) Online Signature : This will enable a new button on the {{WPV}} called "Online Signature"
+
https://alias.smartsimple.com/ex/ex_Evtpage.jsp?token=Gw4NRhwGZVhdQhNRXxdTQlRVbFI%3D&enparentids=<ssEncrypt2>@opportunityid@</ssEncrypt2>&codedid=<ssEncrypt2>@eventid@</ssEncrypt2>
−
:[[Image:Signority-PDFOptions.png|link=]]
+
</pre>
−
2) Store-To value : Determines where the finalized PDF document will be stored in the system.
+
==={{WPV}} token===
−
:[[Image:Signority-ValueStoresTo.png|link=]]
+
<pre style="white-space: pre-wrap;  white-space: -moz-pre-wrap;  white-space: -pre-wrap;  white-space: -o-pre-wrap;  word-wrap: break-word;"><ssEncrypt2>objectid</ssEncrypt2></pre>
−
 
+
Example: To open the {{WPV}} with [[Custom Field ID|custom field ID]] 123456 on a contact you would use the following syntax:
−
By default all on-line signature submissions are flagged as test submissions. Once testing is complete, include the following tag in your {{WPV}}:
+
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><input type=button class=Button  value="Open" onclick="_openpageview('123456','<ssEncrypt2>@userid@</ssEncrypt2>',1)" ></pre>Note: if you have [[URL Parameter Encryption]] enabled, the custom field ID must be encrypted as well using ssEncrypt3. If custom field 654321 is on a {{l1}}:
−
 
+
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><input type=button class=Button  value="Open" onclick="_openpageview('<ssEncrypt3>654321</ssEncrypt3>','<ssEncrypt2>@opportunityid@</ssEncrypt2>',1)" ></pre>
−
{| class="wikitable"
+
===Contact Role Intersection (Level 1)===
−
|-
+
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><ssEncrypt2>oprid</ssEncrypt2></pre>
−
|
+
Example (custom field located on the Level 1 UTA role):
−
<nowiki><!--SignatureProduction--></nowiki>
+
<pre>
−
|}
+
<input type=button class="Button" onclick="javascript:openRoleFields('<ssEncrypt2>@oprid@</ssEncrypt2>',@roleid@)" value="My Vote"/>
−
 
+
<script>
−
==Signature Tag Parameters==
+
function openRoleFields(objectid,roleid){
−
The signature tag is used to define the contact details and signing order for the signee. Each parameter is separated by a semicolon.
+
fieldid_window = window.open('/s_editcustomfields.jsp?
−
 
+
iswin=1&objecttype=91&opportunityid=@levelone.opportunityid@&itemlist='+roleid+'&objectid='+objectid,'field_window',
−
{| class="wikitable"
+
'menubar=no,scrollbars=yes,width=850,height=300,status=no,resizable=yes,top=200,left=200,dependent=yes,alwaysRaised=yes');
−
|-
+
fieldid_window.opener = window;
−
|<nowiki><!--signature email;firstname;lastname;sequenceNo--></nowiki>
+
fieldid_window.focus();
−
|}
+
}
−
 
+
</script>
−
'''Where:'''
+
</pre>
−
:{| class="wikitable"
 
−
|-
 
−
!Parameter!!Description and Use
 
−
|-
 
−
|email
 
−
|Email address of the signee. An email is sent to the signee with a link to sign the document
 
−
|-
 
−
|firstname
 
−
|First name of signee which appears in the email.
 
−
|-
 
−
|lastname
 
−
|Last name of signee which appears in the email.
 
−
|-
 
−
|sequenceNo
 
−
|The numeric signing order if there are multiple signees. Set the value to 1 if a single signee.
 
−
|}
 
−
 
 
−
==Signature line placement==
 
−
The location of the required signatures is defined in the {{WPV}} by the placement of a signature line containing exactly 37 underscores.
 
−
:<font size="3">_____________________________________</font>
 
−
 
 
−
==Signee Email Subject and Body==
 
−
The signees are sent an email which contains a link to view and sign the document. The email subject and message 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>
 
−
|}
 
−
 
 
−
==HTML Examples==
 
−
 
 
−
===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><br />Name : @contact.Signee.fullname@<nowiki><br /></nowiki> <br />Title : @contact.Signee.title@ <nowiki><br /></nowiki><br />
 
−
 
 
−
|}
 
−
 
 
−
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><br />Name : SmartSimple Support<nowiki><br /></nowiki> <br />Title : Support <nowiki><br /></nowiki><br />
 
−
|}
 
−
 
 
−
===Multiple Signatures===
 
−
 
 
−
Use the [[List Syntax]] for contacts in conjunction with the <nowiki><!--Signature--></nowiki> tag and 37-underscore signature line.
 
−
 
 
−
====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~;$?opr_1359726$--></nowiki><br />
 
−
 
 
−
_____________________________________<nowiki><br /></nowiki><br />Name : ~firstname~ ~lastname~<nowiki><br /></nowiki><br />Title : ~title~<nowiki><br /></nowiki><br />#]
 
−
 
 
−
|}
 
−
 
 
−
The field #1359726 is a [[Custom Field Type: Select One – Combo Box|Select One - Combo Box]] with options:
 
−
:<font size="3">''';1;2;3;4;5...n'''</font>
 
−
 
 
−
====Parallel Signing====
 
−
Set the sequence number of signees to the same number for each group of signees. Everyone with the same sequence number will be sent the request for signing at the same time.
 
−
 
 
−
{| class="wikitable"
 
−
|-
 
−
|
 
−
[#(?object=contact;criteria=(roleid='10991' or roleid='10992');orderby=tbl_1359726.valuestr)<br /><nowiki><!--signature ~email~;~firstname~;~lastname~;1--></nowiki><br />_____________________________________<nowiki><br /></nowiki><br />Name : ~firstname~ ~lastname~<nowiki><br /></nowiki><br />
 
−
Title : ~title~<nowiki><br /></nowiki><br />
 
−
<nowiki>#]</nowiki>
 
−
|}
 
−
 
 
−
====Parallel Signing, with multiple sequence groups====
 
−
Configure the Signature tag with multiple sequence numbers. Once the first group (contacts with role IDs 10991 or 10992) has completed signing, the request for signature will be sent to the next group (contacts with role ID of 10993).
 
−
 
 
−
Once all signees of this group have signed, it will request signatures from the next group, or if this is the last group it will complete the document.
 
−
 
 
−
{| class="wikitable"
 
−
|-
 
−
|
 
−
[#(?object=contact;criteria=(roleid='10991' or roleid='10992');orderby=tbl_1359726.valuestr)<br />
 
−
<nowiki><!--signature ~email~;~firstname~;~lastname~;1--></nowiki><br />
 
−
_____________________________________<nowiki><br /></nowiki><br />
 
−
 
 
−
Name : ~firstname~ ~lastname~<nowiki><br /></nowiki><br />
 
−
 
 
−
Title : ~title~<nowiki><br /></nowiki><br />#]<br />[#(?object=contact;criteria=roleid='10993';orderby=tbl_1359726.valuestr)<br /><nowiki><!--signature ~email~;~firstname~;~lastname~;2--></nowiki><br />
 
−
_____________________________________<nowiki><br /></nowiki><br />Name : ~firstname~ ~lastname~<nowiki><br /></nowiki><br />Title : ~title~<nowiki><br /></nowiki><br />
 
−
<nowiki>#]</nowiki><br />
 
−
|}
 
−
 
 
−
{{Template:Signority Variables}}
 
  
 +
===[[Transaction]] token===
 +
<pre style="white-space: pre-wrap;  white-space: -moz-pre-wrap;  white-space: -pre-wrap;  white-space: -o-pre-wrap;  word-wrap: break-word;"><ssEncrypt>userid,typeid</ssEncrypt></pre>
 
==See Also==
 
==See Also==
−
* [[Online Document Signing - Video]]
+
* [[Enable URL Parameter Encryption]]
 +
[[Category:Variables]][[Category:Security]]
  
−
[[Category:Integration]] [[Category: e-Signature]]
+
<!--See 17915 - SERVER UPGRADE NOVEMBER - Save to Server displaying externally-->

Revision as of 14:44, 21 March 2017

ssEncrypt and ssEncrypt2 can be used to dynamically generate an encrypted token when creating URLs to access other entities with SmartSimple.

Tokens are created using two different encryption methods. Accordingly, either ssEncrypt or ssEncrypt2 are used, depending on which entity is involved:

Level 1 template page token

<ssEncrypt>typeid,rootcompanyid</ssEncrypt>

Level 2 template page token

<ssEncrypt>typeid,appid,rootcompanyid</ssEncrypt>

When encrypting parameters in an internet enabled level 2 template (in the url /ex/ex_Evtpage.jsp) it is recommended ssEncrypt2 be used.

  • Instead of using 'eventid' as a parameter, use 'codedid'
  • Instead of using 'parentids' as a parameter, use 'enparentids'

Unencrypted: 

https://alias.smartsimple.com/ex/ex_Evtpage.jsp?token=Gw4NRhwGZVhdQhNRXxdTQlRVbFI%3D&parentids=@opportunityid@&eventid=@eventid@

Encrypted: 

https://alias.smartsimple.com/ex/ex_Evtpage.jsp?token=Gw4NRhwGZVhdQhNRXxdTQlRVbFI%3D&enparentids=<ssEncrypt2>@opportunityid@</ssEncrypt2>&codedid=<ssEncrypt2>@eventid@</ssEncrypt2>

Web Page View token

<ssEncrypt2>objectid</ssEncrypt2>

Example: To open the Web Page View with custom field ID 123456 on a contact you would use the following syntax: 

<input type=button class=Button  value="Open" onclick="_openpageview('123456','<ssEncrypt2>@userid@</ssEncrypt2>',1)" >
Note: if you have URL Parameter Encryption enabled, the custom field ID must be encrypted as well using ssEncrypt3. If custom field 654321 is on a Level 1: 
<input type=button class=Button  value="Open" onclick="_openpageview('<ssEncrypt3>654321</ssEncrypt3>','<ssEncrypt2>@opportunityid@</ssEncrypt2>',1)" >

Contact Role Intersection (Level 1)

<ssEncrypt2>oprid</ssEncrypt2>

Example (custom field located on the Level 1 UTA role): 

<input type=button class="Button" onclick="javascript:openRoleFields('<ssEncrypt2>@oprid@</ssEncrypt2>',@roleid@)" value="My Vote"/>
<script>
function openRoleFields(objectid,roleid){
fieldid_window = window.open('/s_editcustomfields.jsp?
iswin=1&objecttype=91&opportunityid=@levelone.opportunityid@&itemlist='+roleid+'&objectid='+objectid,'field_window',
'menubar=no,scrollbars=yes,width=850,height=300,status=no,resizable=yes,top=200,left=200,dependent=yes,alwaysRaised=yes');
fieldid_window.opener = window;
fieldid_window.focus();
}
</script>

Transaction token

<ssEncrypt>userid,typeid</ssEncrypt>

See Also

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Signority_Configuration&oldid=29083’