-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathUPGRADE
More file actions
3708 lines (2654 loc) · 160 KB
/
UPGRADE
File metadata and controls
3708 lines (2654 loc) · 160 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
################ UPGRADE
NOTE: Upgrading from 2.11 to 2.13 is below the first section
NOTE: Upgrading from 2.9 to 2.11 is below the first section
NOTE: Upgrading from 2.7 to 2.9 is below the first section
NOTE: Upgrading from 2.4 to 2.7 is below the first section
NOTE: Upgrading from 2.2.1 to 2.4 is below the first section
NOTE: Upgrading from 2.0.5 to 2.2.0 is below the second section
NOTE: Upgrading from 2.0.4 to 2.0.5 is below the third section
NOTE: Upgrading from 2.0.3 to 2.0.4 is below the fourth section
NOTE: Upgrading from 2.0.2 to 2.0.3 is below the fifth section
NOTE: Upgrading from 2.0.1 to 2.0.2 is in the next section
NOTE: Upgrading from 1.1.12-3 to 2.0.1 is at the bottom
########## UPGRADING FROM 2.13 TO 2.14 ##########
OPTIONAL STEPS(But highly recommended) - Backup existing system:
1. Run this for a 1-server system or server with database on it:
(this may take hours on large system)
/usr/share/astguiclient/ADMIN_backup.pl --debugX
2. Run this on dialer/Asterisk-only servers:
(do not run this if you only have one server):
/usr/share/astguiclient/ADMIN_backup.pl --debugX --without-db --without-web
REQUIRED STEPS!!!
1. Check system_settings, make sure you are at DB Schema Version 1478 or higher
If not, run the instructions for 2.11 to 2.13 before this section.
2. upgrade the MySQL asterisk database(you have two options):
A. Running the upgrade file directly from Linux:
mysql -f --database=asterisk < /path/from/root/extras/upgrade_2.14.sql
B. Going into mysql and executing the upgrade sql file:
mysql
use asterisk
\. /path/from/root/extras/upgrade_2.14.sql
quit
3. install new files:
perl ./install.pl
NOTES: If you have customized any scripts in the bin or agi folders,
then make sure you back them up before running the install.pl script.
This script will replace existing files in the astguiclient installation.
4. For each of your ViciDial servers, go the Admin -> Servers -> Modify Server
page and set each one to "Rebuild conf files = Y" and click submit.
This will rebuild the conf files to ensure any changes are updated.
5. On one server only, update your phone codes data:
/usr/share/astguiclient/ADMIN_area_code_populate.pl --purge-table --debug
OTHER CHANGES:
1. Added AST_inbound_export.pl script for in-group call data exports
2. Added cm_sc_areacode.agi script that allows you to use a Settings Container
with the script in a Call Menu to define different destinations for
customers from each state to go to: DID, CALLMENU, EXTEN
3. Added Agent DID Report
4. Added the ability for internal chats to have more than one agent participant
5. Added cm_phonesearch.agi script that can search for a phone number within the
system and redirect a call to an in-group that is defined as the Default
Transfer Group in a campaign that the lead belongs to. This must be
configured in a Call Menu
6. Added In-Group option to populate new leads with a DID descriptive value in
the province field of the new lead.
7. Added cm_sc_send_url.agi script for Call Menus on calls tied to a lead_id to
send a URL defined in a Settings Container.
8. Added phone_number_log Non-Agent API export function
9. Added api_only_user User option to prevent access to admin and agent screens
by an API-only user account.
10. Added logging of API request URLs
11. Added campaign setting for Dead Call to Dispo Only, to allow the Dead Call
Max Seconds setting to send the agent to the dispo screen
12. Added web lead loader duplicate check options to check for leads loaded only
within the last 90-days. Also added to Non-Agent API add_lead function.
13. Added Agent API function switch_lead to switch the active call lead_id while
the agent is on a live inbound phone call.
14. Added In-group areacode_filter feature, allowing you to drop calls after a
set number of seconds in queue that either match or do not match a list
of areacodes defined per in-group.
15. Added new DNC options to Manual Dial Filter campaign feature that are not
tied to the campaign DNC settings.
16. Changed Emergency Logout processes to hangup all agent session calls, and
added better logging
17. Changed Custom Fields of SCRIPT type to allow URLs and urlencoded variables
when using --U-- and --V-- to declare variables
18. Added option for custom list fields to be required for all calls or only
inbound calls. Will prevent agent hanging up call if field is not filled
in. Must also have campaign option enabled for it to work. Will work for
the following custom field types:
TEXT, AREA, DATE, SELECT, MULTI, RADIO, CHECKBOX
19. Added admin Automated Reports section, allowing easier web configuration of
scheduled reports being sent by Email or FTP.
20. Added campaign option to validate transfer agent list based upon which
AGENTDIRECT in-groups those agents had selected.
21. Added In-Group option to look up the state based upon the areacode of the
caller ID phone number of the person calling in.
22. Added CHAT option to Inbound Queue No Dial campaign setting to prevent
outbound auto-dialing if a chat is waiting for an agent
23. Added qualify option to phones for IAX type phones
24. Added Pause Code Time Limits to allow you to set a time limit on the number
of seconds an agent can be in a specific pause code before the real-time
report will show them in a different color.
25. Added Drop Lists feature, allowing you to add new leads to a list built from
DROPped calls from inbound groups on a scheduled basis.
26. Added USER_CUSTOM_ options to campaign custom callerID setting to allow for
custom caller IDs to be used per agent in MANUAL and INBOUND_MAN modes
27. Added IP Lists feature, allowing creating of lists of IP Addresses that can
be used as whitelists on a User Group basis for Agent, Admin and API
web resources.
28. Added campaign option(with user override) Ready Max Seconds Logout to log an
agent out of the agent screen if they have been in a ready state for
more than X seconds.
29. Added cm_fpg.agi script to allow callers to place their phone numbers into a
Filter Phone Group. Works from a Call Menu.
30. Added Inbound and Advanced Forecasting Reports. Both use the Erlang formulas
and past data to forecast agent and call metrics.
31. Added campaign option for Callbacks Display Days which can limit the
scheduled callbacks displayed to an agent by a number of days from now
32. Added campaign options to stop recording when a 3-way call is started and
start recording when the hangup xfer line button is clicked
33. Added start call URL feature support for manual dial calls
34. Added logging of Real-Time report monitoring, and report in Admin Utilities
35. Added Agent Push Events, allowing for HTTP Push events to be sent on agent
screen events. See the AGENT_EVENTS.txt doc for more details.
36. Added Add-to-hopper options to update_lead function in the Non-Agent API
37. Added basic one-way Cross-Cluster-Communication feature. Allowing for lead
information to pass from one VICIdial system to another with a call.
See the CROSS_CLUSTER_COMMUNICATION.txt document for more information.
38. Added Real-Time agent status of "DIAL" for agent manual dial calls after
they have been placed but before they have been answered.
39. Changed password fields to allow up to 100 character passwords. Also changed
password recommendations to emphasize length over complexity.
40. Added logging and notification of 3-way call hung up in agent screen.
41. Added URL logging of Agent Screen Webform button clicks and URLs
42. Added AST_agent_wait_check.pl script to send out emails if there are agents
waiting more than X seconds.
43. Added In-Group option to ask callers if they would take a survey after
agent has handled their call. Overrides agent HANGUP CUSTOMER button
to send call to survey instead.
44. Added system setting to allow Lead Management admin utilities to handle
active lists. Also changed Advanced Lead Management tool to allow
you to select multiple lists.
45. Added Inbound DID Summary Report
46. Added Agent Inbound Status Summary Report
47. Added experimental support for Asterisk 13. See the ASTERISK_13.txt doc
for notes on changes needed to get it to work.
48. Added System Settings option to set lists to inactive once they pass their
expiration date
49. NEW REQUIREMENT!!! Perl CPAN Net::Telnet version 3.0.4(April 21, 2013)
If you are using an older Net::Telnet version, you will need to upgrade!
this should take just two commands: "cpan" and "install Net::Telnet"
50. Added DID System-wide filter option to System Settings
51. Added DNC.COM inbound number filtering with DNCcom_inbound_filter.php
52. Added cm_cid_change.agi script to alter the CID of calls in the Call Menu
Prompt. Also, added ability for cm_dnc.agi to recognize Vicidial-tagged
calls and update lead records without lookups from a phone number
53. Added Webphone Layout option in Phones and override in User Groups
54. Added campaigns-scheduled_callbacks_email_alert option to send email alerts
to agents when scheduled callbacks are triggered while they are logged
in to the agent screen. Read the HELP for instructions to set up.
55. Added new Real-Time Whiteboard multi-report
56. Added the ability to include duplicate custom text fields in a custom fields
form in the agent screen.
57. Added Max Inbound Calls Outcome to allow for different behaviors when an
agent reaches their maximum inbound calls for the day
58. Added campaign option to allow agents to pause the Manual Dial Auto Next
feature
59. Added ability to display inbound email messages in Script tab scripts.
60. Added dispo_change_status.php script to allow changing of a lead's status
to a different status after it has been dispositioned as a specified
status a set number of times.
61. Added Agent Screen Time Report campaign option, to display agent time
statistics in the agent screen for the current day.
62. Added List Override setting for Default Transfer Group
63. Added lead_status_search Non-Agent API function
64. Added "Next-Dial My Callbacks" campaign setting that will automatically dial
USERONLY Scheduled Callbacks for agents in MANUAL or INBOUND_MAN
no-hopper campaigns when they click DIAL NEXT NUMBER in the agent screen
65. Added "Anyone Callback Inactive Lists" System Setting option to determine
how ANYONE scheduled callbacks from inactive lists should be handled.
66. Added "Inbound No-Agents No-Dial" Campaign setting, checks if any agents are
ready and waiting for phone calls from listed In-Groups before allowing
outbound auto-dialing.
67. Added new PRESS_CALLBACK_QUEUE option to Hold Time and Wait Time In-Group
settings, allowing for a customer to retain their place in line in the
queue and be called back when their turn is reached.
68. Added new Closed Time features to In-Groups that allow all calls in queue
to be presented with an option when the in-group closing time for the
day has been reached. Also, an option was added to manually force the
end of all queueing of calls for an in-group for the day.
69. Added dial_ingroup option to Agent API external_dial function.
70. Added In-Group option to look up timezone of customer when a new lead is
added during the routing of the call.
71. Added the Outbound Lead Source Report
72. Added basic GDPR features for lead activity download and delete. Must enable
System setting and user permission to use.
73. Added CID Groups, allowing for groups of caller IDs to be defined by state
or areacode, and allowing a single CID Group to be set across multiple
campaigns.
74. Added NO_READY option for no_agent_no_queue in-group feature.
75. Added campaign option "Script on top of Dispo" to allow the agent screen
script tab to cover the dispo screen after hanging up the customer to
allow for Agent-API-enabled IFRAMEs to control the agent dispo process.
77. Added feature to allow for bulk change of campaign and in-group ranks and
grades in the User Modify page.
76. Added "Admin Lead Source ID Display" System Settings option to allow Modify
Lead page modification of Source ID field, and display in hopper list.
77. Added LOCALFQDN trigger for webforms and script Iframes to allow for use of
absolute URLs on multi-home networks. See CALL_URL_FEATURES.txt doc.
78. Added update_did Non-Agent API function
79. Added pause code manager approval option, requires a manager to approve a
specific flagged pause code before the agent is allowed to use it in
their agent screen. Manager approves by entering their login credentials
into a window on the agent's screen.
80. Added DISPO_FILTER Settings Container option allowing for match-and-replace
function in Dispo Call URLs. See CALL_URL_FEATURES.txt doc for details.
81. Added populate_lead_vendor and populate_lead_source options for In-Groups.
82. Added In-Group option to override the Park Music-on-Hold.
83. Added SWITCH custom field type to put buttons on the agent FORM to allow for
the form to be switched while on an active call.
84. Rewrote HELP display in web admin screens to function as database-driven
javascript popup.
85. Added per-user options for maximum number of outbound manual dial hopper
calls per-hour and per-day.
86. Added In-Group option for Waiting Call On/Off URL, which we added to allow
a client to control a web-power-switch to turn lights on and off if
there are any calls waiting in an In-Group.
87. Added In-Group option for Enter In-Group URL, which can send a URL request
when a caller enters an In-Group right before the system looks for an
agent to send the call to.
88. Added Manual Dial Routing Initiated Recording, must enable setting at the
campaign level and have a 0 recording delay.
89. Added campaign features for Dead Call Trigger. Allowing an audio alert to be
sent to an agent and/or a back-end URL to be submitted when an agent has
been in a dead call for X number of seconds.
90. Added the ability for customers to be able to enter a new phone number to be
called back on for the CallerID CallBack Queue feature.
91. Added the new Callmenu Survey Report(linked as "Callmenu Agent" in Reports).
92. Added "Agent Screen Logout Link Credentials" System Setting to change the
agent screen logout page login link to not include user credentials.
93. Added new campaign feature to force agents to call back their triggered
USERONLY Scheduled Callbacks.
94. Added new campaign feature to automatically reschedule ANYONE callbacks when
they are dispositioned as a non-Human-Answered status flag status.
95. Added new campaign feature to allow agents to select a specific timezone to
use when scheduling callbacks. For this to work, the Phone Codes must be
updated on your system using the following command:
/usr/share/astguiclient/ADMIN_area_code_populate.pl --purge-table --debug
96. Added new 'force_fronter_leave_3way' Agent API function, allowing an API
command to be sent to the fronter of a call to leave-3way their call.
97. Added List Daily Reset Limit option, only editable by level 9 users.
98. Added 3-Way Volume Buttons campaign setting to allow disabling of volume
and mute buttons in the LIVE CALLS IN YOUR SESSION panel during a 3-way
call.
99. Added campaign setting to filter ANYONE Scheduled Callbacks by the DNC
settings set in the campaign
100. Added _wait_time options to Next Agent Call settings for Campaigns and
Inbound Groups.
101. Added External Web Socket URL option so a WebRTC phone can be used outside
a network if the Phone is set to Use External Server IP = Y
102. Added SYSTEM options to the campaign detail Manual Dial Filter feature
103. Added lead_callback_info Non-Agent API function, it outputs scheduled
callback data for a specific lead
104. Added Manual Dial Validation campaign and system settings, forces agent to
manually enter in the phone number before a call is placed. Does not
affect 3way calls or transfers.
105. Added alphabet letters translation to phone DTMF digits feature in Agent
Screen. For example, Putting "SMITH" in the SendDTMF field would result
in "76484" being sent over DTMF.
106. Added "force_fronter_audio_stop" Agent API function, allowing an API
command to be sent to the fronter session of a closer call to stop
playing of an audio_playback pre-recorded audio stream
107. Added options to define the static prompts to use for the Inbound Group
"Play Place in Line" feature
108. Added new web pages for mobile application
109. Added feature allowing agents to mute recordings of calls from the agent
screen. Must be enabled in System Settings to be able to use it in
campaigns. There is also a User Override option.
110. Added more options to the Campaign "Hide Call Log Info" feature to be able
to show only the last X number of calls in the Lead Info screen. Also
added a User Override setting for this feature.
111. Released VICIdial Manager Manual version 2.14-704a:
http://www.vicidial.org/store.php#MANAGER
112. Added more logging for Asterisk AMD as well as beta AMD patch for logging
of NOAUDIODATA answered calls and more AMD stats gathering. Also added
an AMD Log Report to the Admin Utilities page.
113. Added Admin User Redirect URL settings, which allows you to define a web
address that a user is to be sent to when they log in to the admin web
screen. This is usually used for level 7 report only users to send them
to one specific report when they log in without seeing the admin web
screen at all. Must be enabled in System Settings.
114. Added experimental SIP event logging. Requires patched Asteirsk 13 and
newer version of MySQL/MariaDB. Must be enabled in System Settings and
each dialer's astguiclient.conf/extensions.conf/manager.conf files
Read SIP_EVENT_LOGGING.txt doc for more details
115. Added new Non-Agent API function 'update_cid_group_entry' which allows you
to add/update/delete/info CID Group entries and AC-CID entries
116. Added new Non-Agent API 'custom_fields_copy' option to the 'add_list'
function
117. Added new Call Quota Lead Ranking recycling feature-set. A new and
completely different way to do lead recycling for outbound campaigns.
See the CALL_QUOTA_LEAD_RANKING.txt document for more info
118. Added bench_agent_assign.php script to allow managers to move
'owner-assigned' to another agent.
119. Added User Inbound Max Calls filtering options. Allowing selective counting
of inbound calls excluding calls involving set in-groups, statuses and
with a minimum time threshold. Also, new in-group routing options based
on last non-filtered call times
120. Added System Settings option for second agent screen script tab
121. Added a Campaign option for VoiceMail Message Groups, allowing agents to be
able to select a message to transfer a customer answering machine to
from a list of pre-recorded messages that can be defined by time-of-day.
122. Added a Campaign option to not send an agent immediately to the disposition
screen after transferring a customer call to a VoiceMail Message.
123. Added Campaign option for Dial Timeout Lead overrides, allowing you to set
up a Settings Container with values for manual-dial and/or auto-dial
lead fields and associated values that will tie to different
Dial Timeouts.
124. Added LTMGAD and XAMMAD Campaign Hotkey options that will transfer to the
Leave-Voicemail option as well as dispositioning the call.
125. Added a per-User option to define an additional Status Group of call
statuses that agents can use to disposition all calls they handle.
126. Added System Setting to hide the first web form button on the agent screen.
127. Added System Setting options for alternate agent screen recording buttons.
This includes different wording, different sizes and removing the blank
space below the recording buttons.
128. Added ability to play multiple audio prompts for outbound survey campaigns
and to use DYN for lead field wildcards defined as audio prompts.
129. Added ability to limit the number of voicemail messages played to a single
lead per day, as a campaign setting.
130. Added CID Group Type of NONE to allow for a group of outbound CIDs to be
used for all outbound phone calls no matter where they are.
131. Added Auto-Rotating CID Group numbers, allowing for timed automatic cycling
of CID numbers, one-at-a-time, within a CID Group.
132. Added optional OpenSIPs CallerID Name settings, for use only with systems
that use an OpenSIPs server to route outbound calls where this feature
has been enabled.
133. Added system settings option to require passwords of a set minimum length.
This setting affects User passwords, Phone and Server registration
passwords and the System Settings default passwords.
134. Added support for KHOMP Answering Machine Detection. This is a 3rd-party
commercial(paid-for) solution. The code and documentation can be found
in the "extras/KHOMP" directory of the codebase.
135. Added AMD Agent Route Options as a campaign option allowing you to set
the specific AMD responses for calls that should be routed to agents
136. Added the "list_custom_fields" Non-Agent API function, to show all list
custom data fields in a list/all-lists.
137. Added an optional "send this user a login link email" link to the User
Modify page to send a shortcut URL link for the agent to more easily
log into the agent screen. Must be enabled in System Settings.
138. Added new System Settings option to allow sending of any CallerID through
the Agent API for external_dial outbound calls.
139. Added system setting to allow you to restrict Admin Phones display to a
set number of records per page.
140. Added options at the campaign and in-group levels to allow you to play
alert sounds when a call arrives in the agent's session, in the agents'
web browser that they are logged into the agent screen with. Must be
enabled in system settings.
141. Added "3-Way Recording Stop Exception" campaign option to override the
"3-Way Recording Stop" setting based upon the 3way phone number dialed.
142. Added the ability to use Automated Reports with standard SFTP and FTPSSL
remote servers.
143. Added the ability to configure when the Answer signal is sent to inbound
calls at the DID, In-Group and Call Menu level. For this to work, you
must set the conf files to be rebuilt after upgrading your systems.
144. Added options for HTML formatting and UTF-8 charset in emails through the
dispo_send_email.php script.
145. Added tools for International DNC phone number scrubbing. See the
INTERNATIONAL_DNC_SCRUB.txt doc for more information.
146. Added option '2' to the User Modify "Modify Leads" setting allowing admin
users to modify all lead fields except for phone number and alt phone.
147. Added campaigns_list & hopper_list functions to the Non-Agent API
148. Added code and instructions for multi-campaign outbound agents, see the
AGENT_MULTI-CAMPAIGN_DIALING.txt doc
149. Added Screen Colors option to set the submit button color on the admin
screens and reports.
150. Added the ability to modify the status of any call or agent log in the
Admin Modify Lead page. Must use new 'Modify Leads' options to enable
for a user.
151. Added system settings allowing you to remove digits from the beginning of
a phone number when it is manual dialed or through the web lead loader.
152. Added Pause Max Exceptions campaign setting, allowing for exceptions to the
Agent Pause Max feature for specified Pause Codes.
153. Added optional display of parked call stats and SLA 1&2 percentages to the
Real-Time Report
154. Added Campaign setting for Hopper Drop-Run triggering. Forcing the one-time
hopper insertion of DROP status leads instead of standard hopper loading
155. Added Agent API function 'vm_message' allowing you to set the VM message to
be played to a customer when the agent clicks on the VM button in the
agent screen.
156. Added Daily Called Count Limits as a campaign setting, with options to
count and/or restrict for manual dial calls or not.
157. Added Transfer-Conf Button Launch campaign setting, allowing you to set a
webform window to open when an agent clicks on the Transfer-Conf button.
158. Added SHARED_... campaign dial method auto-dial options, for more efficient
agent multi-campaign dialing. Read the AGENT_MULTI-CAMPAIGN_DIALING.txt
document for more information.
159. Added Agent Search Method override options for campaigns and in-groups.
160. Added 'copy_user' function to the Non-Agent API.
161. Added 'add_did' function to the Non-Agent API.
162. Added new SOURCESELECT Custom Field Type, it is a single-selection pull-
down menu where there are multiple sets of options available depending
on the value of another field for the lead. Also added the ability to
perform basic Math functions within a SCRIPT Custom Field using values
from other fields in the equations. For more information on how both of
these new features work, see the Field Options help in the admin web
screen.
163. Added Phone Defaults system setting, allowing you to set many default
values when adding new phones through admin.php. Also added a Copy New
Phone admin web function.
164. Redesign of QC module, with new QC scorecards, the ability to do QC by
Campaign/List/In-Group, new reporting and more. See the
docs/QC_PROCCES.txt document for more information.
165. Added the BUTTON Field Type option to Custom List Fields. Allows you to add
a button to the form that will commit any changes made in the form and
automatically reload the form.
166. Added Two-Factor Authentication(2FA) as an option for the admin web screens
This adds a required second step to the admin web screen login process
through a method other than a password, such as: an Email, Phone Call or
Text-Message(SMS). This 2FA auth also lasts only a set amount of time
(defined in System Settings[number of hours, from 1-9999 hours]), or
until the user logs out. For more information, read the
2FA_TWO_FACTOR_AUTHENTICATION.txt document.
167. Added a page to allow Editing existing Lead Loader Templates.
168. Added System Settings for "Agent Hidden Browser Sound" to repeatedly play
a selected sound at a set interval to an agent when their Agent Screen
is hidden from view. Can be used to disable web browser javascript
throttling if set to an audible sound at a 20 second interval. Tested
with the 'click_quiet' sound file at a volume of '25'.
169. Added WAV audio file validation for Audio Store, and display of badly
formatted WAV files in the audio chooser in admin.php
170. Added "Leave 3-Way Start Recording" campaign feature that will start a new
recording after the agent clicks on the LEAVE 3WAY button and leaves the
call. Also includes an "Exception" option to disable/enable only for
specific 3-way call numbers.
171. Added "Populate Lead Comments" In-Group option, allowing configuration of
how the 'comments' lead field is filled-in when a new lead is inserted
because of an inbound phone call.
172. Added options to add/update/delete custom fields within the 'update_list'
function of the Non-Agent API.
173. Added Settings Compare Utility page to Admin Utilities to allow you to
compare the settings from two records in your system and see what
settings are different between the two.
174. Added campaign options to add extra lead-field columns to the "Calls In
Queue" panel in the agent screen.
175. Added Calls In Queue Count Display campaign options, allowing for two
separate Calls Waiting counters at the top of the agent screen, each
with separate configurable labels and in-group/campaign parameters.
Also, this can be used with the alt_display.php script.
176. Added new "Music on Hold Suggest" Phones setting for SIP and IAX phones.
It will define the Hold music played to a customer when the phone user
puts them on hold through the phone.
177. Added compatibility with TILTX STIR/SHAKEN Call Shaper pre-carrier call
filtering service. Read the TILTX_SHAKEN_API.txt doc for more info.
178. Added In-Group Drop Seconds Override Container, allowing for overriding of
the Drop Seconds setting based upon the day of the week and time of day.
179. Added Inbound Manual Dial Agent Forced Ready features allowing for forcing
agents in INBOUND_MAN dial method campaigns to be in the READY state
(able to take inbound calls) for a set amount of time before they are
able to click on the DIAL NEXT NUMBER button each time. Also allows for
an override setting based upon the day of the week and time of day.
180. Added CORS(Cross-Origin Resource Sharing) support for the VICIdial agent
PHP scripts and select admin PHP scripts. see the CORS_SUPPORT.txt doc
for more information.
181. Added Transfer No Dispo campaign setting, allowing for transferred calls
to not immediately show the disposition panel on the agent screen.
182. Added User override setting for campaign Manual Dial Filter option.
183. Added display of active Call Time Holidays in the agent screen Scheduled
Callbacks calendar panel.
184. SECURITY NOTE: For agent screen Webform buttons, we have changed the
default behavior to not include user credentials in non-custom URL
strings unless you set the new agc/options.php settings to do so:
"$user_pass_webform and "$phone_login_webform"
See the "agc/options-example.php" file for more information.
*This will not affect custom webform query strings that start with "VAR"
185. Added display of the Phone Codes and Postal Codes that are loaded into the
system. Linked from the System Settings page.
186. Added 24-Hour Called Count Limit campaign feature, allows you to limit the
number of calls to be placed to a phone number or lead in a 24-hour time
period. Also allows for state-based override settings. For more
information, read the CALL_COUNT_LIMITS.txt doc.
187. Added CID Group Failover setting for campaigns, to allow for backup CID
Group to use if no AREACODE or STATE match found from first CID Group.
188. Added agc/dispo_list_quota.php script to deactivate lists once a limit of
the number of leads matching set statuses is reached. See the comments
in the code for more details.
189. Changed agc/dispo_send_email.php to only allow attachments in the new
"agc/attachments" web directory.
190. Added Asterisk 16 "PJSIP" compatibility
191. Added 'batch_update_lead' Non-Agent API function
192. Added 'Agent In-Call Tally Seconds Threshold' campaign setting, to better
handle dialing volume on campaigns with long agent talk time.
193. Added 'In-Queue No Agents Check' in-group setting, to allow for checking of
logged-in or available agents for the in-group while calls are in-queue,
and if there are no agents available, sending the customers to the
No-Agent-No-Queue Action. With configurable pause code exceptions.
194. Added MIN LENGTH to the Dispo Call URL ALT admin screen, allowing for a
minimum call time threshold before a Dispo Call URL will trigger.
195. Added User Location to the Modify User page. Also added Queue Groups Admin
pages, allowing you to define multiple campaigns and/or in-groups in a
single Queue Group to be used in some reports.
196. Added Campaign and List options for "Auto Alt-Number Dialing Threshold"
allowing you to stop auto-dialing alternate phone numbers for a lead
after a set number of call attempts, and thereafter only dialing the
main phone number for the lead.
197. Added 'update_alt_url' Non-Agent API function
198. Added "Pause Max URL" Campaign feature
199. Added "Allow Web DB Debug" System Settings feature, to allow use of the $DB
variable on the web screens for troubleshooting issues.
It is disabled by default.
200. Added List CID Group Override to the List Modification admin screen.
201. Added "Pre-Filter Recent Call" DID feature, to be able to filter out
inbound calls based on the caller phone number and whether it had been
called(or had called in) within the last X number of days.
202. Added the "Inbound DID Detail Report" to the Admin Utilities page.
203. Added Beta support for ConfBridge Asterisk Conferencing engine. See the
"/extras/ConfBridge" directory for more information.
204. Added Beta support for VERM(the VICIdial Enhanced Reporting Module),
accessible from the "Reports -> Admin Utilities" page.
205. Added User Group "Script Override" option, with per-campaign activation.
206. Added "Webphone Settings" option to Phones, allows for more WebRTC config
options to be set through a Settings Container.
207. Added "Agent Call Hangup Route" campaign settings, allowing you to send
calls that an agent is finished with to a Call Menu, In-Group or a
pre-recorded message before hanging up the call.
NOTE: After upgrading your system, be sure to set each dialer to
"Rebuild conf files" = 'Y' for this feature to work properly.
208. Added instructions and scripts for creating a Gateway Recording server
See the GATEWAY_RECORDING_SERVER.txt doc for more info.
209. Added the ability to have multiple "No Agent Call URL" entries for a
single Campaign/In-Group/List, by putting "ALT" in the No Agent Call URL
field on the Campaign, In-Group, List modify screen. Just like how it
works with Dispo Call URL currently.
210. Added new User Group Script Tab Frame Location allowing the script tab
to extend to the far left side of the screen.
211. Added new campaign setting Max Logged-In Agents, allowing you to set a
maximum number of agents that can be logged into this campaign at any
time.
212. Added list option for Dial Prefix Override.
213. Added a color chooser for the In-Group Color and Screen Colors fields.
Also added color hex code validation to those fields.
214. Added Invalid Phone Number Replacement option to the Web Lead Loader,
allowing you to replace an invalid phone_number lead value with either
the alt_phone or address3 value in the same lead.
215. Added optional Agent Login Kick-all system setting which hangs up any
channels that were already in the agent session before the agent is
placed into the session.
216. Added User Codes Admin Pulldown allowing only User Level 9 users to
modify the User Code field on the User Modify page, and it will change
the User Code field to a pulldown menu.
217. Added "Show Confetti" campaign setting, allowing for confetti to be shown
to agents when they disposition a call as a SALE and/or a CALLBACK
flagged status.
218. Added "Abandon Check Queue" feature, to catch dropped Call Menu calls that
are tagged with a Lead ID. For more information, see the bottom of the
INBOUND_CALLBACK_QUEUE.txt document.
219. Added "Asterisk Restart URL" to the Modify Servers page, this can send a
URL request any time Asterisk is auto-restarted on that server.
220. Added Agent API "send_notification" function, allowing you to send
notifications to agents by User, User Group or Campaign.
221. Added "AMD Agent Route Options" flag to allow immediately hangup and dispo
of calls with no audio data. This is a campaign feature.
222. Added agent screen latency logging, viewable in the Real-Time Report and
the new Agent Latency Report and Latency Gaps Report.
223. Added Demographic Quotas, allowing for setting of quota goals for leads
based upon lead field values for demographic parameters like: gender,
age-group, political-party, etc... For more information on this set of
features, read the DEMOGRAPHIC_QUOTAS.txt document.
224. Added Inbound Calls Credits, allowing per-User setting of a number of
inbound calls that can be handled, until reset by a manager.
225. Added List Weekday Resets, allowing for automatic list resets scheduled by
day-of-the-week on a per-list basis.
226. Added Second and Third Agent Alert Trigger In-Group settings, allowing for
a second and/or third audio alert to be played to the agent on repeat
calls.
227. Added VIDPROMPTSPECIAL Call Menu Handle Methods when sending calls to
In-Groups. Allows for list-based In-Group routing based on settings in
a Settings Container. Also allows for separate routing of not-found
leads.
228. Added Dead Call Stop Recording campaign feature.
229. Manual VM Message Status Updates campaign option.
230. Added Per Call Notes Required campaign option.
231. Added Agent Search In-Group List Restrict options, allowing for Lead
Search restrictions on inbound group calls to a single list ID.
232. Added option to use Two-Factor Authentication with Agent Screen logins
233. Added the "lead_dearchive" Non-Agent API function, to move archived leads
back to the active list table.
234. Added the ability for agents to place 3way calls and require that the
called-party press 1 before the call is bridged to the agent and
customer. For more information, see the AGENT_3WAY_PRESS-1_CALLS.txt
document.
235. Added HCI Screen and Hopper Hold Inserts to allow for required Human
Intervention on phone calls placed out of a campaign. See the
HCI_Human_Call_Indicator_screen.txt document for more info.
236. Added the Daily Phone Number Call Limit System-wide campaign option
237. Added "refresh_panel" Agent API function
238. Added "LAGGED Agent Log Summary Report".
239. Added a Multi-call option to the agent 3-way press-1 calls feature.
240. Added DUPPHONEALT... duplicate_check options within the add_lead
Non-Agent API function. Checks for duplicate phone against both the
phone_number and alt_phone fields.
241. Added State Descriptions Banner campaign and in-group settings, allowing
for a custom description and color banner to appear on the agent screen
on a per-campaign and per-in-group basis.
242. Added Per-User Per-In-Group daily call limits.
243. Added 'delete_dnc_phone' Non-Agent API function.
244. Added "Script Tab Height Override" campaign setting, to allow for longer
Script tab contents.
245. Added "Call Log View Days" campaign setting, to allow restrictions to the
number of days an agent can go back to look at their call logs.
246. Added ALT option for "Start Call URL" to allow for multiple URLs to be
requested at the agent-start of a call.
247. Added archived-log cold-storage options and scripts.
See LOG_ARCHIVING_AND_COLD_STORAGE.txt document for more infomation.
248. Added "API New Lead URL" feature to System Settings, with per List override
setting. This can send a URL request when new leads are added to the
system through the "add_lead" Non-Agent API function.
249. Added agc/dispo_move_listSC.php script, allowing for multiple more complex
Dispo Move List functions after an agent dispositions a call.
250. Added "hopper_bulk_insert" Non-Agent API function.
251. Added Stereo Call Recording, allowing for additional call recordings with
the customer on one side(the Right channel) and the agent on the other
side(the Left channel), as well as optional parallel stereo call
recordings. For more information, read the doc:
STEREO_CALL_RECORDINGS.txt
252. Added "Talk Seconds URLs" Campaign and In-Group features. Allows for URLs
to be sent out from the Agent Screen while the agent is talking to the
customer, based on the number of seconds they have been talking.
253. Added Recording DTMF Muting, allowing for the muting of call recordings
for X seconds if any DTMF signal is detected on the call. Configurable
in Campaigns, In-Groups and system-wide.
254. Added Database crashed table auto-check, with display on Admin Web screens
for level 9 users if crashed tables are found. Enabled by default,
configurable in the System Settings.
########## UPGRADING FROM 2.11 TO 2.13 ##########
OPTIONAL STEPS(But highly recommended) - Backup existing system:
1. Run this for a 1-server system or server with database on it:
(this may take hours on large system)
/usr/share/astguiclient/ADMIN_backup.pl --debugX
2. Run this on dialer/Asterisk-only servers:
(do not run this if you only have one server):
/usr/share/astguiclient/ADMIN_backup.pl --debugX --without-db --without-web
REQUIRED STEPS!!!
1. Check system_settings, make sure you are at DB Schema Version 1403 or higher
If not, run the instructions for 2.9 to 2.11 before this section.
2. upgrade the MySQL asterisk database(you have two options):
A. Running the upgrade file directly from Linux:
mysql -f --database=asterisk < /path/from/root/extras/upgrade_2.12.sql
B. Going into mysql and executing the upgrade sql file:
mysql
use asterisk
\. /path/from/root/extras/upgrade_2.12.sql
quit
3. install new files:
perl ./install.pl
NOTES: If you have customized any scripts in the bin or agi folders,
then make sure you back them up before running the install.pl script.
This script will replace existing files in the astguiclient installation.
4. For each of your ViciDial servers, go the Admin -> Servers -> Modify Server
page and set each one to "Rebuild conf files = Y" and click submit.
This will rebuild the conf files to ensure any changes are updated.
5. On one server only, update your phone codes data:
/usr/share/astguiclient/ADMIN_area_code_populate.pl --purge-table --debug
OTHER CHANGES:
1. Added System Settings to allow custom prompts on agent login and when an
agent leaves a 3way call in the agent screen. Must Have Asterisk 1.8+
for it to work.
2. Added ability to use single-quotes in vicidial_list fields. Through the
agent screen and all lead import methods
3. Added option to populate the entry_list_id from the DID when routing to an
In-Group
4. Added agent screen webform 3 feature
5. Added user API restrictions for allowed lists and allowed API functions
6. Added web administration for chat features
7. Added new campaign settings for Manual Dial Search and Manual Dial Filter to
allow for Alt phone and Address3 phone numbers to be allowed
8. Added campaign option to disable the Manual Dial Override field
9. Added option to change the background color for agent scripts
10. Added option to hide the In-Group ID in the agent screen for inbound calls
11. Added option to not populate the In-Group Name in the security_phrase field
(the "Show" field) of the vicidial_list table on new inbound leads.
12. Added list_description as a webform and script variable
13. Added campaign option to allow you to set the number of seconds after a
customer hangs up before the warning shows on the agent screen
14. Added ability to use No Agent Call URL with the dispo_move_list.php script
see script comments for instructions.
15. Added DID options to check for a Maximum number of calls in queue in a set
In-Group and route the call to an extension if over the set number.
16. Added the ability to define multiple Dispo Call URLs as well as define
specific statuses that they will be triggered for.
17. Added compatibility in the Vicidial code for Asterisk 11.
18. Added database and logfile logging of DTMF events. Works with Asterisk
versions 1.8 and higher. If upgrading, you will need to add "dtmf" to
the listencron user in manager.conf and reload asterisk.
19. Added agent screen debug logging, which will log almost all mouse clicks
and AJAX calls on the agent screen. Can be enabled for all agents or
only one agent. Also added report to display logs by date/time. These
agent debug logs are deleted after 7 days.
20. Added agc/dispo_add_FPG.php script to be able to insert a phone number into
an inbound Filter Phone Group when set to a certain specific disposition
using the Dispo Call URL.