Merge the new Channel Event Logging (CEL) subsystem.
[asterisk/asterisk.git] / configs / cel_adaptive_odbc.conf.sample
1 ;
2 ; This configuration defines the connections and tables for which CEL records may
3 ; be populated.  Each context specifies a different CEL table to be used.
4 ;
5 ; The columns in the tables should match up word-for-word (case-insensitive)
6 ; to the CEL variables set in the dialplan.  The natural advantage to this
7 ; system is that beyond setting up the configuration file to tell you what
8 ; tables to look at, there isn't anything more to do beyond creating the
9 ; columns for the fields that you want, and populating the corresponding
10 ; CEL variables in the dialplan.
11 ;
12 ; Please note that after adding columns to the database, it is necessary to
13 ; reload this module to get the new column names and types read.
14 ;
15 ; Warning: if you specify two contexts with exactly the same connection and
16 ; table names, you will get duplicate records in that table.  So be careful.
17 ;
18 ; CEL FIELDS:
19 ;       eventtype
20 ;         CEL_CHANNEL_START = 1
21 ;         CEL_CHANNEL_END = 2
22 ;         CEL_HANGUP = 3
23 ;         CEL_ANSWER = 4
24 ;         CEL_APP_START = 5
25 ;         CEL_APP_END = 6
26 ;         CEL_BRIDGE_START = 7
27 ;         CEL_BRIDGE_END = 8
28 ;         CEL_CONF_START = 9
29 ;         CEL_CONF_END = 10
30 ;         CEL_PARK_START = 11
31 ;         CEL_PARK_END = 12
32 ;         CEL_BLINDTRANSFER = 13
33 ;         CEL_ATTENDEDTRANSFER = 14
34 ;         CEL_TRANSFER = 15
35 ;         CEL_HOOKFLASH = 16
36 ;         CEL_3WAY_START = 17
37 ;         CEL_3WAY_END = 18
38 ;         CEL_CONF_ENTER = 19
39 ;         CEL_CONF_EXIT = 20
40 ;         CEL_USER_DEFINED = 21
41 ;         CEL_LINKEDID_END = 22
42 ;         CEL_BRIDGE_UPDATE = 23
43 ;         CEL_PICKUP = 24
44 ;         CEL_FORWARD = 25
45 ;       eventtime  (timeval, includes microseconds)
46 ;       userdeftype (set only if eventtype == USER_DEFINED)
47 ;       cid_name
48 ;       cid_num
49 ;       cid_ani
50 ;       cid_rdnis
51 ;       cid_dnid
52 ;       exten
53 ;       context
54 ;       channame
55 ;       appname
56 ;       appdata
57 ;       accountcode
58 ;       peeraccount
59 ;       uniqueid
60 ;       linkedid
61 ;       amaflag  (an int)
62 ;       userfield
63 ;       peer
64
65
66 ;[first]
67 ;connection=mysql1
68 ;table=cel
69
70 ;[second]
71 ;connection=mysql1
72 ;table=extracel
73
74 ;[third]
75 ;connection=sqlserver
76 ;table=AsteriskCEL
77 ;usegmtime=yes ; defaults to no
78 ;alias src => source
79 ;alias channel => source_channel
80 ;alias dst => dest
81 ;alias dstchannel => dest_channel
82 ;
83 ; Any filter specified MUST match exactly or the CDR will be discarded
84 ;filter accountcode => somename
85 ;filter src => 123
86 ;
87 ; Additionally, we now support setting static values per column.  Reason
88 ; for this is to allow different sections to specify different values for
89 ; a certain named column, presumably separated by filters.
90 ;static "Some Special Value" => identifier_code
91
92
93 ; On Wednesday 10 September 2008 21:11:16 Tilghman Lesher wrote:
94 ; (this module patterned after the CDR module)
95 ; I thought that the sample cdr_adaptive_odbc.conf was rather clear, but
96 ; apparently not.  The point of this module is to allow you log whatever you
97 ; like in terms of the CDR variables.  Do you want to log uniqueid?  Then simply
98 ; ensure that your table has that column.  If you don't want the column, ensure
99 ; that it does not exist in the table structure.  If you'd like to call uniqueid
100 ; something else in your table, simply provide an alias in the configuration
101 ; file that maps the standard CDR field name (uniqueid) to whatever column
102 ; name you like.
103
104 At the current time, channel variables are not published with the events.
105 If you wish to store variables, put them in the channel userfield and
106 extract them from there.