Web Interface FAQ: Difference between revisions

From RangerMSP Wiki - PSA software for MSPs and IT services providers
Jump to navigation Jump to search
No edit summary
No edit summary
 
(23 intermediate revisions by 4 users not shown)
Line 1: Line 1:
*[[Web Interface FAQ#How do I install Commit Web Interface?|How do I install Commit Web Interface?]]
{{faq}}
*[[Web Interface FAQ#Can Commit Web Interface run on a server running IIS?|Can Commit Web Interface run on a server running IIS?]]
 
*[[Web Interface FAQ#How do I set up Commit Web Interface when I am using Dynamic DNS (DYNDNS)?|How do I set up Commit Web Interface when I am using Dynamic DNS (DYNDNS)?]]
===Getting Started===
*[[Web Interface FAQ#How can I securely use Commit Web Interface with SSL certificates?|How can I securely use Commit Web Interface with SSL certificates?]]
*[[Web Interface FAQ#How do I install RangerMSP Web Interface?|How do I install RangerMSP Web Interface?]]
*[[Web Interface FAQ#What can my customers see and perform via the Commit Web Interface for customers?|What can my customers see and perform via the Commit Web Interface for customers?]]
*[[Web Interface FAQ#How do I check my RangerMSP Web Interface port is open?|How do I check my RangerMSP Web Interface port is open?]]
*[[Web Interface FAQ#What can my employees do/view via Commit Web Interface for Employees?|What can my employees do/view via Commit Web Interface for Employees?]]
*[[Web Interface FAQ#What can my customers see and perform via the RangerMSP Web Interface for customers?|What can my customers see and perform via the RangerMSP Web Interface for customers?]]
*[[Web Interface FAQ#How can I add a new ticket via the Commit Web Interface for Employees?|How can I add a new ticket via the Commit Web Interface for Employees?]]
*[[Web Interface FAQ#What can my employees do/view via RangerMSP Web Interface for Employees?|What can my employees do/view via RangerMSP Web Interface for Employees?]]
*[[Web Interface FAQ#How can I add a new ticket via the RangerMSP Web Interface for Employees?|How can I add a new ticket via the RangerMSP Web Interface for Employees?]]
*[[Web Interface FAQ#How can I download documents via the Web Interface?|How can I download documents via the Web Interface?]]
*[[Web Interface FAQ#How can I download documents via the Web Interface?|How can I download documents via the Web Interface?]]
*[[Web Interface FAQ#Is there a way to receive an email when new tickets have been created by a client via the web interface?|Is there a way to receive an email when new tickets have been created by a client via the web interface?]]
*[[Web Interface FAQ#Does the Web Interface have the same level of control and management as the installed client software?|Does the Web Interface have the same level of control and management as the installed client software?]]
*[[Web Interface FAQ#Does the Web Interface have the same level of control and management as the installed client software?|Does the Web Interface have the same level of control and management as the installed client software?]]
*[[Web Interface FAQ#How do I define a web user name and password for an employee?|How do I define a web user name and password for an employee?]]
*[[Web Interface FAQ#How do I define a web user name and password for an employee?|How do I define a web user name and password for an employee?]]
*[[Web Interface FAQ#How do I allow my customer to log in to the Commit Web Interface?|How do I allow my customer to log in to the Commit Web Interface?]]
*[[Web Interface FAQ#How do I allow my customer to log in to the RangerMSP Web Interface?|How do I allow my customer to log in to the RangerMSP Web Interface?]]
*[[Web Interface FAQ#How can I add my logo to the Commit web Interface pages?|How can I add my logo to the Commit web Interface pages?]]
*[[Web Interface FAQ#How can I add my logo to the RangerMSP Web Interface pages?|How can I add my logo to the RangerMSP Web Interface pages?]]
*[[Web Interface FAQ#I have created a new privilege group, which doesn't seem to have taken effect in the Commit Web Interface. Why?|I have created a new privilege group, which doesn't seem to have taken effect in the Commit Web Interface. Why?]]
 
===Advanced Use===
*[[Web Interface FAQ#How do I set up RangerMSP Web Interface when I am using Dynamic DNS (DYNDNS)?|How do I set up RangerMSP Web Interface when I am using Dynamic DNS (DYNDNS)?]]
*[[Web Interface FAQ#How can I securely use RangerMSP Web Interface with SSL certificates?|How can I securely use RangerMSP Web Interface with SSL certificates?]]
*[[Web Interface FAQ#I have created a new privilege group, which doesn't seem to have taken effect in the RangerMSP Web Interface. Why?|I have created a new privilege group, which doesn't seem to have taken effect in the RangerMSP Web Interface. Why?]]
*[[Web Interface FAQ#Can RangerMSP Web Interface run on a server running IIS?|Can RangerMSP Web Interface run on a server running IIS?]]
*[[Web Interface FAQ#Can i use the RangerMSP Web Interface with Port 80?|Can I use the RangerMSP Web Interface with Port 80?]]
*[[Web_Interface_FAQ#Can_I_convert_RangerMSP_Web_Interface_value_selection_data_fields_to_Free_Text_fields_where_I_can_type_in_any_value_I_want.3F|Can I convert RangerMSP Web Interface value selection data fields to Free Text fields where i can type in any value I want?]]
 
<br>
*[[Web Interface FAQ#See Also|See Also]]
*[[Web Interface FAQ#See Also|See Also]]
----
===How do I install RangerMSP Web Interface?===
[[Web Interface|Click here to view RangerMSP Web Interface installation instructions]].




===How do I install Commit Web Interface?===
===How do I check my RangerMSP Web Interface port is open?===
[[Web Interface|Click here to view Commit Web Interface installation instructions]].
You can check the port is open and reachable by your customers and remote technicians by using [http://www.myportchecker.com/ My Port Checker] which is a free web based utility.




===Can Commit Web Interface run on a server running IIS?===
===Can RangerMSP Web Interface run on a server running IIS?===
Yes. There is no problem running the Commit web interface side-by-side with IIS on the same server. Requests will automatically be handled by the relevant service.
Yes. There is no problem running the RangerMSP Web Interface side-by-side with IIS on the same server. Requests will automatically be handled by the relevant service.


In addition you can use [[Microsoft IIS as the Web Server for the Web Interface|Microsoft IIS as the Web Server for the RangerMSP Web Interface]].


===How do I set up Commit Web Interface when I am using Dynamic DNS (DYNDNS)?===
===How do I set up RangerMSP Web Interface when I am using Dynamic DNS (DYNDNS)?===
When using dynamic DNS (DYNDNS) you should always use a domain name rather than a static IP address in all the Commit Web Interface settings.
When using dynamic DNS (DYNDNS) you should always use a domain name rather than a static IP address in all the RangerMSP Web Interface settings.


You can find more information in the Readme.txt file located in <server>\Commit\WebInterface.
You can find more information in the Readme.txt file located in <server>\RangerMSP\WebInterface.




===How can I securely use Commit Web Interface with SSL certificates?===
===How can I securely use RangerMSP Web Interface with SSL certificates?===
[[Using SSL with Web Interface|Click here to view how can you use Commit Web Interface with SSL certificates]].


Configuring [[Microsoft_IIS_as_the_Web_Server_for_the_Web_Interface|Microsoft IIS as the back end for the Web interface]] lets you to use encrypted (https) connections with SSL certificates.


===What can my customers see and perform via the Commit Web Interface for customers?===
===What can my customers see and perform via the RangerMSP Web Interface for customers?===
Using the Commit Web Interface for Customers you can create an unlimited amount of web users for your customers.
Using the RangerMSP Web Interface for Customers you can create an unlimited amount of web users for your customers.


Using a browser, your customers will be able to log in to Commit remotely and view data relevant to them, like open Tickets, closed Tickets and scheduled technician visits.
Using a browser, your customers will be able to log in to RangerMSP remotely and view data relevant to them, like open Tickets, closed Tickets and scheduled technician visits.


Customers can also log new Tickets, which will automatically receive a ticket number and enter the Received Tickets queue in Commit, view existing History Notes and add new ones and also view details of Assets, Contracts and Charges.
Customers can also log new Tickets, which will automatically receive a ticket number and enter the Received Tickets queue in RangerMSP, view existing History Notes and add new ones and also view details of Assets, Contracts and Charges.


You can control which features will be available to your Customers from the Tools > Options > Web Interface tab.
You can control which features will be available to your Customers from the Tools > Options > Web Interface tab.




===What can my employees do/view via Commit Web Interface for Employees?===
===What can my employees do/view via RangerMSP Web Interface for Employees?===
Using the Commit Web Interface for Employees, you can give employees remote access to Commit data via a web browser.
Using the RangerMSP Web Interface for Employees, you can give employees remote access to RangerMSP data via a web browser.
   
   
They can then manage (view/add/edit) various types of information in Commit including: Accounts, Tickets, Appointments, Tasks, Charges (Labor, Parts and Expenses), Assets and History Notes. They can also view other information including Items, Contracts, Sales Opportunities, and more.
They can then manage (view/add/edit) various types of information in RangerMSP including: Accounts, Tickets, Appointments, Tasks, Charges (Labor, Parts and Expenses), Assets and History Notes. They can also view other information including Items, Contracts, Sales Opportunities, and more.




===How can I add a new ticket via the Commit Web Interface for Employees?===
===How can I add a new ticket via the RangerMSP Web Interface for Employees?===
To add a new ticket (or any other entity), click the '''Create New''' drop-down menu.
To add a new ticket (or any other entity), click the '''Create New''' drop-down menu.
   
   
Line 59: Line 73:


===How can I download documents via the Web Interface?===
===How can I download documents via the Web Interface?===
Using the Web Interface, employees can download Commit documents which are located on your server, directly from the browser.
Using the Web Interface, employees can download RangerMSP 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.
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 [[Web Interface#Document Download and Upload Settings|Document Download Settings]].
To setup the documents download settings, go to '''Tools > Options > Web Interface'''. Read more about this under [[Web Interface#Document Download and Upload Settings|Document Download Settings]].
===Is there a way to receive an email when new tickets have been created by a client via the web interface?===
Yes. Commit Web Interface for customers can send email alerts to predefined list of email addresses whenever a customer creates a new ticket via the Commit Web Interface or updates it.
To activate the Email Alerts feature:
#Open <server>\Commit\WebInterface\CommitWebIntNotifications.ini file and set your mail server settings.
#Open <server>\Commit\WebInterface\CommitWebIntNotificationsEmails.txt file and write the email addresses that should receive alerts when customer creates a new ticket or update it.
Please note that 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.
<u>Note:</u> There is no need to restart the CommitWebInterface service after modifying the content of these files.




===Does the Web Interface have the same level of control and management as the installed client software?===
===Does the Web Interface have the same level of control and management as the installed client software?===
The Commit Web Interface supports a wide range of management options, features and views for employees and provides them with the same privileges as the installed client. Please note that the installed client is more feature rich.
The RangerMSP Web Interface supports a wide range of management options, features and views for employees and provides them with the same privileges as the installed client. Please note that the installed client is more feature rich.




===How do I define a web user name and password for an employee?===
===How do I define a web user name and password for an employee?===
To define a web user name and password for an employee, log in to Commit (the installed version) as an administrator, select the employee record, go to their Employee tab, and click on '''Configure Web User'''.
To define a web user name and password for an employee, log in to RangerMSP (the installed version) as an administrator, select the employee record, go to their Employee tab, and click on '''Configure Web User'''.




===How do I allow my customer to log in to the Commit Web Interface?===
===How do I allow my customer to log in to the RangerMSP Web Interface?===
To let a customer log in to the Commit Web Interface, you need to create a web username and a password for them. To do so, go to the Accounts window, select a customer record, go to the Web Users tab and click '''New''' (located on the bottom-left corner).
To let a customer log in to the RangerMSP Web Interface, you need to create a web username and a password for them. To do so, go to the Accounts window, select a customer record, go to the Web Users tab and click '''New''' (located on the bottom-left corner).


<u>Note:</u> Web Interface usernames for customers will become active within a few minutes of their creation.
<u>Note:</u> Web Interface usernames for customers will become active within a few minutes of their creation.




===How can I add my logo to the Commit web Interface pages?===
===How can I add my logo to the RangerMSP Web Interface pages?===
You can add your name, logo, etc. to pages displayed by Commit Web Interface.
You can add your name, logo, etc. to pages displayed by RangerMSP 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.
Your name and logos should be formatted using HTML code, which will automatically be embedded in all pages generated by RangerMSP Web Interface.


You can design a header and footer for the page.<br>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).<br>Place the HTML for the Header and Footer in these files:
You can design a header and footer for the page.<br>To display headers and footers, login to RangerMSP, open the Options window, go to the Web Interface page and check the Header/Footer checkboxes (these are checked by default).<br>Place the HTML for the Header and Footer in these files:


Header: <Installation_DIR>\Commit\WebInterface\Files\MyOfficeSetting1.txt<br>Footer: <Installation_DIR>\Commit\WebInterface\Files\MyOfficeSetting2.txt
Header: <Installation_DIR>\RangerMSP\WebInterface\Files\MyOfficeSetting1.txt<br>Footer: <Installation_DIR>\RangerMSP\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.
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.
Line 108: Line 109:


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.
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:<br><img src="/Files/mylogo.jpg"><br>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).
For example, to use the image file called "mylogo.jpg" in your HTML code, save it as <Installation_DIR>\RangerMSP\WebInterface\Files\mylogo.jpg and link to it in the HTML as follows:<br><img src="/Files/mylogo.jpg"><br>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 RangerMSP WebInterface service each time  you modify the header and/or the file(s).
 
 
===I have created a new privilege group, which doesn't seem to have taken effect in the RangerMSP Web Interface. Why?===
After creating a new privilege group or updating an existing group you need to restart the RangerMSP WebInterface service for the changes to take affect.
 
 
===Can I use the RangerMSP Web Interface with Port 80?===
 
Yes, when using [[Microsoft IIS as the Web Server for the Web Interface|Microsoft IIS as the Web Server for the RangerMSP Web Interface]]
 
<br>


===Can I convert RangerMSP Web Interface value selection data fields to Free Text fields where I can type in any value I want?===
Yes, you can customize this using the following method that will allow you to change existing RangerMSP Web Interface fields from a Fixed Dropdown Selection Field to Free Text Input Fields.


===I have created a new privilege group, which doesn't seem to have taken effect in the Commit Web Interface. Why?===
For more information see [[KB:_Web_Interface_Free_Text_Fields|Web Interface Free Text Fields]].
After creating a new privilege group or updating an existing group you need to restart the CommitWebInterface service for the changes to take affect.


<br>


==See Also==
==See Also==
*[[Web Interface]]
*[[Web Interface]]
*[[KB:_Using_Popular_Ports_with_The_Web_Interface|KB: Using Popular Ports with The Web Interface]]


[[Category:FAQ]]
[[Category:FAQ]]
[[Category:Web Interface]]
[[Category:Web Interface]]
__NOTOC__
__NOTOC__

Latest revision as of 13:56, 8 July 2020

FAQ > Web Interface FAQ

Getting Started

Advanced Use



How do I install RangerMSP Web Interface?

Click here to view RangerMSP Web Interface installation instructions.


How do I check my RangerMSP Web Interface port is open?

You can check the port is open and reachable by your customers and remote technicians by using My Port Checker which is a free web based utility.


Can RangerMSP Web Interface run on a server running IIS?

Yes. There is no problem running the RangerMSP Web Interface side-by-side with IIS on the same server. Requests will automatically be handled by the relevant service.

In addition you can use Microsoft IIS as the Web Server for the RangerMSP Web Interface.

How do I set up RangerMSP Web Interface when I am using Dynamic DNS (DYNDNS)?

When using dynamic DNS (DYNDNS) you should always use a domain name rather than a static IP address in all the RangerMSP Web Interface settings.

You can find more information in the Readme.txt file located in <server>\RangerMSP\WebInterface.


How can I securely use RangerMSP Web Interface with SSL certificates?

Configuring Microsoft IIS as the back end for the Web interface lets you to use encrypted (https) connections with SSL certificates.

What can my customers see and perform via the RangerMSP Web Interface for customers?

Using the RangerMSP Web Interface for Customers you can create an unlimited amount of web users for your customers.

Using a browser, your customers will be able to log in to RangerMSP remotely and view data relevant to them, like open Tickets, closed Tickets and scheduled technician visits.

Customers can also log new Tickets, which will automatically receive a ticket number and enter the Received Tickets queue in RangerMSP, view existing History Notes and add new ones and also view details of Assets, Contracts and Charges.

You can control which features will be available to your Customers from the Tools > Options > Web Interface tab.


What can my employees do/view via RangerMSP Web Interface for Employees?

Using the RangerMSP Web Interface for Employees, you can give employees remote access to RangerMSP data via a web browser.

They can then manage (view/add/edit) various types of information in RangerMSP including: Accounts, Tickets, Appointments, Tasks, Charges (Labor, Parts and Expenses), Assets and History Notes. They can also view other information including Items, Contracts, Sales Opportunities, and more.


How can I add a new ticket via the RangerMSP Web Interface for Employees?

To add a new ticket (or any other entity), click the Create New drop-down menu.

To create a Ticket for a specific Account, go to the Accounts page, search for the relevant account and then click on it to view its complete details page. Then, go to the Create For Account pull-down menu, and select Ticket.

You can create any entity from these menus.


How can I download documents via the Web Interface?

Using the Web Interface, employees can download RangerMSP 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.


Does the Web Interface have the same level of control and management as the installed client software?

The RangerMSP Web Interface supports a wide range of management options, features and views for employees and provides them with the same privileges as the installed client. Please note that the installed client is more feature rich.


How do I define a web user name and password for an employee?

To define a web user name and password for an employee, log in to RangerMSP (the installed version) as an administrator, select the employee record, go to their Employee tab, and click on Configure Web User.


How do I allow my customer to log in to the RangerMSP Web Interface?

To let a customer log in to the RangerMSP Web Interface, you need to create a web username and a password for them. To do so, go to the Accounts window, select a customer record, go to the Web Users tab and click New (located on the bottom-left corner).

Note: Web Interface usernames for customers will become active within a few minutes of their creation.


How can I add my logo to the RangerMSP Web Interface pages?

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

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


I have created a new privilege group, which doesn't seem to have taken effect in the RangerMSP Web Interface. Why?

After creating a new privilege group or updating an existing group you need to restart the RangerMSP WebInterface service for the changes to take affect.


Can I use the RangerMSP Web Interface with Port 80?

Yes, when using Microsoft IIS as the Web Server for the RangerMSP Web Interface


Can I convert RangerMSP Web Interface value selection data fields to Free Text fields where I can type in any value I want?

Yes, you can customize this using the following method that will allow you to change existing RangerMSP Web Interface fields from a Fixed Dropdown Selection Field to Free Text Input Fields.

For more information see Web Interface Free Text Fields.


See Also