Introduction #

Streamline Your 3CX Holiday Schedule with Our Free Tool – Say Goodbye to Manual Configuration

Discover a hassle-free solution for configuring holidays on your 3CX installation – introducing the free VoIPTools tool. Easily select National and Religious holidays from various countries worldwide and import them directly into your 3CX system, eliminating manual data entry and time-consuming searches. With the capability to import holidays up to 2029, you’ll save countless hours on holiday schedule updates. Don’t miss this opportunity to streamline your holiday scheduling and focus on business growth.

Why chose 3CX Holiday Importer? #

	SIMPLIFY HOLIDAY SCHEDULE CONFIGURATION	3CX Holiday Importer facilitates effortless import of National and Religious holidays from various countries into your 3CX system, streamlining the process and eliminating the need for manual configuration.
	TIME SAVING EFFECIENY	3CX Holiday Importer lets you import holidays up to the year 2029, eliminating the need for frequent updates and ensuring that your holiday schedule stays current for years ahead, thus freeing up your time for other essential tasks.
	INTERNATIONAL COMPATABILITY	The 3CX Holiday Importer allows businesses with international operations to choose holidays from countries worldwide. It offers comprehensive holiday coverage and ensures compliance across different regions.
	HASSLE-FREE HOLIDAY MANAGEMENT	Bid farewell to the stress of holiday schedule management with our complimentary tool that streamlines the entire process. Effortlessly import all your national and religious holidays, guaranteeing precision and preventing any overlooked dates.

Prerequisites #

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

Installation overview #

	DOWNLOAD SOFTWARE	You can order 3CX Holiday Importer 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 Holiday Importer. The Advanced Installer identifies and installs these applications automatically. Click here to learn about the required prerequisites.
	INSTALL 3CX HOLIDAY IMPORTER	This User Guide contains step-by-step instructions to successfully install 3CX Holiday Importer. Begin by extracting the installer from the downloaded zip file (Step 1 above), then run the setup program named HolidayImporter.exe

Step By Step Installation Procedure #

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

Step 1:  Download ‘3CX Holiday Importer’.   #

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 Holiday Importer 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 install of the prerequisites needed to run ‘3CX Holiday Importer’. 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.

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

The installer will download and install the selected applications.

Step 3: Start the installation process #

1. After all the prerequisites are installed, the 3CX Holiday Importer Setup Wizard appears. Click Next to Continue.

2. On the Select Installation Folder window, the Folder field displays the path where the 3CX Holiday Importer gets installed. You cannot change the location path.
3. Click Next to continue with the installation.

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

4. Click Next to continue when the installation is complete.

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.

4. Click the Test Relay Settings to confirm ‘3CX Auto Logout’ can communicate with the Relay services running on the 3CX server.
5. If the ‘3CX Auto Logout’ 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.
6. 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 Auto Logout and Relay use the same port and protocol.

Step 5: Installing 3CX Holiday Importer #

1. In the Ready to Install window, click Install to start the installation of the ‘3CX Holiday Importer’.

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

2. Once the installation is complete, check Launch 3CX Holiday Importer check box and then click Finish. The 3CX Holiday Importer web application opens. If you want to simply close the installer without opening the web application, then simply uncheck Launch 3CX Holiday Importer check box and then click Finish.

NOTE:

The license key permits you to install this software on one computer. This is not free software.

Step 7: Login to the Web Application #

Follow the procedure to login to your web application,

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.

3CX Holiday Importer Web Application #

Overview of the Web Application #

This section provides you a brief overview of the user interface of the 3CX Holiday Importer.

	User Details	Displays the extension number and the name of the user logged in.
	Logout Icon	Logs you out of the web application.
	Support Resources Icon	Gives the basic details of the application and the contact details of VoIPTools.

Overview of the Menu Items #

	Open AI menu	The Open AI Menu lets you configure OpenAI’s API and create, play, and download TTS audio files efficiently.
	Holiday Settings menu	The Holiday Settings Menu helps you manage, customize, and import holidays, ensuring efficient holiday configuration within 3CX Console.

Open AI Menu #

The Open AI Menu provides you with centralized access to configure OpenAI’s API and utilize its features seamlessly. It includes options like the AI Configuration Tab, where you can integrate the OpenAI API by entering the Base Address and Key, and the Text-to-Speech (TTS) Tab, enabling you to generate, play, and download high-quality TTS audio files. This menu serves as a user-friendly interface for managing AI functionalities efficiently and enhancing your application’s capabilities.

AI Configuration Tab – Setup Open AI’s API #

The AI Configuration Tab allows you to set up OpenAI API access for seamless integration with the web application. By entering the API Base Address and Key, you enable the application to connect with OpenAI’s services, ensuring proper functionality. This setup facilitates interaction with AI features and enhances operational capabilities.

This section guides you to setup Open API AI access for integration with the web application.

Before you Begin: Make sure you have logged into the application and have navigated to the AI Configuration tab under the Open AI menu.

1. Enter the URL endpoint for the OpenAI API in the OpenAI API Base Address field
2. Enter the unique key used for authenticating requests to the OpenAI API in the OpenAI API Key field

3. Click the Test button.

Results: If the Open AI integration is successful, you get a Success popup.

Text-to-Speech Open AI Tab #

The Text-to-Speech Open AI Tab enables you to generate, play, and download TTS audio files by converting text into speech. With customizable options like voice selection, model choice, and speed adjustment, this tab provides a user-friendly interface for creating and managing high-quality audio files for diverse applications.

Add New TTS #

This section guides you to add a new TTS audio file.

Before you Begin: Make sure you have logged into the application and have navigated to the Text-to-Speech Open AI tab under the Open AI menu.

1. Select the voice from the Voice dropdown.

2. Select the TTS model from the Model dropdown.

3. Set the speed of the TTS voice in the Speed dropdown.

4. Enter a name for your TTS file in the File Name field.
5. Enter the text you want to convert to speech in the text area.

6. Click the Generate button.

Results: A success popup gets displayed. Now, you can either play the audio file or download it to your local device.

Download TTS Audio File #

This section guides you to download the generated TTS audio file.

Before you Begin: Make sure you have logged into the application and have navigated to the Text-to-Speech Open AI tab under the Open AI menu. Also, you must have generated the TTS.

• Click the Download button.

Results: The TTS audio file gets downloaded to your local device.

Play TTS Audio File #

This section guides you to play the generated TTS audio file.

Before you Begin: Make sure you have logged into the application and have navigated to the Text-to-Speech Open AI tab under the Open AI menu. Also, you must have generated the TTS.

• Click the Play button to open the inbuilt player.

Results: You can now play the TTS audio file using the audio player. Adjust the zoom to view the waveform of the audio in more detail when playing it.

Holiday Settings Menu #

The Holiday Settings Menu allows you to efficiently manage holiday configurations within the 3CX Console. You can add, edit, delete, and import holidays based on specific countries, years, and departments. It also provides features to customize recurring holidays and clear holiday lists. With tools like the Toolbar for quick actions, Rows Per Page for viewing preferences, and the Page Navigator for seamless navigation, this menu ensures a streamlined process for managing holiday schedules in your organization.

Overview of Holiday Settings Menu #

	Tool Bar	Helps you to add, edit and delete the holidays.
	Rows Per Page	Lets you configure the number of holidays you want to be displayed in a page.
	Page Navigator	Helps you to navigate through the pages.

Toolbar definition #

The Toolbar lets you edit the custom holidays and the existing holidays in easy way.

	APPEND	Add a new custom holiday.
	DELETE	Delete an existing holiday or a new holiday that was created.
	EDIT	Edit an existing holiday or a new holiday that was created.
	END EDIT	End editing the holidays
	CANCEL EDIT	Cancel the edits done to the holidays.

Configure Rows Per Page #

You can configure the number of holidays displayed per page. This feature enhances navigation and increases user engagement. You can view a maximum of 50 holidays per page.

Page Navigator #

The page navigator button helps you to navigate between the pages.

	First Page	Navigates you back to the first page.
	Previous Page	Navigates you to the previous page.
	Next Page	Navigates you to the next page.
	Last Page	Navigates you to the last page.

 Import Holidays #

This section guides you to import standard holidays.

Before you Begin: Make sure you have navigated to the Holiday Settings menu.

1. From the Country Holidays dropdown, select the country for which you want to import the holidays.

2. In the Year dropdown, select the year want to import the holidays.

3. In the Department dropdown, select the group to import the holidays. It is mandatory to select the group name.

NOTE:

The _Default_ Group has been intentionally excluded from the Group dropdown. In 3CX, the Default Group includes all members of the system. While this works fine for smaller environments, importing all members from the Default Group in larger systems can lead to performance issues

4. Click Get Holidays button to import the holidays of the selected country for the desired year.

5. Click Save to 3CX to import the holidays into 3CX.

You can view the list of holidays imported to 3CX.

NOTE:

You can import holidays for multiple countries.

NOTE:

• You can edit the list of holidays prior to importing into 3CX.

• Importing holidays replaces any existing holidays already configured in 3CX.

 Edit Holidays #

This section guides you to edit existing holidays.

Before you Begin: Make sure you have navigated to the Holiday Settings menu.

1. Select the holiday you want to edit.

2. Click the Edit icon.

3. Edit the details of the holiday.

4. Click End Edit icon.
5. Click the Save button.

Results: The holiday gets edited in the 3CX Console Management.

Add Custom Holiday #

This section guides you to add a custom holiday to the holidays list.

Before you Begin: Make sure you have navigated to the Holiday Settings menu.

1. Click the Append  button to create an empty custom holiday field.

2. Select the empty holiday field and click the Edit button to enter details of your holiday.

3. In the Holiday field, enter the name of the holiday.
4. In the Day combo box, select or enter the date for the holiday.
5. In the Month combo box, select or enter the month for the holiday.
6. From the Year dropdown, select the year for the holiday.

7. From the toolbar, click the End Edit button to end the modification.
8. Click Save to 3CX button to save the custom holiday to 3CX server.

The custom holiday gets updated in the 3CX Console.

Delete Holidays #

This section guides you to delete holidays from the holidays list.

Before you Begin: Make sure you have navigated to the Holiday Settings menu.

1. From the holiday list, select the holiday that you want to delete.
2. At the bottom of the grid and from the toolbar, click  Delete button to delete the holiday.
3. Click the Save to 3CX button to save the changes to the 3CX server.

Results: The selected holidays get deleted from the 3CX Console Management.

NOTE:

This does not remove the holiday from the list of available holidays.

Clear Holiday List #

This section guides you to clear the holiday list and start over.

Before you Begin: Make sure you have navigated to the Holiday Settings menu.

1. On the 3CX Holiday Importer web application, click Holidays tab.
2. Click the Clear Holidays button. This will remove any displayed holidays.

Recurring Holidays #

Recurring holidays are those that occur on the same day each year (‘New Year’s Day’ for example), you can set a holiday to reoccur every year.

This section guides you to clear the holiday list and start over.

Before you Begin: Make sure you have navigated to the Holiday Settings menu.

1. Select the holiday that you want to make it recurring.
2. Click the Edit icon.
3. From the Day and Month drop downs, select appropriate date and time.
4. From the Year drop down, select Each option.
5. Click the End Edit icon.
6. Click the Save button.

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

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!