T-Controller [DRAFT]
T-Library Controller (or T-Controller) is a SIP Server module that provides the following services to SIP Server clients:
- Registration operations (register/unregister DN)
- Agent level operations (login/logout, ready/not ready)
- DN level operations (call forward, DND, call supervision)
- Query operations
- Agent reservation
Each T-Controller is connected to each peer T-Controller node in the cluster where a peer node is an HA-pair. [SIP Server diagram?]
T-Controller clients register agent DNs that they control on a given T-Controller node by using the TMonitorAllKnownDNs request. If registration is successful, T-Controller responds with EventACK and updates clients with the current state of monitored DNs using EventPrivateInfo MsgID 8197 (EventClusterDNStatus). After all EventClusterDNStatus events have been sent, T-Controller sends EventPrivateInfo MsgID 8197 (EventEndOfSnapshot) indicating that snapshot transmission has ended.
For registered DNs that are provisioned in Feature Server (DNs that are not configured in CME), SIP Server distributes EventClusterDNStatus containing AttributeAdrressType = 1 (DN). For registered Extensions and ACD Positions provisioned in CME (reserved as a special case for DN configuration), SIP Server distributes EventClusterDNStatus containing AttributeAdrressType as configured in CME.
SIP Server distributes events only for Agent DNs that are controlled by T-Controller. Events for other DN types are not reported to SIP Server clients. [Contradicts with the above statement?]
In a TMonitorAllKnownDNs request the client can set an input mask to specify events that the client wants to receive. In addition, it can specify a UserData filter to limit User Data in events to only requested keys.
The following TQueryAddress types are not supported: [Move it to the T-Library support?]
- AddressInfoNumberOfAgentsInQueue
- AddressInfoNumberOfAvailableAgentsInQueue
- AddressInfoNumberOfCallsInQueue
- AddressInfoQueueStatus
- AddressInfoQueueLoginAudit
Configuration
T-Controller listening port is configured in the SIP Server Application > Server Info.
AttributeExtensions keys
SIP Server supports the following key-value pairs in AttributeExtensions of TRegisterAllKnownDNs requests: UDataFilter and InputMask.
UdataFilter
Description: A key-value list of User Data keys in the following format:
key-<%d> <key value>
where %d is the key’s sequential number starting from 1 and key value is the value of the key in a string format.
If UdataFilter is missing, no filter is used. If the UdataFilter list is empty, the entire User Data is filtered out.
InputMask
Description: Specifies which events T-Controller distributes to a client. The Input Mask value is the same as in AttributeInputMask of TSetInputMask.