Go-Live Process for Promoting the Integration Key to PROD
The integration key was created in DEMO and must be promoted to PROD through the Go-Live process in order to be used in production. If DocuSign OAuth2.0 has not been set up for DEMO, please review DocuSign OAuth2.0 Setup Guide for DEMO for instructions.
Note The Integration key created for the setup of DEMO will be the same integration key used for PROD.
Before the Go-Live process can be started, at least 20 successful API calls must be sent in a row:
Note Users must test sending documents in their TEST environment and send at least 20 documents in order to start the Go-Live process and use this integration key in their PROD environment. Please review Sending Documents Using DocuSign OAuth2.0 for instructions.
As each successful call is completed, the numbers will decrease. Once 20 consecutive successful API calls have completed, the status will change to "Submit for review".
The same document may be sent 20 times in a row in order to complete this requirement.
-
Once the status has changed to "Submit for review", click on Actions > Start Go-Live Process:
-
Click on Submit For Review:
-
Once submitted, it will prompt a message indicating that the app was submitted for review.
-
Check back on the status after 20 minutes:
-
Once the status changes to "Review Passed", you can promote to production.
Click on Actions > Select Go-Live Account:
-
Check the box to accept the terms and conditions and click on Accept:
-
A prompt to log in to your DocuSign production account will appear:
-
Once logged in, a prompt to select an eligible production account will appear. Select the account and click on Select:
-
The app is now live and the integration key can be used in your PROD environment.
Note The Integration key created for the setup of DEMO will be the same integration key used for PROD.
-
Next, the app for PRODUCTION needs to be configured.
Log in to your DocuSign Production account (https://account.docusign.com/) and go to Settings > Apps and Keys. You will see the App Name that is promoted to production:
-
Click on Actions > Edit:
-
Generate a new secret key and add the PROD redirect URI.
Under the Authentication section, select Yes and click on + Add Secret Key
Note Do not check the the Require Proof Key for Code Exchange (PKCE) box.
-
After the secret key is generated, click on the Copy to Clipboard icon before clicking on Save and store this in a safe place. This cannot be accessed after saving.
Scroll down to the Additional Settings. Under Redirect URIs, click on Add URI:
-
The format of this URI has "/SysESign/docuSignAccessToken.do" added to the end of the URL used for your application.
For example, if the URL to the CMiC Field module is: www.cmicdemo.com/cmicprod/SdMenu
Then the redirect URL will be: www.cmicdemo.com/cmicprod/SysESign/docuSignAccessToken.do
Enter the redirect URI in the box that appears:
-
Before saving, make sure to save the secret key to a safe location. It cannot be viewed again.
Once the secret key has been saved, click on Save at the bottom of the page:
The set up for production is now complete.
Adding Your Integration Key and Secret Key to CMiC in Project System Options
-
Copy the integration key you created from your DocuSign account’s Apps and Keys section:
-
Go to the Project System Options screen in CMiC Field and find the four DocuSign settings:
-
DocuSign Environment
-
DocuSign OAuth Flag
-
DocuSign Integration Key
-
DocuSign Secret Key
-
For DocuSign Environment:
-
Select PROD.
-
-
DocuSign OAuth Flag Checkbox
-
Select this checkbox to enable OAuth2.0.
-
You can switch back to Basic Authentication by unchecking this box.
-
Note DocuSign is retiring Basic Authentication on Sept 2023 so all users must be tested and migrated before this date.
-
-
-
DocuSign Integration Key
-
Add the integration key for your app.
-
-
DocuSign Secret Key
-
Add the new secret key you generated for your integration key after the Go-Live process is complete.
-
-
Click on Save at the top. Once you save, your settings are applied and your PROD environment is ready to send documents.