[asterisk-commits] rmudgett: branch rmudgett/bridge_phase r393613 - in /team/rmudgett/bridge_pha...
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Wed Jul 3 17:41:08 CDT 2013
Author: rmudgett
Date: Wed Jul 3 17:41:06 2013
New Revision: 393613
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=393613
Log:
Add agents.conf config framework XML documentation and other related documentation updates.
Modified:
team/rmudgett/bridge_phase/CHANGES
team/rmudgett/bridge_phase/UPGRADE.txt
team/rmudgett/bridge_phase/apps/app_agent_pool.c
team/rmudgett/bridge_phase/configs/agents.conf.sample
team/rmudgett/bridge_phase/configs/queues.conf.sample
Modified: team/rmudgett/bridge_phase/CHANGES
URL: http://svnview.digium.com/svn/asterisk/team/rmudgett/bridge_phase/CHANGES?view=diff&rev=393613&r1=393612&r2=393613
==============================================================================
--- team/rmudgett/bridge_phase/CHANGES (original)
+++ team/rmudgett/bridge_phase/CHANGES Wed Jul 3 17:41:06 2013
@@ -439,7 +439,14 @@
channel before calling AgentLogin.
* chan_agent is removed and replaced with AgentLogin and AgentRequest dialplan
applications. Agents are connected with callers using the new AgentRequest
- dialplan application. See agents.conf.sample for valid configuration options.
+ dialplan application. The Agents:<agent-id> device state is available to
+ monitor the status of an agent. See agents.conf.sample for valid
+ configuration options.
+
+chan_bridge
+------------------
+ * chan_bridge is removed and its functionality is incorporated into ConfBridge
+ itself.
chan_local
------------------
Modified: team/rmudgett/bridge_phase/UPGRADE.txt
URL: http://svnview.digium.com/svn/asterisk/team/rmudgett/bridge_phase/UPGRADE.txt?view=diff&rev=393613&r1=393612&r2=393613
==============================================================================
--- team/rmudgett/bridge_phase/UPGRADE.txt (original)
+++ team/rmudgett/bridge_phase/UPGRADE.txt Wed Jul 3 17:41:06 2013
@@ -128,7 +128,13 @@
reason as the updatecdr option.
- chan_agent is removed and replaced with AgentLogin and AgentRequest dialplan
applications. Agents are connected with callers using the new AgentRequest
- dialplan application. See agents.conf.sample for valid configuration options.
+ dialplan application. The Agents:<agent-id> device state is available to
+ monitor the status of an agent. See agents.conf.sample for valid
+ configuration options.
+
+chan_bridge
+ - chan_bridge is removed and its functionality is incorporated into ConfBridge
+ itself.
chan_dahdi:
- Analog port dialing and deferred DTMF dialing for PRI now distinguishes
Modified: team/rmudgett/bridge_phase/apps/app_agent_pool.c
URL: http://svnview.digium.com/svn/asterisk/team/rmudgett/bridge_phase/apps/app_agent_pool.c?view=diff&rev=393613&r1=393612&r2=393613
==============================================================================
--- team/rmudgett/bridge_phase/apps/app_agent_pool.c (original)
+++ team/rmudgett/bridge_phase/apps/app_agent_pool.c Wed Jul 3 17:41:06 2013
@@ -49,7 +49,6 @@
#include "asterisk/stringfields.h"
#include "asterisk/stasis_channels.h"
-/* BUGBUG Need config framework option documentation. */
/*** DOCUMENTATION
<application name="AgentLogin" language="en_US">
<synopsis>
@@ -71,17 +70,19 @@
already be done by dialplan. While logged in, the agent can receive calls
and will hear a configurable <literal>beep</literal> sound when a new call
comes in for the agent. Login failures will continue in the dialplan
- with AGENT_STATUS set.</para>
+ with <variable>AGENT_STATUS</variable> set.</para>
<para>Before logging in, you can setup on the real agent channel the
CHANNEL(dtmf-features) an agent will have when talking to a caller
and you can setup on the channel running this application the
CONNECTEDLINE() information the agent will see while waiting for a
caller.</para>
- <para>AGENT_STATUS enumeration values:</para>
+ <para><variable>AGENT_STATUS</variable> enumeration values:</para>
<enumlist>
<enum name = "INVALID"><para>The specified agent is invalid.</para></enum>
<enum name = "ALREADY_LOGGED_IN"><para>The agent is already logged in.</para></enum>
</enumlist>
+ <note><para>The Agents:<replaceable>AgentId</replaceable> device state is
+ available to monitor the status of the agent.</para></note>
</description>
<see-also>
<ref type="application">Authenticate</ref>
@@ -106,8 +107,8 @@
</syntax>
<description>
<para>Request an agent to connect with the channel. Failure to find and
- alert an agent will continue in the dialplan with AGENT_STATUS set.</para>
- <para>AGENT_STATUS enumeration values:</para>
+ alert an agent will continue in the dialplan with <variable>AGENT_STATUS</variable> set.</para>
+ <para><variable>AGENT_STATUS</variable> enumeration values:</para>
<enumlist>
<enum name = "INVALID"><para>The specified agent is invalid.</para></enum>
<enum name = "NOT_LOGGED_IN"><para>The agent is not available.</para></enum>
@@ -179,6 +180,88 @@
<para>Sets an agent as no longer logged in.</para>
</description>
</manager>
+ <configInfo name="app_agent_pool" language="en_US">
+ <synopsis>Agent pool applications</synopsis>
+ <description>
+ <note><para>Option changes take effect on agent login or after an agent
+ disconnects from a call.</para></note>
+ </description>
+ <configFile name="agents.conf">
+ <configObject name="global">
+ <synopsis>Unused, but reserved.</synopsis>
+ </configObject>
+ <configObject name="agent-id">
+ <synopsis>Configure an agent for the pool.</synopsis>
+ <description>
+ <xi:include xpointer="xpointer(/docs/configInfo[@name='app_agent_pool']/description/note)" />
+ </description>
+ <configOption name="ackcall">
+ <synopsis>Enable to require the agent to acknowledge a call.</synopsis>
+ <description>
+ <para>Enable to require the agent to give a DTMF acknowledgement
+ when the agent receives a call.</para>
+ <note><para>The option is overridden by <variable>AGENTACKCALL</variable> on agent login.</para></note>
+ <xi:include xpointer="xpointer(/docs/configInfo[@name='app_agent_pool']/description/note)" />
+ </description>
+ </configOption>
+ <configOption name="acceptdtmf">
+ <synopsis>DTMF key sequence the agent uses to acknowledge a call.</synopsis>
+ <description>
+ <note><para>The option is overridden by <variable>AGENTACCEPTDTMF</variable> on agent login.</para></note>
+ <xi:include xpointer="xpointer(/docs/configInfo[@name='app_agent_pool']/description/note)" />
+ </description>
+ </configOption>
+ <configOption name="autologoff">
+ <synopsis>Time the agent has to acknowledge a call before being logged off.</synopsis>
+ <description>
+ <para>Set how many seconds a call for the agent has to wait for the
+ agent to acknowledge the call before the agent is automatically
+ logged off. If set to zero then the call will wait forever for
+ the agent to acknowledge.</para>
+ <note><para>The option is overridden by <variable>AGENTAUTOLOGOFF</variable> on agent login.</para></note>
+ <xi:include xpointer="xpointer(/docs/configInfo[@name='app_agent_pool']/description/note)" />
+ </description>
+ </configOption>
+ <configOption name="wrapuptime">
+ <synopsis>Minimum time the agent has between calls.</synopsis>
+ <description>
+ <para>Set the minimum amount of time in milliseconds after
+ disconnecting a call before the agent can receive a new call.</para>
+ <note><para>The option is overridden by <variable>AGENTWRAPUPTIME</variable> on agent login.</para></note>
+ <xi:include xpointer="xpointer(/docs/configInfo[@name='app_agent_pool']/description/note)" />
+ </description>
+ </configOption>
+ <configOption name="musiconhold">
+ <synopsis>Music on hold class the agent listens to between calls.</synopsis>
+ <description>
+ <xi:include xpointer="xpointer(/docs/configInfo[@name='app_agent_pool']/description/note)" />
+ </description>
+ </configOption>
+ <configOption name="recordagentcalls">
+ <synopsis>Enable to automatically record calls the agent takes.</synopsis>
+ <description>
+ <para>Enable recording calls the agent takes automatically by
+ invoking the automixmon DTMF feature when the agent connects
+ to a caller. See <filename>features.conf.sample</filename> for information about
+ the automixmon feature.</para>
+ <xi:include xpointer="xpointer(/docs/configInfo[@name='app_agent_pool']/description/note)" />
+ </description>
+ </configOption>
+ <configOption name="custom_beep">
+ <synopsis>Sound file played to alert the agent when a call is present.</synopsis>
+ <description>
+ <xi:include xpointer="xpointer(/docs/configInfo[@name='app_agent_pool']/description/note)" />
+ </description>
+ </configOption>
+ <configOption name="fullname">
+ <synopsis>A friendly name for the agent used in log messages.</synopsis>
+ <description>
+ <xi:include xpointer="xpointer(/docs/configInfo[@name='app_agent_pool']/description/note)" />
+ </description>
+ </configOption>
+ </configObject>
+ </configFile>
+ </configInfo>
***/
/* ------------------------------------------------------------------- */
@@ -399,9 +482,9 @@
}
/* Agent options */
- aco_option_register(&cfg_info, "autologoff", ACO_EXACT, agent_types, "0", OPT_UINT_T, 0, FLDSET(struct agent_cfg, auto_logoff));
aco_option_register(&cfg_info, "ackcall", ACO_EXACT, agent_types, "no", OPT_BOOL_T, 1, FLDSET(struct agent_cfg, ack_call));
aco_option_register(&cfg_info, "acceptdtmf", ACO_EXACT, agent_types, "#", OPT_STRINGFIELD_T, 1, STRFLDSET(struct agent_cfg, dtmf_accept));
+ aco_option_register(&cfg_info, "autologoff", ACO_EXACT, agent_types, "0", OPT_UINT_T, 0, FLDSET(struct agent_cfg, auto_logoff));
aco_option_register(&cfg_info, "wrapuptime", ACO_EXACT, agent_types, "0", OPT_UINT_T, 0, FLDSET(struct agent_cfg, wrapup_time));
aco_option_register(&cfg_info, "musiconhold", ACO_EXACT, agent_types, "default", OPT_STRINGFIELD_T, 0, STRFLDSET(struct agent_cfg, moh));
aco_option_register(&cfg_info, "recordagentcalls", ACO_EXACT, agent_types, "no", OPT_BOOL_T, 1, FLDSET(struct agent_cfg, record_agent_calls));
Modified: team/rmudgett/bridge_phase/configs/agents.conf.sample
URL: http://svnview.digium.com/svn/asterisk/team/rmudgett/bridge_phase/configs/agents.conf.sample?view=diff&rev=393613&r1=393612&r2=393613
==============================================================================
--- team/rmudgett/bridge_phase/configs/agents.conf.sample (original)
+++ team/rmudgett/bridge_phase/configs/agents.conf.sample Wed Jul 3 17:41:06 2013
@@ -7,27 +7,27 @@
; for future use.
;[agent-id]
-; Set how long a call for the agent has to wait for the agent to acknowledge
-; the call before the agent is automatically logged off (in seconds).
-; If set to zero then the call will wait forever for the agent to acknowledge.
-; The channel variable AGENTAUTOLOGOFF overrides on login.
-; Default is 0.
-;autologoff=15
-;
; Define ackcall to require the agent to give a DTMF acknowledgement
; when the agent receives a call.
-; The channel variable AGENTACKCALL overrides on login.
+; The channel variable AGENTACKCALL overrides on agent login.
; Default is "no".
;ackcall=no
;
; Set what DTMF key sequence the agent should use to acknowledge a call.
-; The channel variable AGENTACCEPTDTMF overrides on login.
+; The channel variable AGENTACCEPTDTMF overrides on agent login.
; Default is "#".
;acceptdtmf=##
;
+; Set how many seconds a call for the agent has to wait for the agent to
+; acknowledge the call before the agent is automatically logged off. If
+; set to zero then the call will wait forever for the agent to acknowledge.
+; The channel variable AGENTAUTOLOGOFF overrides on agent login.
+; Default is 0.
+;autologoff=15
+;
; Set the minimum amount of time after disconnecting a call before
; the agent can receive a new call in milliseconds.
-; The channel variable AGENTWRAPUPTIME overrides on login.
+; The channel variable AGENTWRAPUPTIME overrides on agent login.
; Default is 0.
;wrapuptime=5000
;
@@ -41,11 +41,11 @@
; Default is "no".
;recordagentcalls=yes
;
-; A custom beep sound file to play to the agent.
+; The sound file played to alert the agent when a call is present.
; Default is "beep".
;custom_beep=beep
;
-; Set the agent name used in logging messages.
+; A friendly name for the agent used in log messages.
; Default is "".
;fullname=Mark Spencer
;
Modified: team/rmudgett/bridge_phase/configs/queues.conf.sample
URL: http://svnview.digium.com/svn/asterisk/team/rmudgett/bridge_phase/configs/queues.conf.sample?view=diff&rev=393613&r1=393612&r2=393613
==============================================================================
--- team/rmudgett/bridge_phase/configs/queues.conf.sample (original)
+++ team/rmudgett/bridge_phase/configs/queues.conf.sample Wed Jul 3 17:41:06 2013
@@ -543,18 +543,7 @@
;member => DAHDI/1
;member => DAHDI/2,10
;member => DAHDI/3,10,Bob Johnson
-;member => Agent/1001
-;member => Agent/1002
+;member => Local/1001 at agents,0,May Flowers,Agent:1001
+;member => Local/1002 at agents,0,John Doe,Agent:1002
;member => Local/1000 at default,0,John Smith,SIP/1000
;member => Local/2000 at default,0,Lorem Ipsum,SIP/2000,no
-
-;
-; Note that using agent groups is probably not what you want. Strategies do
-; not propagate down to the Agent system so if you want round robin, least
-; recent, etc, you should list all the agents in this file individually and not
-; use agent groups.
-;
-;member => Agent/@1 ; Any agent in group 1
-;member => Agent/:1,1 ; Any agent in group 1, wait for first
- ; available, but consider with penalty
-
More information about the asterisk-commits
mailing list