Deploying the Push Notification Service
NOTE: The Push Notification Service is needed only if your connector is installed on-premises. If you have a SaaS deployment (as is possible for Microsoft Dynamics CRM 2.0, for example), please ignore this section.
The Push Notification Service: (1) receives an Event Notification (callback) from eSignLive every time the status of an e-signature process changes; (2) transmits that information to the relevant connector (e.g., eSignLive for Microsoft Dynamics CRM, eSignLive for Microsoft SharePoint).
This section describes:
- Installing the Push Notification Service
- Verifying the Push Notification Service
- Uninstalling the Push Notification Service
To install the Push Notification Service for an eSignLive connector:
- If you are using Microsoft Dynamics CRM 2.0, unzip the file
PushNotificationService.zipinto the folder where you want to install the service.
- Create an IIS Website by doing the following:
- Connect to IIS with sufficient privileges.
- Click Add Web Site. A new dialog box appears.
- Specify the following parameters:
- Site name — You can specify any name you want.
- Physical path — If you are using Microsoft Dynamics CRM 2.0, this path should identify the folder where the zip file was unzipped in Step 1. If you are using any other connector, this path should identify the folder where the Push Notification Service will be installed.
- Port — You can specify any port number you want.
- Update the connectionString in the "<add name="CrmLocal" connectionString="....">" section of the file.
- Update the following parameters:
- URL — The URL of your Microsoft Dynamics CRM organization (e.g., http://hostname:8888/Dynamics2015)
- Domain — The domain name
- Username — The user name associated with a domain account that has Admin privileges on Microsoft Dynamics CRM 2.0
- Password — Password for the Username
- Double-click the file ESLEventReceiverInstaller.msi.
- On the Welcome screen, click Next. A new dialog box appears.
- Specify the IIS Site and Application Pool.
- Click Next. The Connection Settings page appears.
- 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.
- Server Name — Name of the SQL server
- Database Name — Name of the SQL database
- User Name — The user name associated with the database
- Password — Password for the User name
- Click Next.
- After the installation is complete, click Close.
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.
- The URL for the Push Notification Service is:
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 eSignLive's IP address. If so, you can obtain that IP address from eSignLive Support.
NOTE: This URL should be used in eSignLive Account > Callback URL in the connector configuration.
PostESLEvent is the method in the service that receives
HTTP POST requests with a JSON payload as event data.
To verify that events are being properly received by the Push Notification Service:
- Create a package using your eSignLive connector.
- Do one of the following:
- If you are using Microsoft Dynamics CRM 2.0, the service should receive an eSignLive Notification Entity about the new package.
- If you are using a connector other than Microsoft Dynamics CRM 2.0, the service should receive at least one event associated with the new package. To verify that it has, check the SQL table:
- If the expected events do not appear, check the following service log:
- 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 write permissions to the Website folder.
Select * From EslNotifications
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.
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:
- If you are using a connector other than Microsoft Dynamics CRM 2.0, run the file ESLEventReceiverInstaller.msi, and select Remove ESLEventReceiverInstaller. Then click Finish.
- To delete the IIS Website and Application Pool, right-click PushNotificationService, and select Remove.
- If you are using Microsoft Dynamics CRM 2.0, remove the service's unzipped folder.