Change Read to set READSTATUS as an indication of the result
[asterisk/asterisk.git] / UPGRADE.txt
1 Information for Upgrading From Previous Asterisk Releases
2 =========================================================
3
4 AEL:
5
6 * Macros are now implemented underneath with the Gosub() application.
7   Heaven Help You if you wrote code depending on any aspect of this!
8   Previous to 1.6, macros were implemented with the Macro() app, which
9   provided a nice feature of auto-returning. The compiler will do its
10   best to insert a Return() app call at the end of your macro if you did
11   not include it, but really, you should make sure that all execution
12   paths within your macros end in "return;".
13
14 * The conf2ael program is 'introduced' in this release; it is in a rather
15   crude state, but deemed useful for making a first pass at converting
16   extensions.conf code into AEL. More intelligence will come with time.
17
18 Core:
19
20 * The 'languageprefix' option in asterisk.conf is now deprecated, and
21   the default sound file layout for non-English sounds is the 'new
22   style' layout introduced in Asterisk 1.4 (and used by the automatic
23   sound file installer in the Makefile).
24
25 * The ast_expr2 stuff has been modified to handle floating-point numbers.
26   Numbers of the format D.D are now acceptable input for the expr parser, 
27   Where D is a string of base-10 digits. All math is now done in "long double",
28   if it is available on your compiler/architecture. This was half-way between
29   a bug-fix (because the MATH func returns fp by default), and an enhancement.
30   Also, for those counting on, or needing, integer operations, a series of
31   'functions' were also added to the expr language, to allow several styles
32   of rounding/truncation, along with a set of common floating point operations,
33   like sin, cos, tan, log, pow, etc. The ability to call external functions
34   like CDR(), etc. was also added, without having to use the ${...} notation.
35  
36 * The delimiter passed to applications has been changed to the comma (','), as
37   that is what people are used to using within extensions.conf.  If you are
38   using realtime extensions, you will need to translate your existing dialplan
39   to use this separator.  To use a literal comma, you need merely to escape it
40   with a backslash ('\').  Another possible side effect is that you may need to
41   remove the obscene level of backslashing that was necessary for the dialplan
42   to work correctly in 1.4 and previous versions.  This should make writing
43   dialplans less painful in the future, albeit with the pain of a one-time
44   conversion.
45
46 * The logger.conf option 'rotatetimestamp' has been deprecated in favor of
47   'rotatestrategy'.  This new option supports a 'rotate' strategy that more
48   closely mimics the system logger in terms of file rotation.
49
50 Voicemail:
51
52 * The voicemail configuration values 'maxmessage' and 'minmessage' have
53   been changed to 'maxsecs' and 'minsecs' to clarify their purpose and
54   to make them more distinguishable from 'maxmsgs', which sets folder
55   size.  The old variables will continue to work in this version, albeit
56   with a deprecation warning.
57 * If you use any interface for modifying voicemail aside from the built in
58   dialplan applications, then the option "pollmailboxes" *must* be set in
59   voicemail.conf for message waiting indication (MWI) to work properly.  This
60   is because Voicemail notification is now event based instead of polling
61   based.  The channel drivers are no longer responsible for constantly manually
62   checking mailboxes for changes so that they can send MWI information to users.
63   Examples of situations that would require this option are web interfaces to
64   voicemail or an email client in the case of using IMAP storage.
65
66 Applications:
67
68 * ChanIsAvail() now has a 't' option, which allows the specified device
69   to be queried for state without consulting the channel drivers. This
70   performs mostly a 'ChanExists' sort of function.
71 * SetCallerPres() has been replaced with the CALLERPRES() dialplan function
72   and is now deprecated.
73 * DISA()'s fifth argument is now an options argument.  If you have previously
74   used 'NOANSWER' in this argument, you'll need to convert that to the new
75   option 'n'.
76 * Macro() is now deprecated.  If you need subroutines, you should use the
77   Gosub()/Return() applications.  To replace MacroExclusive(), we have
78   introduced dialplan functions LOCK(), TRYLOCK(), and UNLOCK().  You may use
79   these functions in any location where you desire to ensure that only one
80   channel is executing that path at any one time.
81 * Read() now sets a READSTATUS variable on exit.  It does NOT automatically
82   return -1 (and hangup) anymore on error.  If you want to hangup on error,
83   you need to do so explicitly in your dialplan.
84
85 Dialplan Functions:
86
87 * QUEUE_MEMBER_COUNT() has been deprecated in favor of the QUEUE_MEMBER() function. For
88   more information, issue a "show function QUEUE_MEMBER" from the CLI.
89
90 CDR:
91
92 * The cdr_sqlite module has been marked as deprecated in favor of
93   cdr_sqlite3_custom.  It will potentially be removed from the tree
94   after Asterisk 1.6 is released.
95
96 * The cdr_odbc module now uses res_odbc to manage its connections.  The
97   username and password parameters in cdr_odbc.conf, therefore, are no
98   longer used.  The dsn parameter now points to an entry in res_odbc.conf.
99
100 Formats:
101
102 * format_wav: The GAIN preprocessor definition and source code that used it
103   is removed.  This change was made in response to user complaints of
104   choppiness or the clipping of loud signal peaks.  To increase the volume
105   of voicemail messages, use the 'volgain' option in voicemail.conf
106
107 Channel Drivers:
108
109 * chan_sip.c: a small upgrade to support the "Record" button on the SNOM360,
110   which sends a sip INFO message with a "Record: on" or "Record: off" 
111   header. If asterisk is set up (via features.conf) to accept "One Touch Monitor"
112   requests (by default, via '*1'), then the user-configured dialpad sequence
113   is generated, and recording can be started and stopped via this button. The
114   file names and formats are all controlled via the normal mechanisms. If the
115   user has not configured the automon feature, the normal "415 Unsupported media type"
116   is returned, and nothing is done.
117
118 * chan_local.c: the comma delimiter inside the channel name has been changed to a
119   semicolon, in order to make the Local channel driver compatible with the comma
120   delimiter change in applications.
121
122 Configuration:
123
124 * pbx_dundi.c: tos parameter changed to use new values. Old values like lowdelay,
125   lowcost and other is not acceptable now. Look into qos.tex for description of 
126   this parameter.
127
128 Manager:
129
130 * The CallerID fields across Manager events have now been made more
131   consistent. CallerID Number will be sent as CallerIDNum and CallerID
132   Name will be sent as CallerIDName wherever used.
133
134 * The IAXpeers command output has been changed to more closely resemble the
135   output of the SIPpeers command.
136