▲ Top

eSignLive for Microsoft Dynamics CRM

Welcome! 

This guide is intended only for users of eSignLive for Microsoft Dynamics CRM Online (update 8.2 or higher).

The product called OneSpan Sign provides a complete e-signature platform for the Web, including preparing, distributing, reviewing, signing, and downloading documents.

A connector called eSignLive for Microsoft Dynamics CRM enables its users to quickly obtain secure and compliant electronic signatures for transactions created in eSignLive for Microsoft Dynamics CRM.

This guide is intended to get you up and running quickly with version 2 of this connector by performing the following procedures:

Installing the Solution

Prerequisites

  • You have a Sandbox or Production account for version 11 of OneSpan Sign, and an associated API Key. To get a free Sandbox account, follow the instructions on this page.
  • You have Administrator privileges for eSignLive for Microsoft Dynamics CRM.

Action

To install version 2 of eSignLive for Microsoft Dynamics CRM:

  1. Log into Microsoft Dynamics CRM as a user with Administrator privileges.
  2. Navigate to Microsoft Dynamics CRM > Settings.
  3. In the Customization group, click Solutions.
  4. In the All Solutions window, click Import.
  5. You are prompted for the location of the solution package.

  6. Click Browse, and select the file Download OneSpan Sign for Microsoft Dynamics v2.0 Release Candidate (Solution Package).
  7. Click Next to display the Solution Information.
  8. Click Next to display the Import Options.
  9. Select the check box under Post Import Actions, then click Import. The solution is imported, and a summary page appears. After a certain delay, a message should state that the import was successful.
  10. Click Close.
  11. Click Publish All Customizations. This ensures that eSignLive for Microsoft Dynamics CRM online will be aware of all data changes that affect the User Interface.
  12. Repeat steps 4 through 10 for the eslConnectorSiteMap file.

To complete your installation, you must configure the solution.

Configuring the Solution

This section describes how to configure your solution by performing the following procedures:

Configuring Microsoft Azure

Prerequisites

  • You must have Administrator privileges for Microsoft Azure.

Action

To configure Microsoft Azure for eSignLive for Microsoft Dynamics CRM to authenticate OneSpan Sign for Callback notifications:

  1. Log into https://portal.azure.com as a user with Administrator privileges.
  2. From the menu, select Azure Active Directory.
  3. From the active menu, select App registrations.
  4. In the App registrations pane, click the name of the relevant application (e.g., OneSpan Sign).
  5. If you have not previously configured the connector:
    1. In the App registrations pane, click New application registration. The Create window appears.
    2. Complete the Name field.
    3. From the Application type drop-down menu, select Native.
    4. Specify the following Redirect URI:
    5. https://<DOMAIN_NAME>/connectors/api/v2/authorization/oauth2/dynamicscrm/<ORGANIZATION_NAME>

      In the above URI:

      • Replace the variable <Domain_Name> with the string in the following table that corresponds to your environment.
       SandboxProduction
      US Customerssandbox.esignlive.comapps.esignlive.com
      Candadian Customerssandbox.e-signlive.caapps.e-signlive.ca
      Australian Customers apps.esignlive.com.au
      European Customers apps.esignlive.eu
      • Replace the variable <ORGANIZATION_NAME>. To find the right replacement, log in to eSignLive for Microsoft Dynamics CRM by clicking the Avatar icon in the top menu. Your organization name begins with "org" (although those characters and others have been erased from the following image).

    6. Click Create.
  6. If you have previously configured the connector:
    1. Click the OneSpan Sign application (the name previously configured in the Active Directory). The Application ID is your client ID.
    2. Specify a Redirect URI, using the information in Step 5d above.
  7. Click Save. A Successfully updated application message appears.
  8. In the Settings pane, click Required Permissions.
  9. Ensure that the following permissions are selected in the Required Permissions pane:
    • Dynamics CRM Online (Microsoft.CRM)
    • Windows Azure Active Directory (Microsoft.Azure.ActiveDirectory)
  10. If these permissions are not displayed:
    1. Click Add from the Required permissions menu.
    2. From the Required permissions pane:
      1. Select the API for which you wish to grant a permission. The API appears in the Enable Access pane.
      2. Select the option box associated with the permission, and click Save.
  11. Click Grant Permissions, and then click Yes in the dialog box that appears.

Specifying Account Information

Your organization should have only one OneSpan Sign account.

To inform eSignLive for Microsoft Dynamics CRM about your OneSpan Sign account:

  1. Log into eSignLive for Microsoft Dynamics CRM as a user with Administrator privileges.
  2. Navigate to eSignLive for Microsoft Dynamics CRM > OneSpan Sign > Account Settings.
  3. An Active OneSpan Sign Accounts list appears. Initially this list should be empty.

  4. From the ribbon, click New to create a new OneSpan Sign account. A new page appears.
  5. Specify the following required parameters:
    • Name: Name of the active OneSpan Sign account
    • Email: Email address of the account owner
    • API Key: OneSpan Sign API key. You can obtain this information from Technical Support (sign.support@onespan.com; 1-855-MYESIGN).
    • As mentioned above, you must have a Sandbox account. Accordingly, specify the parameters API URL, Designer URL and Signer URL as follows:
    • API URLhttps://sandbox.OneSpan Sign.com/api
      Designer URLhttps://sandbox.OneSpan Sign.com/auth?senderAuthenticationToken={0}&target=https://sandbox.OneSpan Sign.com/designer/{1}?profile=dynamics2.1
      Signer URLhttps://sandbox.esignlive.com/auth?signerAuthenticationToken={0}&target=https://sandbox.esignlive.com/packages/{1}/sign?iframe=true
    • Callback URL: Enter the following value: https://server/PostEvent.svc/PostESLEvent
    • Client ID: Specify the Client ID that appeared in Configuring Microsoft Azure.
  6. If you wish, you can change the default value of any of the following parameters: SharePoint Integration, Maximum Number of Documents, Maximum Document Size, Accepted File Types and Package Name Date Stamp Format.
  7. Click Save or Save and Close.
  8. From the ribbon, click Verify Settings to confirm that: (a) the API Key and API URL are correct; (b) communications with the OneSpan Sign server can be established.
  9. From the ribbon, click Set Callback URL to register the URL with OneSpan Sign.

Specifying a Language

To specify a language for OneSpan Sign transactions:

  1. Log into eSignLive for Microsoft Dynamics CRM as a user with Administrator privileges.
  2. Navigate to eSignLive for Microsoft Dynamics CRM > OneSpan Sign > Language. An OneSpan Sign Languages list appears. Initially this list should be empty.
  3. Click New to create a new language for OneSpan Sign.
  4. Enter the required information (e.g., Name = English, Value = en). You can view all supported languages and their associated values here. You must enter one of those values, though you can specify the name as you wish.
  5. Click Save.

Specifying User Permissions

To test your installation, at least one user must have the right to create packages or the right to create templates. System Adminstrators always have those rights.

To specify a user's permissions:

  1. Log into eSignLive for Microsoft Dynamics CRM as a user with Administrator privileges.
  2. Navigate to eSignLive for Microsoft Dynamics CRM > Settings > Security > Users.
  3. From the Enabled Users list, double-click the name of the relevant user.
  4. Click Manage Roles.
  5. Check all and only the boxes next the Roles you want to give the user. 
  6. Click OK.

Testing the Solution

After you've installed and configured your solution, you can test it by performing the following procedures:

  1. Creating, Preparing and Sending a Package
  2. Signing Documents

Creating, Preparing and Sending a Package

To create a package:

  1. Log into eSignLive for Microsoft Dynamics CRM as a user who has permission to create a package..
  2. Navigate to eSignLive for Microsoft Dynamics CRM > OneSpan Sign > OneSpan Sign Packages. An OneSpan Sign Packages list appears. Initially this list should be empty.
  3. On the ribbon, click New. The New OneSpan Sign Package page appears.
  4. In the Package Details section, type a name for the package.
  5. Click Save.
  6. The package is created, with the logged-in user as its default signer.

A package must have been saved before documents can be added to it.

To add documents to a package:

  1. From the Documents section of the package, click "+". The New OneSpan Sign Document page appears.
  2. From the Document Type drop-down list, select Upload Local Files.
  3. Click Choose Files.
  4. Select one or more files from your local directory, and click Open.
  5. OneSpan Sign supports the following types of documents:

    • Adobe's Portable Document Format (*.pdf)
    • Microsoft Word (*.doc or *.docx)
    • Open Office (*.odt)
    • Text (.txt)
    • Rich Text Format (.rtf)

    Please be aware of the following:

    • The system supports a maximum of 16 MB per document, except for our Salesforce and Microsoft SharePoint connectors, whose maximum is 5 MB per document. Smaller documents yield better performance — we recommend under 5 MB per document.
    • The system supports a maximum of 10 documents per transaction or transaction template. However, there is no limit to the total collective size of documents in a transaction.
    • Document file names should not contain any of the following comma-separated characters: *, /, \, :, <, >, |, ?, ".
    • A document's name cannot contain the string esigned.
    • Uploading password-protected or corrupted documents will trigger an error.
    • PDFs added to a transaction must not have syntax errors. We strongly recommend that you scan a PDF for syntax errors before you add it to a transaction (e.g., by using Adobe's Preflight tool).
    • PDFs with the NeedAppearances flag set to true are not currently supported.

  6. Select those files in the Selected Documents pane, and click Add Documents. A confirmation prompt appears.
  7. Click OK. The selected documents are added to the package.

To prepare documents for signing:

  1. While viewing a package to which one or more documents have been added, click Prepare.The Designer view appears
  2. On the Electronic Disclosure and Signature Consent agreement, click the right arrow to display the package's first document.
  3. From the drop-down Signers list, select a Signature Block to add to the document.
  4. Click Add Signature.
  5. Drag the Signature Block to where you want it to appear in the document.
  6. If you want to change the Signature Block type or want to add a field, click the gear icon. The Signature Block menu appears.
  7. Repeat Steps 3-6 for each Signature Block you want to add to the document.
  8. If there is another document, click the right arrow to display it, and repeat Steps 3-7.
  9. Repeat Step 8 for each document in the package.

To send documents to be signed:

  1. From within the Designer view of the package, click Send.
  2. Click OK. The documents are sent to be signed, and each signer receives an appropriate email.

Signing Documents

To sign the documents in a package that has been sent:

  1. Log into eSignLive for Microsoft Dynamics CRM as the user who created the package you want to sign.
  2. Navigate to eSignLive for Microsoft Dynamics CRM > OneSpan Sign > OneSpan Sign Packages.
  3. Open the package, and verify that its status is Sent.
  4. Click Start Signing.
  5. Read the Consent Agreement, and click Accept. The package's first document appears.
  6. Sign all of your Signature Blocks in the document. Those blocks should be indicated by sticky notes.
  7. If any unsigned Signature Blocks lie outside your screen, an Unsigned Signatures notification displays the number of signatures that are still required.

    A progress bar at the top of the document indicates the number of signatures you have completed, as well as the total number of signatures assigned to you in this document (e.g., 3/10 completed).

  8. To confirm your signatures in the current document, click OK.
  9. Repeat Steps 6-7 for each document in the package.
  10. Click Save & Close. The page associated with the signed package appears.
  11. To verify that all documents have been signed, click the link to download signed documents (that link is at the bottom of the page). Open each document, and verify that all its Signature Blocks have been signed.