Download Commit Web Interface Installation Guide 371KB
 
  Commit Web Interface Installation Instructions:
   
  This document contains information about how to install, configure and run the Commit Web Interface application
   
  This document is also available as Readme.txt file: <Installation_DIR>\Commit\WebInterface\ Readme.txt
   
  Note: "<Installation_DIR>" refers to the path on the server (drive and directory) where the Commit server files are installed.
   
  For additional information please visit www.CommitCRM.com or contact technical support at support@CommitCRM.com.
   
  Contents:
   
  1. General Settings and Configuration
  2. Install/Uninstall Commit Web Interface
  3. Define Web Users
  4. Tips & Tricks
  5. Troubleshooting
  6. Using SSL with Commit Web Interface
   
   
   
  1.General Settings and Configuration
   
 

A. Setting the Port
  B. Setting the server IP or URL
  C. Embedding a login page on your web site
   
  A. Setting the Port:
   
  Commit Web Interface communicates with users/browsers through a port.
   
  Set a port number for Commit Web Interface. This port should not be in use by any other application or service.
   
  Commit's default configuration uses Port 4961. You can modify the port setting with the 'ServerPort' property in <Installation_DIR>\Commit\WebInterface\CommitWebInterface.ini
   
  IMPORTANT NOTE :
If you use a firewall, proxy, etc. it is recommended that you open Port 4961 in order to allow a connection to be established with Commit Web Interface . If this port is blocked by a firewall, a connection cannot be established
   
  B. Setting the Server IP or URL:
   
  Commit Web Interface uses a permanent IP address or URL. This IP/URL is the external Internet address of the server on which Commit Web Interface is running.
   
  Set up the server IP or URL by setting the 'ServerIP' property in <Installation_DIR>\Commit\WebInterface\CommitWebInterface.ini
(e.g. ServerIP=212.140.210.143 or ServerIP=www.mydomainname.com) .
   
  C. Embedding a login page in your web site
   
  All user logins are performed through a browser login page.
This login page is usually accessed from your existing web site.
   
  You can choose to:
  (1) Use a predefined login page
  or
  (2) Customize your own login page (advanced).
   
 
***
   
  (1) To use the predefined login page:
Add the following link to the relevant page/s in your existing web site:
   
  <A HREF="http://10.0.0.01:4961">Click to login</A>
   
  Note: You should edit this link to reflect your IP/URL address and Port. (10.0.0.1 to your IP/URL and 4961 to the port in use)
   
  TIP: Your name and logo may also be displayed on the login page.
See the Tips & Tricks section below.
   
  (2) Customize your own login page (advanced):
   
  If you prefer that a login area will be embedded in one of your web site pages (i.e. the actual login fields will be displayed in the page and not only a link to a login page) complete the following instructions.
   
  The <SCRIPT> code should be added beween the HTML <HEADER> and </HEADER>.
The <FORM> code should be added in the HTML <BODY> area; You need to update the default IP/URL (10.0.0.1) to your IP/URL, and the default port number (4961) to your port settings .
   
  Please embed the following HTML code:
   
  Copy and paste this section to your HTML <HEADER> section:
   
  <SCRIPT language="JavaScript">
< !--
function CmtCheckInput ()
{
if (document.CmtForm.CmtUsrNamePrm.value == "")
{
alert('Please enter your user name');
document.CmtForm.CmtUsrNamePrm.focus();
return false ;
}
else if (document.CmtForm.CmtUsrPWPrm.value == "")
{
alert('Please enter your password');
document.CmtForm.CmtUsrPWPrm.focus();
return false ;
}
else
{
aWinSize = ",width="+screen.width+",Height="+(screen.Height-100)+",Top=0,Left=0 ";
aNewWin = window.open("","CmtNewWindow","toolbar=0,menubar=0,scrollbars=1,resizable=1,status=1,
directories=0,location=0"+aWinSize);
aNewWin.name = "CmtNewWindow ";
return true ;
}
}
function cmtLogin()
{
if (CmtCheckInput())
{
document.CmtForm.submit();
document.CmtForm.CmtUsrPWPrm.value = "";
}
}
//-->
</SCRIPT>
   
  Copy the following HTML code, paste it in the HTML <BODY> area and modify the IP and Port as described above:
   
  <FORM name="CmtForm" target="CmtNewWindow" method="post" action="http://10.0.0.01:4961" onSubmit="return CmtCheckInput ()">
<table>
<tr>
<td>User Name:</td>
<td><input name="CmtUsrNamePrm" type="text" id="CmtUsrNamePrm"></td>
</tr>
<tr>
<td>Password:</td>
<td><input name="CmtUsrPWPrm" type="password" id="CmtUsrPWPrm"></td>
</tr>
<tr>
<td>&nbsp;</td>
<td><input type="button" onClick=cmtLogin() value="Login"></td>
</tr>
</table>
</FORM>
   
  2. Install/Uninstall Commit Web Interface
   
  Commit Web Interface runs as a Windows Service on your server.
   
  Install:
   
  This part of the installation should be performed on the server itself.
   
  When logged in to the server with an Administrator account, open a command prompt window and enter the following command:
   
  <Installation_DIR>\Commit\WebInterface\CommitWebInterface.exe -install
   
  Note: The <Insallation_Dir> must refer to a LOCAL server path (e.g. c:\ or D:\Software, etc.) and NOT to a shared network name/path.
   
  A service called CommitWebInterface is now displayed in the system services management window (Control Panel - Administration Tools – Services).
Using the Services Management window make sure that the service is running and that it is set to start automatically (Startup type > Automatic) each time the server is restarted .
   
  Uninstall:
   
  To Uninstall Commit Web Interface stop the CommitWebInterface service and then type the following command in a command prompt window on the server :
   
  <Installation_DIR>\Commit\WebInterface\CommitWebInterface.exe -uninstall
   
  3. Define Web Users
   
  To test the installation and start using Commit Web Interface, create web users for employees and customers.
   
  Web user management is done within the Commit application .
Login to Commit and follow these instructions:
   
  Creating web users for employees:
   
  Open the Employees/Accounts window and navigate to the desired employee record.
Select the "Employee" tab and click on the "Configure Web User" Button.
Set a web username and password and confirm.
   
  Creating web users for customer Accounts:
   
  Open the Accounts window and navigate to the desired Account record.
Select the "Web Users" page, click on the "Add" button at the bottom of the page and set the web user username, password and other information and confirm.
   
  NOTES:
   
  (1) Commit Web Interface will identify the newly created users within several minutes
  (2) All passwords are case sensitive.
  (3) Since each username must be unique in the entire system, it may be a good idea to add a common prefix to all the web users of each Account, i.e. BIZ_1_John, BIZ_1_Mary, BIZ_2_John, BIZ_2_Phil etc.
   
  If you set an Account number for each of your accounts (using the Account # field), you can set the system to automatically add the Account# as a prefix for each new web user you create. Use the Options window - Web Interface page to set this feature.
   
  4. Tips & Tricks
   
  Adding your name and logo to Commit Web Interface pages
   
  You can add your name, logo, etc. to pages displayed by Commit Web Interface . Your name and logos should be formatted using HTML code, which will automatically be embedded in all pages generated by Commit Web Interface.
   
  You can design a header and footer for the page.
   
  To display headers and footers, login to Commit, open the Options window , go to the Web Interface page and check the Header/Footer checkboxes (these are checked by default).
   
  Place the HTML for the Header and Footer in these files:
   
  Header: <Installation_DIR>\Commit\WebInterface\Files\MyOfficeSetting1.txt
  Footer: <Installation_DIR>\Commit\WebInterface\Files\MyOfficeSetting2.txt
   
  You can open these files in an editor (Notepad etc.) either navigate to their location using Windows file explorer or by clicking on the dedicated buttons in the Options window - Web Interface page.
   
 

NOTES:
   
  These files are not standalone HTML pages and should NOT include the standard HTML page tags like <HEAD>, <BODY>, etc.
The HTML code should include only HTML code related to the design of your name, logo etc. and not to any other page related HTML tags.
   
  If you use image files in the HTML, you should save these images in the same directory and link to them using the "/Files/" token.
For example, to use the image file called "mylogo.jpg" in your HTML code, save it as
<Installation_DIR>\Commit\WebInterface\Files\mylogo.jpg and link to it in the HTML as follows: <img src="/Files/mylogo.jpg "> .
   
  If you are using the predefined login page (i.e. you've added a link to it from your web site) you need to restart the CommitWebInterface service each time you modify the header and/or the file(s).
   
  Receiving Email Alerts whenever a customer creates a new ticket or updates it
   
  To activate the Email Alerts feature:
  (1) Open <Installation_DIR>\Commit\WebInterface\CommitWebIntNotifications.ini file and set your mail server settings.
   
  (2) Open <Installation_DIR>\Commit\WebInterface\CommitWebIntNotificationsEmails.txt
file and write the email addresses that should receive alerts when customer creates a new ticket or update it.
   
  Each email address should be added in a separate line and without any additional
characters (do not use any commas, colons, semi-Colon, quotes etc.- just standard email addresses).
   
  The Commit Web Interface will immediately start sending alerts as the files are
saved. There is no need to restart the CommitWebInterface service after modifying the content of these files.
   
  Testing Commit Web Interface on your LAN prior to installing it for internet use
   
  (1) Set the ServerIP in CommitWebInterface.ini to your internal server’s IP
  (2) Make sure that the default ServerPort is not already in use, or modify it if necessary
  (3) Restart CommitWebInterface service
  (4) To login, open the following file in Internet Explorer
<Installation_DIR>\Commit\WebInterface\Files\cmtcustlogin.html
   
  5. Troubleshooting
   
  A. After modifying <Installation_DIR>\Commit\WebInterface\CommitWebInterface.ini , restart CommitWebInterface service for the changes to take effect.
   
  B. If you cannot login using web users you've just created/enabled, please note that it may take up to five minutes until your new settings take effect, and that the password is case sensitive.
   
  C. If a connection cannot be established through the Internet/LAN, and the CommitWebInterface service is running, make sure no other applications or services on the server are using the same port as that set for Commit Web Interface, and that you have set up the correct IP/URL address.
   
  D. If a connection cannot be established through the internet, but can be established on your LAN, make sure you have opened up the port used by Commit Web Interface in your firewall/proxy.
   
  E. Timeouts: If a user doesn't perform any action within a specified period of time his session expires and he needs to reenter the system . The default timeout value is 60 minutes. You can modify the default by editing the TimeOutAmount value in file
<Installation_DIR>\Commit\WebInterface\CommitWebInterface.ini
   
   
  A D V A N C E D   T O P I C - O P T I O N A L
   
  6. Using SSL with Commit Web Interface
   
 

A. Background
  B. Saving the Certificates Files
  C. Activating SSL with Commit
  D. Setting the SSL Port
  E. Setting SSL Certificate Password
  F. Modifying the Login Page to Use SSL
  G. SSL Troubleshooting
   
  A. Background:
   
  Commit Web Interface supports the ability to accept SSL connections (https rather than http).
   
  Using SSL with Commit Web Interface is OPTIONAL.
You can use Commit Web Interface without setting up SSL.
   
  The first step you should take if you want to use SSL with Commit Web Interface is to obtain SSL certificates from an authorized SSL authority such as Verisign or Thawte.
   
  B. Saving the Certificate Files:
   
  Commit requires that your certificates files be in the .pem file format.
   
  You should have three certificates files with the following names:
Key.pem
Cert.pem
Root.pem
   
  Place your certificates files in the following folder:
<Installation_DIR>\Commit\WebInterface
   
  If your certificates are in another file format, convert them to the .pem file format.
Read section F on SSL Troubleshooting below to see how to convert certain types of SSL certificate file formats.
   
  C. Activating the SSL with Commit:
   
  You need to instruct Commit Web Interface to use SSL. To do so, you must edit the following file:
  <Installation_DIR>\Commit\WebInterface\CommitWebInterface.ini
   
  Change the token settings in the above file to Yes as follows:
  UseSSLEncryption=Y
   
  D. Setting the SSL Port:
   
  The SSL communication between users/browsers and Commit Web Interface uses a dedicated port.
   
  Set a port number for Commit Web Interface. This port should not be in use by any other application or service.
   
  We recommend using the Commit default port for SSL: 4962.
   
  If you decide to use another port, make sure that:
(1) You select a DIFFERENT port than the one used for standard connections (ServerPort).
(2) You select a port value other than the standard SSL port (443) which is probably already in use on your server (by IIS for example).
   
  To configure the SSL port, set the SSLPort token value in the following settings file: <Installation_DIR>\Commit\WebInterface\CommitWebInterface.ini
   
  IMPORTANT NOTE:
If you use a firewall, proxy, etc., it is recommended that you open Port 4962 in order to allow a connection to be established with Commit Web Interface.
If this port is blocked by a firewall, a connection cannot be established.
   
  E. Setting SSL Certificate Password:
   
  If you have a password for your SSL Certificate (SSL Certificate passwords are optional), enter the password for the SSlPassword token in:
<Installation_DIR>\Commit\WebInterface\CommitWebInterface.ini
   
  F. Modifying the Login Page to Use SSL:
   
  To use an SSL secure connection, modify your login page as follows:
   
  You should change:
* Http to Https
* Standard Port (default 4961) to the SSL Port (default 4962)
   
  For example:
If you've used the predefined login page (as described in section C.(1) above) the link, from your web site, to the secure login page should appear as follows:
<A HREF="https://10.0.0.01:4962">Click to login</A>
   
  If you have embedded the login fields on one of your web pages (as described in section C.(2) above), modify the JavaScript used to post the login request as follows:
   
  Original: Method="post" action="http://10.0.0.01:4961"
Modified: Method="post" action="https://10.0.0.01:4962"
   
  IMPORTANT NOTE :
If you use a firewall, proxy, etc. it is recommended that you open Port 4961 in order to allow a connection to be established with Commit Web Interface . If this port is blocked by a firewall, a connection cannot be established
   
  G. SSL Troubleshooting:
   
  Note:
The main Troubleshooting section of this document (5. Above) is valid for SSL settings. Make sure you read it as well.
   
  The section below only deals with SSL specific issues:
   
  Preparing SSL Certificate files (including converting them to the .pem file format if needed)
   
  (a) General Infomation
  (b) Export Certificate
  (c) Convert Certificate to a .pem format
  (d) Splitting the .pem file
   
 
***
   
  (a) General Information
This issue is relevant only when you configure Commit Web Interface to use SSL.
Commit requires that your certificate files all have the .pem format.
   
  If your certificates are in another format, convert them to the .pem format by following these instructions:
   
  Note1:
This procedure assumes that you have already received your key and certificate pair from a Certificate Authority (like Verisign or Thawte) and that you have installed them in Microsoft Internet Explorer under the Personal Certificates tab.
   
  Note2:
To install the certificates in Internet Explorer, follow these instructions:
Open Internet Options… window: Internet Explorer > Tools > Internet Options…
Navigate to the: Content tab
Click on the "Certificates" button
The Certificates Window dialog box will open.
Navigate to the Personal tab, select the Import option and follow the wizard to install your certificate.
   
  (b) Export Certificate
The first step is to export your certificate to a .pfx file format.
Open Internet Options… window: Internet Explorer > Tools > Internet Options…
Navigate to the Content tab.
Click on the Certificates.
The Certificates Window dialog box will open.
Navigate to the Personal tab, select your installed certificate and select Export.
Follow the wizard and select to export it as a .pfx file (Personal Exchange Format).
You may optionally protect it with a password.
   
  (c) Convert the exported .pfx file to a .pem format
To convert the .pfx file to a .pem file, you need to use a utility called openssl.exe.
The utility can be downloaded from Commit's web site at the following URL:
http://www.CommitCRM.com/downloads/openssl.exe
   
  After downloading this file and saving it to your disk, open a command window and
navigate to the folder where the utility is stored. Run the following command:
   
  openssl.exe pkcs12 –in <your file>.pfx –out <your file>.pem
   
  Where <your file> is the name of the file created during the export phase.
   
  Openssl.exe will prompt you for a password. Enter it if you used one during the export phase, or leave it blank if you did not specify one.
It will also prompt you for a new password for the .pem file. This is optional, but if you protect it with a password be sure to enter the SSLPassword token in the CommitWebInterface.ini file as explained above.
   
  (d) Splitting the .pem file
Now it is time to split the newly created .pem file into the different files required by Commit Web Interface.
   
  If you examine the new .pem file with Notepad, you will notice that it consists of two parts:
* the private key
* the certificate (public key) part
   
  Using Notepad, create a file called Key.pem
Into this file, paste everything between AND including these two statements:
-----BEGIN RSA PRIVATE KEY-----
-----END RSA PRIVATE KEY-----
   
  Using Notepad create a file named: Cert.pem
Into this file, paste everything between AND including these two statements:
-----BEGIN CERTIFICATE-----
-----END CERTIFICATE-----
   
  The final stage is to obtain the Root.pem file.
This is the Certificate Authority certificate file. You can obtain this from Internet Explorer > Tools > Internet Options… Navigate to the Content tab and click on Certificates. In Trusted Root Certificate Authority tab, select the Authority that issued your certificate and the Export it in Base64 (cer) format.
   
  The exported file format is the SAME as the .pem format, so after exporting it simply rename the file Root.pem and save it with the other certificate file in folder <Installation_DIR>\Commit\WebInterface
   
Copyright © 2002-2008, Commit Business Solutions Limited - All Rights Reserved.
For more information please read our legal terms and notices.