View Categories

Custom Presence V20

16 min read

Introduction #

Unleash the Power of Custom Presence: Elevate Communication with 3CX’s Limitless Status Customization.

Experience the power of 3CX Custom Presence, which allows you to have additional statuses such as “Break,” “Project Work,” “Wrap-up,” or “Vacation” for your agents. These custom statuses indicate their availability and ensure efficient handling of incoming work items. While 3CX provides only five built-in Presence Statuses, our solution enables you to establish a unique set of statuses that align with your operational needs. With our custom interface, you can create and manage these statuses, while adhering to the restrictions set by 3CX. Take control of your communication system and optimize your workflow with 3CX Custom Presence.

Why Choose 3CX Custom Presence? #

MONITOR AGENTSMonitor your agent’s availability and utilize data-driven insights to optimize productivity and workflow efficiency.
EASY REPORTINGUnlock the power of generating comprehensive reports on past presence information with our exclusive feature, unavailable in the standard 3CX package.
MAP TO 3CXAlign your unique status seamlessly with any of the five pre-set options to elevate your user experience. Ensure accurate and visible information within the user-friendly 3CX clients.
REAL-TIME WALLBOARDEffortlessly monitor and manage your status and stay synchronized with your colleagues’ availability in real-time on a single, convenient screen. Experience the power of seamless collaboration and stay connected like never before.

NOTE:

  • Installation on a domain controller may require additional assistance
  • 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

Prerequisites #

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

PREREQUISITE PURPOSE
3CX Version V203CX Custom Presence is designed to work seamlessly with this version for enhanced features and performance.
Windows 10 or above / Windows Server 2012 or aboveThese operating systems provide the necessary environment for the application to run efficiently.
IIS Features and Configuration – VoIPToolsIIS is needed as a web server to host and manage web-based applications and services.
.NET Framework 4.7.2 (Web Installer)This framework provides essential components for running and developing applications.
.NET Core SDK. .NET Core SDK is required for development and deployment purposes. It provides the necessary tools, libraries, and runtime environment for building and running .NET Core applications. and allows developers to create custom integrations, plugins, or extensions for the 3CX system.

Click here to download the application and install it in the VoIPTools server.
VoIPTools Universal UpdaterThis component is necessary for updates, ensuring the application remains current and functional.
VoIPTools Relay ServiceIt is used for proper integration and functionality of the 3CX Custom Presence Status within the 3CX environment.
Microsoft SQL Server 2016 or above (Including the free SQL Express edition)3CX requires Microsoft SQL Server 2016 or later for database management.
Static IP for VoIPTools and 3CX serversThis is to ensure proper two-way communication, both the 3CX server (Relay) and the VoIPTools server. Dynamically assigned IP addresses are not supported. Additionally, it is recommended to use HTTPS for secure communication, which requires a FQDN for SSL/TLS certificate validation between the VoIPTools server and the Relay.
Port number 7900 opened on your devicePort 7900 is a specific network port used by 3CX for communication purposes. Opening this port on the device’s firewall allows incoming and outgoing traffic to pass through, enabling the 3CX software to send and receive data over the network effectively.

Installation overview #

DOWNLOAD SOFTWAREYou can order 3CX Custom Presence online at https://www.voiptools.com.  Your order confirmation email will include your license key and a link to download the software.
INSTALL PREREQUISITESYou must install several prerequisites before installing the 3CX Custom Presence. The Advanced Installer identifies and installs these applications automatically. Click here to learn about the required prerequisites.
INSTALL 3CX CUSTOM PRESENCEThis User Guide contains step-by-step instructions to install 3CX Custom Presence successfully. Begin by extracting the installer from the downloaded zip file, then run the setup program named CustomPresence.exe
LOGIN TO THE WEB APPLICATIONYou can now log in to the web application using the extension number and the PIN.

Step By Step Installation Procedure #

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

Step 1: Download 3CX Custom Presence #

Find the software download link in the Order Confirmation Email, or you can download the application by following the procedure,

  1. Open your browser and go to the VoIPTools official website or click here to get redirected to the website.
  2. Search for the Custom Presence Application and click the Download button to download your application.

Step 2: Install the Prerequisites #

Click on the software installer downloaded in Step 1. The installation wizard will automatically identify the prerequisites and assist you with each installation required for 3CX Custom Presence. It includes .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. You must 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

The installer will download and install the selected applications.

Figure 3: Prerequisites Installation in progress
  1. In the Microsoft SQL Server License Terms click the Accept button to acknowledge the license terms and continue.
    • This page appears if you do not have SQL Server Express preinstalled in your device.
Figure 4: SQL Server Express: Accept License Terms
  1. View the SQL Server Media target location in the Media Location field. If required, you can click the Browse button to change the location. Click Install to begin the installation of SQL Server Express.
Figure 5: SQL Server Express: Target Location

SQL server installation is in progress. This may take several minutes to complete.

Figure 6: SQL Server Installation In Progress
  1. Click the Close button once the prerequisites are installed.
Figure 7: SQL Server Express: Installed Successfully
  1. In the confirmation message box, click Yes to reboot the computer.
Figure 9: SQL Server Express: Reboot your computer

Step 3: Start the installation process #

  1. After all the prerequisites are installed, the 3CX Custom Presence Setup Wizard appears. Click Next to Continue.
Figure 10: 3CX Custom Presence Status Setup Wizard
  1. On the Select Installation Folder window, the Folder field displays the location where the ‘3CX Custom Presence’ will be installed. Note that you cannot change the path.
  2. Click Next to continue with the installation.
Figure 11: Installation Folder Location

Step 4: Test Relay Settings #

  1. In the 3CX Relay Services window, in the Relay Host field, enter the FQDN of your 3CX server.
  2. Enter 8801 in the Relay Port field.
  3. Enter the public key you took from VoIPTools Relay services in the Public Key text area.
Figure 12: Configure Relay Services
  1. Click the Test Relay Settings to confirm ‘3CX Custom Presence’ can communicate with the Relay services running on the 3CX server.
  2. If the ‘3CX Custom Presence’ is successfully able to communicate with the Relay services that run on the 3CX server, a Success message box appears. Click OK. If the test fails, you will not be able to continue until communication with the relay is established.
  3. Click Next to continue with the installation.
Figure 13: Relay connection test successful

NOTE:

If the test was unsuccessful: 

  • confirm you have the correct firewall port open (default TCP 8801) on the 3CX server and the firewall protecting the 3CX server.
  • confirm that you have entered the correct FQDN for the 3CX server.
  • confirm that 3CX Custom Presence and the Relay are using the same port and protocol.

Step 5: Configure the database #

When configuring the 3CX Custom Presence, select an existing Microsoft SQL Server instance in your environment.  The database server can be a remote SQL Server, or a local instance running on the VoIPTools server.

You can set up the SQL database using SQL Authentication or Windows Integrated Authentication.

SQL Authentication #

  1. Enter your server name in the Server field.
    •  If using the free SQL Express Edition, the default SQL Instance name is SQLExpress.
Figure 14: Configure Database – Server Field

NOTE:

  • If you want to use ‘SQL Authentication’, then install SQL Server in ‘Mixed‘ mode.
  • If SQL Server is installed on a server other than the server where 3CX Exporter is installed, you will need to configure SQL Server to allow remote connections.
  1. Enter your credentials in the Username and Password fields.
Figure 15: Configure Database – Database Credentials

NOTE:

Make sure that you select a SQL Login that has sufficient permissions to alter the database and create SQL objects.

  1. Select or enter the 3CX Custom Presence in the Database dropdown.
Figure 16: Configure Database – Database Dropdown
  1. In the Test SQL Connections section, click the Tool button to test the connection and click OK in the Test Results popup box.
Figure 17: TOOL connection to database results

Windows Integrated Authentication #

  1. To use Windows Integrated Authentication check the Trusted Connection (Windows integrated authentication) checkbox.
    •  The VoIPTools installer will create a local Windows user name as “VoIPToys” and give you sufficient rights to this user to create/update the SQL database.
  2. In the Test SQL Connection section, click the Tool button to test the connection.
  3. Click the Next button which gets enabled when the database connection is successful.

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”.

Step 6: Installing 3CX Custom Presence #

  1. In the Ready to Install window, click Install to start the installation of the ‘3CX Custom Presence’.
Figure 18: Install 3CX Custom Presence Status

The application installation progresses. This may take several minutes to complete.

Figure 19: Installation of ‘3CX Custom Presence Status’ in Progress
  1. Once the installation is complete, click Finish.
Figure 20: Installation Complete

Step 7: Log in to the Web Application #

  1. Click the 3CX Custom Presence Status desktop icon to open the web application.
  2. On the Login page, do the following tasks,
    1. In the Extension field, enter your 3CX extension number.
    2. In the PIN field, enter your 3CX voicemail PIN.
    3. Click the Login button to log in to your account.
Figure 21: 3CX Custom Presence Status Login

NOTE:

Upon successful application registration in the relay, you’ll be automatically redirected to the web application. To understand how to register the application in the relay, click here.

Web Portal #

Login Privileges #

3CX Custom Presence provides different screens for both users and Managers. This approach empowers managers with administrative authority, enabling oversight and specialized functionalities, while users maintain limited access, fostering security and tailored functionalities for their specific roles.

User Privileges #

As a User you can only access the Wallboard screen.

Figure 22: User Login View

Manager Privileges #

As a Manager, you can view all the screens of the 3CX Custom Presence application.

Figure 23: Left Side Panel – Expanded View

Application Overview #

This section gives you an overview of the user interface of the web application.

Figure 24: Web Application – Overview
Left Side Panel – Expand/Minimise buttonThis button lets you minimize the menus in the left side panel to have more space for the main content.
Left Side PanelThe Left Side panel consists of all the tabs in the 3CX Custom Presence.
Logout ButtonYou can log out of the web application using the logout button.
Support Resources ButtonGives you basic information about the application and contact details of the VoIPTools support team.

Left Side Panel #

The Left Side Panel consists of all the menus of the web application. You can minimize the Left Side Panel to enlarge your main content.

Figure 25: Left Side Panel – Expanded View
Figure 26: Left Side Panel – Compressed View

The Left Side Panel consists of the following tabs,

WALLBOARDThe Wallboard screen provides 3CX managers with a visual representation of staff statuses, allowing them to monitor and track the current status of various extensions associated with specific groups
STATUS MAPPINGThe Status Mapping screen allows customization of statuses, allowing administrators or managers to create and align multiple custom statuses with the 5 built-in presence statuses. This feature facilitates better organization and visualization of individualized statuses, ensuring their visibility on the Wallboard screen for effective communication and tracking of staff availability.
STATUS REPORTThe Status Reports screen lets managers with appropriate access rights track and analyze agents’ time spent on specific statuses. This feature provides detailed reports showcasing individual agent data, including status duration, facilitating performance assessment, and resource allocation. It allows for exporting data in various formats for further analysis or documentation purposes.
SITE SETTINGSThe Site Settings screen serves to customize the application’s branding elements. It lets users tailor the visual aspects such as header gradient color, grid color in data displays, custom logo uploads, and header title prefixes. This customization enhances the application’s appearance, aligning it with organizational branding guidelines for a cohesive user experience.

Wallboard #

The Wallboard screen is a custom web page that makes it possible for your staff to see the custom status of their colleagues.

USER FUNCTIONMANAGER FUNCTIONSSYSTEM ADMIN FUNCTIONS
Select Extension Group NameSelect Extension Group NameSelect Extension Group Names
Set Current Status and NotesSet Current Status and NotesSet Current Status and Notes
Add or Update Agents From 3CX

Select ‘Extension Group Name #

Based on the selected ‘Extension Group Name’, the ‘Team Status’ grid lists associated 3CX extensions and their current status.

Figure 27: Wallboard screen: Extension Group Name

Set your current presence status #

Your agents can do the following in the My Status section,

  • Set their current presence status in the.
  • Describe their current presence status in the Notes field.

NOTE:

This grid will display all 3CX built-in statuses and any custom statuses.

Follow the procedure to set the current status and add notes,

  1. In the My Status section, select the desired status or click the link to create a new custom status.
Figure 28: My Status Section
  1. In the Notes section enter the notes that you want to display on the wallboard.
Figure 29: Notes on the Status

You can view your status and notes added to the wallboard.

Figure 30: Status and Notes Updated

NOTE:

Any changes made in the 3CX Phone System gets reflected in the Wallboard tab and in the Reports tab in real time.

  • On the 3CX Phone System, in the Status dropdown, select any status.
Figure 31: 3CX Phone System – Status Dropdown

You can view the status is updated in the Wallboard tab and in the Reports tab.

Figure 32: Status Changed in Reports Tab
Figure 33: Status Changed in Wallboard Tab

Add or Update Agents From 3CX #

As a System Administrator, you can add the agents of a selected Extension Group Name from 3CX.

  • Click the Add/Update Agents From 3CX box to update the agents.
Figure 34: Add/Update Agents From 3CX Checkbox

NOTE:

  • The Add/Update Agents From 3CX checkbox is visible only to the System Administrators.
  • Changes made in extension names in the 3CX Admin Console will not reflect in the 3CX Custom Presence Status unless the System Administrator selects the Add/Update Agents From the 3CX checkbox.

Status Mapping #

3CX only offers 5 built-in Presence Statuses. You can have as many custom statuses as you want, but they all have to map back to one of the 5 statuses built into 3CX. Only 3CX Admins/Managers can access the ‘Status Mapping’ screen to create or rename custom statuses.

In the Status Mapping screen, you can do the following tasks

  • Add a new Custom Status
  • Activate and Inactivate existing Custom Statuses.

NOTE:

Only ‘Active’ Custom Statuses will appear in the ‘My Status’ grid of the ‘Wallboard’ page.

Add a new status map #

Follow the procedure to add a new status map,

  1. In the Status Mapping tab click the Add Custom Status button.
Figure 35: Add Custom Status – Add Button
  1. In the Custom Status field, enter the desired status.
  2. In the 3CX Status list, select the 3CX status you want to map to your custom status.
  3. In the Color field, select the desired color or enter the color code of your desired color to label your custom status.
Figure 36: Custom Status Details
  1. Check the Active checkbox to activate the custom status.
  2. Click the Save button to save your custom status.
Figure 37: Custom Status – Activate Status Box
  1. Click OK on the Information Saved popup.
Figure 38: Mapping Saved

In the Wallboard tab you can see your custom status is now added.

Figure 39: Custom Status Added To Wallboard

Activate and Inactive Custom Statuses #

You can activate the desired custom statuses to make them visible on the My Status section in the Wallboard screen.

  1. On the Status Mapping screen in the Active column select the desired custom statuses to display on the Wallboard screen.
Figure 40: Activate Column
  1. Click OK in the Information Saved message box.
Figure 41: Information Saved Popup

You can view the selected statuses visible on the Wallboard screen.

Figure 42: List of Activated Status on Wallboard

Status Report #

Extensions with ‘Manager’ rights can access reports. The reports specify how much time each agent spent on a particular status.

Figure 43: Status tab overview

Field Definitions #

ExtensionAgent’s extension
Agent Name Name of the Agent
StatusStatus of the agent
Start TimeThe start time of the agent’s status
End Time The end time of the agent’s status
DurationThe total duration of the agent’s status. It is the difference between the Start Time and the End Time.
NotesYou can make notes for references.

Generate report #

Follow the procedure to generate the reports,

  1. In the Report Starting Time field, select the date from the calendar or enter the start date and time.
Figure 44: Generate Report – start date
  1. In the Report End Timing field, select the date from the calendar or enter the end date and time.
Figure 45: Generate Report – end date
  1. From the Time Zone dropdown menu, choose the time zone you prefer for displaying the reports.
Figure 46: Time Zone Dropdown
  1. Enter the desired culture in the Cultures field.
Figure 47: Cultures Field
  1. Click the Get Report button to generate the status report.
Figure 48: Get Report button

The following image shows a sample status report generated.

Figure 49: Sample status report

Export Report Data #

  1. In the Report Starting Time and Report Ending Time fields, enter the date range and then click the Get Report button.
  2. Once the Status Report page displays data as per the selected date range, click the desired export button to export the report data in the respective format.
Figure 50: Export Report Data
  1. Click OK on the Success popup.
Figure 51: Export Data Success Popup

Following image represents data exported in xls. file,

Figure 52: Sample XLS Report

The following image reporesents data exported in .CSV file,

Figure 53: Sample .CSV File

Site Settings #

Site Settings enable you to customize branding settings for the application that include the following:

  • Customize the gradient color of ‘Application Header’
  • Customize grid color in screens that display grid data
  • Customize logo on the ‘Application Header’
  • Customize ‘Header Title Prefix’ on the ‘Application Header.’

1. Customize Header Title #

  • In the Header Title field, enter the text to display as a ‘prefix’ for the existing title.
Figure 54: Header Title

2. Upload Custom Logo #

  1. In the Custom Logo Upload File section, click the Browse button to choose a logo from your device.
Figure 55: Custom Logo – Browse Button
  1. Locate the image on your local device and either double-click the file or select it and click Open to upload the image file.
Figure 56: Custom Logo – Upload File from Local
  1. Select the uploaded logo from the Select Logo dropdown list.
Figure 57: Select Logo Dropdown

3. Customize Header Gradient Color #

In the Header Colour section do the following,

  1. Select the top paint from the Top Colour color palette. 
  2. Select the bottom paint from the Bottom Colour color palette.
Figure 58: Header Gradient Color

4. Customize Grid Color #

  • From the Grid Color palette, select the color that you want to display for the grid in screens that display grid data
Figure 59: Grid Color

The final result of the page when you do all the customizations,

Figure 60: Display of Customized Brand Settings

Support Resources Screen #

  • Click the Support Resources button on the top right of the application to open the Support Resources screen.
Figure 61: Support Resources Icon

The Support Resources screen displays the application’s version number and the contact information of VoIPTools. Click on the link to learn about the comprehensive support provided by VoIPTools.

Figure 62: Support Resources Page

Need Support? #

You get quick answers to most of your inquiries in our online manual. If you prefer direct contact, we offer various support channels, including phone, email, live chat, and our helpful VoIPTools forums.

24/7 Support Availability #

Rest assured, our dedicated team is here to assist you around the clock, every day of the year. Whether you’re based in the USA or India, we’re ready to provide prompt responses to your technical queries.

Windows Event Log for VoIPTools Applications and Services #

For troubleshooting any application errors, our Windows Event Log contains a comprehensive list of error messages, warnings, and informative notes related to all our VoIPTools applications and services. It’s a valuable resource to help you pinpoint and resolve any issues you may encounter.

Join Our Forum Community #

Are you looking to collaborate with other VoIPTools customers facing similar challenges? Our forum is the perfect platform to exchange ideas, solutions, and best practices. Join the conversation at: https://www.voiptools.com/community/

Real-Time Live Chat Assistance #

Got questions that need immediate answers? Our chat support team is available to assist you in real time. Just click on the Live Chat button located at the lower right corner of our website, and we’ll acknowledge your queries right away.

Efficient Email Support #

To ensure a thorough understanding of your concerns, email us at support@voiptools.com. Describe your issue in detail, and we’ll get back to you within one business day with the support you need.

Reach Us by Phone #

If you prefer to speak with a representative directly, you can reach us at +1 801-642-4655. Our attentive team is available to take your calls from 8:00 AM to 6:00 PM (Central Standard Time).

Comprehensive support services: #

Free Support #

If you’ve purchased our products through a VoIPTools Partner, rest assured that they provide first-level support at no additional cost. Partners have access to 100% free technical assistance and actively participate in the troubleshooting process.

VoIPTools customers enjoy access to our online manuals and receive support through emails (with responses within one business day) and live chat. However, please note that we do not provide remote server login assistance.

Paid Support #

For a more hands-on experience, consider our “Installation Support” package. Our expert support team can log in to your servers, and install and configure all our tools. This comprehensive service includes setting up SQL Server Express and Internet Information Server if necessary. We’ll work closely with you to tailor our applications to meet your requirements.

We’re committed to providing top-notch support to ensure your VoIPTools experience is smooth and hassle-free. Contact us today, and let us assist you in making the most of our powerful tools!

What are your Feelings

Powered by BetterDocs