3CX Hosted Billing V18

1. Introduction #

Are you wishing to save your web hosting business from unwanted errors and loss in profits through manual billing, unclear transactions and faulty invoices? Are you looking for a billing software that makes your payment appealing and rapid? Then 3CX Hosted Billing can be your right choice!!

3CX Hosted Billing is an automated interface billing software specially created for web-hosting providers. The application is a simple yet powerful tool that connects to all your client’s 3CX hosted servers, collab them together and generate a report of total extension count and simultaneous call count; and know if the ‘Transcription’ feature is enabled or not. This makes your billing easier, and zero scope for errors. Then why retarded gratification when 3CX Hosted Billing is waiting for you to save your tremendous amount of money as well as time?

2. Prerequisites #

Before installing ‘3CX Hosted Billing’, you need to ensure that your computer meets the minimum requirements mentioned below:

  1. 3CX Version V16 and V18 (Professional or Enterprise Version Only)
  2. Windows 10 or above / Windows Server 2012 or above
  3. Microsoft SQL Server 2014 or above (Including the free SQL Express edition)
  4. Internet Information Server (IIS) 7.0 or above
  5. .Net 4.7.2 or above

Note:

  • When installing SQL Server, we recommend you install it in “Mixed Mode” to include SQL Authentication, and install SQL Management Studio
  • When installing IIS, be sure to install Basic Authentication, .Net Extensibility, and ASP.Net 4.X

3.Installation #


Download software

You can order ‘3CX Hosted Billing’ on-line at http://www.voiptools.com.  Your order confirmation email will include your license key and a link to download the software.


Install Prerequisites

There are a number of prerequisites that must be installed prior to installing ‘3CX Hosted Billing’. These prerequisites include Microsoft Internet Information Server (IIS) and Microsoft SQL Server


Install ‘3CX Hosted Billing’

This User Guide contains step-by-step instructions to successfully install ‘3CX Hosted Billing’.  Begin by extracting the installer from the downloaded zip file (Step 1 above), then run the setup program named HostedBillingInstaller.exe


Register your License Key

You must register your license key to activate ‘3CX Hosted Billing’. Your license key is included in your order confirmation email, and can also be found in your order history on our website.

4. STEP BY STEP INSTALLATION PROCEDURE #

The following section guides you through a detailed walk-through of the installation process.

Step 1:  Download ‘3CX Hosted Billing’

You can locate the software download link included in your order confirmation email. As an alternative, you can also find the link from your order history on our website.

Step 2:  Install Prerequisites

Click on the software installer that was downloaded in step 1 above. The installation wizard will automatically identify the needed prerequisites and assist you with the install of the prerequisites needed to run ‘3CX Hosted Billing’. These include .NET Framework (Web Installer), SQL Server Express (Web Installer) and, SQL Server Management Studio.

  1. Click the downloaded installer executable to launch the Prerequisites Setup Wizard and click Next.
Figure 1: Prerequisites Setup Wizard
  1. In the Prerequisites window, the installer will identify the missing prerequisites. It is important that you install all the required prerequisites. However, you can select/unselect the applications to be installed based on your unique requirements. Click Next to continue.
Figure 2: Select Prerequisites to Install
  1. The installer will download and install the selected applications.
Figure 3: Prerequisites Installation in progress
  1. If you have selected to install “SQL Server Express”, the Microsoft SQL Server License Terms page will display. Click Accept to acknowledge the license terms and continue.
Figure 4: SQL Server Express: Accept License Terms
  1. In the next window, the Media Location field displays the SQL Server Media target location. If required, you can browse to change the location. Click Install to begin the installation of SQL Server Express.
Figure 5: SQL Server Express: Target Location
  1. Once the prerequisites are installed successfully, click Close.
Figure 6: SQL Server Express: Installed Successfully
  1. Microsoft SQL Server Management Studio begins to install. Once the installation is complete, click Next
Figure 7: Microsoft SQL Server Management Studio: Installation in progress
  1. In the confirmation message box, click Yes to reboot the computer.
Figure 8: SQL Server Express: Reboot your computer

Step 3: Start the installation process

  1. After all the prerequisites are installed, the 3CX Hosted Billing Setup Wizard appears. Click Next to Continue.
Figure 9: 3CX Hosted Billing Setup Wizard
  1. On the Select Installation Folder window, the Folder field displays the location where the ‘3CX Competitive Wallboard’ will be installed. Note that you cannot change the path.
Figure 10: Installation Folder Location
  1. Click Next to continue.

Step 4: Configure the database

When configuring 3CX Hosted Billing, select an existing Microsoft SQL Server instance in your environment.  The database server can be a remote SQL Server (How-to configure SQL Server to permit remote connections), or a local instance running on the VoIPTools server.

  1. On the SQL Database window, in the Server field, select the desired instance of SQL Server

Note:

We encourage you to use SQL Authentication rather than Windows authentication.  Many of our tools leverage a Call Flow Designer (CFD) application running on the 3CX.  Frequently our CFD applications require access to a SQL database.  If the 3CX server and the database server are not in an Active Directory domain, Windows authentication will fail.  To use SQL authentication, your SQL Server must be configured to run in “Mixed Mode”.  If you installed SQL Server with one of our tools, we configure SQL in “Mixed Mode”.

Figure 11: SQL Authentication
  1. To use SQL Authentication, be sure to uncheck the Trusted Connection checkbox.
  2. In the Username and Password fields, enter valid SQL login account credentials
Figure 12: Configure Database
  1. To use Windows Integrated Authentication (not recommended), check the Trusted Connection (Windows integrated authentication) checkbox.
  2. In the Database field, the installer will automatically display the default database name.  We encourage you to use the default name.  If you are upgrading or reinstalling 3CX Hosted Billing, select the existing database name from the list.
  3. Click the Test Sql Connection button to confirm connectivity to SQL Server and then click Next to continue.
Figure 13: Test SQL Connection

Step 5: Installing 3CX Hosted Billing

  1. In the Ready to Install window, click Install to start the installation of the ‘3CX Hosted Billing’
Figure 14: Install 3CX Hosted Billing
  1. The application installation progresses.
Figure 15: Installation of ‘3CX Hosted Billing’ in Progress
  1. Once the installation is complete, check Launch 3CX Hosted Billing check box and then click Finish. The 3CX Hosted Billing configuration screen opens. If you want to simply close the installer without opening the configuration screen, then simply uncheck Launch 3CX Hosted Billing check box and then click Finish
Figure 16: Installation Complete

5. Web Portal #

To access the ‘3CX Hosted Billing’ web portal, click on the desktop icon that was created during the installation process (3CX Hosted Billing Web). You will be directed to the default page of the Web Portal, as shown below:

Figure 8: 3CX Hosted Billing Web Portal

5.1. License #

Registration is required to authorize your software. Registering also makes it possible for VoIPTools to provide a replacement key if your license key is ever lost. Also, it enables VoIPTools to notify you of any product updates.

  1. Login to ‘3CX Hosted Billing’ web portal and then click License tab.
  2. Enter your registration information in all the fields (Note that the red dot denotes a required field).
  3. Click Register.
Figure 18: Register Software

5.2. Servers #

The Servers screen enables you to add multiple FQDN servers, query 3CX to know count of extensions and server simultaneous calls, know if ‘Transcription’ feature is enabled or not, and apply extension filter to know the count of test extensions. You can also filter the search results to identify the desired FQDN server or extension filter. The Reports screen displays data as per the settings configured in Servers screen.

Figure 19: Servers Screen
  1. In the Extract Data box, check the following check boxes as per your requirement so that the report will display data accordingly; and then click Query 3CX button.
    1. Extension Count – to know the extension count in each of the FQDN server.
    2. Server Simultaneous Count – to know the simultaneous call count in each of the FQDN server.
    3. Transcriptions – to know if ‘Transcription’ feature is enabled or not in each of the FQDN server.
    4. Recordings – to know the total used space for recordings and if the recordings quota is reached or not.

Note: If you uncheck a specific checkbox, then the respective column will not display in the report results.

  1. You can add one or more FQDNs of all the servers that you want to include in the report. To add/delete new or existing FQDN, follow the instructions below:
    1. To add new FQDN, in the 3CX Servers box, click the Add button.
    2. In the Customer field, enter customer name.
    3. In the Server Name field, enter the server name.
    4. In the FQDN field, enter the ‘3CX Console Management’ login url.
    5. In the Username and Password fields, enter the ‘3CX Console Management’ username and password for respective FQDN. If you have entered valid credentials, then the data will be saved in Servers tab else, an error message will display.
    6. Once the application validates the credentials, click Test button so that the application re-validates if the credentials remain the same as those that were added last time. If the data is valid then the application automatically checks the Autorized checkbox for the respective FQDN else, the re-validation fails and the respective Authorized checkbox remains unchecked.
    7. Click Save Changes.
    8. To delete FQDN, select the desired FQDN that you want to delete and then click Delete button beside the respective FQDN and click Save Changes.

Note: You will not be able to query a server until connectivity is verified. Authorized servers cannot be deleted for 35 days.

  1. You can add one or more extension filters and add the desired filter that you want to include in the report.
    1. To add extension filter, in the Exclude Extensions That Contain box, click Add button.
    2. In the Extension filter field, enter the text so that the extensions with respective name will not be counted in the report data.
    3. To delete extension filter, select the desired extension filter that you want to delete and then click Delete button beside the respective extension filter and click Save Changes.

5.3. reports #

The Reports screen displays report data as per the scheduled 3CX queries, FQDNs and extension filter applied in the Billing Host screen. From here, you can export data in various formatsview server details for the desired customer and, group column name and display report.

Figure 20: Reports Screen

Column Definitions

CustomerName of the customer who is to be included in the report.
ServerFully Qualified Domain Name (FQDN), it is a 3CX Console Management URL
UpdatedLatest query for respective FQDN
Version3CX Version along with 3CX server system type (Windows or Linux)
SCSimultaneous Calls count for respective customer
ExpirationNo. of days for license to expire.
BackupsIf Automatic Backups  Configured or  Not Configured.
ServicesIf all 3CX Services  started or  not started.
Ext. CountTotal extension count for respective customer.
Ext. UpNo. of extensions currently registered.
Trunks UpNo. of trunks currently registered.
CallsNo. of active calls.
CPU% of CPU utilization.
RAM% of memory utilization
DiskDisk space utilization.
RecordingsIf the storage has not yet crossed the recording quota  (recordings will not be stopped) or crossed recording quota  (recordings will be stopped).
UsedTotal used space from 3CX Phone System for respective FQDN and the Maximum recording storage space (storage limit).
TranscribeIf transcription feature for the respective FQDN is  enabled or  disabled.

5.3.1. Export Report #

To export report data into desired file format, click on the desired export button and then browse the path where you want to save the file.

Figure 21: Export Report

5.3.2. View Server Details #

To view the server details associated to a specific customer, simply click on the respective customer name. 3CX Server Details popup appears.

Figure 22: 3CX Server Details

Column Definitions

Server FQDN3CX Server FQDN.
Webmeeting FQDN3CX Webmeeting FQDN
Version3CX Version
ResellerName of the reseller
Ext. CountTotal extension count for respective customer
License KeyLicense Key of 3CX Server.
License ExpiresLicense expiry date & time.
Support ExpiresSupport expiry date & time.
Public IPPublic IP of the 3CX Server.
TranscribeIf transcription feature for the respective FQDN is  enabled or  disabled.
Trunks UpNo. of trunks currently registered.
Extension UpNo. of extensions currently registered.
Active CallsNo. of active calls.
BlackListed IPsCount of blacklisted IPs for the respective FQDN
Last BackUPLast backup date & time.
CPU Usage% of CPU utilization
Memory Usage% of memory utilization
Disk UsageDisk space utilization.
UsedTotal used space from 3CX Phone System for respective FQDN and the Maximum recording storage space (storage limit).
RecordingsIf the storage has not yet crossed the recording quota  (recordings will not be stopped) or crossed recording quota  (recordings will be stopped).

5.3.3. Group Columns #

You can display report results by a grouping the desired column name. This is done by dragging the desired column header into space above the column header. You can check the image below for better understanding:

Figure 23: Reports Results: Grouped By Column Name

5.4.Settings #

The ‘Settings’ screen enables you to configure refresh rate for refreshing 3CX Servers information and also configure specific mail ids to get notified whenever the CPU and RAM reaches the threshold level.

5.4.1. Settings Tab #

The ‘Settings’ screen enables you to set page ‘Refresh Interval(In seconds only)’ to refresh 3CX servers information in ‘Reports’ page.

  1. In the Settings page, click Settings tab.
  2. Under General and in the Refresh Interval field, enter the time in seconds so that the 3CX servers information will refresh for every specified interval in the Reports page.
  3. Click Save
Figure 24: Settings tab

5.4.2. Email Settings #

The ‘Email Settings’ enable you to configure specific email ids which you want to notify whenever the CPU and RAM capacity reaches the threshold level of 90%.

  1. In the Settings page, click Email Settings tab.
  2. Under Email Server:
    1. In the Server field, enter the IP address or Fully Qualified Domain Name (FQDN) of your email server. Examples: 192.168.1.20 or mail.mydomain.com
    2. In the Port field, enter SMTP Port number. Default port number is 25.
    3. In the From Email field, enter the reply email address for email notifications of CPU and RAM if reached threshold levels.
    4. In the To Email field, enter the desired email addresses (separated by comma) to which you want to notify whenever the CPU and RAM capacity reaches to a threshold level of 90%.
  3. Under Authentication:
    1. Enter valid credentials in Username and Password fields.
    2. Check Requires SSL/ TLS check box if your mail server requires a secure connection – Secure Socket Layer (SSL) or Transport Layer Security (TLS) to relay email. Gmail, Google Apps and Microsoft 365 require a secure connection.
    3. Click Test button to test if Email Server is able to communicate with 3CX Phone System.
  4. Click Save to save the data.
Figure 25: Email Settings

6. Support #

Visit our website to access our on-line manuals and receive quick answers to most of your questions. Otherwise, you can contact us by phone, email, live chat and on the VoIPTools forums.

  • Support Hours (USA and India)

Our team is ready to assist you with answers to your technical questions, during normal business hours, which is Monday through Friday, 8:00 AM to 6:00 PM (Central Standard Time), and 8:00 AM to 12:00 AM (Indian Standard Time).

  • Windows Event Log (Applications and Services > VoIPTools)

The Windows Event Log lists various errors, information messages and warnings related to all our VoIPTools applications and services. The data here can be used for troubleshooting various application errors.

  • Forums

Our forum is intended for VoIPTools customers to collaborate on real-life challenges, solutions and best practices. You can participate on our forum at: https://www.voiptools.com/community/

  • Submit a Bug

If you suspect a bug in any of our VoIPTools products, you can bring it to our notice by reporting your issue at: https://www.voiptools.com/report-a-bug/

  • Live Chat

Our chat support team is ready to acknowledge your queries in real-time. You can start a live chat with us by simply clicking on the Live Chat button at the lower right corner of our web page.

  • Email

You can email us at: support@voiptools.com. Be sure to describe your issue in detail. We’ll get back to you within one business day of receiving your request.

  • Phone

You can call us at +1 801-642-4655 to reach a representative. VoIPTools will accept calls at this number from 8:00 AM to 6:00 PM (Central Standard Time).

  • Support Services
  • Free Support:

If you purchased our products through a VoIPTools Partner, your Partner will provide first level support. Partners have access to 100% free technical support, provided they participate actively in the troubleshooting process.

VoIPTools customers have access to our on-line manuals and we will respond to emails (next business day) and live chat, but we will not login to your servers remotely.

  • Paid Support:

If you purchase “Installation Support’ our support team can login to your servers and install and configure all our tools for you. This includes installing SQL Server Express and Internet Information Server if required. Our team will work with you to configure our applications to best meet your needs.