Collapse All Expand All

DocuSign Service

Introduction

With the release of K2 4.6.10, integration with K2 and DocuSign is now possible. In order to integrate K2 and DocuSign, the creation of a DocuSign Service Instance is required. Once complete, SmartObjects are created for the instance and Wizards are available within the Designers. The following steps below discuss how this can be achieved in K2 Workspace.

The following are prerequisites for K2-DocuSign integration:

1. DocuSign Enterprise Version. K2 integration requires the DocuSign API and a DocuSign Integrator Key. If you are using a different version of DocuSign, please contact DocuSign to determine whether you will be able to use the API and obtain an Integrator Key in your version of DocuSign.
2. DocuSign Developer Account. This account must be created prior to integrating K2 with DocuSign, and the Developer Account must be obtained from DocuSign – it is not provided by K2. See the following link for more information on obtaining a developer account: https://www.docusign.com/developer-center

Required Permissions

The following are permissions required for DocuSign integration:

• Account-Wide Rights
• Sequential Signing (API)

To set these permissions in DocuSign for a single user, log in with a valid  user in the DocuSign site, go to Preferences > Account Administration > Users > [Select Your User] > Permissions, and  check the permissions stated above under DocuSign API section.

To set these permissions in DocuSign for Profiles, log in with a valid user in the DocuSign site, go to Preferences > Account Administration  > Permission Profiles > [Select Your Permission Profile from the drop down], and check the Permissions stated above under DocuSign API section.

Registering Multiple Service Instances

When registering multiple DocuSign instances with different user credentials, DocuSign Templates will not be available across all service instances (Service Instance A will be unable to see Service Instances B's templates). To rectify this, Template Sharing is required. To enable Template Sharing, log in to the DocuSign  site, click on the Manage tab > My Templates > Actions > Share.

Then the Template Sharing window will open, select the appropriate User(s)/Group(s) to share templates, then click Save.

Registering a DocuSign Service Instance in K2 Workspace

The following steps below discuss how to register an instance of DocuSign in K2 Workspace.

Step 1:

Firstly, a DocuSign Developer Account is required, if one is not already set up, use the link below:

https://www.docusign.com/developer-center

Step 2:

Once the account is created, log in to the DocuSign website via the LOG IN TO SANDBOX button. Click the Profile options on the top right and select the Preferences as shown below:

 

Step 3:

Next, navigate to the API page, by click the  API link under the Account Administration drop down as shown below:

Step 4:

Next click the Get Demo Integrator Key button to generate a new API Integrator Key.

The values to note here are the API UserName, API Account ID, and Active Integrator Key. These values will used for setting up the DocuSign Service Instance in K2 Workspace.

Step 5:

Next, log in to K2 Workspace and go to the K2 Management Console. Go to the DocuSign Service as shown below:

Click the ADD button.

When creating a new DocuSign Service Instance use  Static Authentication Mode. Use the following value mappings:

1. DocuSign URL - Address for DocuSign's API. By Default this is set to the demo URL. Production DocuSign instances will most likely require a different URL.
2. Account ID - DocuSign API Account ID
3. Integrator Key - DocuSign Active Integrator Key
4. Polling Interval

   The Polling Interval is set to 15 minutes by default. This can be changed but take note, any value that is set below 15 minutes will return cached values instead of real-time values. To return real-time values it is recommended that the value be set higher that 15 minutes within the Polling Interval.

5. Authentication Mode - Static
6. User Name - DocuSign API UserName (either the GUID or user email will suffice)
7. Password - DocuSign API Password (User's DocuSign account password)

Click Next.

On the next page assign any values as required.

Click Save.

The DocuSign Service Instance has been created.

Important Considerations

• Once the DocuSign Service Instance has been registered and ready to be used in a solution, DocuSign will require certification. This certification allows for the Sandbox Integrator Key to be used against DocuSign's Production Service Address. See the following link which discusses in more detail:

           https://www.docusign.com/developer-center/go-live/certification

• If the Service Instance is registered using tooling other than the Features page (Features.Main) such as SmartObject Tester Tool, Workspace or Package and Deployment, the Docusign wizard category will not be added in the web designers in SmartForms and K2 for SharePoint. To enable the wizards that are exposed by feature activation, navigate to the features form (Features.Main) and update the Docusign instance.

 

 

---

K2 blackpearl Help 4.6.11 (4.12060.1731.0)