com.genesyslab.platform.openmedia.protocol.interactionserver.requests.agentmanagement
Class RequestStopPlaceAgentStateReportingAll
java.lang.Object
com.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.openmedia.protocol.interactionserver.requests.agentmanagement.RequestStopPlaceAgentStateReportingAll
- All Implemented Interfaces:
- ProtocolDescriptionSupport
public abstract class RequestStopPlaceAgentStateReportingAll
- extends Message
With this request, the reporting engine can cancel its registration for reporting
events regarding specified reportable objects. This request does not necessarily
cancel all previous registrations, but it may. This request can be sent multiple
times to cancel registration for some specified objects.
Field Summary |
static int |
ID
|
static java.lang.String |
NAME
|
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
ID
public static final int ID
- See Also:
- Constant Field Values
NAME
public static final java.lang.String NAME
- See Also:
- Constant Field Values
create
public static RequestStopPlaceAgentStateReportingAll create()
- Creates instance of RequestStopPlaceAgentStateReportingAll with no parameters set.
- Returns:
- instance of RequestStopPlaceAgentStateReportingAll
create
public static RequestStopPlaceAgentStateReportingAll create(java.lang.Integer proxyClientId,
KeyValueCollection tenantList,
KeyValueCollection extension)
- Creates instance of RequestStopPlaceAgentStateReportingAll with all parameters set.
- Parameters:
proxyClientId
- The identifier of the client of proxy.tenantList
- extension
- Extensions.
- Returns:
- instance of RequestStopPlaceAgentStateReportingAll
create
public static RequestStopPlaceAgentStateReportingAll create(KeyValueCollection tenantList)
- Creates instance of RequestStopPlaceAgentStateReportingAll with required parameters set.
- Parameters:
tenantList
-
- Returns:
- instance of RequestStopPlaceAgentStateReportingAll
getReferenceId
public abstract java.lang.Integer getReferenceId()
- Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.
setReferenceId
public abstract void setReferenceId(java.lang.Integer referenceId)
- Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.
setReferenceId
public abstract void setReferenceId(int referenceId)
- Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.
getProxyClientId
public abstract java.lang.Integer getProxyClientId()
- Proxy client identifier. Mandatory if client connects via proxy.
setProxyClientId
public abstract void setProxyClientId(java.lang.Integer proxyClientId)
- Proxy client identifier. Mandatory if client connects via proxy.
setProxyClientId
public abstract void setProxyClientId(int proxyClientId)
- Proxy client identifier. Mandatory if client connects via proxy.
getTenantList
public abstract KeyValueCollection getTenantList()
- List of reportable objects that reporting engine wants to receive reporting events for.
If the list is empty, Interaction Server assumes that the reporting engine wants to register
for all reportable objects.
If the list includes a key-value pair with the key ESP:
- If its value is empty, Interaction Server assumes that reporting engine wants to register for all of the ESP (External Services Protocol) server activity.
- If its value is another key-value list, each key is interpreted as a ESP server name reporting want to register for, and values are ignored.
If a key-value pair with the key equal to some tenant identifier (database ID) is present in
the list:
- If its value is empty, Interaction Server assumes that reporting wants to register for all
reportable objects of the specified tenant.
- If its value is another key-value list, Interaction Server processes the list looking for
the following keys:
- Places - If this key is present with an empty value, Interaction Server assumes that reporting
wants to register for all places. If this key is present and its value is another key-value
list, each key in that list is interpreted as a place identifier that reporting wants to
register for, and values are ignored.
- Queues - If this key is present with an empty value, Interaction Server assumes that the reporting
engine wants to register for all queues. If this key is present and its value is a non-empty
key-value list, each key in the list is interpreted as a queue name that reporting wants to
register for, and values are ignored.
- Strategies - If this key is present with an empty value, Interaction Server assumes that the
reporting engine wants to register for all strategies. If this key is present and its value
is another key-value list, each key in the list is interpreted as a strategy name that reporting
wants to register for, and values are ignored.
- Workbins - If this key is present with an empty value, Interaction Server assumes that the
reporting engine wants to register for all workbins of all owners. If it has as its value
another key-value list, each key in the list is interpreted as a workbin type name, and each
value is interpreted as follows:
- If the value is empty, Interaction Server assumes that the reporting engine wants
to register for all workbin instances (regardless of the owner) of the specified
workbin type.
- If the value is another key-value list, each key in the list is interpreted as an
owner identifier of the workbin instance that the reporting engine wants to register
for. The owner identifier is either agent identifier (employee identifier), place
identifier (place name), agent group identifier (name), or place group identifier
(name), depending on workbin owner type.
setTenantList
public abstract void setTenantList(KeyValueCollection tenantList)
- List of reportable objects that reporting engine wants to receive reporting events for.
If the list is empty, Interaction Server assumes that the reporting engine wants to register
for all reportable objects.
If the list includes a key-value pair with the key ESP:
- If its value is empty, Interaction Server assumes that reporting engine wants to register for all of the ESP (External Services Protocol) server activity.
- If its value is another key-value list, each key is interpreted as a ESP server name reporting want to register for, and values are ignored.
If a key-value pair with the key equal to some tenant identifier (database ID) is present in
the list:
- If its value is empty, Interaction Server assumes that reporting wants to register for all
reportable objects of the specified tenant.
- If its value is another key-value list, Interaction Server processes the list looking for
the following keys:
- Places - If this key is present with an empty value, Interaction Server assumes that reporting
wants to register for all places. If this key is present and its value is another key-value
list, each key in that list is interpreted as a place identifier that reporting wants to
register for, and values are ignored.
- Queues - If this key is present with an empty value, Interaction Server assumes that the reporting
engine wants to register for all queues. If this key is present and its value is a non-empty
key-value list, each key in the list is interpreted as a queue name that reporting wants to
register for, and values are ignored.
- Strategies - If this key is present with an empty value, Interaction Server assumes that the
reporting engine wants to register for all strategies. If this key is present and its value
is another key-value list, each key in the list is interpreted as a strategy name that reporting
wants to register for, and values are ignored.
- Workbins - If this key is present with an empty value, Interaction Server assumes that the
reporting engine wants to register for all workbins of all owners. If it has as its value
another key-value list, each key in the list is interpreted as a workbin type name, and each
value is interpreted as follows:
- If the value is empty, Interaction Server assumes that the reporting engine wants
to register for all workbin instances (regardless of the owner) of the specified
workbin type.
- If the value is another key-value list, each key in the list is interpreted as an
owner identifier of the workbin instance that the reporting engine wants to register
for. The owner identifier is either agent identifier (employee identifier), place
identifier (place name), agent group identifier (name), or place group identifier
(name), depending on workbin owner type.
getExtension
public abstract KeyValueCollection getExtension()
- A key-value list of extensions.
For media servers the following extensions are defined, with values of type integer:
- event_properties_changed-If present and set to a non-zero value, Interaction Server
sends EventPropertiesChanged to the media server if properties of any interaction submitted
by this media server change.
- event_processing_stopped-If present and set to a non-zero value, Interaction Server sends
EventProcessingStopped to the media server if processing stops on any interaction submitted
by this media server.
setExtension
public abstract void setExtension(KeyValueCollection extension)
- A key-value list of extensions.
For media servers the following extensions are defined, with values of type integer:
- event_properties_changed-If present and set to a non-zero value, Interaction Server
sends EventPropertiesChanged to the media server if properties of any interaction submitted
by this media server change.
- event_processing_stopped-If present and set to a non-zero value, Interaction Server sends
EventProcessingStopped to the media server if processing stops on any interaction submitted
by this media server.
Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.