As requested by kpfleming, renaming messagecount to inboxcount and messagecount2...
[asterisk/asterisk.git] / UPGRADE.txt
1 Information for Upgrading From Previous Asterisk Releases
2 =========================================================
3
4 Build Process (configure script):
5
6 Asterisk now uses an autoconf-generated configuration script to learn how it
7 should build itself for your system. As it is a standard script, running:
8
9 $ ./configure --help
10
11 will show you all the options available. This script can be used to tell the
12 build process what libraries you have on your system (if it cannot find them
13 automatically), which libraries you wish to have ignored even though they may
14 be present, etc.
15
16 You must run the configure script before Asterisk will build, although it will
17 attempt to automatically run it for you with no options specified; for most users,
18 that will result in a similar build to what they would have had before the
19 configure script was added to the build process (except for having to run 'make'
20 again after the configure script is run). Note that the configure script does NOT
21 need to be re-run just to rebuild Asterisk; you only need to re-run it when your
22 system configuration changes or you wish to build Asterisk with different options.
23
24 Build Process (module selection):
25
26 The Asterisk source tree now includes a basic module selection and build option
27 selection tool called 'menuselect'. Run 'make menuselect' to make your choices.
28 In this tool, you can disable building of modules that you don't care about,
29 turn on/off global options for the build and see which modules will not (and cannot)
30 be built because your system does not have the required external dependencies
31 installed.
32
33 (TODO: document where 'global' and 'per-user' menuselect input files should go
34 and what they need to contain)
35
36 PBX Core:
37
38 * The (very old and undocumented) ability to use BYEXTENSION for dialing
39   instead of ${EXTEN} has been removed.
40
41 Command Line Interface:
42
43 * 'show channels concise', designed to be used by applications that will parse
44   its output, previously used ':' characters to separate fields. However, some
45   of those fields can easily contain that character, making the output not
46   parseable. The delimiter has been changed to '!'.
47
48 Applications:
49
50 * In previous Asterisk releases, many applications would jump to priority n+101
51   to indicate some kind of status or error condition.  This functionality was
52   marked deprecated in Asterisk 1.2.  An option to disable it was provided with
53   the default value set to 'on'.  The default value for the global priority
54   jumping option is now 'off'.
55
56 * The applications Cut, Sort, DBGet, DBPut, SetCIDNum, SetCIDName, SetRDNIS,
57   AbsoluteTimeout, DigitTimeout, ResponseTimeout, SetLanguage, GetGroupCount,
58   and GetGroupMatchCount were all deprecated in version 1.2, and therefore have
59   been removed in this version.  You should use the equivalent dialplan
60   function in places where you have previously used one of these applications.
61
62 * The application SetVar has been renamed to Set.  The syntax SetVar was marked
63   deprecated in version 1.2 and is no longer recognized in this version.
64
65 * app_read has been updated to use the newer options codes, using "skip" or
66   "noanswer" will not work.  Use s or n.  Also there is a new feature i, for
67   using indication tones, so typing in skip would give you unexpected results.
68
69 * OSPAuth is added to authenticate OSP tokens in in_bound call setup messages.
70
71 * The CONNECT event in the queue_log from app_queue now has a second field 
72   in addition to the holdtime field. It contains the unique ID of the 
73   queue member channel that is taking the call. This is useful when trying 
74   to link recording filenames back to a particular call from the queue.  
75
76 * The old/current behavior of app_queue has a serial type behavior
77   in that the queue will make all waiting callers wait in the queue
78   even if there is more than one available member ready to take
79   calls until the head caller is connected with the member they
80   were trying to get to. The next waiting caller in line then
81   becomes the head caller, and they are then connected with the
82   next available member and all available members and waiting callers
83   waits while this happens. This cycle continues until there are
84   no more available members or waiting callers, whichever comes first.
85   The new behavior, enabled by setting autofill=yes in queues.conf
86   either at the [general] level to default for all queues or 
87   to set on a per-queue level, makes sure that when the waiting 
88   callers are connecting with available members in a parallel fashion 
89   until there are no more available members or no more waiting callers,
90   whichever comes first. This is probably more along the lines of how
91   one would expect a queue should work and in most cases, you will want 
92   to enable this new behavior. If you do not specify or comment out this 
93   option, it will default to "no" to keep backward compatability with the old 
94   behavior.
95
96 * The app_queue application now has the ability to use MixMonitor to 
97   record conversations queue members are having with queue callers. Please
98   see configs/queues.conf.sample for more information on this option.
99
100 * ast_play_and_record would attempt to cancel the recording if a DTMF
101   '0' was received.  This behavior was not documented in most of the
102   applications that used ast_play_and_record and the return codes from
103   ast_play_and_record weren't checked for properly.
104   ast_play_and_record has been changed so that '0' no longer cancels a
105   recording.  If you want to allow DTMF digits to cancel an
106   in-progress recording use ast_play_and_record_full which allows you
107   to specify which DTMF digits can be used to accept a recording and
108   which digits can be used to cancel a recording.
109
110 * ast_app_messagecount has been renamed to ast_app_inboxcount.  There is now a
111   new ast_app_messagecount function which takes a single context/mailbox/folder
112   mailbox specification and returns the message count for that folder only.
113   This addresses the deficiency of not being able to count the number of
114   messages in folders other than INBOX and Old.
115
116 Manager:
117
118 * After executing the 'status' manager action, the "Status" manager events
119   included the header "CallerID:" which was actually only the CallerID number,
120   and not the full CallerID string.  This header has been renamed to
121   "CallerIDNum".  For compatibility purposes, the CallerID parameter will remain
122   until after the release of 1.4, when it will be removed.  Please use the time
123   during the 1.4 release to make this transition.
124
125 * The AgentConnect event now has an additional field called "BridgedChannel" 
126   which contains the unique ID of the queue member channel that is taking the 
127   call. This is useful when trying to link recording filenames back to 
128   a particular call from the queue.
129
130 Variables:
131
132 * The builtin variables ${CALLERID}, ${CALLERIDNAME}, ${CALLERIDNUM},
133   ${CALLERANI}, ${DNID}, ${RDNIS}, ${DATETIME}, ${TIMESTAMP}, ${ACCOUNTCODE},
134   and ${LANGUAGE} have all been deprecated in favor of their related dialplan
135   functions.  You are encouraged to move towards the associated dialplan
136   function, as these variables will be removed in a future release.
137
138 * The CDR-CSV variables uniqueid, userfield, and basing time on GMT are now 
139   adjustable from cdr.conf, instead of recompiling.
140
141 * OSP applications exports several new variables, ${OSPINHANDLE},
142   ${OSPOUTHANDLE}, ${OSPINTOKEN}, ${OSPOUTTOKEN}, ${OSPCALLING},
143   ${OSPINTIMELIMIT}, and ${OSPOUTTIMELIMIT}
144
145 Functions:
146
147 * The function ${CHECK_MD5()} has been deprecated in favor of using an
148   expression: $[${MD5(<string>)} = ${saved_md5}].
149
150 * The 'builtin' functions that used to be combined in pbx_functions.so are
151   now built as separate modules. If you are not using 'autoload=yes' in your
152   modules.conf file then you will need to explicitly load the modules that
153   contain the functions you want to use.
154
155 * The ENUMLOOKUP() function with the 'c' option (for counting the number of records),
156   but the lookup fails to match any records, the returned value will now be "0" instead of blank.
157
158 * The REALTIME() function is now available in version 1.4 and app_realtime has
159   been deprecated in favor of the new function. app_realtime will be removed
160   completely with the version 1.6 release so please take the time between
161   releases to make any necessary changes
162
163 The IAX2 channel:
164
165 * The "mailboxdetail" option has been deprecated.  Previously, if this option
166   was not enabled, the 2 byte MSGCOUNT information element would be set to all
167   1's to indicate there there is some number of messages waiting.  With this
168   option enabled, the number of new messages were placed in one byte and the
169   number of old messages are placed in the other.  This is now the default
170   (and the only) behavior.
171
172 The SIP channel:
173
174 * The "incominglimit" setting is replaced by the "call-limit" setting in sip.conf.
175
176 * OSP support code is removed from SIP channel to OSP applications. ospauth 
177   option in sip.conf is removed to osp.conf as authpolicy. allowguest option
178   in sip.conf cannot be set as osp anymore. 
179
180 The Zap channel:
181
182 * Support for MFC/R2 has been removed, as it has not been functional for some time
183   and it has no maintainer.
184
185 Installation:
186
187 * On BSD systems, the installation directories have changed to more "FreeBSDish" directories. On startup, Asterisk will look for the main configuration in /usr/local/etc/asterisk/asterisk.conf
188 If you have an old installation, you might want to remove the binaries and move the configuration files to the new locations. The following directories are now default:
189         ASTLIBDIR       /usr/local/lib/asterisk
190         ASTVARLIBDIR    /usr/local/share/asterisk
191         ASTETCDIR       /usr/local/etc/asterisk
192         ASTBINDIR       /usr/local/bin/asterisk
193         ASTSBINDIR      /usr/local/sbin/asterisk
194
195 Sounds:
196
197 * The phonetic sounds directory has been removed from the asterisk-sounds package
198   because they are now included directly in Asterisk.  However, it is important to
199   note that the phonetic sounds that existed in asterisk-sounds used a different
200   naming convention than the sounds in Asterisk.  For example, instead of alpha.gsm
201   and bravo.gsm, Asterisk has a_p.gsm and b_p.gsm.