esignlive for microsoft dynamics crm 2013 - deployment guide · about this document 1 this guide...

NOTE: This PDF is no longer being maintained. For the latest updates, please refer to our Community Portal.

eSignLive for Microsoft Dynamics CRM 2013 Deployment GuideDate: January 28, 2020

Product Release: 1.2

https://community.onespan.com/documentation/onespan-sign

Copyright Notices

Copyright © 2019 OneSpan North America, Inc. All rights reserved.

Trademarks

OneSpan™, DIGIPASS® and CRONTO® are registered or unregistered trademarks of OneSpan North America Inc. and/or OneSpan International GmbH (collectively "OneSpan") in the U.S. and other countries.

OneSpan reserves all rights to the trademarks, service marks and logos of OneSpan and its subsidiaries.

All other trademarks or trade names are the property of their respective owners.

Intellectual Property

OneSpan Software, documents and related materials (“Materials”) contain proprietary and confidential information. All title, rights and interest in OneSpan Software and Materials, updates and upgrades thereof, including software rights, copyrights, patent rights, industrial design rights, trade secret rights, sui generis database rights, and all other intellectual and industrial property rights, vest exclusively in OneSpan or its licensors. No OneSpan Software or Materials may be downloaded, copied, transferred, disclosed, reproduced, redistributed, or transmitted in any form or by any means, elec-tronic, mechanical or otherwise, for any commercial or production purpose, except as otherwise marked or when expressly permitted by OneSpan in writing.

Disclaimer

OneSpan accepts no liability for the accuracy, completeness, or timeliness of content, or for the reliability of links to and content of external or third party websites or materials.

OneSpan shall have no liability under any circumstances for any loss, damage, or expense incurred by you, your com-pany, or any third party arising from the use or inability to use OneSpan Software or Materials, or any third party mater-ial made available or downloadable. OneSpan will not be liable in relation to any loss/damage caused by modification of these Legal Notices or content.

Reservation

OneSpan reserves the right to modify these Notices and the content at any time. OneSpan likewise reserves the right to withdraw or revoke consent or otherwise prohibit use of the OneSpan Software or Materials if such use does not con-form to the terms of any written agreement between OneSpan and you, or other applicable terms that OneSpan pub-lishes from time to time.

Contact us

Phone: 1-855-MYESIGNe-Mail: [email protected] Support: https://www.esignlive.com/customer-supportResource center: https://www.esignlive.com/resource-centerCompany Website: https://www.onespan.com

Date: January 28, 2020

https://www.esignlive.com/customer-support

https://www.esignlive.com/resource-center

https://www.onespan.com/

CONTENTS

1 About This Document 1

1.1 Released Files 3

1.2 Installation Prerequisites 4

1.3 Installing SQL 5

2 Deploying the Push Notification Service for eSignLive for Microsoft Dynamics CRM 6

2.1 Installing the Push Notification Service 7

2.2 Verifying the Push Notification Service 13

2.3 Uninstalling the Push Notification Service 17

3 Installing the Solution 18

3.1 Step 1: Importing the Solution 19

3.2 Step 2: Configuring the Dashboard & Report 21

3.3 Step 3: Configuring Connector Settings 25

3.4 Step 4: Configuring the Language 30

3.5 Step 5: Installing the Notification Service for Dynamics CRM 31

4 Managing Users 33

4.1 Adding Users 34

4.2 Changing User Permissions 36

eSignLive for Microsoft Dynamics CRM 2013 - Deployment Guide

iii

5 SharePoint Integration (Optional) 38

6 Upgrading the Solution 40

6.1 Updating the Managed Solution 41

6.2 Updating the Dashboard & Reports 43

6.3 Updating the Notification Service 44

6.4 Updating the Account Settings 45

7 Uninstalling the Solution 46

8 Troubleshooting 47

8.1 Connectivity to OneSpan Sign 47

8.2 No Package Updates 48

8.3 Push Notification Service Not Working 49

8.4 Managing OneSpan Sign's Notification Service 50

8.5 Debugging Tips 51

eSignLive for Microsoft Dynamics CRM 2013 - Deployment Guide

iv

1 About This Document

This guide describes how to:

l Install eSignLive for Microsoft Dynamics CRM 2013

l Upgrade to eSignLive for Microsoft Dynamics CRM 2013

l Uninstall eSignLive for Microsoft Dynamics CRM 2013

l Perform various troubleshooting procedures

In particular, this guide has the following sections:

l Released Files on page 3

l Installation Prerequisites on page 4

l Installing SQL on page 5

l Deploying the Push Notification Service for eSignLive for Microsoft Dynamics CRM on page 6

l Installing the Solution on page 18

l Managing Users on page 33

l SharePoint Integration (Optional) on page 38

l Upgrading the Solution on page 40

l Uninstalling the Solution on page 46

l Troubleshooting on page 47

1 About This DocumenteSignLive for Microsoft Dynamics CRM 2013 - Deployment Guide

1

TIP: After eSignLive for Microsoft Dynamics CRM 2013 has been installed, see the eSignLive for Microsoft Dynamics CRM User's Guide for step-by-step instructions on how to use the product.


2

http://docs.esignlive.com/content/resources/pdfs/esl_for_crm_2013_-_user_s_guide.pdf

1.1 Released Files l ESLConnector_1_0_0_14_managed.zip (Dynamics CRM solution package)

l eSignLive.comESLNotificationService.zip (Windows Service for Noti-fications) {Zip file}

l ESL Dashboard, Report and Upload Document.7z {Zip file}

l ESL.CRM.DB.SQL {SQL Script}

l SharePoint 2013 Solution.7z (SharePoint 2013 Solution)

l ESLEventReceiverInstaller.msi

l Setup.exe


3

1.2 Installation PrerequisitesThe following must be installed on the server where eSignLive for Microsoft Dynam-ics CRM 2013 will be deployed:

l Database — One of the following:

l Microsoft SQL Server 2012 (64-bit)

l Microsoft SQL Server 2008 R2 (64-bit)

l Application Software

l Version 6.1.0.581 of Dynamics CRM Server 2013, with Service Pack 1 (SP1) or above

l Operating System — One of the following:

l Windows Server 2012 Datacenter or Windows Server 2012 R2 Datacenter

l Windows Server 2012 Standard or Windows Server 2012 R2 Standard

l Windows Server 2008 Standard SP2 (64-bit) or Windows Server 2008 Stand-ard R2 SP1

l Windows Server 2008 Enterprise SP2 (64-bit) or Windows Server 2008 Enterprise R2 SP1

l Windows Server 2008 Datacenter SP2 (64-bit) or Windows Server 2008 Datacenter R2 SP1

The user must also have:

l Administrator rights to eSignLive for Microsoft Dynamics CRM.

l A Sandbox or Production OneSpan Sign account and an API Key. For testing pur-poses, a Sandbox account is recommended.


4

1.3 Installing SQL

1.3.1 Prerequisites l You must have Administrator privileges on the relevant SQL database.

1.3.2 ActionTo install SQL:

1. Create a database on the SQL server named esignlive.

2. In SQL server, open the SQL Script named ESL.CRM.DB.SQL.

3. Execute the script against the new database.


5

2 Deploying the Push Notification Service for eSignLive for Microsoft Dynamics CRM

NOTE: The Push Notification Service is needed only if your connector is installed on-premises. If you have a SaaS deployment, please ignore this section.

NOTE: The deployment instructions below are relevant only if you are using v1.2 of eSignLive for Microsoft Dynamics CRM. If you are using v2.1, click here.

The Push Notification Service:

1. Receives an Event Notification (callback) from OneSpan Sign every time the status of an e-signature process changes;

2. Transmits that information to the relevant connector.

The rest of this section describes:

l Installing the Push Notification Service on page 7

l Verifying the Push Notification Service on page 13

l Uninstalling the Push Notification Service on page 17

2 Deploying the Push Notification Service for eSignLive for Microsoft Dynamics CRMeSignLive for Microsoft Dynamics CRM 2013 - Deployment Guide

6

2.1 Installing the Push Notification ServiceTo install the Push Notification Service:

1. Create an IIS Website by doing the following:

a. Connect to IIS with sufficient privileges.

b. Click Add Web Site. A new dialog box appears.

c. Specify the following parameters:


7

l Site name: You can specify any name you want.

l Physical path: This path should identify the folder where the Push Notification Service will be installed.

l Port: You can specify any port number you want.

d. Click OK.

e. Ensure that the Application Pool version is 4.0 by selecting the Basic Set-tings of the Application Pool, as illustrated below.


8

2. Run the Installer by doing the following:

a. Double-click the file ESLEventReceiverInstaller.msi.

b. On the Welcome screen, click Next. A new dialog box appears.


9

c. Specify the IIS Site and Application Pool.

NOTE: Specify a Virtual directory only if you want to host the service on a virtual directory inside the IIS Website. Otherwise, leave that field blank.

d. Click Next. The Connection Settings page appears.


10

e. Specify the following parameters, which will be used to store the service's notifications. Their values were determined when the SQL database was installed as part of your connector's deployment.

l Server Name: Name of the SQL server

l Database Name: Name of the SQL database

l User Name: The user name associated with the database

l Password: Password for the User name

f. Click Next.

g. After the installation is complete, click Close.


11

3. To verify that the service is running: (1) open the service in the Contents View of IIS; (2) browse for PostEvent.svc.

4. Bind the IIS Website to the public IP or domain, so OneSpan Sign can send noti-fications to the Push Notification Service. For this purpose, bear in mind that:

l The URL for the Push Notification Service is:

http://{SERVER_NAME:PORT}/PostEvent.svc/PostESLEvent

Here {SERVER_NAME:PORT} is a placeholder for the server name and port number.

NOTE: The service can be hosted on any port you want.

NOTE: The server name and port must be accessible from the Internet. You may want to open your firewall exclusively to OneSpan Sign's IP address. If so, you can obtain that IP address from our Support Team.

NOTE: This URL should be used in OneSpan Sign Account > Callback URL in the connector configuration.

NOTE: PostESLEvent is the method in the service that receives HTTP POST requests with a JSON payload as event data.


12

https://www.esignlive.com/customer-support

2.2 Verifying the Push Notification ServiceTo verify that events are being properly received by the Push Notification Service:

1. Create a package using your OneSpan Sign connector.

2. The service should have received at least one event associated with the new package. Verify that it has by checking the SQL table:

Select * From EslNotifications

3. If the expected events do not appear, check the following service log:

{SERVICE_INSTALLATION_FOLDER}\Logs\Log.txt

4. If the log files have not been created, there could be a permission issue on the IIS Website directory. Ensure that the account running the Application Pool has


13

write permissions to the Website folder.


14


15

NOTE: The Push Notification Service will not work if there is not enough free memory. If you find that it isn't working, ensure that on the server where the service is installed, the free memory is > 5% of the total memory.


16

2.3 Uninstalling the Push Notification Service

NOTE: The Push Notification Service is needed by your connector if it was installed on-premises. Thus you should uninstall the service only if you also want to uninstall the on-premises deployment of your connector.

To uninstall the Push Notification Service for your connector:

1. Run the file ESLEventReceiverInstaller.msi, and select Remove ESLEventRe-ceiverInstaller. Then click Finish.

2. Delete the IIS Website and Application Pool by right-clicking PushNo-tificationService, and selecting Remove.


17

3 Installing the Solution

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

Step 1: Importing the Solution on page 19

Step 2: Configuring the Dashboard & Report on page 21

Step 3: Configuring Connector Settings on page 25

Step 4: Configuring the Language on page 30

Step 5: Installing the Notification Service for Dynamics CRM on page 31

3 Installing the SolutioneSignLive for Microsoft Dynamics CRM 2013 - Deployment Guide

18

3.1 Step 1: Importing the SolutionTo import the solution into eSignLive for Microsoft Dynamics CRM:

1. Connect to eSignLive for Microsoft Dynamics CRM as a user with Admin-istrator privileges.

2. From the top menu, click eSignLive 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.


19

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.


20

3.2 Step 2: Configuring the Dashboard & ReportTo configure the Dashboard and Report:

1. Create a new site with the name 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 be done in the DNS server.

5. Change the port number to the port of your choice.

6. Click OK.


21

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:

<appSettings> <add key="CRMURL" value="http://ServerName/OrganizationName/XRMServices/2011/Organization.svc" /> <add key="crmuser" value="UserName" /> <add key="crmpass" value="Password" /> </appSettings>

9. In Settings, go to Customizations and click Customize the System.


22

10. Select Web resources from the left pane, and find the ESL Dashboard HTML type web resource.

11. Open it, and replace the host name with the site name (where Dashboard and Report is deployed). Then save and publish it.

12. Repeat the process for the OneSpan Sign Report web resource.


23


24

3.3 Step 3: Configuring Connector SettingsTo configure the connector settings:

1. From Settings, click OneSpan Sign Account in the OneSpan Sign Settings group. This grid containing the OneSpan Sign accounts will appear (the list should initially be empty).

2. From the Ribbon, click New to create a new OneSpan Sign account.

3. Enter the following required information.

l Name: Name of the configuration item

l Email: Email address of the account owner

NOTE: Your configuration settings depend on the URL you use to log in, but eSignLive is in the process of removing the hyphen from its URLs . If you are uncertain about which URL to use, please 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, and your login URL will appear in your browser's address bar.

l For new US clients who have signed up for a OneSpan Sign Production account, who are deploying to a US Production Environment, and whose login URL is https://apps.esignlive.com/login:

l API URL:

https://apps.esignlive.com/api

l Designer URL:


25

https://apps.esignlive.com/login

https://apps.esignlive.com/auth?senderAuthenticationToken={0}&target=https://apps.esignlive.com/designer/{1}?profile=dynamics1.2

l Signing URL:

https://apps.esignlive.com/auth?signerAuthenticationToken={0}&target=https://apps.esignlive.com/packages/{1}/sign

l For new US clients have signed up for a OneSpan Sign Sandbox account, who are deploying to a US Sandbox Environment, and whose login URL is https://sandbox.esignlive.com/login:

l API URL:

https://sandbox.esignlive.com/api

l Designer URL:

https://sandbox.eSignlive.com/auth?senderAuthenticationToken={0}&target=https://sandbox.esignlive.com/designer/{1}?profile=dynamics1.2

l Signing URL:

https://sandbox.eSignlive.com/auth?signerAuthenticationToken={0}&target=https://sandbox.esignlive.com/packages/{1}/sign

l For existing US clients who signed up for their OneSpan Sign account, who are deploying to a US Production Environment, and whose the login URL is https://apps.esignlive.com/login:

l API URL:

https://apps.e-SignLive.com/api

l Designer URL:


26

https://sandbox.esignlive.com/login

https://apps.esignlive.com/login

https://apps.e-SignLive.com/auth?senderAuthenticationToken={0}&target=https://apps.e-SignLive.com/designer/{1}?profile=dynamics1.2

l Signing URL:

https://apps.e-SignLive.com/auth?signerAuthenticationToken={0}&target=https://apps.e-SignLive.com/packages/{1}/sign

l For existing US clients who signed up for their OneSpan Sign Sandbox account, who are deploying to a US Sandbox Environment, and whose login URL is https://sandbox.e-SignLive.com/login:

l API URL:

https://sandbox.e-SignLive.com/api

l Designer URL:

https://sandbox.e-SignLive.com/auth?senderAuthenticationToken={0}&target=https://sandbox.e-SignLive.com/designer/{1}?profile=dynamics1.2

l Signing URL:

https://sandbox.e-SignLive.com/auth?signerAuthenticationToken={0}&target=https://sandbox.e-SignLive.com/packages/{1}/sign

l For Canadian customers deploying to a Canadian Production Environment, and whose login URL is https://apps.e-SignLive.ca/login:

l API URL:

https://apps.e-SignLive.ca/api

l Designer URL:


27

https://sandbox.e-signlive.com/login

https://apps.e-signlive.ca/login

https://apps.e-SignLive.ca/auth?senderAuthenticationToken={0}&target=https://apps.eSignLive.ca/designer/{1}?profile=dynamics1.2

l Signing URL:

https://apps.eSignLive.ca/auth?signerAuthenticationToken={0}&target=https://apps.e-SignLive.ca/packages/{1}/sign

l For Canadian customers deploying to a Canadian Sandbox Environment, and whose login URL is https://sandbox.e-SignLive.ca/login:

l API URL:

https://sandbox.e-SignLive.ca/api

l Designer URL:

https://sandbox.e-SignLive.ca/auth?senderAuthenticationToken={0}&target=https://sandbox.e-SignLive.ca/designer/{1}?profile=dynamics1.2

l Signing URL:

https://sandbox.e-SignLive.ca/auth?signerAuthenticationToken={0}&target=https://sandbox.e-SignLive.ca/packages/{1}/sign


28

https://sandbox.e-signlive.ca/login

4. Enter the Callback URL used for the Event notification service. For example: ''http://server/PostEvent.svc/PostESLEvent''

5. Save the form, and then click the Set Callback URL ribbon button to register the URL with OneSpan Sign.

6. Enter the Audit Connection String from the database created earlier.

Data Source=servername; Initial Catalog=databasename; uid=userid ; pwd=password

7. Indicate if you want to use SharePoint Integration. If yes:

a. Enter the Document Upload Host URL (the hostname of the hosted site created in Step 2: Configuring the Dashboard & Report on page 21).

b. Enter the SharePoint Documents URL, where eSignLive.com.ESL.WebService.wsp will be deployed in the SharePoint Integration. This is the SharePoint Site URL from where you will select doc-uments for CRM.

c. Enter the SharePoint Completed Document URL (the URL of the SharePoint Site Library to which signed documents from OneSpan Sign will be saved).

8. 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.


29

3.4 Step 4: Configuring the LanguageTo configure the language the connector will display:

1. In Settings, click OneSpan Sign Language. An OneSpan Sign Languages grid appears (that list should initially be empty).

2. Click New to create a new OneSpan Sign Language.

3. Enter the language's Name and Value (e.g., for English, enter English as the Name, and en as the Value). For the name-value pairs of all supported lan-guages, see Supported Languages.

4. Click Save.


30

3.5 Step 5: Installing the Notification Service for Dynamics CRM

The following procedure installs the Windows 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 OneSpan Sign package data.

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, and modify the connection strings for the SQL Server and Dynamics CRM Server as follows:

SQL Server connection string:

Data Source=<ServerName>;Initial Catalog=<dbname>;User ID=<sqluser>;Password=<password>

l Replace <ServerName> with the name of the SQL Server.

l Replace <dbname> with the name of the database where the Notifications table was installed.

l Replace <sqluser> and <password> with the SQL login cre-dentials that have Read and Write access to the database.

3. 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" />


31

<add key="crmpass" value="password" /> </appSettings>

l Replace <crmURL> with the URL of the CRM installation;

l Replace <domain>, <user>, and <password> with the domain user credentials that have administrative access to the CRM installation.

4. Open a Windows command prompt, and select Run As Administrator. Then navigate to the folder into which the service files were copied in Step 1.

5. Run the command: eSignLive.comESLNotificationService.exe -install

6. Open the Windows Services management tool (Start > Administrative Tools > Services), and confirm that the eSignLive Notifications service is present.

7. Start the Service.

8. Open the Windows Event viewer (Start > Administrative Tools > Event Viewer), and confirm that a new event log called eSignLive.comEventLog has been cre-ated under the Applications and Services Logs group.

9. Navigate to the eSignLive.comEventLog, and confirm the record of an event which indicates that the service has been started.


32

4 Managing Users

This section describes the following aspects of managing users:

l Adding Users on page 34

l Changing User Permissions on page 36

4 Managing UserseSignLive for Microsoft Dynamics CRM 2013 - Deployment Guide

33

4.1 Adding Users

4.1.1 Prerequisite l The user must be present in the Active Directory.

To add a user to eSignLive for Microsoft Dynamics CRM:

1. Click the eSignLive for Microsoft Dynamics CRM drop-down menu, and select Settings.

2. Click Users.

3. Click New to add a new user.

4. Add a new user by selecting them from Active Directory.


34

5. Click Save & Close.


35

4.2 Changing User PermissionsTo change a user's permissions:

1. Click the eSignLive for Microsoft Dynamics CRM drop-down menu, and select Settings > Security > Users.

2. On the list of Enabled Users, click the user whose permissions you want to modify.

3. Click the ellipse (…), then click Manage Roles.

4. Check the box next to each Role that applies to the user.


36

5. Click OK to apply these permissions for the user.

6. Click Save & Close.


37

5 SharePoint Integration (Optional)

SharePoint and Dynamics CRM can be installed on two separate servers. Although the servers can be physical or virtual, they must be on the same domain and net-work.

To deploy eSignLive.com.ESLCRM.WebService.wsp globally to the SharePoint site:

1. Run the SharePoint management shell as an Administrator.

2. Go to the folder where CrmServiceDeploy.ps1 resides.

3. Run the following command:

./CrmServiceDeploy.ps1

4. From the unzipped files in the section II. Configuring the Dashboard & Report, update the web.config file as below:

<appSettings> <add key="CRMURL" value="http://ServerName/OrganizationName/XRMServices/2011/Organization.svc"/> <add key="crmuser" value="CRMAdmin"/> <add key="crmpass" value="CRMAdminPassword"/> <add key="spadmin" value="SharePointAdmin"/> <add key="sppass" value="SharePointAdminPassword"/> </appSettings>

5 SharePoint Integration (Optional)eSignLive for Microsoft Dynamics CRM 2013 - Deployment Guide

38

Here SharePointAdmin is the SharePoint Administrator's username, and SharePointAdminPassword is their password.

5. Ensure that Dynamics CRM users will have at least Read permissions on the SharePoint sites that must be used in the SharePoint integration.

5 SharePoint Integration (Optional)eSignLive for Microsoft Dynamics CRM 2013 - Deployment Guide

39

6 Upgrading the Solution

If you want to upgrade an existing installation of eSignLive for Microsoft Dynamics CRM, a Dynamics CRM Deployment Administrator should perform the following pro-cedures:

1. Updating the Managed Solution on page 41

2. Updating the Dashboard & Reports on page 43

3. Updating the Notification Service on page 44

4. Updating the Account Settings on page 45

CAUTION: When you upgrade the connector, ensure that no CRM users are using Dynam-ics CRM.

6 Upgrading the SolutioneSignLive for Microsoft Dynamics CRM 2013 - Deployment Guide

40

6.1 Updating the Managed Solution

NOTE: A managed solution is a completed solution that is intended to be distributed and installed.

To update your managed solution:

1. By doing the following, ensure the eSignLive Notification Service is running, and has processed all notifications:

a. On the CRM Server, open theSQL Server Management Studio.

b. Log in, and expand the databases from the Object Explorer.

c. Right-click the esignlive (for example) database that was created in the SQL installation.

d. Execute the following query:

select * from EslNotifications where Processed is null

i. If the Processed column contains NULL, you must wait until: (A) all entries are processed and updated to 1 by the Windows service; (B) there are no further entries.

ii. Run the above query again. If there are no rows, it means that all rows have been processed.

2. Stop the eSignLive Notification Service. Click Start > Administrative Tools > Ser-vices.

3. By doing the following, import the new eSignLive for Microsoft Dynamics CRM solution.

a. Connect to Dynamics CRM as a user with Administrator privileges.

b. In the Dynamics CRM top menu, click Settings, then click Solutions.

c. From the Solutions grid, click Import.


41

d. Dynamics CRM will prompt you for the location of the solution package. Click Browse, and select the provided solution package (e.g., ESLConnector_1_0_0_X_managed.zip).

4. Click Next to display information about the solution. Dynamics CRM will indic-ate that the new solution contains an update for the solution that is already installed.

5. Ensure that the option Maintain customizations (recommended) is enabled, and that any SDK message-processing steps in the solution are checked. Then click Next.

6. The solution will import, and a summary page will appear. You may receive a warning message that can safely be ignored. This message indicates that when the solution was imported, the SDK message steps were disabled and then enabled.

7. Click Close.

8. Click Publish All Customizations from All Solutions, and then reload the page. You should see that the managed solution bears the version number of your solution update.


42

6.2 Updating the Dashboard & ReportsTo update the Dashboard and Reports:

1. Backup the file web.config, which is in the directory where you installed the Dashboard and Reports package.

2. Stop the IIS site associated with the Dashboard and Reports.

3. Extract the new 7z file, and replace all Dashboard and Reports files.

4. Update the new web.config file, using information from the backup you made in Step 1. If in doubt, refer to the Installation section of the Dashboard.

5. Restart the IIS site.


43

6.3 Updating the Notification ServiceTo update the Notification Service:

1. Backup the file eSignLive.comESLNotifcationService.exe.config, which is in the directory where you installed the Notification Service package.

2. Open a Windows command prompt, select Run As Administrator, and navigate to the Notification Service folder.

3. Run the following command: eSignLive.comESLNotificationService.exe -uninstall.

4. From the extracted 7z file, replace all Notification Service files.

5. Update the new eSignLive.comESLNotifcationService.exe.config file, using the from the backup you made in Step 1. If in doubt, refer to the Installation sec-tion of the Notification Service.

TIP: During this process, you have an opportunity to set the time interval for updating the Notification Service.

6. Run the following command: eSignLive.comESLNotificationService.exe -install.

7. Open the Windows Services management tool (Start > Administrative Tools > Services), and confirm that the eSignLive Notification service is present.

8. Start the OneSpan Sign Notification Service.

9. Open the Windows Event Viewer (Start > Administrative Tools > Event Viewer), and confirm that a new event log called eSignLive.comEventLog has been cre-ated under the Applications and Services Logs group.

10. Navigate to the eSignLive.comEventLog, and confirm the record of an event which indicates that the service has been started.


44

6.4 Updating the Account SettingsTo update the Account settings:

1. In Dynamics CRM, navigate to the OneSpan Sign Account.

2. Select the OneSpan Sign account you've created, and then click Edit. The OneSpan Sign Account: Information page opens.

3. Update the Document Upload Host URL with the site (including port) where you are hosting the Dashboard and Reports site as you've configured it in IIS.


45

7 Uninstalling the Solution

To uninstall the solution:

1. From Dynamics CRM Settings > Solutions, select the OneSpan Sign Connector solution, and click Delete.

CAUTION: You will lose all OneSpan Sign data stored in the OneSpan Sign's lists. You will also lose any documents uploaded from a disk, since they are attached to eSignLive's Document list.

2. Clean up the esignlive database (created during the SQL Installation) by trun-cating the tables EslAudit and EslNotifications.

7 Uninstalling the SolutioneSignLive for Microsoft Dynamics CRM 2013 - Deployment Guide

46

8 Troubleshooting

8.1 Connectivity to OneSpan SignTo confirm that an OneSpan Sign Account has been created and properly con-figured for eSignLive for Microsoft Dynamics CRM, click Verify Settings. The soft-ware will indicate if a valid API Key and connectivity to the OneSpan Sign service have been established.

8 TroubleshootingeSignLive for Microsoft Dynamics CRM 2013 - Deployment Guide

47

8.2 No Package UpdatesIf package updates are not occurring as expected, check the eSignLive.comEventLog on the server where the Notifications Service is installed: Windows Server Manager > Diagnostics > Event Viewer > Applications and Services Logs.


48

8.3 Push Notification Service Not WorkingThe Push Notification Service will not work if there is not enough free memory. To fix this, make the server's free memory more than 5% of its total memory.


49

8.4 Managing OneSpan Sign's Notification ServiceTo find the start, stop, pause, and shutdown logs for OneSpan Sign's Notification Ser-vice, go to the path that contains the file eSignLive.comESLNotificationService.exe. The folder eSignLive.comESLNotificationService Logs for CRM in that location contains all the Notication Service's logs.


50

8.5 Debugging TipsSiteMap Settings contains links that show internal operations that could be useful for debugging.

Note that:

l eSignLive Plugin Commands displays a list of the commands sent from eSignLive for Microsoft Dynamics CRM's GUI to the eSignLive for Microsoft Dynamics CRM plugin.

l eSignLive Events displays a list of status-update notifications received from the Notification Update service.


51