DocuSign Integration - Revision history

Tvi: 9 revisions imported

2021-12-10T10:51:22Z

9 revisions imported

← Older revision	Revision as of 12:51, 10 December 2021
(No difference)

old>Tvi: Retskrivning

2021-07-05T14:36:20Z

Retskrivning

← Older revision		Revision as of 16:36, 5 July 2021
Line 1:		Line 1:
	== Prereq ==		== Prereq ==

	To ~~setup the~~ integration an account ~~with~~ one of the following criteria is needed.<br/>		To set up DocuSign integration an account that meets one of the following criteria is needed.<br/>
	~~Either it should be a~~ DocuSign-partner or ~~subscribed to the "~~Advanced developer ~~plan~~".		* A DocuSign-partner or
			* Advanced developer" license

	To use the integration, the uploading user only needs a regular eSignature subscription.		To use the integration, the uploading user only needs a regular eSignature subscription.

	The integration will be created in demo mode and has to be approved, before it can be moved to production.<br/>		The integration will initially be created in demo mode and has to be approved, before it can be moved to production.<br/>
	~~The criteria for that is: the last~~ 20 uploads ~~have to be successful and~~ performed within the last 30 days.<br/>		Approval requires 20 consecutive successful uploads performed within the last 30 days.<br/>
	After that, an account with the proper access has to sign in and the integration will be transferred to their account.		After that, an account with the proper access permissions has to sign in and the integration will be transferred to their account.

	== Setup in DocuSign ==		== Setup in DocuSign ==

	First: Sign in with an admin account and create a new "Integration" under "Settings" -> "Integrations" -> "Apps and Keys". Give it a descriptive name~~, it~~ will be shown to all who upload documents via the integration.		First: Sign in with an admin account and create a new "Integration" under "Settings" -> "Integrations" -> "Apps and Keys". Give it a descriptive name. This name will be shown to all who upload documents via the integration.

	Second: Add a "Secret Key", save it~~, it~~ is needed for ''docuSignSecretKey''.		Second: Add a "Secret Key", save it. This is needed for ''docuSignSecretKey''.

	Third: Under "Redirect URIs" ~~add one~~ using the following ~~formular~~:<br/>		Third: Under "Redirect URIs" provide a URL using the following syntax:<br/>
	https://[~~TS-~~domain]/[TS-app-name]/[docuSignAuthCallbackUrl]~~<br/>~~		https://[domain]/[TS-app-name]/[docuSignAuthCallbackUrl]
	~~Sample~~: https://omega.tempusserva.dk/TempusServa/main?command=dk.tempusserva.signing.docusign.PageLoginCallback
			URL Example: https://omega.tempusserva.dk/TempusServa/main?command=dk.tempusserva.signing.docusign.PageLoginCallback

	== Setup in TS ==		== Setup in TS ==

	There are 11 parameters available~~, 7~~ of ~~them have to~~ be set for the integration to work.		There are 11 parameters available. Seven of these (marked with an asterisk below) must be set for the integration to work:

	* docuSignActive*		* docuSignActive*
Line 36:		Line 38:
	* docuSignBrandId		* docuSignBrandId

	~~And the type of the field with documents where~~ DocuSign upload should be available~~, has to~~ be changed from "[[FieldFiles\|Files: Documents]]" to "[[FieldFilesSigning\|Files: Documents with signing]]".		The Field Type Component for which DocuSign upload should be available must be changed from "[[FieldFiles\|Files: Documents]]" to "[[FieldFilesSigning\|Files: Documents with signing]]".

	=== docuSignActive ===		=== docuSignActive ===
Line 44:		Line 46:
	=== docuSignLog ===		=== docuSignLog ===

	This is for debugging and should '''not''' be enabled in production.<br/>		This is used for debugging and should '''not''' be enabled in production.<br/>
	It enables debuggin-logs on all uploads, both in TS and in DocuSign, thus breaking confidentiality, because all parameters will be saved to a log somewhere.		It enables debuggin-logs on all uploads, both in TS and in DocuSign, thus breaking confidentiality, because all parameters will be saved to a log somewhere.

Line 58:		Line 60:
	=== docuSignHost ===		=== docuSignHost ===

	This parameter is account-dependant.~~<br/>~~		This parameter is account-dependant. It is used to redirect the user, after a successful upload.<br/>
	~~This parameter~~ is used to redirect the user, after a successful upload.<br/>
	It's value should be "https://appdemo.docusign.com" during testing.<br/>		It's value should be "https://appdemo.docusign.com" during testing.<br/>
	The production value is found by signing in with an account, that will be using the integration, and then copying the ~~url~~ from the browser. Remember to only copy from beginning to end of ''docusign.com'', don't include the trailing /.		The production value is found by signing in with an account, that will be using the integration, and then copying the URL from the browser. Remember to only copy from beginning to end of ''docusign.com'', don't include the trailing /.

	=== docuSignAccountId ===		=== docuSignAccountId ===
Line 67:		Line 68:
	This attribute is account-dependant.<br/>		This attribute is account-dependant.<br/>
	It can be found on the "Apps and Keys" page in DocuSign, labeled "API Account ID".<br/>		It can be found on the "Apps and Keys" page in DocuSign, labeled "API Account ID".<br/>
	It's a GUID, ~~formattet~~ like this: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX		It's a GUID, formatted like this: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

	=== docuSignIntegrationKey ===		=== docuSignIntegrationKey ===
Line 73:		Line 74:
	This parameter is integration-dependant.<br/>		This parameter is integration-dependant.<br/>
	It can be found on the "Apps and Keys" page in DocuSign, or when viewing the details about the integration.<br/>		It can be found on the "Apps and Keys" page in DocuSign, or when viewing the details about the integration.<br/>
	It's a GUID, ~~formattet~~ like this: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX		It's a GUID, formatted like this: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

	=== docuSignSecretKey ===		=== docuSignSecretKey ===
Line 80:		Line 81:
	It can be found when viewing the details about the integration, in DocuSign.<br/>		It can be found when viewing the details about the integration, in DocuSign.<br/>
	You will only have access to the entire key when creating it, but you can just add a new one if the key is lost. Remember to delete the old one.<br/>		You will only have access to the entire key when creating it, but you can just add a new one if the key is lost. Remember to delete the old one.<br/>
	It's a GUID, ~~formattet~~ like this: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX		It's a GUID, formatted like this: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

	=== docuSignAuthCallbackUrl ===		=== docuSignAuthCallbackUrl ===

	~~Should~~ always be "main?command=dk.tempusserva.signing.docusign.PageLoginCallback".		This parameter I static and should always be<br/>
			"main?command=dk.tempusserva.signing.docusign.PageLoginCallback".

	=== docuSignEventCallbackUrl ===		=== docuSignEventCallbackUrl ===

	~~Should~~ always be "docusign-event-callback".		This parameter is static and should always be<br/>
			"docusign-event-callback".

	=== docuSignBrandId ===		=== docuSignBrandId ===
Line 95:		Line 98:
	In DocuSign it is possible to create "Brands" ("Settings" -> "Account" -> "Brands").<br/>		In DocuSign it is possible to create "Brands" ("Settings" -> "Account" -> "Brands").<br/>
	All brands have a unique ID, it doesn't have to be the owner of the integration that creates the brand.<br/>		All brands have a unique ID, it doesn't have to be the owner of the integration that creates the brand.<br/>
	To enable custom branding on email, the signing formula, etc., input the ~~brandId~~ here.<br/>		To enable custom branding in email, the signing formula, etc., input the brandID here.<br/>
	If this is empty, the default DocuSign branding will be used.<br/>		If this parameter is left is empty, the default DocuSign branding will be used.<br/>
	It's a GUID, ~~formattet~~ like this: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX		It's a GUID, formatted like this: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

	== Moving to production ==		== Moving to production ==
Line 103:		Line 106:
	When moving the integration to production, the following should be taken into account.		When moving the integration to production, the following should be taken into account.

	Make sure to ~~successfully upload~~ 20 ~~documents~~ in a row.<br/>		Make sure to complete 20 successful uploads in a row within 30 days.<br/>
	~~They~~ don't have to be ~~actual~~ documents, empty ones will do, and they don't have to be different documents, you can upload the same ~~one~~ 20 times.		Uploads don't have to be full featured documents, empty ones will do, and they don't have to be different documents, you can upload the same document 20 times.

	If the production account is different from the test account, the following parameters should be updated:		If the production account is different from the test account, the following parameters should be updated:
Line 116:		Line 119:
	* docuSignAuthHost		* docuSignAuthHost

	If ~~there is a different~~ TS~~-application~~ for test and production (different base ~~url~~), remember to add the "Redirect URIs" in DocuSign.		If the TS Application for test and production are different (different base URL), remember to add the "Redirect URIs" in DocuSign. And make sure that docuSignLog is set to false.

	And make sure that docuSignLog is set to false.

old>Tvi: /* Prereq */

2021-07-05T12:02:53Z

Prereq

← Older revision		Revision as of 14:02, 5 July 2021
Line 4:		Line 4:
	Either it should be a DocuSign-partner or subscribed to the "Advanced developer plan".		Either it should be a DocuSign-partner or subscribed to the "Advanced developer plan".

	To use the ~~feature~~, a regular eSignature subscription ~~is required~~.		To use the integration, the uploading user only needs a regular eSignature subscription.

	The integration will be created in demo mode and has to be approved, before it can be moved to production.<br/>		The integration will be created in demo mode and has to be approved, before it can be moved to production.<br/>

old>Tvi: /* Prereq */

2021-07-05T11:46:03Z

Prereq

← Older revision		Revision as of 13:46, 5 July 2021
Line 3:		Line 3:
	To setup the integration an account with one of the following criteria is needed.<br/>		To setup the integration an account with one of the following criteria is needed.<br/>
	Either it should be a DocuSign-partner or subscribed to the "Advanced developer plan".		Either it should be a DocuSign-partner or subscribed to the "Advanced developer plan".

			To use the feature, a regular eSignature subscription is required.

	The integration will be created in demo mode and has to be approved, before it can be moved to production.<br/>		The integration will be created in demo mode and has to be approved, before it can be moved to production.<br/>

old>Tvi: Description of GUID

2021-07-05T11:04:56Z

Description of GUID

← Older revision		Revision as of 13:04, 5 July 2021
Line 64:		Line 64:

	This attribute is account-dependant.<br/>		This attribute is account-dependant.<br/>
	It can be found on the "Apps and Keys" page in DocuSign, labeled "API Account ID".		It can be found on the "Apps and Keys" page in DocuSign, labeled "API Account ID".<br/>
			It's a GUID, formattet like this: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

	=== docuSignIntegrationKey ===		=== docuSignIntegrationKey ===

	This parameter is integration-dependant.<br/>		This parameter is integration-dependant.<br/>
	It can be found on the "Apps and Keys" page in DocuSign, or when viewing the details about the integration.		It can be found on the "Apps and Keys" page in DocuSign, or when viewing the details about the integration.<br/>
			It's a GUID, formattet like this: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

	=== docuSignSecretKey ===		=== docuSignSecretKey ===
Line 75:		Line 77:
	This parameter is integration-dependant.<br/>		This parameter is integration-dependant.<br/>
	It can be found when viewing the details about the integration, in DocuSign.<br/>		It can be found when viewing the details about the integration, in DocuSign.<br/>
	You will only have access to the entire key when creating it, but you can just add a new one if the key is lost. Remember to delete the old one.		You will only have access to the entire key when creating it, but you can just add a new one if the key is lost. Remember to delete the old one.<br/>
			It's a GUID, formattet like this: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

	=== docuSignAuthCallbackUrl ===		=== docuSignAuthCallbackUrl ===
Line 91:		Line 94:
	All brands have a unique ID, it doesn't have to be the owner of the integration that creates the brand.<br/>		All brands have a unique ID, it doesn't have to be the owner of the integration that creates the brand.<br/>
	To enable custom branding on email, the signing formula, etc., input the brandId here.<br/>		To enable custom branding on email, the signing formula, etc., input the brandId here.<br/>
	If this is empty, the default DocuSign branding will be used.		If this is empty, the default DocuSign branding will be used.<br/>
			It's a GUID, formattet like this: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

	== Moving to production ==		== Moving to production ==

old>Tvi: /* Setup in TS */

2021-07-05T08:27:10Z

Setup in TS

← Older revision		Revision as of 10:27, 5 July 2021
Line 34:		Line 34:
	* docuSignBrandId		* docuSignBrandId

	And the type of the field with documents where DocuSign upload should be available, has to be changed from "[[FieldFiles\|Files: Documents]]" to "Files: Documents with signing".		And the type of the field with documents where DocuSign upload should be available, has to be changed from "[[FieldFiles\|Files: Documents]]" to "[[FieldFilesSigning\|Files: Documents with signing]]".

	=== docuSignActive ===		=== docuSignActive ===

old>Tvi: /* Setup in TS */

2021-07-05T08:26:30Z

Setup in TS

← Older revision		Revision as of 10:26, 5 July 2021
Line 34:		Line 34:
	* docuSignBrandId		* docuSignBrandId

	And the type of the field with documents where DocuSign upload should be available, has to be changed from "[[Files: Documents]]" to "Files: Documents with signing".		And the type of the field with documents where DocuSign upload should be available, has to be changed from "[[FieldFiles\|Files: Documents]]" to "Files: Documents with signing".

	=== docuSignActive ===		=== docuSignActive ===

old>Tvi: /* Setup in TS */

2021-07-05T08:25:27Z

Setup in TS

← Older revision		Revision as of 10:25, 5 July 2021
Line 33:		Line 33:
	* docuSignEventCallbackUrl		* docuSignEventCallbackUrl
	* docuSignBrandId		* docuSignBrandId

			And the type of the field with documents where DocuSign upload should be available, has to be changed from "[[Files: Documents]]" to "Files: Documents with signing".

	=== docuSignActive ===		=== docuSignActive ===

old>Tvi: /* Setup in TS */

2021-07-05T08:20:52Z

Setup in TS

← Older revision		Revision as of 10:20, 5 July 2021
Line 20:		Line 20:
	== Setup in TS ==		== Setup in TS ==

	There are 11 parameters available, 7 of them have to be ~~changed~~ for the integration to work.		There are 11 parameters available, 7 of them have to be set for the integration to work.

	* docuSignActive*		* docuSignActive*

old>Tvi: Created the page

2021-07-05T08:07:57Z

Created the page

New page

== Prereq ==

To setup the integration an account with one of the following criteria is needed. 
Either it should be a DocuSign-partner or subscribed to the "Advanced developer plan".

The integration will be created in demo mode and has to be approved, before it can be moved to production. 
The criteria for that is: the last 20 uploads have to be successful and performed within the last 30 days. 
After that, an account with the proper access has to sign in and the integration will be transferred to their account.

== Setup in DocuSign ==

First: Sign in with an admin account and create a new "Integration" under "Settings" -> "Integrations" -> "Apps and Keys". Give it a descriptive name, it will be shown to all who upload documents via the integration.

Second: Add a "Secret Key", save it, it is needed for ''docuSignSecretKey''.

Third: Under "Redirect URIs" add one using the following formular: 
https://[TS-domain]/[TS-app-name]/[docuSignAuthCallbackUrl] 
Sample: https://omega.tempusserva.dk/TempusServa/main?command=dk.tempusserva.signing.docusign.PageLoginCallback

== Setup in TS ==

There are 11 parameters available, 7 of them have to be changed for the integration to work.

* docuSignActive*
* docuSignLog
* docuSignApiHost*
* docuSignAuthHost*
* docuSignHost*
* docuSignAccountId*
* docuSignIntegrationKey*
* docuSignSecretKey*
* docuSignAuthCallbackUrl
* docuSignEventCallbackUrl
* docuSignBrandId

=== docuSignActive ===

To enable the DocuSign functionality, this has to be set to "true".

=== docuSignLog ===

This is for debugging and should '''not''' be enabled in production. 
It enables debuggin-logs on all uploads, both in TS and in DocuSign, thus breaking confidentiality, because all parameters will be saved to a log somewhere.

=== docuSignApiHost ===

This parameter is account-dependant. 
It can be found on the "Apps and Keys" page in DocuSign, labeled "Account Base URI".

=== docuSignAuthHost ===

This parameter should always be "https://account-d.docusign.com/oauth/" when testing the integration and "https://account.docusign.com/oauth/", when the integration is in production.

=== docuSignHost ===

This parameter is account-dependant. 
This parameter is used to redirect the user, after a successful upload. 
It's value should be "https://appdemo.docusign.com" during testing. 
The production value is found by signing in with an account, that will be using the integration, and then copying the url from the browser. Remember to only copy from beginning to end of ''docusign.com'', don't include the trailing /.

=== docuSignAccountId ===

This attribute is account-dependant. 
It can be found on the "Apps and Keys" page in DocuSign, labeled "API Account ID".

=== docuSignIntegrationKey ===

This parameter is integration-dependant. 
It can be found on the "Apps and Keys" page in DocuSign, or when viewing the details about the integration.

=== docuSignSecretKey ===

This parameter is integration-dependant. 
It can be found when viewing the details about the integration, in DocuSign. 
You will only have access to the entire key when creating it, but you can just add a new one if the key is lost. Remember to delete the old one.

=== docuSignAuthCallbackUrl ===

Should always be "main?command=dk.tempusserva.signing.docusign.PageLoginCallback".

=== docuSignEventCallbackUrl ===

Should always be "docusign-event-callback".

=== docuSignBrandId ===

This parameter is optional. 
In DocuSign it is possible to create "Brands" ("Settings" -> "Account" -> "Brands"). 
All brands have a unique ID, it doesn't have to be the owner of the integration that creates the brand. 
To enable custom branding on email, the signing formula, etc., input the brandId here. 
If this is empty, the default DocuSign branding will be used.

== Moving to production ==

When moving the integration to production, the following should be taken into account.

Make sure to successfully upload 20 documents in a row. 
They don't have to be actual documents, empty ones will do, and they don't have to be different documents, you can upload the same one 20 times.

If the production account is different from the test account, the following parameters should be updated:

* docuSignAccountId
* docuSignApiHost

Make sure to change the following parameters:

* docuSignHost
* docuSignAuthHost

If there is a different TS-application for test and production (different base url), remember to add the "Redirect URIs" in DocuSign.

And make sure that docuSignLog is set to false.