User Guide. 3CX Audio Scheduler. Version

Size: px

Start display at page:

Download "User Guide. 3CX Audio Scheduler. Version"

Stella Edwards
5 years ago
Views:

1 User Guide 3CX Audio Scheduler Version

2 "Copyright VoIPTools, LLC " Information in this document is subject to change without notice. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission VoIPTools, LLC. Version Last updated February 12, P a g e

3 Table of Contents Table of Figures... 4 What is 3CX Audio Scheduler?... 5 Why 3CX Audio Scheduler?... 5 What s New?... 5 Prerequisites... 5 Installation... 6 Download software... 6 Install Prerequisites... 6 Install 3CX Audio Scheduler... 6 Register your License Key... 6 Step by step Installation Procedure... 7 Settings CX Dial Code Audio Files Set Path for Audio Files Upload Audio File Delete Audio File Schedule Create New Scheduled Task Edit Scheduled Task General tab Triggers tab Add New Trigger Edit Existing Trigger Delete Trigger Actions tab Add New Action P a g e

4 Edit Action Delete Action Conditions tab Idle Conditions Power Conditions Network Conditions Settings tab Run Times tab History tab Delete Scheduled Task Run Scheduled Task TTS Support P a g e

5 Table of Figures Figure 1: Voiptools 3CX Audio Scheduler Setup Wizard... 7 Figure 2: Test VoIP 3CX Relay settings... 9 Figure 3: Run Application Figure 4: Register 3CX Audio Scheduler Figure 5: 3CX Audio Scheduler - Settings Figure 6: 3CX Audio Scheduler - Schedule Figure 7: Schedule tab - Toolbar Figure 8: Schedule tab - New Task Figure 9: Schedule Task Properties General tab Figure 10: Schedule Task Properties Triggers tab Figure 11: New Trigger dialog box Figure 12: Triggers tab - Begin the task: dropdown Figure 13: Triggers tab Settings Figure 14: Schedule Task Properties - Actions tab Figure 15: Actions - Start a Program Figure 16: Actions - Send Figure 17: Actions - Display a message Figure 18: Edit Action Figure 19: Schedule Task Properties - Conditions tab Figure 20: Schedule Task Properties - Settings tab Figure 21: Schedule Task Properties - Run Times tab Figure 22: Schedule Task Properties - History tab Figure 23: 3CX Audio Scheduler TTS Figure 24: Confirmation message box P a g e

6 What is 3CX Audio Scheduler? With 3CX Audio Scheduler you can schedule the playing of tones or alarms over your paging system (and phones). 3CX Audio Scheduler is great for notifying employees of break times, shift changes, and more. You can schedule multiple alarms throughout the day. You can play custom tones to meet your specific needs -- including fire alarms, tornado warnings, or shift change notifications. 3CX Audio Scheduler is a perfect solution for Schools, Airports, Shift work. Why 3CX Audio Scheduler? Schedule custom paging announcements or tones with 3CX Audio Scheduler. Use it to notify staff of break times, shift changes and more. What s New? Compatible with 3CX Version 15 Greatly simplified administration of scheduled audios Upload custom audio files Play an unlimited number of different audio files You can page to any device type including traditional overhead paging, phones, PA1 (and similar products) Improved installer allows you to add, edit, delete and run scheduled audio directly from the configuration screen Prerequisites Before installing 3CX Audio Scheduler, you need to ensure that your computer meets the minimum requirements mentioned below: 3CX Version Microsoft.Net VoIPToys Relay Agent (free) 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 5 P a g e

7 Installation Download software You can order 3CX Audio Scheduler on-line at Your order confirmation will include your license key and a link to download the software. Install Prerequisites There are a number of prerequisites that must be installed prior to installing 3CX Audio Scheduler. Install 3CX Audio Scheduler This User Guide contains step-by-step instructions to successfully install 3CX Audio Scheduler. Begin by extracting the installer from the downloaded zip file (Step 1 above), then run the setup program named AudioSchedulerInstaller.exe. Register your License Key You must register your license key to activate 3CX Audio Scheduler. Your license key is included in your order confirmation , and can also be found in your order history on our website. 6 P a g e

8 Step by step Installation Procedure The following section guides you through a detailed walk-through of the installation process. Step 1: Download 3CX Audio Scheduler You can check for the software download link included in your order confirmation . As an alternative, you can also find the link from your order history on our website. Step 2: Extract the installer from the downloaded.zip file The file you downloaded in the above step is a compressed.zip file. 1. Position the mouse on the zip file and right-click. 2. From the popup menu, select Extract All to extract the software. Step 3: Start the installation process 1. From the extracted folder, find the AudioSchedulerInstaller.exe. 2. Double-click the file to start the VoIPToys Setup Wizard. 3. Click Next to continue. Figure 1: Voiptools 3CX Audio Scheduler Setup Wizard 7 P a g e

9 Special note for Multi-tenant installations: If you are installing 3CX Audio Scheduler on a 3CX Cloud (Multi-tenant) server, an additional screen will display with a combo box containing a list of all installed tenants. Select the correct tenant and continue. Step 4: Download the VoIPTools 3CX Relay (if required) If you are installing 3CX Audio Scheduler on a separate server and pointing it to a 3CX Cloud server, you will need to tell the installer the name of the specific tenant desired. Start the installer from a command window and include an additional parameter: tenantname=<your-tenant-name>. Passing the tenant name to the installer will pre-fill the combo box with the correct tenant name. For example: 3CXAudioScheduler.exe tenantname=the3cxtenantname 3CX permits one 3 rd party application to communicate with the 3CX server at a time. To overcome this limitation, VoIPTools created the 3CX Relay Service. The Relay is a lightweight application that is installed directly on the 3CX server. The Relay exposes the 3CX Call Control API (and other VoIPTools services) to all our applications, and manages requests and events between by VoIPTools products and 3CX. The Relay also makes it possible to install our VoIPTools products on a remote server (including over the internet). If you have not previously installed the Relay on your 3CX Server, you can download the Relay installer by clicking on the Download Relay button. The Relay must be installed directly on the 3CX server. If you are installing 3CX Audio Scheduler directly on the 3CX server, you can install the Relay simply by clicking the Install/ Upgrade Relay button and following the Relay install instructions. If you have already installed the Relay, you need not install it again unless a newer version is required. Step 5: Test Relay Settings 1. In the Relay Services Host field, enter localhost if installing 3CX Audio Scheduler on the 3CX server. If 3CX resides on a different server, enter the IP address or FQDN of the 3CX server. 2. In the Relay Services Port field, enter the value as 8700 The default port number is 8700 but will likely be different in multi-tenant environment. 8 P a g e

3. Click Test Relay Settings to confirm 3CX Audio Scheduler can communicate with the Relay services running on the 3CX server. Figure 2: Test VoIP 3CX Relay settings 4.

10 3. Click Test Relay Settings to confirm 3CX Audio Scheduler can communicate with the Relay services running on the 3CX server. Figure 2: Test VoIP 3CX Relay settings 4. If the 3CX Audio Scheduler is successfully able to communicate with the Relay services that run on the 3CX server, Success confirmation message box appears. Click OK. 5. Click Next to continue the installation 9 P a g e

11 Step: 4 Run Application Once the installation is complete, click Run Application Figure 3: Run Application 10 P a g e

Step: 5 Register Registration is required to authorize your license key. Registering also makes it possible for VoIPTools to provide a replacement key if your license key is ever lost.

12 Step: 5 Register Registration is required to authorize your license key. Registering also makes it possible for VoIPTools to provide a replacement key if your license key is ever lost. Also, it enables VoIPTools to notify you of any product updates, and reminders if your key is reaching the renewal date. Figure 4: Register 3CX Audio Scheduler 1. On the 3CX Audio Scheduler configuration screen and in the License tab, enter your registration information in all the required fields (Note the red dot denotes a required field). 2. Click Register. The license key permits you to install the software on one computer. This is not free software. 11 P a g e

Settings The Settings screen enables you to set paging code that causes the phone to auto-answer, set path for Audio Folder to store audio files, upload a new or delete an existing audio file from

13 Settings The Settings screen enables you to set paging code that causes the phone to auto-answer, set path for Audio Folder to store audio files, upload a new or delete an existing audio file from the 3CX Audio Scheduler. 3CX Dial Code Figure 5: 3CX Audio Scheduler - Settings When dialing a phone, using the paging dial code will cause the phone to auto-answer (provided it is provisioned correctly). Under 3CX Dial Code section, in the Paging Dial Code field enter valid dial code that is already configured in the 3CX Management console. Dial codes are configured in the 3CX Management console at: V12.5: Settings Advanced Dial Codes Paging V14: Settings PBX Dial Codes Paging 12 P a g e

Audio Files Schedule Set Path for Audio Files 1. On the Audio Scheduler configuration screen and in the Settings tab, beside Audio Folder field, click Browse button. 2.

14 Audio Files Schedule Set Path for Audio Files 1. On the Audio Scheduler configuration screen and in the Settings tab, beside Audio Folder field, click Browse button. 2. Select appropriate folder to store the audio files you uploaded into the 3CX Audio Scheduler. Upload Audio File 1. In the Settings tab, click Upload button. 2. Browse for the audio file you want to upload. Delete Audio File 1. In the Settings tab, under Audio Files section, from the Audio File list box, select the audio file that you want to delete. 2. Click Delete button. Schedule tab enables you to create new scheduled tasks and delete, edit or run existing scheduled tasks. Figure 6: 3CX Audio Scheduler - Schedule 13 P a g e

From the Dial Ext dropdown, select the extension for which you want to schedule the new scheduled task. 4.

15 Create New Scheduled Task 1. In the Schedule tab and in the toolbar, click New button. Figure 7: Schedule tab - Toolbar 2. In the New Task dialog box, and in the Task Name field, enter the name for the scheduled task. Figure 8: Schedule tab - New Task 3. From the Dial Ext dropdown, select the extension for which you want to schedule the new scheduled task. 4. From the Audio File dropdown, select the audio file that you want to play for this new scheduled task. 5. If you want the phone to auto-answer the call, check Use Dial Code box. 6. Click Create Task. New Trigger dialog box appears. 7. In the New Trigger dialog box, enter appropriate details in all the fields of all the tabs. For more details, see New Trigger dialog box and for its definitions, see Trigger Type and Trigger Settings tables. 14 P a g e

Edit Scheduled Task 1. In the Schedule tab and from the Scheduled Tasks list box, select the scheduled task that you want to edit. 2. From the toolbar, click Edit button.

16 Edit Scheduled Task 1. In the Schedule tab and from the Scheduled Tasks list box, select the scheduled task that you want to edit. 2. From the toolbar, click Edit button. Schedule Task Properties dialog box appears. General tab General tab allows you to set general properties of a task. 1. In the Schedule Task Properties dialog box and in the Description text field, enter the description for the task. Figure 9: Schedule Task Properties General tab 2. Click Change User or Group button to select a different user or group account for a task to run under. 3. Select Run only when user is logged on option if you want to run the task interactively. 4. Select Run whether user is logged on or not option if you want to run the task when the user is logged in or not. When you select this option, you may be prompted to enter account credentials while saving the task, regardless of whether you checked Do not store password box or not. 15 P a g e

17 5. Check Do not store password box if you do not want the Task Scheduler to store the credentials on the local computer. 6. Check Run with highest privileges to allow the scheduler to run the task that is registered using the Administrators group. 7. From the Configure for dropdown select the operating system that the task is configured for. 8. Check Hidden box if you want to hide the task. Triggers tab When you create a task, you can specify the conditions that will trigger the task. From the Triggers tab, you can view the list of existing triggers for the schedule task, add new trigger and, edit or delete existing trigger. You can access trigger settings from the New Trigger or Edit Trigger dialog box. Figure 10: Schedule Task Properties Triggers tab 16 P a g e

In the New Trigger dialog box, from the Begin the task

18 Add New Trigger 1. In the Triggers tab, click New button. New Trigger dialog box appears. Figure 11: New Trigger dialog box 2. In the New Trigger dialog box, from the Begin the task dialog box, select appropriate trigger. For more details, see Trigger Type table below. Figure 12: Triggers tab - Begin the task: dropdown 17 P a g e

3. From the Settings section, select appropriate trigger setting and set the time at which you want the trigger to occur. For more details, see Trigger Settings table below.

19 3. From the Settings section, select appropriate trigger setting and set the time at which you want the trigger to occur. For more details, see Trigger Settings table below. Figure 13: Triggers tab Settings 4. In the Advanced settings section, Edit Existing Trigger Delete Trigger a. Check Delay task for up to (random delay) box to specify an amount of time to delay the task from running, after the task is triggered. b. Check Repeat task every box to set a repetition time interval for the task. The task will run, wait for the time interval specified, and then run again. This cycle will continue until the duration time is met. c. Check Stop task if it runs longer than: box to stop long running tasks by setting a time limit on the amount of time the task is allowed to run (execute the action). d. Check Expire box to set a date and time for the trigger to expire. e. Check Enabled box to enable the task so that it can run. f. Click OK. 1. In the Triggers tab, click Edit button. Edit Trigger dialog box appears. 2. Edit all the required details. (See Trigger Type and Trigger Settings tables for more details) 3. Click OK. 1. In the Triggers tab, from the trigger list box, select the trigger that you want to delete. 2. Click Delete. 18 P a g e

20 Table -1: Trigger Type definitions Begin the task: dropdown On a schedule At log on At start up On idle On an event At task creation/ modification On connection to user session On disconnect from user session On workstation lock On workstation unlock This trigger causes the task to run according to a schedule, and the trigger settings allow you to set the schedule. This trigger causes the task to run when a user logs on to the computer, and the trigger s settings allow you to specify that the task should be triggered when any user logs on the computer or when a specific user logs on. This trigger causes the task to run when the computer starts up. The only settings for this trigger are the described in the Advanced Settings section of the New Trigger dialog box. This trigger causes the task to run after the computer enters an idle state, and the idle settings can be set from the Conditions tab in the Create Task or Task Properties dialog box. This trigger causes the task to run when specific event entries are added to an event log. This trigger causes a task to run as soon as it is created and when the task is modified. The only settings for this trigger are the advanced settings described in the Advanced Settings section of the New Trigger dialog box. This trigger causes a task to run when a user session is connected to from the local computer or from a remote desktop connection. This trigger causes a task to run when a user session is disconnected from the local computer or from a remote desktop connection. This trigger causes the task to run when the computer is locked. This trigger causes the task to run when the computer is unlocked. 19 P a g e

21 Table -2: Trigger Settings definitions Trigger Settings One time Daily Weekly Monthly Actions tab Choose date and time to trigger the task. Choose the recurrence interval for the task and the date and time to start the task. An interval of 1 produces a daily schedule and an interval of 2 produces an every other day schedule. The task will start at the specified time each day. Choose the recurrence interval for the task, the date and time to start the task, and the days of the week in which to start the task. An interval of 1 produces a weekly schedule and an interval of 2 produces an every other week schedule. The task will start at the specified time on each of the specified days. Choose the months in which you want to start the task and the weeks of the month and the days of the week for each month in which you want to start the task. You can also specify that you want to start a task on the last day of each month. A task action is the work that is performed when the task has run. A task can have single action or a maximum of 32 actions. Each action contains settings that determine how the action is performed. When you create a task, you must specify the action that will occur when your task starts. You can access Actions settings when you create a new or edit an existing action. Figure 14: Schedule Task Properties - Actions tab 20 P a g e

Add New Action 1. In the Actions tab, click New button. New Action dialog box appears. 2. From the Action dropdown, a. Start a program This action starts a program on script. i.

22 Add New Action 1. In the Actions tab, click New button. New Action dialog box appears. 2. From the Action dropdown, a. Start a program This action starts a program on script. i. In the Program/ script text box, enter the name of the program or script that you want to start. ii. iii. In the Add arguments (optional) text box, enter the arguments if the program or script takes command line arguments. In the Start in (optional) text box, you can specify the working directory for the command line that executes the program or script. This should be either the path to the program or script file or the path to the files that are used by the executable file. Figure 15: Actions - Start a Program 21 P a g e

b. Send an e-mail This action sends an e-mail when a task is triggered. i. In the From field, enter the e-mail address that acts as the sender of the mail. ii. iii. iv.

23 b. Send an This action sends an when a task is triggered. i. In the From field, enter the address that acts as the sender of the mail. ii. iii. iv. In the To field, enter the address that the mail will be sent to. In the Subject field, enter the subject of the . In the Text field, enter the message. v. As an optional, you can browse and add an attachment. vi. vii. In the SMTP server field, specify the SMTP server that you use to send from. Click OK. Figure 16: Actions - Send 22 P a g e

24 c. Display a message This action shows a message box with a specified message and title. i. In the Title field, enter the title for the message. ii. iii. In the Message field, enter the message that you want to send. Click OK. Figure 17: Actions - Display a message 23 P a g e

Edit Action 1. In the Actions tab, click Edit button. Edit Action dialog box appears. 2. Edit all the required details. (See New Action dialog box for more details) 3.

25 Edit Action 1. In the Actions tab, click Edit button. Edit Action dialog box appears. 2. Edit all the required details. (See New Action dialog box for more details) 3. Click OK. Delete Action Figure 18: Edit Action 1. In the Actions tab, from the actions list box, select the action that you want to delete. 2. Click Delete. 24 P a g e

Conditions tab Conditions control whether a task along with the trigger should run. The task will not run if any condition specified is not true.

26 Conditions tab Conditions control whether a task along with the trigger should run. The task will not run if any condition specified is not true. Conditions are of 3 categories: Idle conditions are set to run the task only when the computer is in an idle state for a specific amount of time when a task trigger is activated. Power conditions are set to run the task only when the computer runs on AC power (not battery power) when the task trigger is activated. If this condition is set, the task will stop if the computer switches to battery power. Network conditions are set to run the task only if a specified named network connection is available or if any network connection is available when the task s trigger is activated. If your task action requires a network connection to execute, then set this condition. Figure 19: Schedule Task Properties - Conditions tab 25 P a g e

27 Idle Conditions 1. Check Start the task only if the computer is idle for: box if you want the task scheduler to start the task if the computer is idle for the specified time. You can select the time from the dropdown. 2. From the Wait for idle for dropdown, select the amount of time to wait (after the task is triggered) for the computer to enter an idle state. 3. Check Stop if the computer ceases to be idle check box so that when a task is running while the computer is in idle state will stop running when the computer ceases to be idle. 4. Check Restart if the idle state resumes box so that the task that stopped when the computer was in idle state will start running again the next time the computer enters an idle state. Power Conditions 1. Check Start the task only if the computer is on AC power box if you want to run the task only when the computer runs on AC power. 2. Check Stop if the computer switches to battery power box to stop the task if the computer switches to battery power. 3. Check Wake the computer to run this task box to wake the computer from sleep mode and run the task when the trigger is activated. Network Conditions Settings tab 1. Check Start only if the following network connection is available box if your task action requires a network connection to execute. 2. From the network connection dropdown, select required network connection so that the task will run when the specified network is available. Settings tab enables you to specify additional settings that affect the behavior of the task. The task settings specify how a task should run, stop or delete. 1. Check Allow task to be run on demand box if you want to run the task at any time on demand. 2. Check Run task as soon as possible after a scheduled start is missed box so that the Task Scheduler service will start the task if the task was scheduled to run at a certain time, but for some reason the task was not activated. 26 P a g e

The Task Scheduler service will not start the task immediately after the task was missed. By default the service waits for ten minutes before starting the missed task. 3.

28 The Task Scheduler service will not start the task immediately after the task was missed. By default the service waits for ten minutes before starting the missed task. 3. Check If the task fails, restart every: box to restart a task if the last run of the task fails. From the dropdown, specify the time interval that takes place between task restart attempts and the number of times to try to restart the task. 4. Check Stop the task if it runs longer than: box to limit the amount of time a task is allowed to run and from the dropdown, select appropriate time. 5. Check If the task is not scheduled to run again, delete it after: box so that the task Scheduler service will automatically delete the task after waiting for the specified time period, if it is not scheduled to run again. Figure 20: Schedule Task Properties - Settings tab 27 P a g e

29 Run Times tab 6. From the If the task is already running, then the following rule applies: dropdown, a. Do not start a new instance The Task Scheduler service will not run the new instance of the task and will not stop the instance that is already running. b. Run a new instance in parallel The Task Scheduler service will run the new instance of the task in parallel with the instance that is already running. c. Queue a new instance The Task Scheduler service will add the new instance of the task to the queue of tasks that the service will run, and the service will not stop the instance of the task that is already running. d. Stop the existing instance The Task Scheduler service will stop the instance of the task that is already running, and run the new instance of the task. Run Times tab allows you to view the scheduled tasks have not yet run and are ready to run once the time arrives. 1. From the From calendar, select appropriate date and time from which you want to see the run times of the scheduled tasks that need to run. 2. From the To calendar, select appropriate date and time before which you want to see the run times of the scheduled tasks that need to run. Figure 21: Schedule Task Properties - Run Times tab 28 P a g e

Delete Scheduled Task Run Scheduled Task Figure 22: Schedule Task Properties - History tab 1.

30 History tab History tab enables you to view the scheduled task logs that had run. The details include level, date and time, event id, task category, operation, and correlation id. To view further details, select the log and click General and Details tabs. Delete Scheduled Task Run Scheduled Task Figure 22: Schedule Task Properties - History tab 1. In the Schedule tab and from the Scheduled Tasks list box, select the scheduled task that you want to delete. 2. From the toolbar, click Delete button. 1. In the Schedule tab and from the Scheduled Tasks list box, select the scheduled task that you want to run. 2. From the toolbar, click Run button. The scheduled task causes to perform the call. 29 P a g e

31 TTS The TTS screen enables you to type the text that you want the Audio Scheduler to convert into speech. The conversion will be done according to the Culture you select and the voice of the speech will be according to the Voice you select. Figure 23: 3CX Audio Scheduler TTS 1. On the 3CX Audio Scheduler configuration screen, in the TTS tab, and in the Text- To-Speech textbox, type the text that you want the Audio Scheduler to convert into speech. 2. From the Culture dropdown, select the type of language into which you want to the Audio Scheduler to convert the Text-To-Speech. 3. From the Voice dropdown, select the voice so that the Text-To-Speech audio file will play according to the voice you have selected. 4. In the File Name field, enter the name for the Text-To-Speech audio file. 30 P a g e

32 5. Click Save to save the Text-To-Speech audio file. 6. Confirmation message box appears. Click OK. Figure 24: Confirmation message box 7. Click Play to play the Text-To-Speech audio file. Every time you play the Text-To-Speech audio file, you should save it or else the file will be deleted from the database. 31 P a g e

33 Support If you need support, would like to request an enhancement to 3CX Audio Scheduler, or are interested in discussing a custom solution, you can contact as at the following: Address: Hours: 2306 Shimmering Bay Lane Cincinnati, OH Monday Friday 8:00 A.M. 5:00 P.M. Central Standard Time Phone: USA: Skype: Web: VoIPToys info@voiptools.com 32 P a g e

User Guide. Reception. Version

User Guide. Reception. Version User Guide Reception Version 15.5.9 "Copyright VoIPTools, LLC 2011-2018" Information in this document is subject to change without notice. No part of this document may be reproduced or transmitted in any