[asterisk-commits] russell: branch russell/sla_rewrite r52996 - /team/russell/sla_rewrite/configs/

[asterisk-commits at lists.digium.com]

Author: russell
Date: Tue Jan 30 14:15:14 2007
New Revision: 52996

URL: http://svn.digium.com/view/asterisk?view=rev&rev=52996
Log:
document sla.conf.sample

Modified:
    team/russell/sla_rewrite/configs/sla.conf.sample

Modified: team/russell/sla_rewrite/configs/sla.conf.sample
URL: http://svn.digium.com/view/asterisk/team/russell/sla_rewrite/configs/sla.conf.sample?view=diff&rev=52996&r1=52995&r2=52996
==============================================================================
--- team/russell/sla_rewrite/configs/sla.conf.sample (original)
+++ team/russell/sla_rewrite/configs/sla.conf.sample Tue Jan 30 14:15:14 2007
@@ -1,21 +1,36 @@
+;
+; Configuration for Shared Line Appearances (SLA).
+;
+; Asterisk is a PBX, not a key system.  However, people still insist on being
+; able to make Asterisk act like a key system.  So, here it is.  This has got
+; to be the most complicated implementation of a simple key system, ever.
+;
+
+; ---- General Options ----------------
 [general]
+; There are none!
 
-[station](!)
-type=station
-autocontext=sla_stations
-trunk=line1
-trunk=line2
-trunk=line3
-trunk=line4
+; -------------------------------------
 
+
+; ---- Trunk Declarations -------------
+
+; Provide a name for this trunk.
 [line1]
+; This line is what marks this entry as a trunk.
 type=trunk
-device=Zap/1
+; Map this trunk declaration to a specific device.
+; NOTE: At this point, this *must* be a zap channel!
+device=Zap/3
+; This supports automatic generation of the dialplan entries if the autocontext
+; option is used.  Each trunk should have a unique context name.  Then, in
+; zapata.conf, this device should be configured to have incoming calls go to
+; this context.
 autocontext=line1
 
 [line2]
 type=trunk
-device=Zap/2
+device=Zap/4
 autocontext=line2
 
 [line3]
@@ -27,8 +42,33 @@
 type=trunk
 device=Zap/4
 autocontext=line4
+; --------------------------------------
 
+
+; ---- Station Declarations ------------
+
+; In this example, all stations have the same trunks, so this configuration
+; template is used to simplify the declaration of each station.
+[station](!)
+; This line indicates that this entry is a station.
+type=station
+; This supports automatic generation of the dialplan entries if the autocontext
+; option is used.  All stations can use the same context without conflict.  The
+; device for this station should have its context configured to the same one
+; listed here.
+autocontext=sla_stations
+; Individually list all of the trunks that will appear on this station.  This
+; order is significant.  It should be the same order as they appear on the
+; phone.  The order here defines the order of preference that the trunks will
+; be used.
+trunk=line1
+trunk=line2
+trunk=line3
+trunk=line4
+
+; Define a station that uses the configuration from the template "station".
 [station1](station)
+; Each station must be mapped to a device.
 device=SIP/station1
 
 [station2](station)
@@ -42,3 +82,25 @@
 
 [station5](station)
 device=SIP/station5
+; --------------------------------------
+
+
+;-- Phone Specific Configuration -------
+
+The only other thing that needs to be done to get this working is that the
+phone must be configured.  Each line button is actually an extension state
+watcher.  Each button must be configured to subscribe to a different hint that
+was automatically added to the dialplan.
+
+For example, for a station named "station1" with trunks "trunk1" through
+"trunk4", the line buttons would subscribe to the following:
+
+Line 1 button --> station1_line1
+Line 2 button --> station1_line2
+Line 3 button --> station1_line3
+Line 4 button --> station1_line4
+
+When these buttons are pressed, the phone should call the extension of the
+same name.
+
+------------------------------------- --;