Installing OneSpan Sign for Microsoft Dynamics CRM

To install OneSpan Sign for Microsoft Dynamics CRM 2013 for the first time, sequentially perform the following procedures:

    Step 1: Importing the Solution

    Step 2: Configuring the Dashboard & Report

    Step 3: Configuring Connector Settings

    Step 4: Configuring the Language

    Step 5: Installing the Notification Service for Dynamics CRM

Step 1: Importing the Solution

To import the solution into OneSpan Sign for Microsoft Dynamics CRM:

  1. Connect to OneSpan Sign for Microsoft Dynamics CRM as a user with Administrator privileges.
  2. From the top menu, click OneSpan Sign for Microsoft Dynamics CRM > Settings.
  3. From Customization, click Solutions.
  4. From All Solutions, click Import.
  5. Dynamics CRM prompts you for the location of the solution package. Click Browse, and select the solution package ESLConnector_1_0_0_X_managed.zip.
  6. Click Next to display the Solution Information.
  7. Click Next to show the Import Options. Select the checkbox for activate any processes…, then click Next. The solution will import, and a summary page will appear.
  8. Click Close to complete the solution installation.
  9. From Solutions, click Publish All Customizations.

Step 2: Configuring the Dashboard & Report

To configure the Dashboard and Report:

  1. Create a new site named ESL Dashboard and Report.
  2. Unzip the file ESL Dashboard and Report.zip.
  3. Provide the Physical path to the above unzipped folder.
  4. Provide a Host name. This mapping of the host name to the physical server's IP should also be done in the DNS server.
  5. Change the port number to the port of your choice.
  6. Click OK.
  7. In the dialog box Edit Application Pool, make the settings match the following screen.
  8. In the unzipped folder, modify the file Web.config as follows:
  9. <appSettings>
                <add key="CRMURL" value="http://ServerName/OrganizationName/XRMServices/2011/Organization.svc" />
                <add key="crmuser" value="UserName" />
                <add key="crmpass" value="Password" />
                </appSettings>
  10. In Settings, go to Customizations and click Customize the System.
  11. Select Web resources from the left pane, and find the ESL Dashboard HTML type web resource.
  12. Open it, and replace the host name with the site name (where Dashboard and Report is deployed). Then save and publish it.
  13. Repeat the process for the OneSpan Sign Report web resource.

Step 3: Configuring Connector Settings

To configure the connector settings:

  1. On the Settings tab under OneSpan Sign Settings, click OneSpan Sign Account. A grid appears that displays OneSpan Sign accounts. Its list should initially be empty.
  2. From the Ribbon, click New to create a new OneSpan Sign account.
  3. A new dialog box appears.
  4. Enter the following required information.
    • Name: Name of the configuration item
    • Email: Email address of the account owner
    • The following configuration settings depend on the URL from which you log in to OneSpan Sign. If you're uncertain about your login URL, refer to the email you received when you signed up, and follow the link Log into your account. You will be directed to a login page, at which point your login URL will appear in your browser's address bar.

    • For US clients who are deploying to a US Production Environment, and whose login URL is https://apps.esignlive.com/login:
      • API URL:
      https://apps.esignlive.com/api
    • Designer URL:
    https://apps.esignlive.com/auth?senderAuthenticationToken={0}&target=https://apps.esignlive.com/designer/{1}?profile=dynamics1.2
  5. Signing URL:
  6. https://apps.esignlive.com/auth?signerAuthenticationToken={0}&target=https://apps.esignlive.com/packages/{1}/sign
  7. For US clients who are deploying to a US Sandbox Environment, and whose login URL is https://sandbox.esignlive.com/login:
    • API URL:
    https://sandbox.esignlive.com/api
  8. Designer URL:
  9. https://sandbox.eSignlive.com/auth?senderAuthenticationToken={0}&target=https://sandbox.esignlive.com/designer/{1}?profile=dynamics1.2
  10. Signing URL:
  11. https://sandbox.eSignlive.com/auth?signerAuthenticationToken={0}&target=https://sandbox.esignlive.com/packages/{1}/sign
  12. For US clients who are deploying to a US Production Environment, and whose login URL is https://apps.e-Signlive.com/login:
    • API URL:
    https://apps.e-SignLive.com/api
  13. Designer URL:
  14. https://apps.e-SignLive.com/auth?senderAuthenticationToken={0}&target=https://apps.e-SignLive.com/designer/{1}?profile=dynamics1.2
  15. Signing URL:
  16. https://apps.e-SignLive.com/auth?signerAuthenticationToken={0}&target=https://apps.e-SignLive.com/packages/{1}/sign
  17. For US clients who are deploying to a US Sandbox Environment, and whose login URL is https://sandbox.e-SignLive.com/login:
    • API URL:
    https://sandbox.e-SignLive.com/api
  18. Designer URL:
  19. https://sandbox.e-SignLive.com/auth?senderAuthenticationToken={0}&target=https://sandbox.e-SignLive.com/designer/{1}?profile=dynamics1.2
  20. Signing URL:
  21. https://sandbox.e-SignLive.com/auth?signerAuthenticationToken={0}&target=https://sandbox.e-SignLive.com/packages/{1}/sign
  22. For Canadian clients who are deploying to a Canadian Production Environment, and whose login URL is https://apps.e-SignLive.ca/login:
    • API URL:
    https://apps.e-SignLive.ca/api
  23. Designer URL:
  24. https://apps.e-SignLive.ca/auth?senderAuthenticationToken={0}&target=https://apps.eSignLive.ca/designer/{1}?profile=dynamics1.2
  25. Signing URL:
  26. https://apps.eSignLive.ca/auth?signerAuthenticationToken={0}&target=https://apps.e-SignLive.ca/packages/{1}/sign
  27. For Canadian clients who are deploying to a Canadian Sandbox Environment, and whose login URL is https://sandbox.e-SignLive.ca/login:
    • API URL:
    https://sandbox.e-SignLive.ca/api
  28. Designer URL:
  29. https://sandbox.e-SignLive.ca/auth?senderAuthenticationToken={0}&target=https://sandbox.e-SignLive.ca/designer/{1}?profile=dynamics1.2
  30. Signing URL:
  31. https://sandbox.e-SignLive.ca/auth?signerAuthenticationToken={0}&target=https://sandbox.e-SignLive.ca/packages/{1}/sign
  32. Enter the Callback URL used for the Event notification service. For example: http://server/PostEvent.svc/PostESLEvent
  33. Save the form, and then click the Set Callback URL ribbon button to register the URL with OneSpan Sign.
  34. Enter the Audit Connection String from the database created earlier.
  35. Data Source=servername; Initial Catalog=databasename; uid=userid ; pwd=password
  36. Indicate if you want to use SharePoint Integration. If yes, then:
    1. Enter the Document Upload Host URL. This is the hostname of the hosted site created in Step 2: Configuring the Dashboard & Report.
    2. Enter the SharePoint Documents URL, where eSignLive.com.ESL.WebService.wsp will be deployed in your SharePoint Integration. This is the SharePoint Site URL from which you will select documents for Dynamics CRM.
    3. Enter the SharePoint Completed Document URL. This is the URL of the SharePoint Site Library to which signed documents from OneSpan Sign will be saved.
  37. Click Verify Settings to confirm that the API Key and API URL are correct, and that communication with the OneSpan Sign server can be established.

Step 4: Configuring the Language

To configure the language that the connector will display:

  1. In Settings, click OneSpan Sign Language. A OneSpan Sign Languages grid appears. Its list should initially be empty.
  2. To configure a new language for the connector, click New.
  3. Enter the language's Name and Value. For example, for English: Name = English and Value = en. To see the name-value pairs of all supported languages, see Supported Languages.
  4. Click Save.

Step 5: Installing the Notification Service for Dynamics CRM

The following procedure installs a Windows Notification Service that will: (1) read status updates from the SQL Notifications Database table created in a previous step; (2) apply these updates to Dynamics CRM's data about OneSpan Sign packages.

To install the Notification Service:

  1. Unzip the contents of eSignLive.comESLNotificationService.zip into a new directory.
  2. Open the file eSignLive.comESLNotificationService.exe.config in a text editor.
  3. Modify the connection string for the SQL Server as follows:
  4. SQL Server connection string:

    Data Source=<ServerName>;Initial Catalog=<dbname>;User ID=<sqluser>;Password=<password>
  • Replace <ServerName> with the name of the SQL Server.
  • Replace <dbname> with the name of the database where the Notifications table was installed.
  • Replace <sqluser> and <password> with the SQL login credentials that have Read and Write access to the database.
  • Modify the connection string for the Dynamics CRM Server as follows:
  • CRM connection string:

    Url=<crmURL>; Domain=<domain>; Username=<user>; Password=<password>
                <appSettings>
                <addkey="CRMURL"value="<crmURL>/XRMServices/2011/Organization.svc"/>
                <add key="crmuser" value="Username" />
                <add key="crmpass" value="password" />
                </appSettings>
    • Replace <crmURL> with the URL of the CRM installation.
    • Replace <domain>, <user> and <password> with the domain user credentials that have administrative access to the CRM installation.
  • Open a Windows command prompt, and select Run As Administrator.
  • Navigate to the folder into which the Notification Service files were copied in Step 1.
  • Run the command: eSignLive.comESLNotificationService.exe -install
  • Open the Windows Services management tool (Start > Administrative Tools > Services), and confirm that the eSignLive Notifications service is present.
  • Start the Service.
  • Open the Windows Event viewer (Start > Administrative Tools > Event Viewer), and confirm that a new event log called eSignLive.comEventLog has been created under the Applications and Services Logs group.
  • Navigate to the eSignLive.comEventLog, and confirm the record of an event which indicates that the service has been started.
  • Installing OneSpan Sign for Microsoft Dynamics CRM

    To install OneSpan Sign for Microsoft Dynamics CRM 2015 for the first time, sequentially perform the following procedures:

      Step 1: Importing the Solution

      Step 2: Configuring the Dashboard & Report

      Step 3: Configuring Connector Settings

      Step 4: Configuring the Language

      Step 5: Installing the Notification Service for Dynamics CRM

    Step 1: Importing the Solution

    To import the solution into OneSpan Sign for Microsoft Dynamics CRM:

    1. Connect to OneSpan Sign for Microsoft Dynamics CRM as a user with Administrator privileges.
    2. From the top menu, click OneSpan Sign for Microsoft Dynamics CRM > Settings.
    3. From Customization, click Solutions.
    4. From All Solutions, click Import.
    5. Dynamics CRM prompts you for the location of the solution package. Click Browse, and select the solution package ESLConnector_1_0_0_X_managed.zip.
    6. Click Next to display the Solution Information.
    7. Click Next to show the Import Options. Select the checkbox for activate any processes…, then click Next. The solution will import, and a summary page will appear.
    8. Click Close to complete the solution installation.
    9. From Solutions, click Publish All Customizations.

    Step 2: Configuring the Dashboard & Report

    To configure the Dashboard and Report:

    1. Create a new site named ESL Dashboard and Report.
    2. Unzip the file ESL Dashboard and Report.zip.
    3. Provide the Physical path to the above unzipped folder.
    4. Provide a Host name. This mapping of the host name to the physical server's IP should also be done in the DNS server.
    5. Change the port number to the port of your choice.
    6. Click OK.
    7. In the dialog box Edit Application Pool, make the settings match the following screen.
    8. In the unzipped folder, modify the file Web.config as follows:
    9. <appSettings>
      					<add key="CRMURL" value="http://ServerName/OrganizationName/XRMServices/2011/Organization.svc" />
      					<add key="crmuser" value="UserName" />
      					<add key="crmpass" value="Password" />
      				</appSettings>
    10. In Settings, go to Customizations and click Customize the System.
    11. Select Web Resources from the left pane, and find the ESL Dashboard HTML type web resource.
    12. Open it, and replace the host name with the site name (where Dashboard and Report is deployed). Then save and publish it.
    13. Repeat the process for the ESL Report web resource.

    Step 3: Configuring Connector Settings

    To configure the connector settings:

    1. On the Settings tab under OneSpan Sign Settings, click OneSpan Sign Account. A grid appears that displays OneSpan Sign accounts. Its list should initially be empty.
    2. From the Ribbon, click New to create a new OneSpan Sign account.
    3. A new dialog box appears.
    4. Enter the following required information.
      • Name: Name of the configuration item
      • Email: Email address of the account owner
      • The following configuration settings depend on the URL from which you log in to OneSpan Sign. If you're uncertain about your login URL, refer to the email you received when you signed up, and follow the link Log into your account. You will be directed to a login page, at which point your login URL will appear in your browser's address bar.

      • For US clients who are deploying to a US Production Environment, and whose login URL is https://apps.esignlive.com/login:
        • API URL:
        https://apps.esignlive.com/api
      • Designer URL:
      https://apps.esignlive.com/auth?senderAuthenticationToken={0}&target=https://apps.esignlive.com/designer/{1}?profile=dynamics1.2
    5. Signing URL:
    6. https://apps.esignlive.com/auth?signerAuthenticationToken={0}&target=https://apps.esignlive.com/packages/{1}/sign
    7. For US clients who are deploying to a US Sandbox Environment, and whose login URL is https://sandbox.esignlive.com/login:
      • API URL:
      https://sandbox.esignlive.com/api
    8. Designer URL:
    9. https://sandbox.eSignlive.com/auth?senderAuthenticationToken={0}&target=https://sandbox.esignlive.com/designer/{1}?profile=dynamics1.2
    10. Signing URL:
    11. https://sandbox.eSignlive.com/auth?signerAuthenticationToken={0}&target=https://sandbox.esignlive.com/packages/{1}/sign
    12. For US clients who are deploying to a US Production Environment, and whose login URL is https://apps.e-Signlive.com/login:
      • API URL:
      https://apps.e-SignLive.com/api
    13. Designer URL:
    14. https://apps.e-SignLive.com/auth?senderAuthenticationToken={0}&target=https://apps.e-SignLive.com/designer/{1}?profile=dynamics1.2
    15. Signing URL:
    16. https://apps.e-SignLive.com/auth?signerAuthenticationToken={0}&target=https://apps.e-SignLive.com/packages/{1}/sign
    17. For US clients who are deploying to a US Sandbox Environment, and whose login URL is https://sandbox.e-SignLive.com/login:
      • API URL:
      https://sandbox.e-SignLive.com/api
    18. Designer URL:
    19. https://sandbox.e-SignLive.com/auth?senderAuthenticationToken={0}&target=https://sandbox.e-SignLive.com/designer/{1}?profile=dynamics1.2
    20. Signing URL:
    21. https://sandbox.e-SignLive.com/auth?signerAuthenticationToken={0}&target=https://sandbox.e-SignLive.com/packages/{1}/sign
    22. For Canadian clients who are deploying to a Canadian Production Environment, and whose login URL is https://apps.e-SignLive.ca/login:
      • API URL:
      https://apps.e-SignLive.ca/api
    23. Designer URL:
    24. https://apps.e-SignLive.ca/auth?senderAuthenticationToken={0}&target=https://apps.eSignLive.ca/designer/{1}?profile=dynamics1.2
    25. Signing URL:
    26. https://apps.eSignLive.ca/auth?signerAuthenticationToken={0}&target=https://apps.e-SignLive.ca/packages/{1}/sign
    27. For Canadian clients who are deploying to a Canadian Sandbox Environment, and whose login URL is https://sandbox.e-SignLive.ca/login:
      • API URL:
      https://sandbox.e-SignLive.ca/api
    28. Designer URL:
    29. https://sandbox.e-SignLive.ca/auth?senderAuthenticationToken={0}&target=https://sandbox.e-SignLive.ca/designer/{1}?profile=dynamics1.2
    30. Signing URL:
    31. https://sandbox.e-SignLive.ca/auth?signerAuthenticationToken={0}&target=https://sandbox.e-SignLive.ca/packages/{1}/sign
    32. Enter the Callback URL used for the Event notification service. For example: http://server/PostEvent.svc/PostESLEvent
    33. Save the form, and then click the Set Callback URL ribbon button to register the URL with OneSpan Sign.
    34. Enter the Audit Connection String from the database created earlier.
    35. Data Source=servername; Initial Catalog=databasename; uid=userid ; pwd=password
    36. Indicate if you want to use SharePoint Integration. If yes, then:
      1. Enter the Document Upload Host URL. This is the hostname of the hosted site created in Step 2: Configuring the Dashboard & Report.
      2. Enter the SharePoint Documents URL, where eSignLive.com.ESL.WebService.wsp will be deployed in your SharePoint Integration. This is the SharePoint Site URL from which you will select documents for Dynamics CRM.
      3. Enter the SharePoint Completed Document URL. This is the URL of the SharePoint Site Library to which signed documents from OneSpan Sign will be saved.
    37. Click Verify Settings to confirm that the API Key and API URL are correct, and that communication with the OneSpan Sign server can be established.

    Step 4: Configuring the Language

    To configure the language that the connector will display:

    1. In Settings, click OneSpan Sign Language. A OneSpan Sign Languages grid appears. Its list should initially be empty.
    2. To configure a new language for the connector, click New.
    3. Enter the language's Name and Value. For example, for English: Name = English and Value = en. To see the name-value pairs of all supported languages, see Supported Languages.
    4. Click Save.

    Step 5: Installing the Notification Service for Dynamics CRM

    The following procedure installs a Windows Notification Service that will: (1) read status updates from the SQL Notifications Database table created in a previous step; (2) apply these updates to Dynamics CRM's data about OneSpan Sign packages.

    To install the Notification Service:

    1. Unzip the contents of eSignLive.comESLNotificationService.zip into a new directory.
    2. Open the file eSignLive.comESLNotificationService.exe.config in a text editor.
    3. Modify the connection string for the SQL Server as follows:
    4. SQL Server connection string:

      Data Source=<ServerName>;Initial Catalog=<dbname>;User ID=<sqluser>;Password=<password>
    • Replace <ServerName> with the name of the SQL Server.
    • Replace <dbname> with the name of the database where the Notifications table was installed.
    • Replace <sqluser> and <password> with the SQL login credentials that have Read and Write access to the database.
  • Modify the connection string for the Dynamics CRM Server as follows:
  • CRM connection string:

    Url=<crmURL>; Domain=<domain>; Username=<user>; Password=<password>
                <appSettings>
                <addkey="CRMURL"value="<crmURL>/XRMServices/2011/Organization.svc"/>
                <add key="crmuser" value="Username" />
                <add key="crmpass" value="password" />
                </appSettings>
    • Replace <crmURL> with the URL of the CRM installation.
    • Replace <domain>, <user> and <password> with the domain user credentials that have administrative access to the CRM installation.
  • Open a Windows command prompt, and select Run As Administrator.
  • Navigate to the folder into which the Notification Service files were copied in Step 1.
  • Run the command: eSignLive.comESLNotificationService.exe -install
  • Open the Windows Services management tool (Start > Administrative Tools > Services), and confirm that the eSignLive Notifications service is present.
  • Start the Service.
  • Open the Windows Event viewer (Start > Administrative Tools > Event Viewer), and confirm that a new event log called eSignLive.comEventLog has been created under the Applications and Services Logs group.
  • Navigate to the eSignLive.comEventLog, and confirm the record of an event which indicates that the service has been started.
  • Installing OneSpan Sign for Microsoft Dynamics CRM

    This section describes how to install version 2 of OneSpan Sign for Microsoft Dynamics CRM.

    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 OneSpan Sign for Microsoft Dynamics CRM.
    • If you are installing the connector within an on-premises instance of Dynamics CRM, you have performed the procedure Installing the Push Notification Service.

    Action

    To install version 2 of OneSpan Sign 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 checkbox 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 OneSpan Sign for Microsoft Dynamics CRM online will be aware of all data changes that affect the User Interface.

    To complete your installation, you must configure the solution.