In order to use the ClientPay web application, Persolvent requires a new customer to install and host a web service on their local Windows Server. In addition to the web service, a new customer must patch their copy of the ProLaw database. This installation guide will walk a new customer through the installation process. If you have any questions or encounter any problems during installation please contact firstname.lastname@example.org for assistance.
While the ClientPay SQL script does not manipulate any existing tables, procedures, or data, as an extra precaution we recommend that you run it at a time when no one is using the system.
You must have administrator privileges to install all of the following components.
Static Domain or IP Address, Firewall Port, ClientPay SSL Certificate Installation
In order to implement ClientPay, you will need to provide a static Public IP address or domain along with a dedicated port assigned to ClientPay. Clientpay accepts ports 443,444, and 32321. A firewall configuration may be needed when assigning this port. We are now offering free SSL certificates for use with ClientPay. Click here for instructions on how to install the certificate.
Transport Layer Security (TLS) 1.2 or higher
The payment card industry (PCI) requires TLS 1.2 or higher for compliance. If your server does not allow for secure messages via TLS 1.2 or your users have older browsers that do not support TLS 1.2, you will experience disruptions when accessing ClientPay.
Microsoft .NET 4.0 Framework
At a minimum, the 4.0 version of the Microsoft .NET Framework must be installed on the server before continuing the installation. The .NET Framework is free and can be downloaded from Microsoft.
To determine what versions of the .NET Framework are currently installed on your server, navigate to the “Windows\Microsoft.NET\Framework” folder using Windows Explorer. If the 4.0 version is installed you will see a folder with a prefix of “v4.0”.
SQL Server Management Studio
In order to install the database patch, it is recommended that you have SQL Server Management Studio application installed on your server. This application is normally already installed if you have a newer copy of SQL Server. Some older versions like SQL Express do not include this application. The SQL Express version is free and can be downloaded from the Microsoft download center. Search the download center using the following criteria: “Microsoft SQL Server Management Studio Express.”
Internet Information Services (IIS)
The ClientPay web service is hosted in IIS. To determine if IIS is installed on your server, look in the “Administrative Tools” folder. If it is currently installed, it will be listed. Refer to Figure 1 below.
Version 2012 ONLY - Please ensure that the following server roles are installed:
Incoming/Outgoing Network Transactions
Web Server (IIS) Support
WindowsProcess Activation Service
Web Server (IIS)
IIS Hostable Web Core
IIS Management Console
.NET 3.5 Features
.NET 3.5 Framework
.NET 4.5 Features
.NET 4.5 Framework
If IIS is not currently installed, select “Start” -> “Administrative Tools” -> “Server Manager”. From the server manager select “Roles” and then select “Add Roles”. Refer to Figures 2 and 3 below.
The “Add Roles Wizard” will be displayed. Click the “Next” button if the default page is displayed. Select “Web Server (IIS)” from the role list and then click the “Next” button. An introductory page will open with links for further information. Click the “Next” button. Refer to Figures 4 and 5 below.
Select the “ASP.NET” and “.NET Extensibility” services. You will have to select the “ISAPI” services as well. Click the “Next” button. Refer to Figure 6 below.
From the confirmation window, click the “Install” button to start the installation of IIS. The actual installation process should take less than one minute. Refer to Figure 7 below.
Click the “Add Role Services” link. Refer to Figure 8 below.
Select the “IIS 6 Management Compatibility” role service and then click the “Next” button. Refer to Figure 9 below.
From the confirmation window, click the “Install” button to start the installation of the role service. The actual installation process should take less than one minute.
Confirm that the Web server is properly installed by launching Internet Explorer and navigating to http://localhost. Refer to Figure 10 below.
Even if you currently have IIS on your server, you must follow these steps to configure it for ClientPay. Launch the “Internet Information Services (IIS) Manager” application from the start menu. Navigate to the correct server click on “Application Pools”. Then select “Add Application Pool”. Refer to Figure 11 below.
Name the application pool “ClientPay App Pool”. Select the 4.0 version of the .NET Framework and “Integrated” for the managed pipeline mode. Make sure that the “Start application pool immediately” is checked. Click the “OK” button to continue. Refer to Figure 12 below.
You will have to configure the newly created application pool to allow access to system resources like the ProLaw database. Select the “ClientPay App Pool” entry and then click the “Advanced Settings” link. Refer to Figure 13 below.
Click “Identity” and then the “…” button to the right to modify the Identity settings. Refer to Figure 14 below.
Supply an account that has enough privileges to login and access the ProLaw database. The ProLaw Web Service configuration uses a trusted connection model to connect to the ProLaw database. If a non system account is used for the Windows user account, you must change the connection string in the configuration file of the ProLaw Web Service. Refer to Figure 15 below.
Now, click “Sites” under the server name and then “Add Web Site…” to host the web service. Refer to Figure 16 below.
Enter “ClientPay Web Service” for the site name. Click the “Select” button and assign the “ClientPay App Pool” for the application pool. Assign the port and leave the “Host name” empty and IP address at “All Unassigned” unless you have a reason to assign a specific address. The port must be either 443,444, or 32321. You will want to configure your firewall to allow communications via the port you choose. Refer to Figure 17 below.
Click the “…” button and navigate to the “Inetpub” folder. Refer to Figure 18 below.
Click the “Make New Folder” button. Refer to figure 19 below.
Make the name of the new folder “ClientPay Web Service”. Refer to Figure 20 below.
Click the “OK” button to complete the creation of the web site. Refer to Figure 21 below.
Your environment should look similar to Figure 22 below.
PROLAW WEB SERVICE INSTALLATION
Locate the “ProLawService.zip” included in the installation packet. Copy the contents into the ProLaw Web Service folder of IIS (C:\inetpub\ProLaw Web Service.) The contents are shown in Figure 23 (the subfolder “bin” contains some required libraries).
PATCHING THE PROLAW DATABASE
The final step in the installation is to patch your ProLaw database. This step does not change any of your existing data. It simply creates tables and stored procedures that allow the ClientPay web application to communicate with your local copy of ProLaw.
Start the “SQL Server Management Studio” application and login into the server.
Note: It is highly recommended that you take a backup of the ProLaw database before continuing.
File > Open > File… Open the “ClientPayInstall_ProLawXI.sql” script you received from ClientPay Support and then click the “Execute” button. This will create two new tables in your ProLaw database (make sure you are pointing towards your ProLaw XII database; your database could be named differently). Confirm that the command completed successfully. Refer to Figure 24 below.
The installation is now complete.
If you have questions or need assistance, please contact email@example.com.