Web Interface

This document contains information about how to install, configure and run the 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.

General Settings and Configuration

Setting the Port

Commit Web Interface communicates with users/browsers through a port.

In order for the service to use the port, it should be set up in the Web Interface properties file. This port should not be in use by any other application or service.

Commit's default configuration uses Port 4961.

To change the port number, edit the file <Installation_DIR>\Commit\WebInterface\CommitWebInterface.ini and change the port under the token: 'ServerPort'

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.

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 computer on which Commit Web Interface is running.

You can set up the server IP or URL by editing the file <Installation_DIR>\Commit\WebInterface\CommitWebInterface.ini and changing the token: 'ServerIP' (e.g. ServerIP=212.140.210.143 or ServerIP=www.mydomainname.com).

Note that by default the Web Interface uses IP 127.0.0.1 (localhost), which means you can use the Web Interface on your local computer only.

Activating Commit Web Interface

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 or on the computer on which the CommitCRM is installed.

Note: Make sure to run CommitCRM client at least once before installing the Web interface service for the first time.

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

Notes:

1. In case you wish to install and run the Web Interface service on Vista, you should run the command prompt from Start > Accessories > Command Prompt > right-click it and select > Run as administrator.
2. 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.

After installing the service, a pop-up window should be displayed letting you know the service was installed successfully. If this window does not appear, this may be because the user running the command prompt does not have the required rights - make sure you run as administrator (see Note 1 above).

After a successful service installation, a service called CommitWebInterface is now displayed in the system services management window (Control Panel > Administration Tools > Services).

Using the Services Management window, start the service ad make sure that the service is defined 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

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 > Web Interface to set this feature.

Login to the Web Interface

In your web browser, enter in the URL: http://127.0.0.1:4961

Note: You should modify this link to reflect your IP/URL address and Port.

A login page will be displayed. Enter the username and password you defined. Click the Login button to log-in.

You can also embed the login page in your web site.