Upgrading OneSpan Sign Embedded Integration for CRM

Upgrading

If you want to upgrade an existing installation of OneSpan Sign Embedded Integration for CRM, a Dynamics CRM Deployment Administrator should perform the following procedures:

1. Updating the Managed Solution

2. Updating the Dashboard & Reports

3. Updating the Notification Service

4. Updating the Account Settings

When you upgrade the connector, ensure that no CRM users are using Dynamics CRM.

Updating the Managed Solution

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 that OneSpan Sign's Notification Service is running, and has processed all notifications:

   1. On the CRM Server, open the SQL Server Management Studio.

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

   3. Right-click the database that was created in the SQL installation (e.g., esignlive).

   4. Execute the following query:

      select * from EslNotifications where Processed is null

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

      2. 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 > Services.

3. By doing the following, import the new OneSpan Sign Embedded Integration for CRM solution:

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

   2. From the Dynamics CRM top menu, select Settings > Solutions.

   3. From the Solutions grid, click Import.

   4. 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 indicate that the new solution contains an update for the solution that is currently installed.

5. Ensure that: (i) the option Maintain customizations (recommended) is enabled; (ii) you have selected any SDK message-processing steps that were included in the solution..

6. Click Next. 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.

Updating the Dashboard & Reports

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

Updating the Notification Service

To 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 backup you made in Step 1. If in doubt, refer to the Installation section of the Notification Service.

   During this process, you have an opportunity to configure a 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 OneSpan Sign 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 created 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.

Updating the Account Settings

To update the Account settings:

1. In Dynamics CRM, navigate to 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) that hosts the Dashboard and Reports, as you configured it in IIS.

   

Upgrading

If you want to upgrade an existing installation of OneSpan Sign Embedded Integration for CRM, a Dynamics CRM Deployment Administrator should perform the following procedures:

1. Updating the Managed Solution

2. Updating the Dashboard & Reports

3. Updating the Notification Service

4. Updating the Account Settings

When you upgrade the connector, ensure that no CRM users are using Dynamics CRM.

Updating the Managed Solution

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 that OneSpan Sign's Notification Service is running, and has processed all notifications:

   1. On the CRM Server, open the SQL Server Management Studio.

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

   3. Right-click the database that was created in the SQL installation (e.g., esignlive).

   4. Execute the following query:

      select * from EslNotifications where Processed is null

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

      2. 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 > Services.

3. By doing the following, import the new OneSpan Sign Embedded Integration for CRM solution.

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

   2. From the Dynamics CRM top menu, select Settings > Solutions.

   3. From the Solutions grid, click Import.

   4. 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 indicate that the new solution contains an update for the solution that is currently installed.

5. Ensure that: (i) the option Maintain customizations (recommended) is enabled; ; (ii) you have selected any SDK message-processing steps that were included in the solution.

6. Click Next. 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.

Updating the Dashboard & Reports

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

Updating the Notification Service

To 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 information from the backup you made in Step 1. If in doubt, refer to the Installation section of the Notification Service.

   During this process, you have an opportunity to configure a 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 OneSpan Sign 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 created 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.

Updating the Account Settings

To 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) that hosts the Dashboard and Reports, as you configured it in IIS.

   

Upgrading

This section is relevant only if you have an on-premises deployment of OneSpan Sign Embedded Integration for CRM.

If you want to upgrade an installed 1.1 version of OneSpan Sign Embedded Integration for CRM to the 2.1 version, a OneSpan Sign Embedded Integration for CRM Administrator should sequentially perform the following procedures:

• Importing the New Solution

• Specifying Account Settings

• Completing the Upgrade

• Reinstalling the Push Notification Service

Importing the New Solution

To import the new solution:

1. Log in to OneSpan Sign Embedded Integration for CRM as a user with Administrator privileges.

2. From the top menu, select OneSpan Sign Embedded Integration for CRM > Settings > Solutions.

3. From the Solutions grid, click Import. You are prompted for the location of the solution package.

4. Click Browse, and select the provided solution package — e.g., Download OneSpan Sign Embedded Integration for CRM v2.1 Release Candidate (Solution Package).

5. Click Next to display solution information. OneSpan Sign Embedded Integration for CRM will indicate that there is an update for the solution that is currently installed.

6. Ensure that: (i) the Maintain customizations (recommended) option is enabled; (ii) you have selected any SDK message-processing steps that were included in the solution.

7. Click Next. The solution is imported, and a summary page appears. A warning message may appear that can safely be ignored. The message states that when the solution was imported, the SDK message steps were disabled and then enabled.

8. Click Close.

9. From All Solutions, click Publish All Customizations.

10. Reload the page. The solution should now be the updated version (e.g., 2.1.1.2).

Specifying Account Settings

To inform OneSpan Sign Embedded Integration for CRM about your OneSpan Sign account:

1. Navigate to OneSpan Sign Embedded Integration for CRM > OneSpan Sign Account.

2. Select your OneSpan Sign account. The OneSpan Sign Account: Information page appears.

   

3. Specify all parameters appropriately. For more information, see Specifying Account Information.

Completing the Upgrade

To complete your upgrade to version 2.1 of OneSpan Sign Embedded Integration for CRM:

1. Install the setup file eSignLive.com.Crm.UpgradeService.Setup.msi.

   This creates a folder in C:\Program Files (x86)\eSignLive\eSignLive.com.Crm.UpgradeService.Setup.

   

2. Open the configuration file eSignLive.com.Crm.UpgradeService.exe.config, and update the CrmLocal settings with your OneSpan Sign Embedded Integration for CRM service user credentials.

   All variables in the preceding example refer to OneSpan Sign Embedded Integration for CRM.

   For example:

   <add name="CrmLocal" connectionString="Url=http://<server>/<organization>; Domain=xxxxxx; Username=xxxxx; Password=xxxx"/>

3. Run the services.msc file from the Start menu. Then select and start the service named OneSpan Sign Connector Upgrade Service.

   

4. Run the Event viewer, and verify the status of the selected service (e.g., there should not be any error messages).

   

5. Log in to OneSpan Sign Embedded Integration for CRM, and verify that data has been appropriately updated for existing OneSpan Sign packages. Specifically, all Account and Opportunity drop-down values must be Related Entity fields or Related Record fields.

Reinstalling the Push Notification Service

To reinstall the Push Notification Service, see Deploying the Push Notification Service. Your new service will replace the previous Push Notification Service, but it will use the same port.