Introduction #
Revolutionize Your Call Center Operations with Surveyor: The Future of Campaign Management and Customer Engagement
The 3CX Surveyor is an advanced web-based “preview” dialer designed to revolutionize your call center’s campaign management. With Surveyor, you easily make impactful outbound calls to your contacts, ensuring high-touch interactions and exceptional results. Manage campaigns, assign agents to phone lists, and personalize interactions with script-reading capabilities. Gain valuable insights through web-based performance reports to optimize your call center operations. 3CX Surveyor provides detailed customer profiles, an integrated mini CRM, and the tools to treat customers like family, empowering your team to build strong relationships, ensure customer satisfaction, and drive sales.
What is a 3CX Surveyor? #
The 3CX Surveyor is a web-based “preview” dialer designed for the 3CX platform. Empower your agents to conduct personalized outbound calls, manage campaigns efficiently, use survey scripts, and generate performance reports. Manually import contacts into the tool and seamlessly integrate it with 3CX PBX for Windows. Agents can work from home or the office using the user-friendly web interface and 3CX softphone. Optimize your outbound calling processes with 3CX Surveyor for remarkable results.
Why choose 3CX Surveyor? #
CAPTIVATING SCRIPTS | Effectively engage your clients with captivating, personalized scripts tailored to their needs and preferences. Our user-friendly web-based system enables seamless script management and customization for exceptional customer interactions. | |
SEAMLESS MONITORING | Efficiently monitor customer service progress with our integrated mini CRM. Track and evaluate customer interactions seamlessly to deliver personalized experiences and exceptional support. | |
REAL-TIME INSIGHTS | Gain access to comprehensive and real-time insights through powerful web-based performance reports on survey data. Utilize simple yet robust analyses to reveal valuable trends and patterns, empowering data-driven decisions that propel your business forward. | |
CAMPAIGN OPTIMIZATION | Efficiently organize and optimize your campaigns by assigning agents to targeted phone lists and equipping them with survey scripts. Empower your team to conduct impactful outreach, ensuring valuable feedback and driving superior campaign results with confidence | |
HIGH-TOUCH OUTBOUND CALLS | Establish profound connections with your contacts through our personalized and “high-touch” outbound calls. Our solution empowers your agents to confidently build rapport and foster relationships, guaranteeing that every interaction leaves a positive and enduring impact. |
Prerequisites #
Before you begin with the installation steps mentioned in this guide, you need to ensure that your computer meets the minimum requirements mentioned below for installing a 3CX Surveyor.
PREREQUISITE | PURPOSE |
---|---|
3CX Version V20 | 3CX Surveyor is designed to work seamlessly with this version for enhanced features and performance. |
Windows 10 or above / Windows Server 2012 or above | These operating systems provide the necessary environment for the application to run efficiently. |
IIS Features and Configuration – VoIPTools | IIS 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. |
VoIPTools Universal Updater | This component is necessary for updates, ensuring the application remains current and functional. |
VoIPTools Relay Service | It is used for proper integration and functionality of the 3CX Surveyor 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 servers | This 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. |
8 GB RAM | You need a minimum of 8 GB RAM to ensure that the 3CX Surveyor, along with other necessary applications (like VoIPTools, IIS, SQL Server, and .NET Framework), can run smoothly and efficiently |
Port number 5800 opened on your device | Port 5800 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. |
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
- Installation on a domain controller is not supported.
DOWNLOAD SOFTWARE | You can order 3CX Surveyor online at https://www.voiptools.com. Your order confirmation email will include your license key and a link to download the software. | |
INSTALL PREREQUISITES | You must install several prerequisites before installing the 3CX Surveyor. The Advanced Installer identifies and installs these applications automatically. Click here to learn about the required prerequisites. | |
INSTALL 3CX SURVEYOR | This User Guide contains step-by-step instructions to successfully install 3CX Surveyor. Begin by extracting the installer from the downloaded zip file (Step 1 above), then run the setup program named Surveyor.exe | |
LOG IN TO THE WEB APPLICATION | You can now log in to the web application using the extension number and the PIN. |
Step-by-step Installation Procedure #
Step 1: Download 3CX Surveyor(Server) #
Find the software download link in the Order Confirmation Email, or you can download the application by following the procedure,
- Open your browser and go to the VoIPTools official website or click here to get redirected to the website.
- Search for the On Surveyor Application and click the Download button to download your application.
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 installation of the prerequisites needed to run the 3CX Surveyor.
- Click the downloaded installer executable to launch the Prerequisites Setup Wizard and click Next.
- 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 and click Next to continue.
The installer will download and install the selected applications.
- 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.
- 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.
SQL server installation is in progress. This may take several minutes to complete.
- Click the Close button once the prerequisites are installed.
- In the Confirmation Message box, click OK to reboot the computer.
Step 3: Start the installation process #
- After all the prerequisites are installed, click Next in the 3CX Surveyor Setup Wizard Continue.
- On the Select Installation Folder window, in the Folder field view the location where the 3CX Surveyor gets installed.
- Click Next to continue with the installation.
NOTE:
You cannot change the path.
Step 4: Test Relay Settings #
- In the 3CX Relay Services window, in the Relay Host field, enter the FQDN of your 3CX server.
- Enter 8801 in the Relay Port field.
- Enter the public key you took from VoIPTools Relay services in the Public Key text area.
- Click the Test Relay Settings to confirm 3CX Surveyor can communicate with the Relay services running on the 3CX server.
- If the 3CX Surveyor successfully communicates 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.
- Click Next to continue with the installation.
NOTE:
- You must set the Relay Port to 8801.
- If the Relay test fails, you cannot continue the installation until you establish communication with the Relay. Confirm the following 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 the 3CX Surveyor and Relay use the same port and protocol.
Step 5: Configure the database #
When configuring the 3CX Surveyor, 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 #
- Enter your server name in the Server field.
- If using the free SQL Express Edition, the default SQL Instance name is SQLExpress.
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.
- Enter your credentials in the Username and Password fields.
NOTE:
Make sure that you select a SQL Login that has sufficient permissions to alter the database and create SQL objects.
- Select or enter the 3CX Surveyor in the Database dropdown.
- In the Test SQL Connections section, click the Tool button to test the connection and click OK in the Test Results popup box.
Windows Integrated Authentication #
- 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.
- In the Test SQL Connection section, click the Tool button to test the connection.
- 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 Surveyor #
- In the Ready to Install window, click Install to start the installation of the 3CX Surveyor.
The application installation progresses.
- Once the installation is complete, click Finish to complete the installation process.
Step 7: Login to the Web Application #
Before you Start: Make sure you have registered with the VoIPTools Relay which grants access to the application.
Follow the procedure to register your software,
- Click the 3CX Surveyor desktop icon to open the web application.
- On the Login page, do the following tasks,
- In the Extension field, enter your 3CX extension number.
- In the PIN field, enter your 3CX voicemail PIN.
- Click the Login button to log in to your account
Login Privileges: #
Login privileges in 3CX Surveyor ensure secure, role-based access to the system. Managers have full access to configure settings and oversee operations, while Agents are limited to specific functionalities like the Wallboard screen. These privileges enhance security, streamline workflows, provide tailored experiences, and enable efficient user and role management.
You can log in to the 3CX Surveyor as a Manager and as an Agent. An Agent has access only to the
As a Manager, you have access to all the tabs in the 3CX Surveyor.
To learn how to assign roles to the agents in the 3CX Console Management, click here.
Getting Started with 3CX Surveyor #
Application Logo | This is the default application logo. You can modify and use a custom logo in the Site Settings. | |
Header Title Prefix | This is the default header title prefix. You can modify and use a custom header title prefix in the Site Settings. | |
Menu Bar | The menu bar displays all the menus available. | |
User Details | The application shows the extension number and the name of the user. |
Overview of the Menu Bar #
Dialer menu | The Dialer Menu streamlines campaign management, call operations, and agent workflows, enhancing communication efficiency and improving customer engagement. |
Campaign menu | The Campaign Menu lets you create, organize, and manage campaigns, assign agents, configure scripts, and streamline campaign coordination. |
Contact menu | The Contacts Menu manages contacts, updates details, sets preferences, tracks interaction history, and enhances communication and database accuracy. |
Import menu | The Import menu helps you upload, map, and organize contacts from a CSV file into the central repository efficiently. |
Reports menu | The Reports menu provides insights into campaigns, agent activity, and customer interactions, aiding decision-making, strategy optimization, and performance improvement. |
Settings menu | The Settings menu offers customization for functionality, security, and branding, including General Settings for operations and Site Settings for visuals. |
About menu | The About menu provides software version, company details, and support contact, ensuring easy access to version verification and assistance. Click the link to know more about the VoIPTools support. |
Settings Menu #
The Settings menu in the 3CX Surveyor portal provides comprehensive customization options to enhance both functionality and branding. It consists of two sections: General Settings, which optimize usability, security, and operational efficiency, and Site Settings, which allow for visual customization of the application’s branding, improving user experience and alignment with your brand.
General Settings | The General Settings allow customization of culture, access, wait times, session expiry, and automatic CSV imports for enhanced efficiency. |
Site Settings | Site Settings allow you to customize the application’s branding, including header colors, grid colors, logo, and title prefix. |
General Settings #
The General Settings section allows you to customize various aspects of the 3CX Surveyor portal to enhance usability and security. You can adjust culture settings, manage portal access, set wait times between contact retries, define session expiry times, and enable automatic CSV imports for streamlined contact management. These settings improve operational efficiency, ensure data consistency, and allow for a tailored user experience, ultimately optimizing the functionality of the portal for campaign and user management.
How to Open the General Settings #
This section guides you to open the General Settings in the web application.
Before you Start: Make sure you have logged in with manager rights.
- Hover over the Settings menu in the menu bar.
- In the drop down, click the General Settings option.
Results: You have opened the General Settings screen. Read further to learn the functions of each tabs in the General Settings.
Getting to Know Tabs in General Settings #
Tab Name | Purpose of the tab |
---|---|
Widget | The Widget Tab allows you to customize the Dialer screen by selecting desired widgets, improving accessibility and user experience. |
General | The General tab customizes culture, access, wait times, session expiry, and imports, enhancing usability, security, and operational efficiency. |
Controls | The Controls tab manages role-based access, customizes control items, and allows permission assignments, enhancing security, efficiency, and application clarity. |
Dispositions | The Disposition tab categorizes call outcomes, improving clarity, follow-up efficiency, and decision-making for better customer interactions and satisfaction. |
Lookups | The Lookups tab manages preset values, standardizing data entry, improving consistency, reporting, and user experience, while controlling available selections. |
Widget Tab – Configure Widgets in Dialer Menu #
The Widget Tab lets you select the desired widgets to display on the Dialer screen. With this feature, you can customize your interface by choosing which widgets to include, enhancing your user experience and allowing for quick access to relevant tools and information. This flexibility ensures that you can tailor the Dialer menu to meet your specific needs and preferences.
Before you start, make sure you have logged in with Manager credentials and navigated to the Widgets tab in the General Settings under the Settings menu.
- Select the desired widget in the Enable column.
- Click the Save button.
Figure: Configure Widgets
Results: The selected widgets are updated on the Dialer screen according to your preferences. This customization allows you to rearrange, add, or remove widgets, ensuring that the interface reflects your workflow and enhances your efficiency.
General Tab #
The General tab provides tools to customize culture settings, manage portal access, set wait times, define session expiry, and enable automatic CSV imports. These features enhance usability, security, and efficiency, streamline contact data management, and ensure organized operations within the 3CX Surveyor portal for improved campaign and user management.
General Section #
The General section enables you to customize culture settings, manage portal access, set contact wait times, and define session expiry time, enhancing usability, security, and operational efficiency in the 3CX Surveyor portal.
Set Culture Settings #
You can utilize the culture settings to control the display format of dates and currency across the web portal. By default, these settings are configured to English, however, they can be adjusted to suit your specific preferences.
Before you start, make sure you have logged in with Manager credentials and navigated to the General tab in the General Settings under the Settings menu.
- Click to open the Culture dropdown.
- Select the desired culture and click the Save button.
Results: You have changed the display culture of the 3CX Surveyor web application.
Manage Access to Surveyor Web Portal #
The Surveyor Access Management feature lets you control access to the Surveyor web portal by designating a 3CX extension group. With this feature, you can ensure that only members of this specific extension group have permission to log in to the portal, and Surveyor licensing is aligned with the total number of members in this group, including extension group managers.
This feature also grants the following capabilities to Managers within the extension group:
- Creating campaigns
- Managing and importing contact lists
- Assigning agents to lists
NOTE:
To assign the Manager role to a specific extension,
Before you start, make sure you have logged in with Manager credentials and navigated to the General tab in the General Settings under the Settings menu.
- Click to open the Survey Extension Group dropdown.
- Select the desired extension group and click the Save button.
Results: The members of the selected group are granted access to log in to the Surveyor web portal. Additionally, Surveyor licensing will be calculated based on the number of individuals in the chosen extension group, including both members and any assigned group managers.
Set Wait Time #
The Wait Time feature lets you set a specific interval before a contact is presented again after receiving a previous disposition, such as No Answer. This setting enables efficient contact management by controlling reattempt timing, helping to prevent immediate retries and improve engagement opportunities on subsequent contact attempts.
Before you start, make sure you have logged in with Manager credentials and navigated to the General tab in the General Settings under the Settings menu.
- On the General section in the Wait Time field, set the desired wait time.
- Click the Save button.
Results: The contacts who were previously dispositioned with outcomes like “No Answer” will not be immediately reattempted. Instead, they reappear in the system for follow-up only after the specified waiting period has elapsed.
Set Session Expiry Time #
The Session Timeout feature lets you manage the web page session expiration based on user inactivity.
With this feature, you can automatically terminate a session after a specified period, enhancing security by minimizing the risk of unauthorized access. When a session expires, users are redirected to the login page and must reauthenticate to regain access to the portal.
Before you start, make sure you have logged in with Manager credentials and navigated to the General tab in the General Settings under the Settings menu.
- On the General section in the Session Timeout field, set the desired session expiry time.
- Click the Save button.
Results: The user session expires after the set period of inactivity. This means that if a user does not interact with the web portal within the specified time frame, their session gets terminated automatically and the user will be redirected to the login page, requiring them to re authenticate to continue using the portal.
Auto Import Section – Enable Automatic Import of New CSV Files #
The purpose of the Automatic Import feature is to streamline the process of importing contact data into campaigns by enabling Surveyor to monitor a designated folder for new CSV files. When a new file is detected, its contents are automatically imported, reducing the need for manual intervention and ensuring that the campaign data is always up to date.
Benefits:
- Automating contact data entry processes saves time.
- Integrating new information enhances campaign effectiveness.
- Minimizing human error improves data accuracy and reliability.
The Auto Import feature lets you automate CSV file imports, skip header rows, set archive paths, and download templates for proper data formatting in campaigns.
Before you start, make sure you have logged in with Manager credentials and navigated to the General tab in the General Settings under the Settings menu.
NOTE:
Before initiating the auto-import process for your CSV files, download and use the sample CSV file to ensure proper formatting of your files.
- In the Auto Import section, select the Auto Import Contacts box to enable the auto import feature.
- Select the First Row Header box to skip the first row if your CSV file contains header as first row.
- Enter the import path data in the Import Path field to specify where Surveyor monitors for new CSV files.
- Enter the archive path in the Archive Path field to move the imported CSV files after processing.
- Click the Save button to save your changes.
Results: The Surveyor automatically monitors the designated folder for new CSV files. Once a new file is placed in the specified import path, the system imports the contact data from that file into the designated campaign. Additionally, imported CSV files will be moved to the specified archive path, keeping your import folder organized.
Controls Tab #
The Controls tab enables role-based access management and customization of control items in the 3CX Surveyor portal. It allows administrators to assign permissions for viewing or editing controls to specific user groups and modify control labels for clarity, enhancing security, workflow efficiency, and application customization.
Field Definitions of Controls Tab #
Column Name | Purpose/Function |
---|---|
Culture | Displays the language culture in which the information is displayed. |
Screen | Indicates the menu where the control item is present. |
Label Name | Indicates the label of the control item. Label name cannot be changed. |
Label Text | Indicates the name of the control item. You can change the name of the control item. |
Control Name | Name of the control item |
Admins | To allow admins to view the control items, check the box. To restrict their access, simply leave the box unchecked. |
Managers | To allow the managers to view the control items, check the box. To restrict their access, simply leave the box unchecked. |
Users | To allow the users to view the control items, check the box. To restrict their access, simply leave the box unchecked. |
Grant Permission to Edit a Control Item #
This feature allows organizations to control data access by assigning permissions to specific user groups, such as Admins, Managers, and Users. By enabling role-based access, it enhances data security, supports workflow efficiency, and ensures accountability, allowing only authorized users to modify designated data within the application.
Before you start, make sure you have logged in with Manager credentials and navigated to the Controls tab in the General Settings under the Settings menu.
The following instructions enable administrators to grant an agent permission to access a restricted control.
- Search for the control item in the Label Text field.
- Check the Users box to give access to that control item.
- Click the Save button to save the action.
- Click the Reload button to apply the saved actions.
Results: The agent can access the restricted control item.
Edit Label Text for a Control Item #
You can modify the label text of specific controls, enhancing customization and clarity within the application. By editing labels, you can ensure that control names are relevant and meaningful, aiding user navigation and alignment with organizational terminology.
Before you start, make sure you have logged in with Manager credentials and navigated to the Controls tab in the General Settings under the Settings menu.
- Search for the control item in the Label Text field.
- Double-click on the Label Text and edit the label text of the control item.
- Click the Save button to save your actions.
- Click the Reload button to apply the saved actions.
Results: The name of the control item is changed.
Dispositions Tab #
The Disposition tab categorizes call outcomes like ‘Busy’ or ‘Not Interested,’ improving clarity, reporting, and agent workflows. Adding new dispositions enhances call tracking and follow-up efficiency, enabling better decision-making for managers and ultimately leading to improved customer interactions and satisfaction through accurate categorization of call results.
Field Definitions of Dispositions Tab #
Column Name | Definition/Purpose |
---|---|
Description | Give you the name of the disposition to configure. |
AllowRetry | Lets the agent try calling again if the first attempt was busy. |
Disable | It disables the disposition from the application. |
Add New Dispositions to Call Status Widget #
This section guides you to add a new widget to the Call Status widget in the Dialer menu.
Before you start, make sure you have logged in with Manager credentials and navigated to the Dispositions tab in the General Settings under the Settings menu.
- Click the Add button.
- Enter the name of the disposition in the Description field.
- You can select the Allow Retry box to let the agent try calling again if the first attempt was busy.
- Click the Save button to save your changes.
Results: The new disposition gets added to Call Status widget in the Dialer menu.
NOTE:
3CX Surveyor supports batch edits and hence, you may edit one or more dispositions before you save them.
Disable an Existing Disposition #
This section guides you to disable an existing disposition from the Call Status widget in the Dialer menu.
Before you start, make sure you have logged in with Manager credentials and navigated to the Dispositions tab in the General Settings under the Settings menu.
- Select the Disable box for the dispositions you want to disable from the application.
- Click the Save Changes button to save your results.
Results: The selected dispositions are disabled from the Call Status widget in the Dialer menu.
Lookups Tab #
The Lookups tab in lets you centrally manage preset values, such as “Buying Status” or “Customer Status,” to standardize data entry. You can customize options to improve user experience, ensure data consistency, enhance reporting capabilities, and control available selections, creating a streamlined and flexible application setup.
Field Definitions of Lookups Tab #
Columns Name | Definition | Purpose |
---|---|---|
Lookup Type | It defines the type or category of the lookup. It is used to group different settings under specific labels, such as “Buying Status,” “BTC,” “Class,” or “Customer Status.” | It organizes entries into logical groups so that similar items can be managed together. For instance, all entries related to “Buying Status” might reflect a customer’s purchasing behavior, while “BTC” could relate to different time segments of a day. |
Lookup Value | This column provides an abbreviated or coded value representing the specific option within each LookupType category. Examples include “NB,” “NVB,” and “VB” under the “Buying Status” type. | These coded values are likely used internally within the system for quick reference or to set specific conditions. This makes it easier to programmatically access specific settings without using long descriptive text. |
Lookup Display | This column shows the human-readable description of each LookupValue. This text is what users or system operators see on the user interface, making it easy to understand what each code stands for. | It translates coded values from the LookupValue column into plain language, improving usability by making settings understandable at a glance. |
Disable | This column is a checkbox column that lets you disable certain lookup entries. | The administrators can disable specific lookup entries, preventing them from being used or displayed in the interface. This provides control over which options are available or active without permanently deleting them. |
How to Add a Lookup? #
The following instructions set guides you to add new lookup entries in the Lookups tab. By specifying a lookup type, value, and display text, administrators create standardized options for various fields, enhancing data consistency and user experience across the platform.
Before you start, make sure you have logged in with Manager credentials and navigated to the Lookups tab in the General Settings under the Settings menu.
- Click the Add button.
- In the Lookup Type field, enter the lookup type.
- In the Lookup Value field, enter the lookup value.
- In the Lookup Display field, enter the lookup text to display.
- Click Save Changes to save the new lookup.
Results: The new lookup gets added in the web application.
Disable an Existing Lookup #
The following instructions guides you to disable a specific lookup’s display text in the Lookups tab of 3CX Surveyor settings, ensuring updated, accurate information is saved.
Before you start, make sure you have logged in with Manager credentials and navigated to the Lookups tab in the General Settings under the Settings menu.
- Search for the lookups to display.
- Select the Disable box for the lookups to disable.
Results: The selected lookups get disabled in the web application.
Site Settings #
The Site Settings allow you to customize the branding of the web application, providing flexibility in visual presentation. These settings enable you to change the gradient color of the Application Header, modify the grid color for data display screens, upload a custom logo, and set a header title prefix. These customizations enhance the user experience by aligning the application’s appearance with your brand identity, making the interface more visually appealing and consistent with organizational standards.
Site Settings enable you to customize branding settings for the application that includes the following:
- Customize the gradient color of the Application Header.
- Customize grid color in screens that display grid data.
- Customize the logo on the Application Header.
- Customize Header Title Prefix on the Application Header.
Customize Application Title Header – Gradient Color #
The following instructions guides you to change the title color of the Surveyor web application.
Before you start, make sure you have logged in with Manager credentials and navigated to the Site Settings in the Settings menu.
- Select the top paint from the Top Colour color palette.
- Select the bottom paint from the Bottom Colour color palette.
- Click Apply to Save the settings.
Customize Grid Color #
The following instructions guides you to change the grid color of the Surveyor web application.
Before you start, make sure you have logged in with Manager credentials and navigated to the Site Settings in the Settings menu.
- From the Grid Color palette, select the color that you want to display for the grid in screens that display grid data
- Click Apply to save your settings.
Customize Logo #
The following instructions guides you to upload a custom logo to your web application.
Before you start, make sure you have logged in with Manager credentials and navigated to the Site Settings in the Settings menu.
- Click the Browse button to choose a logo from your device.
- Select the uploaded logo from the Custom Logo dropdown list.
- Click Apply to save your changes.
Customize ‘Header Title Prefix’ Text #
The following instructions guides you to change the prefix of the header title.
Before you start, make sure you have logged in with Manager credentials and navigated to the Site Settings in the Settings menu.
- In the Header Title field, enter the text that you want the application to display as a ‘prefix’ for the existing title in the application header.
- Click Apply to save the header title prefix.
The final result of the page when you do all the customizations,
Dialer Menu #
The Dialer Menu allows you to manage campaigns, initiate calls, and streamline communication workflows using various widgets. You can control caller IDs, schedule callbacks, assess contact attributes, and update contact information. This feature simplifies call operations, optimizes targeting, and enhances agent efficiency, improving overall campaign success and customer engagement.
Getting to Know the Dialer Menu #
Widgets | The available widgets in the dialer menu. You can hover over the widgets to know the name of the widget. | |
Reset Layout Icon | It resets the Dialer menu to the default layout. | |
Save Layout Icon | You can organize the widgets and save the layout. |
Overview of the Dialer Widgets #
Widget Icon | Widget Name | Purpose of the Widget |
---|---|---|
Campaign | The Campaign widget enables you to manage campaigns, select call lists, and initiate calls for assigned agents efficiently. | |
Show Call Control | In the Call Control widget, you can automatically see the contact number of the first contact in the campaign list. | |
Call Status | Call Status widget lets you select one of the dispositions from the available dispositions list. | |
Prior Ad | The Prior Ad widget allows users to retrieve, reference, or duplicate details of a previous advertisement, enabling easy reuse, validation, customization, or historical tracking of campaigns. | |
Address | Contact Address widget displays address details of the contact in the call. | |
Agent Script | Agent Script widget displays the information specific for the agent. | |
Attributes | The Contact Attributes widget displays sales information such as order history, contact details, status, class, and territory for contacts. | |
Qualification Script | The Call Qualification widget assesses prospects’ eligibility based on key attributes, enabling efficient targeting, data collection, and optimized call timing to maximize campaign success. | |
Caller ID | The Caller ID widget allows you to manage and update outbound caller IDs for logged-in users’ extensions in 3CX. |
Campaign Widget #
This section guides you to manage campaigns and initiate calls from assigned lists
- In the Campaign drop down, select the campaign for which you want to work.
- From the List drop down, select the Campaign List so that you can start calling the agents assigned to it.
Results: The selected campaign and list are loaded, enabling agents to begin making assigned calls.
Call Control Widget #
In the Call Control widget, you can automatically see the contact number of the first contact in the campaign list.
Dial a Number #
This icon lets you to dial the number that appears in the Contacts field
You can also dial additional phone numbers. Click Dial icon beside Phone 1/ Phone 2/ Mobile/ FAX fields.
End a Call #
This icon lets you end the current call.
Transfer the Call #
This icon lets you transfer the call. To transfer a call,
- Enter the extension number in the Contacts field.
- Click the Transfer icon.
To transfer a call to another extension, you must first enter the extension number in the Contact field. When you click the Transfer icon.
Search a Contact #
Lets you search a contact.
- Enter any of the contact details.
- Click the Search icon.
Save Contact Details #
To save the contact details,
- Enter the contact details in the respective fields.
- Click the Save icon.
Next Contact #
Moves to the next contact in the dialer. Once you are done with the current contact you can click the Next icon to move to the next contact.
NOTE:
- The number beside the Next button indicates how many people are yet to be called.
- In order to move to the next customer, you need to disposition the call.
Call Status Widget – Move to Next Call #
Call Status widget lets you select one of the dispositions from the available dispositions list.
- Select any of the disposition in the Call Status widget.
- Click the Next icon in the Call Control widget.
To learn to add or disable dispositions in the Call Status widget, click here.
Contact Address Widget #
Contact Address widget displays address details of the contact in the call.
You can modify the contact address details.
To learn to add/modify/delete the address fields, click here.
Prior Ads Widget #
The Prior Ad widget allows users to retrieve, reference, or duplicate details of a previous advertisement, enabling easy reuse, validation, customization, or historical tracking of campaigns.
CallBack Widget #
Call Back widget lets you schedule a call back according to the customer’s preferred timings. If you are working on a call and if the call back scheduled time arrive, the dialer waits till you have finished the call and once you click the Next button, the call will be dialed to the Call Back number.
- In the Date/ Time drop-down, select the appropriate date and time.
- In the Phone field, enter the phone number to which you need to call back.
- Once the call back has been performed successfully, check the Done box to know in future that the call back for the customer has been performed.
Agent Script Widget #
Agent Script widget displays the information specific for the agent.
Contact Attributes Widget #
All the sales information related to the contact will be populated in the Contact Attributes widget. From here, you can know what the contact’s first order, last order, last contact details, class, status and territory are.
To learn to modify the details of the Contact Attributes widget, click here.
Call Qualification Widget #
The Call Qualification widget assesses prospects’ eligibility based on key attributes, enabling efficient targeting, data collection, and optimized call timing to maximize campaign success.
Caller ID Widget #
Caller ID widget enables you to work in sync with the ‘Caller IDs’ menu of the ‘3CX Caller ID’ application. From here, you can update Outbound Caller ID for logged-in user’s extension, revert back to agent default Caller ID, and manually update Outbound Caller ID for logged-in user’s extension. For more information, you can refer Caller ID manual.
NOTE:
To view Caller ID widget, you need to install ‘3CX Caller ID’ application.
Update Outbound Caller ID for Logged-in User’s Extension #
- From the Numbers drop down, select the franchise whose extension you want to apply to your outbound caller ID.
Results: Once applied, the system displays the successfully updated message and the desired franchise would apply to the outbound caller ID.
Revert Back To Agent Default Caller ID #
Reverting a CallerID for an agent will revert it back to the ‘Agent Caller ID’ (specified in the Agents tab). If the agent is not assigned any Caller ID, then the application takes ‘Default CallerID’ (specified in the Settings tab) of the extension group to which the agent belongs to.
- Beside Numbers drop down, click the Revert button.
NOTE:
Every agent must have a default Caller ID (Agents tab) else Caller ID will not be reverted.
Campaign Menu #
The Campaign Menu enables you to efficiently manage campaigns by creating and organizing them, adding campaign lists, and assigning agents. You can configure campaign details, set statuses, define timeframes, include agent scripts, and manage contact lists. This feature ensures streamlined coordination and execution of your targeted campaigns with ease and professionalism.
Add New Campaign #
This section guides you to add a new campaign.
Before you start: Make sure you have logged in with Manager credentials and navigated to the Campaign Menu in the menu bar.
- Click the Add icon.
- In the Campaign popup screen, do the following
- Enter a title in Description 1 field.
- Enter a short description of the campaign in the Description 2 field.
- In the Status dropdown,
- Set the status to Active to activate the campaign.
- Set the status to Inactive to inactivate the campaign.
- Enter a script for the agent in the Agent Script text area.
- Click the Save icon.
Results: The campaign gets added to the campaigns list.
Add a Campaign List #
This section guides you to add a campaign list to the existing campaigns.
Before you start: Make sure you have logged in with Manager credentials and navigated to the Campaign Menu in the menu bar. You must have created a campaign first before adding a campaign list. Refer the earlier section to learn how to add a campaign.
Step 1: Open the Campaign List Screen #
- Click the Expand icon.
- Click the Add icon.
Step 2: General Section – Add General Details of the Campaign List #
- Enter the name of the campaign list in the List Name field.
- In the Status dropdown,
- Set the status to Active to activate the campaign.
- Set the status to Inactive to inactivate the campaign.
- Set the Start Date and End Date from the Calendar dropdown.
Step 3: Agent Script Section – Add Agent Script to Campaign List #
- Enter the script for the agent using the inbuilt word processor.
Step 4: SQL Query Section – Add SQL Query to Campaign List #
The SQL Query section displays the list of contacts involved in the campaign list. The list is exported from the Contacts menu. You can add new contacts in this section.
- Click the Add icon.
- Enter the contact details.
- Click the Save Changes text.
Step 5: Assign Agents Section – Add or Remove Agents to the Campaign List #
The Assign Agents tab lets you assign specific agents to a campaign list. The Unassigned list box shows agents in the Surveyor Extension Group, defined in the In the General tab under the Settings menu.
To assign agents, select them from the Unassigned list box and move them to the Assigned list box.
Assign Agent | Lets you assign a selected agent for the campaign. | |
Unassign Agent | Lets you remove a selected agent from the campaign. | |
Assign All | Lets you assign all the available agents to the campaign. | |
Unassign All | Lets you remove all the assigned agents in the campaign. |
Contacts Menu #
The Contacts Menu in 3CX Surveyor provides a centralized platform to manage, organize, and update contact information efficiently. It enables users to search, add, delete, or edit contacts, ensuring accurate and streamlined database management. The menu also supports advanced features such as setting contacts as private or in “Do Not Disturb” mode. Additionally, the History Tab records interaction notes for better customer insights, while the Qualification Tab displays comprehensive contact details, enhancing overall communication and operational efficiency.
Contacts Tab #
The Contacts Tab enables you to manage contact information effectively within the 3CX Surveyor. You can search for, add, delete, or update contact details with ease. This feature streamlines database management, ensures accurate information retrieval, and provides a user-friendly interface for maintaining a centralized repository of contact data.
Getting to Know the Contacts Tab Toolbar #
Search | Type appropriate information anywhere in the field and click the Search button. 3CX Surveyor finds the person from the database and populates the information in all the fields. | |
Delete Contact | Search for the contact that you want to delete and click the Delete Contact button to delete the contact. | |
Save | Click the Save button to save the changes you made to the contact. | |
Clear Contact | Click the Clear Contact button to clear the contact details in the Contact tab. |
Search a Contact #
This section guides you to search a contact in the Contacts tab.
Before you Start: Make sure you have logged in with Manager Rights and have navigated to the Contacts tab under the Contacts menu.
- Enter the complete details or partial details of the contact in any of the field.
- Click the Search icon.
- Select the desired contact from displayed contacts list.
Results: Details of the contact is populated.
Add a Contact #
This section guides you to add a contact.
Before you Start: Make sure you have logged in with Manager Rights and have navigated to the Contacts tab under the Contacts menu.
- Enter the necessary contact details in the fields.
- Click the Save icon.
Results: You get a Success popup when the contact gets added to the contacts list.
Set Contact as Private #
This section guides you to add a contact.
Before you Start: Make sure you have logged in with Manager Rights and have navigated to the Contacts menu.
- Search for the contact you want to set a private. Click here to learn to search a contact.
- Select the Private box.
Set Contact as Do Not Disturb #
This section guides you to add a contact.
Before you Start: Make sure you have logged in with Manager Rights and have navigated to the Contacts menu.
- Search for the contact you want to set a do not disturb. Click here to learn to search a contact.
- Select the Do Not Disturb box.
History Tab #
The History screen allows you to record notes about various conversations your company had with a specific contact over time. You can record important information like commitments or services you provided so that when the customer calls you, you can quickly look into notes to know if you can perform something on their behalf to achieve great customer satisfaction. It provides a great way to understand your customer even before you start talking to them.
Add New Notes #
This section guides you to add new notes for a contact.
Before you Start: Make sure you have logged in with the Manager Rights and have navigated to the History tab under the Contacts menu. Also, ensure you have searched or created the contact before writing notes. Click here to know to create/search a contact.
- Click the Add icon.
- Enter the notes in the Notes field.
Results: The note gets updated with other information regarding the notes.
Qualification tab #
Contact screen enables you to view the information about contact.
Import Menu #
The Import menu enables you to efficiently upload and organize contact information from a CSV file into the central repository. By providing tools to map data fields, manage duplicates, and specify delimiters, it ensures accurate and streamlined data integration, enhancing your ability to maintain an updated contact database.
Import Contacts from a CSV File #
This section guides you to import contacts from a .CSV file in your local device.
Before you Start: Make sure you have logged in with the Manager Rights and have navigated to the Import menu in the menu bar and have a existing .CSV file in your device.
- Click the Browse button and browse the CSV file from your local device.
- Enter a name for contact list in the Contact List field.
- Select the Delimiter type.
- Select Comma if the data in your CSV file is separated by commas.
- Select Tab if the data in your CSV file is separated by tab spaces.
- Click the Get Field icon to load the CSV column headers into the CSV File list box.
- Move each column from the CSV File list box into the CSV Field list box by appropriately using buttons such that the columns in the CSV Field list box will match those of the Contact Field list box.
- Select the Update Existing Contacts box to overwrite existing contacts.
- Click the Import button to import all the contacts from the CSV file into the central repository of contacts.
Results: The contact list in the CSV file gets exported to the web application.
Reports Menu #
The Reports Menu provides access to various report types, including Sales, Performance, Call, and Call Back Reports. Each report offers valuable insights into different aspects of your business operations, such as campaign performance, agent activity, customer interactions, and callback efficiency. By grouping columns, analyzing trends, and exporting data, you can make informed decisions, optimize strategies, and improve performance. This streamlined process enhances data visibility, supporting better management and operational efficiency across your organization.
Report Name | Purpose |
---|---|
Sales Report | The Sales Reports screen tracks campaign performance, analyzes sales data, enables grouping, and exports insights for informed decision-making. |
Performance Report | The Performance Reports screen provides insights into agent activities, enabling analysis, monitoring, optimization, and export of performance data. |
Call Report | The Call Reports screen tracks customer interactions, analyzes call outcomes, evaluates agent performance, and supports exporting and grouping data. |
Call Back Report | The Call Back Reports screen tracks callback activities, monitors performance, and enables analysis through column grouping and data export. |
Sales Report #
The Sales Reports screen offers detailed insights into sales campaign performance, allowing you to track company interactions, sales values, and key contacts. It helps you analyze trends, group data for better clarity, and export information for further review, facilitating informed decision-making and enhancing overall business strategies.
Sales Report – Column Definitions #
Column Name | Definition / Purpose |
---|---|
Campaign Name | Name of the campaign |
Date/ Time | Date and time of the start of the campaign. The date format is MM/DD/YYYY and the time format is HH:MM AM/PM |
Name | Name of the company contacted |
Phone | Phone number of the company contacted |
Value | The sales value in US Dollars. |
First | First Name of the contacted person. |
Last | Last Name of the contacted person. |
Sales Report – Export Data #
This section guides you to export the sales report in various file formats to you local device.
Before you Start: Make sure you have logged into the application with manager rights and have navigated to the Sales Reports screen under the Reports menu.
- Click any of the desired format to export to your local device.
Sales Report – Group the Columns #
Grouping columns in a report organizes data into logical sections, enhancing readability, enabling comparisons, and simplifying analysis by presenting related information cohesively.
This section guides you to group the columns of the sales reports.
Before you Start: Make sure you have logged into the application with manager rights and have navigated to the Sales Reports screen under the Reports menu.
- Drag and drop any of the available columns into the space provided above the columns.
- Click the Expand icon to expand the grouped items.
Results: You have grouped the columns in the Sales Reports screen.
NOTE:
The grouped columns do not reflect in the exported files.
Performance Reports #
The Performance Reports screen offers a comprehensive view of agent activities, including call volume, durations, and campaign involvement. It enables detailed analysis, effective monitoring, and informed decision-making to optimize performance and ensure operational efficiency. Users can group columns for better organization and export data in various formats for further review.
Performance Report – Column Definitions #
Column Name | Definition / Purpose |
---|---|
First | First Name of the contacted person. |
Last | Last Name of the contacted person. |
Login Date/ Time | Date and time of the start of the campaign. The date format is MM/DD/YYYY and the time format is HH:MM AM/PM |
Calls | Number of calls made by the agent. |
Duration | Total duration of all the calls made. The format is HH:MM:SS |
Campaign Name | Name of the campaign |
Performance Report – Export Data #
This section guides you to export the performance report in various file formats to you local device.
Before you Start: Make sure you have logged into the application with manager rights and have navigated to the Performance Reports screen under the Reports menu.
- Click any of the desired format to export to your local device.
Performance Report – Group the Columns #
Grouping columns in a report organizes data into logical sections, enhancing readability, enabling comparisons, and simplifying analysis by presenting related information cohesively.
This section guides you to group the columns of the performance reports.
Before you Start: Make sure you have logged into the application with manager rights and have navigated to the Performance Reports screen under the Reports menu.
- Drag and drop any of the available columns into the space provided above the columns.
- Click the Expand icon to expand the grouped items.
Call Reports #
The Call Reports screen provides detailed records of customer interactions, including call dates, times, dispositions, and agent involvement. It enables tracking and analysis of call outcomes, facilitating performance evaluation, campaign effectiveness assessment, and operational improvement. Users can organize data through column grouping and export reports in various formats for detailed review.
Call Report – Column Definitions #
Column Name | Definition / Purpose |
---|---|
Customer | Name of the customer |
Campaign | Name of the campaign |
Agent Name | Name of the agent who contacted the customer. |
Phone | Phone number of the customer. |
Date/Time | Date and time of the call. The date format is MM/DD/YYYY and the time format is HH:MM AM/PM |
Dispositon | The response of the customer as noted by the agent. |
Call Report – Export Data #
This section guides you to export the performance report in various file formats to you local device.
Before you Start: Make sure you have logged into the application with manager rights and have navigated to the Call Reports screen under the Reports menu.
- Click any of the desired format to export to your local device.
Call Report – Group the Columns #
Grouping columns in a report organizes data into logical sections, enhancing readability, enabling comparisons, and simplifying analysis by presenting related information cohesively.
This section guides you to group the columns of the call reports.
Before you Start: Make sure you have logged into the application with manager rights and have navigated to the Call Reports screen under the Reports menu.
- Drag and drop any of the available columns into the space provided above the columns.
- Click the Expand icon to expand the grouped items.
Call Back Reports #
The Call Back Reports screen provides detailed information about callback activities, including caller, buyer, and agent details, as well as callback status and campaign association. It helps monitor callback performance, ensures follow-up actions, and supports analysis through column grouping and data export for effective campaign and agent management.
Call Back Report – Column Definitions #
Column Name | Definition / Purpose |
---|---|
Agent Last Name | Last Name of the agent. |
Agent First Name | Frist Name of the agent. |
Caller | Name of the caller who made the call back. |
Name | Name of the caller who made the call back. |
Buyer | Name of the buyer who made the call back. |
Contact | Name of the contact who made the call back. |
Phone | Phone number of the contact who made the call back. |
Complete | Indicates whether the callback is complete. |
Campaign Name | Name of the campaign. |
Callback Date | Date and time of the call back. The date format is MM/DD/YYYY and the time format is HH:MM AM/PM |
Call Back Report – Export Data #
This section guides you to export the performance report in various file formats to you local device.
Before you Start: Make sure you have logged into the application with manager rights and have navigated to the Call Back Reports screen under the Reports menu.
- Click any of the desired format to export to your local device.
Call Back Report – Group the Columns #
Grouping columns in a report organizes data into logical sections, enhancing readability, enabling comparisons, and simplifying analysis by presenting related information cohesively.
This section guides you to group the columns of the Call Back reports.
Before you Start: Make sure you have logged into the application with manager rights and have navigated to the Call Back Reports screen under the Reports menu.
- Drag and drop any of the available columns into the space provided above the columns.
- Click the Expand icon to expand the grouped items.
About Menu #
The About menu provides essential information about the application, including the version number, company details, and contact information for support. It serves as a reference to verify the software version you are using and facilitates easy access to customer support for assistance or inquiries.
Click the link to know more about the VoIPTools support.
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!