Web Interface

User Manuals > Web Interface

Introduction

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>\CommitCRM\WebInterface\Readme.txt

Note: "<Installation_DIR>" refers to the path on the server (drive and directory) where the CommitCRM server files are installed.

Related Videos

• Web Interface Installation Video
• Web Interface for Employees Tutorial

General Settings and Configuration

Setting the Port

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

CommitCRM's default configuration uses Port 4961.

If you want to change the default port number, to a port number other than the default (4961) follow these instructions:

1. Edit the Properties File: <Installation_DIR>\CommitCRM\WebInterface\CommitWebInterface.ini.
2. Modify the port number under the token: 'ServerPort'.
3. Note that you must use a port number greater than 1024 in order for the Web Interface service to work.
4. Make sure that the port you choose is not being used by any other application or service.
5. If you use a firewall, proxy, etc. it is recommended that you open Port 4961 (or the port defined in the properties file) in order to allow a connection to be established with CommitCRM Web Interface. If this port is blocked by a firewall, a connection cannot be established.

Setting the Server IP or URL

** Required only for version 6.1 and older **

From version 6.2 and up you do not need to configure this.

CommitCRM 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>\CommitCRM\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 CommitCRM Web Interface

Install/Uninstall CommitCRM Web Interface

CommitCRM 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>\CommitCRM\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 <Installation_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 CommitCRM WebInterface is now displayed in the system services management window (Control Panel > Administration Tools > Services).

Using the Services Management window, start the service and make sure that the service is defined to start automatically (Startup type > Automatic) each time the server is restarted.

Uninstall

To Uninstall CommitCRM Web Interface stop the CommitCRM WebInterface service and then type the following command in a command prompt window on the server: <Installation_DIR>\CommitCRM\WebInterface\CommitWebInterface.exe -uninstall

Starting To Use Web Interface

To start using the Web Interface, you should first define Web Users for Employees and for Customers. Then, browse to the login page and log in to the system.

Note that logging in via mobile devices will automatically adjust the display to be optimized for small screens. See more details in Web Interface From Mobile Devices.

Define Web Users

To test the installation and start using CommitCRM Web Interface, create web users for employees and customers.

Web user management is done within the CommitCRM application. Login to CommitCRM and follow these instructions:

Creating web users for Employees

1. Open the Employees/Accounts window and navigate to the desired employee record.
2. Select the "Employee" tab and click on the "Configure Web User" Button.
3. Set a web username and password and confirm.

Note: You can use Employee Web Users to work with Subcontractors. See more details in Activating Subcontractors.

Creating web users for customer Accounts

1. Open the Accounts window and navigate to the desired Account record.
2. Select the "Web Users" page, click on the "New" button at the bottom of the page.
3. Set the web user username, password and other information and confirm.

Note: After defining the user, you can send them an email with the Account login credentials. See more details in Sending Account Login Credentials to Customers.

Notes:

1. CommitCRM 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.

Web Interface From Mobile Devices

When using the Web Interface from Mobile devices, CommitCRM Web Interface uses an optimized display for mobile devices with small displays. The mobile display allows you to easily view and manage tickets, get customer contact details, log time and parts charges and much more directly from your phone.

Options for mobile devices:

• All HTML templates are adjusted to fit mobile screen resolution (minimum screen width 320 pixels).
• Instead of the existing tabs in regular browsers (i.e. Account/Tickets etc.), a quick selection list will switch between the tabs.
• Users can adjust the amount of characters to make long textual fields look better on mobile devices. To make the adjustment go to Tools > Options > Web Interface.
• It is possible to switch to mobile display also on any browser using the new switch to mobile / switch to standard option.

File:Web mobile demo all os.gif

Document Download and Upload Settings

Using the Web Interface, employees can download and upload CommitCRM documents which are located on your server, directly from the browser.

In order to allow file downloads and uploads, you should first enable file download and upload to allow the Web Interface Service to access the documents for downloads and uploads.

To enable uploads and downloads, go to Tools > Options > Web Interface:

File:CommitCRM web interface options download upload flag.gif

In this window an administrator user can determine whether Web Interface users will be able to download and upload documents:

• Check the Enable file downloads over the Web option to allow files download.
• Check the Enable file uploads over the Web option to allow files uploads.

In any case, both for download and for upload, the administrator should also take care of folders mapping (see below).

Document Folders Mapping In order to allow file downloads and uploads, you should first map the folder locations for the documents, so that the Web Interface Service will be able to access them for download and uploads. You can also define folders which will deny access, in case you need to protect sensitive information from being accessed via the web interface.

The CommitCRM Document files can be physically stored in various places on your server. The system has a default documents folder (as mapped in Tools > Options > Documents > Default Document Folder), which is usually physically located on the server. Note that the documents UNC path in the Document's properties is stored in the same way the client PCs sees it.

When the Web Interface tries to access a file on the server, this is done via the Web Interface service, running on your server. This means that the paths that are specified in the document properties in CommitCRM will probably not be comprehensible to the Web Interface Service running on your server.

For the service to be able to access these files, you need to 'teach' the server how to access the files locally, when encountering a mapped drive in the file path.

To setup the documents folders mapping settings, go to Tools > Options > Web Interface:

File:Commit web interface options zoom.gif

To map the folders, click the Setup folder mappings button to open the download folders settings window.

Allow Folders Settings

In the Allow Web Access To Folders tab, you should map the folders in order for the web interface service to be able to access them from the Web Interface.

File:Commit web interface download folders settings.gif

In this tab, you can enter the path mappings, which will map the 'network' path to the 'local' server path.

In the edit box, enter the Network Path (as client PCs see it), then an * (asterisk), and then the local server folder.

You should enter one mapping per line. For Example: F:\OfficalFiles\Docs * C:\AllUserOfficeFiles\Docs

Where:
F:\OfficalFiles\Docs - Mapped path as Client PCs see it.
* - Divides between the network and local path of the mapping.
C:\AllUserOfficeFiles Docs - Local path as the server sees it.

Note: You only need to set mappings for root document folders. All files stored under each root folder, including files in subfolders, will become available from the Web Interface automatically.

For example, if you map the folder F:\OfficalFiles\Docs then files stored at F:\OfficalFiles\Docs\your customer\ will be available.

Deny Folders Settings

In the Deny Web Interface Access To Folders tab, you can define the folders for which you want to deny access from the Web Interface.

In this tab, you can deny access to certain folders, in order to protect a document folder from unauthorized downloads and uploads

In the edit box, you should type in the paths you wish to deny access to. It's better to use a server's local path, although network paths are also allowed (they should appear in the same way they appear in the document's properties).

You should enter one folder path per line. For Example:
C:\OfficeFiles\Private
D:\ITDocs\Passwords

Note: The system will automatically block access to files stored under each specified folder, including files in subfolders.
For example, if you block the folder D:\ITDocs\Passwords, files stored at D:\ITDocs\Passwords\RDP\ will be blocked too.

Default Uploading Folder Settings

When files are uploaded via the Web Interface, they are automatically saved in the account's “Docs Dir” folder (which can be defined in the account window, under the Details tab). However under certain circumstances the Docs Dir folder cannot be accessed over the Web Interface, such as when no Docs Dir folder has been created for an account, or when it has been placed in the Deny Folders list.

For this reason, users should define an “Uploads Default Folder.” When a file cannot be uploaded to the account’s Docs Dir folder, it will be automatically uploaded to this default folder. To define the Uploads Default Folder, go to Tools > Options > Web Interface > Download/Upload Settings > Click Set Folder Mapping. In the Folder Mapping Settings window > Default Uploading Folder:

File:Commit web interface options upload folder.gif

Web Interface Options

Web Interface Options control different aspects of the way the Web Interface behaves. To customize the Web Interface, go to Tools > Options > Web Interface tab.

Note: Always make sure to restart the CommitCRM Web Interface service after performing any changes, so they will take effect in the Web Interface.

File:Commit web interface options general.gif

In this window you can set up the following (note there are more options when you scroll down, see more screenshots below):

Default Web Calendar View

The Default Web Calendar view options allow you to choose how you want to see your appointments when using the Web Interface. Your options are:

• Graphic weekly Calendar.
• List of Appointments (non graphic).

Memo Fields Display Limits

The Memo Fields Display Limits Option controls the amount of characters that will be displayed for long textual fields (Memo fields) showing up in lists on the Web Interface. This feature helps you manage the way you see the list, and the amount of data that will be displayed when showing long (Memo) fields.

In situations where the text is very long and exceeds the length defined here, a linkable '...' sign will appear at the end of the truncated text and this will open for viewing the full details for this entity.

The length of text to show in the lists is defined separately for standard Web browsers and for mobile devices' browsers (small display).

The length settings are personal, and affect each user's display separately.

Web Pages – Header and Footer

The Header and Footer option lets you design the Web pages for the Web Interface. This affects both customers and employees view.

Click Edit Header and Edit Footer to design these parts using html.

See also:

• Embedding a login page in your web site.
• Adding your name and logo to CommitCRM Web Interface pages.

Download/Upload Settings

Using the Web Interface, employees and customers can download and upload (only employees) CommitCRM documents which are located on your server, directly from the browser. In order to allow file downloads and uploads, you should first enable file download and upload to allow the Web Interface Service to access the documents for downloads and uploads. See more details in Document Download and Upload Settings.

More Options (scroll Down):

File:Commit web interface options screen2.gif

Default Technician Service Form

Choose the report which will be printed when clicking the Print icon from the Ticket page in the Employees Web Interface.

Web Links in Emails

Web Links refer to email Alerts being sent via CommitCRM Alerts Server. When enabled, the system will add a link to the relevant entity in the email alert body. This allows employees to quickly open CommitCRM Web Interface and view or edit the details of the entity being referred in the email. This saves the need to go explicitly to the Web Interface site, login and search for the entity in order to see its details.

Web Links Options:

1. Enable - enabling this option will automatically add links to email Alerts sent by CommitCRM Alerts Server.
2. Disable - disabling this option will not add the links to the emails sent by CommitCRM Alerts Server.
3. Use SSL/Https - if SSL is configured for the Web Interface (see more details in Using SSL with Web Interface), the links will include Https in the link URL.

Note: When using Alerts to Customers, which send email alerts regarding new Tickets and Tickets being closed, it is possible to add Web Links to the email template sent to the customer. This requires using CommitCRM Web Interface for Customers. See more details in Alerts to Customers Settings.

Memo Fields Display Limits (for Customer Users)

The Memo Fields Display Limits Option controls the amount of characters that will be displayed for long textual fields (Memo fields) showing up in lists on the Web Interface. This feature helps Administrators manage the way customers see lists, and the amount of data that will be displayed when showing long (Memo) fields.

In situations where the text is very long and exceeds the length defined here, a linkable '...' sign will appear at the end of the truncated text and this will open for viewing the full details for this entity.

The length of text to show in the lists is defined separately for standard Web browsers and for mobile devices' browsers (small display).

These settings are global for all customer users.

Sort Items List According To

This option determines the sort criteria for Items when choosing Items from the list, i.e. when creating a new Charge and choosing the Item. Possible options are to sort the list either by the Item Code or Item Name.

Initialize Customer Web Usernames

When using the "Initialize new Web users with the account number" option, new Customer Web Users will be automatically copied to the username so all this customer's Web users will start with the same prefix. This can help standardize the usernames for customers.

The Account number is copied only if defined for the Account in Details tab > Accnt #.

Setting Customer Privileges

Using the Web Interface, customers can create new tickets and view their open and closed tickets. When given additional privileges, customers can also optionally view contract information, charges, assets, and Knowledge Base articles; download files; and more.

To control what each user can see, each customer Web user should be assigned a Privilege Group. See more details in Customer Privileges.

Generating and Printing Reports Using the Web Interface

When using the Web Interface, users can generate reports and save them as PDF files. These files are automatically downloaded to the user’s local computer, from where they can be printed. For most entities (all other than Tickets), the system allows for only one pre assigned report—referred to as the “Default Detailed Report” —to be generated via the Web Interface. This report is defined in the client application by going to Tools > Options > Accounts/Assets/Opportunities tab > ”Default Detailed Report” field.

To print a report for an entity (other than Tickets), open the entity’s window in the Web Interface. Click on the ”Print Default Details Report” field in top right corner

File:Commit web interface options print default.gif

Generating and Printing Ticket Reports When working with Tickets over the Web interface, users have more Report options. Users can choose from two predefined Ticket reports that are only available over the Web interface—the “Printable Service Form” or the “Printable Service Form, Including Taxes”. These reports are specifically designed to be used from the Web Interface and are available from the Ticket window. Printing any of these reports will immediately display them in a print-preview window, allowing you to print the report to a local printer.

For all other reports, click on the “Printing to PDF...” option, which opens a drop-down list of all the reports available for tickets. In this list you can can choose from any of the reports available for tickets in the client application. The report is generated and saved as a PDF file and downloaded to the local PC.

File:Commit web interface options print ticket.gif

Selecting one of these reports prints the report into a temporary PDF file on the server, and immediately downloads it so you can open the PDF file or save it locally. You can then print the PDF report to a local printer.

Working with Subcontractors

CommitCRM Subcontractors feature allows you to effectively manage subcontractors and track their work.

Subcontractor licenses are fully-featured CommitCRM Employee licenses. You can let subcontractors access the system via the CommitCRM Web Interface, restrict them to view only specific Accounts and give them limited privileges.

See more details about using CommitCRM Web Interface to work with subcontractors in Subcontractors.

Tips & Tricks

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 use a predefined login page or customize your own login page (advanced).

To use the predefined login page
Add the following line to the relevant page/s in your existing web site:

<A HREF="http://127.0.0.1:4961">Click to login</A>

Note: You should edit this link to reflect your IP/URL address and Port (127.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.

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. Embed the following HTML/script code in one of your web pages.
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 (127.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:

Note: Copying from here may contain some illegal characters (depending on the web browser). If you are encountering any problems embedding this code, please try copying the HTML part from the Tips&Tricks section inside the readme file at: <Installation_DIR>\CommitCRM\WebInterface\Readme.txt file instead.

<SCRIPT Language="JavaScript">
      <!--
        function CmtCheckInput()
        {

          if (document.CmtForm.CmtUsrNamePrm.value=="" )
          {
            alert('Please enter a value for Name');
            document.CmtForm.CmtUsrNamePrm.focus();
            return false;
          }
          else if (document.CmtForm.CmtUsrPWPrm.value=="")
          {
            alert('Please enter a value for Password');
            document.CmtForm.CmtUsrPWPrm.focus();
            return false;
          }
          else
          {
            return true;
          }
        }

        function CmtKeyPress(event)
        {
          if (event.keyCode == 13)
          {
            CmtCheckInput();
          }
        }
      //-->
</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" method="post" action="http://1.0.0.127: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> </TD><TD><input type="submit" value="Login"></TD>
	</TR>
        <TR><TD> </TD><TD><input name="CmtUsrMobPrm" type="CheckBox"> Mobile Layout</TD>
        </TR>
      </TABLE>
</FORM>

Adding your name and logo to CommitCRM Web Interface pages

You can add your name, logo, etc. to pages displayed by CommitCRM Web Interface. Your name and logos should be formatted using HTML code, which will automatically be embedded in all pages generated by CommitCRM Web Interface.

You can design a header and footer for the page.

To display headers and footers, login to CommitCRM, 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>\CommitCRM\WebInterface\Files\MyOfficeSetting1.txt
Footer: <Installation_DIR>\CommitCRM\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>\CommitCRM\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 CommitCRM WebInterface service each time you modify the header and/or the file(s).

Testing CommitCRM 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 CommitCRM WebInterface service
4. To login, open the following file in Internet Explorer <Installation_DIR>\CommitCRM\WebInterface\Files\cmtcustlogin.htm

Sending Account Login Credentials to Customers

After defining a Web User for your customer (see Defining Web Users), you can send them an email with the Customer Account Credentials (username and password). This can help you streamline the process of providing your customers with Web user credentials to log into the Customer Web portal.

To send an email with the customer account login credentials:

1. Open the Account window and go to the Web Users tab.
2. Select the customer's Web User you want to send to.
3. On the bottom part of the tab, click the Email icon. This will open a popup menu with available email templates that contain the Web User's username and password.
4. Choose the template you want to send. An email window will open with the template and details of the selected user.

Notes:

1. The default email template provided for this purpose includes the account credentials, including the username and password. You can create your own templates via the Email Templates feature.
2. If the customer has already modified the password or has already used the password (even once), it is not possible to send the password to the customer, to avoid security issues. In this case, it is only possible to reset the password and change it to another password.

Troubleshooting

Changing CommitWebInterface.ini parameters does not take effect

Solution: After modifying <Installation_DIR>\CommitCRM\WebInterface\CommitWebInterface.ini, restart CommitCRM WebInterface service for the changes to take effect.

Cannot login using newly defined web users

Solution: 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.

No response from the server (seeing a blank page or an access error message)

Solution:

1. If a connection cannot be established through the Internet/LAN, and the CommitCRM WebInterface service is running, make sure no other applications or services on the server are using the same port as that set for CommitCRM Web Interface, and that you have set up the correct IP/URL address.
2. 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 CommitCRM Web Interface in your firewall/proxy.
3. A common problem which can result with no response from the server, relates to DEP (Data Execution Prevention). You should open Window's DEP settings and allow CommitCRM WebInterface service to accept connections.
   DEP can be found under System Properties -> Advanced -> Performance - Settings -> tab DATA EXECUTION PREVENTION.
   Make sure you allow the CommitCRM WebInterface service (its executable is found in <server>\CommitCRM\WebInterface\CommitWebInterface.exe)
   Usually this requires reboot of the server for the changes to take effect.

Session timeout is too short

Solution: 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>\CommitCRM\WebInterface\CommitWebInterface.ini

Can't download documents from the web interface

Solution: Using the Web Interface, employees can download CommitCRM documents which are located on your server, directly from the browser.
In order to allow file downloads, you should first map the folder locations for the download, so that the Web Interface Service will be able to access them for download. You can also define folders which will deny download, in case you need to protect sensitive information from being accessed via the web interface. To setup the documents download settings, go to Tools > Options > Web Interface. Read more about this under Document Download Settings.

See Also

• Using SSL with Web Interface
• CommitCRM Web Interface Troubleshooting
• Web Interface FAQ
• Web Interface Installation Video
• Web Interface for Employees Tutorial Video