Merged revisions 53810 via svnmerge from
[asterisk/asterisk.git] / doc / sla.txt
1 -------------------------------------------------------------
2 --- Shared Line Appearances ---------------------------------
3 -------------------------------------------------------------
4
5 -------------------------------------------------------------
6 INTRODUCTION
7
8 The "SLA" functionality in Asterisk is intended to allow a setup that emulates
9 a simple key system.  It uses the various abstraction layers already built into
10 Asterisk to emulate key system functionality across various devices, including
11 IP channels.
12 -------------------------------------------------------------
13
14 -------------------------------------------------------------
15 DIALPLAN CONFIGURATION
16
17 The SLA implementation can automatically generate the dialplan necessary for
18 basic operation if the "autocontext" option is set for trunks and stations in
19 sla.conf.  However, for reference, here is an automatically generated dialplan
20 to help with custom building of the dialplan to include other features, such as
21 voicemail:
22
23 [line1]
24 exten => s,1,SLATrunk(line1)
25
26 [line2]
27 exten => s,2,SLATRUNK(line2)
28
29 [sla_stations]
30 exten => station1,1,SLAStation(station1)
31 exten => station1_line1,hint,SLA:station1_line1
32 exten => station1_line1,1,SLAStation(station1_line1)
33 exten => station1_line2,hint,SLA:station1_line2
34 exten => station1_line2,1,SLAStation(station1_line2)
35
36 exten => station2,1,SLAStation(station2)
37 exten => station2_line1,hint,SLA:station2_line1
38 exten => station2_line1,1,SLAStation(station2_line1)
39 exten => station2_line2,hint,SLA:station2_line2
40 exten => station2_line2,1,SLAStation(station2_line2)
41
42 exten => station3,1,SLAStation(station3)
43 exten => station3_line1,hint,SLA:station3_line1
44 exten => station3_line1,1,SLAStation(station3_line1)
45 exten => station3_line2,hint,SLA:station3_line2
46 exten => station3_line2,1,SLAStation(station3_line2)
47 -------------------------------------------------------------
48
49 -------------------------------------------------------------
50 TRUNKS
51
52 For the trunk side of SLA, the only channels that are currently supported are
53 Zap channels.  Support for IP trunks is planned, but not yet implemented.
54
55 Be sure to configure the trunk's context to be the same one that is set for the
56 "autocontext" option in sla.conf if automatic dialplan configuration is used.
57
58 If the dialplan is being built manually, ensure that calls coming in on a trunk
59 execute the SLATrunk() application with an argument of the trunk name.
60 -------------------------------------------------------------
61
62
63 -------------------------------------------------------------
64 STATIONS
65
66 Currently, the only channel driver that has all of the features necessary to
67 support an SLA environment is chan_sip.  Here are some hints on configuring
68 a SIP phone for use with SLA:
69
70 1) Add the SIP channel as a [station] in sla.conf.
71
72 2) Configure the phone in sip.conf.  If automatic dialplan configuration was
73    used by enabling the "autocontext" option in sla.conf, then this entry in
74    sip.conf should have the same context setting.
75
76 3) On the phone itself, there are various things that must be configured to
77    make everything work correctly:
78
79    Let's say this phone is called "station1" in sla.conf, and it uses trunks
80    named "line1" and line2".
81
82    a) Two line buttons must be configured to subscribe to the state of the
83       following extensions:
84         - station1_line1
85         - station1_line2
86
87    b) The line appearance buttons should be configured to dial the extensions
88       that they are subscribed to when they are pressed.
89
90    c) If you would like the phone to automatically connect to a trunk when it
91       is taken off hook, then the phone should be automatically configured to
92       dial "station1" when it is taken off hook.
93 -------------------------------------------------------------