EXAMPLE

Dim mylog as VBVLog

Set mylog = new VBVLog

mylog.SetLineStatusExtra(Channel, 2, Getting PIN)

EXAMPLE

If the ID of the LStat applet is LineStat and the method is called on the applet, such as:

LineStat.getChannelData(1,2)

Then the events onSetChannelCallDuration, onSetChannelCallSpacing, and onSetChannelUserStats will be called repeatedly, once for every channel requested. Events that are not implemented on the page will be ignored: you need only implement events that provide needed data.

Similarly, the Group events are called in response to getGroupData and the Total events in response to getTotalData.

onSetConnectStatus

onSetConnectStatus(String msg)

onSetTimes

onSetTimes(int chnl, String channelTime, String controlTime)

onSetStatus

onSetStatus(int chnl, String status)

onSetControlName

onSetControlName(int chnl, String controlname)

onSetLineName

onSetLineName(int chnl, String linename)

onSetConnectStatus

onSetConnectStatus(String y)

onSetUserData

onSetUserData(int chnl, int which, String y)

onSetChannelCallDuration

onSetChannelCallDuration(int chnl, int avg, int minval, int maxval, int last, int total)

onSetChannelCallSpacing

onSetChannelCallSpacing(int chnl, int avg, int minval, int maxval, int last, int total)

onSetChannelUserStats

onSetChannelUserStats(int chnl, int whichuser, int avg, int minval, int maxval, int last, int total)

onSetGroupCallDuration

onSetGroupCallDuration(int group, int avg, int minval, int maxval, int last, int total)

onSetGroupCallSpacing

onSetGroupCallSpacing(int group, int avg, int minval, int maxval, int last, int total)

onSetGroupUserStats

onSetGroupUserStats(int group, int whichuser, int avg, int minval, int maxval, int last, int total)

onSetTotalCallDuration

onSetTotalCallDuration(int avg, int minval, int maxval, int last, int total)

onSetTotalCallSpacing

onSetTotalCallSpacing(int avg, int minval, int maxval, int last, int total)

onSetTotalUserStats

onSetTotalUserStats(int whichuser, int avg, int minval, int maxval, int last, int total)

addEvent

addEvent(String dataType)

The addEvent method requests events whenever data of the requested type changes. Possible event types are:

1. LineName

2. ChannelTime

3. ControlName

4. ControlTime

5. Status

6. UserData1

7. UserData2

8. UserData3

startStatusUpdates

startStatusUpdates(int startch, int numch)

startStatusUpdates method initiates status updates from VBVRLOG.EXE. As data is received, events are fired into the page as specified by the addEvent method. Only data requested by addEvent is provided.

stopStatusUpdates

stopStatusUpdates()

stopStatusUpdates method terminates status updates from VBVRLOG.EXE.

getChannelData

getChannelData(int start, int numch)

getGroupData

getGroupData(int start, int numch)

getTotalData

getTotalData()

EXAMPLE

<param name = Filter value = 00001CFC

Clear

Clears the log list display

onMessage

onMessage(int size)

The onMessage event signals that an AgentX message has been received. The size parameter indicates how many key/value pairs are available in this message. The message data can be retrieved using the methods described below.

onSetConnectStatus

onSetConnectStatus(String msg)

The onSetConnectStatus event is used to signal changes in the connect status of the Lstat applet with the server.

AddData

int AddData(String key, String data)

See Send below.

Connect

int Connect(String appid, int events)

Disconnect

int Disconnect()

Connect and Disconnect are used to connect the applet to the server and are equivalent to the Connect and Disconnect methods in the AgentX control. Messages cannot be sent or received until a connection is made. Connect and Disconnect return the value 0 if successful.

Remember that if you expect a reply from the server, you should not disconnect until it has been received. It is a good idea to use a timer (SetInterval function) to ensure that the connection is always disconnected.

getNextMessage

int getNextMessage()

See getMessageData.

getNextMessageKey

String getNextMessageKey()

See getMessageData

getMessageData

String getMessageData()

These three methods are used to retrieve data from incoming AgentX messages. When an incoming message is signalled, the getNextMessageKey method can be used to retrieve the name of the first key from this message. The getMessageData returns the data associated with this key. These two functions can be called repetitively to retrieve all data associated with the message. The getNextMessageKey function will return a null string when all keys have been enumerated.

The getNextMessage function will clear the current message from the queue.

EXAMPLE

This example is taken from admin.htm (where is this?) and it demonstrates the use of the AgentX control and the onMessage event. This event iterates through all waiting messages and for each message it prints the key and value names to a DHTML object agentxdata.

function onMessage(sz)

{

   var key;

   alert (sz + " messages received")

   vkey = agentx.getNextMessageKey();

   var obj = document.all.agentxdata

   obj.innerHTML = sz + " messages received<BR>"

   do   //iterate over all messages

   {

      while (vkey!= null)   //iterate over all keys

      {

         vdata = agentx.getMessageData();

         document.all.agentxdata.innerHTML =

         obj.innerHTML += "key: '" + vkey + "' - data: '" + vdata + "'<BR>";

         vkey = agentx.getNextMessageKey();

      }

      vkey = agentx.getNextMessageKey();

   } while (agentx.getNextMessage()!= 0);

}

Send

int Send()

This method is used with the AddData method to send AgentX messages to the server. A message can be built by calling AddData repetitively, once for each key/value pair required. The Send method is then used to send the message to the server. Send returns 0 if successful.

EXAMPLE: sending a message

   // connect with the appid "CALLME"

var ret = agentx.Connect("CALLME", 1);

if (ret)

{

   alert("failed to connect: error code " + ret)

   return;

}

// add 2 keys, "dial" and "customer"

agentx.AddData("dial", "aaa");

agentx.AddData("customer", "aaaaaa");

//send the message      

ret = agentx.Send();

if (ret)

{

   alert("failed to send: error code " + ret)

   return;

}

// we don't want replies so disconnect now

var ret = agentx.Disconnect();

if (ret)

{

   alert("failed to disconnect: error code " + ret)

   return;

}

EXAMPLE: receiving a message

event handler:

<script language="JScript" for="agentx" event="onMessage(sz)">
 onMessage(sz)
</script>

This function iterates through all the messages waiting and processes each key in each message. If a key Alert is found, a message box is displayed. The key and value are set to a DHTML element for display.

function onMessage(sz)

   var key;

   alert (sz + " messages waiting from server")

   vkey = agentx.getNextMessageKey()

   var obj = document.all.agentxdata

   obj.innerHTML = sz + "messages received<BR>"

   for (i = 0; i < sz; i++)

   {

      while (vkey!= null)

      {

         vdata = agentx.getMessageData();

         if (vkey == "Alert")

         {

            window.alert(vdata)

         }

         document.all.agentxdata.innerHTML =

         obj.innerHTML += "key " + vkey + " - data " + vdata + "<BR>";

         vkey = agentx.getNextMessageKey();

      }   //delete cur message, get next

      agentx.getNextMessage();

   }

}

Web Page

Associated VB program

See Page

Statistics

stats_1.htm

admin.vbp

??????

stats_2.htm

admin.vbp

stats_3.htm

 admin.vbp

stats_all.htm

admin.vbp

AgentX

agentx_callme.htm 

callme.vbp

admin.htm

admin.vbp

LineStatus

lstatbasic.htm

admin.vbp 

lstatcfg.htm

admin.vbp

admin.htm

 admin.vbp

Logs and Call Details

logs.htm

Any VBVoice application

channellog1.htm

Any VBVoice application

channellog2.htm

Any VBVoice application

admin.htm

admin.vbp

Applet Declaration

<applet code="lstat.class" width=1 height=1 id="linestat">
 <param name="FiresScriptEvents" value="true">
 <param name="updateperiod" value="1000">
</applet>

Note that the parameter FiresScriptEvents must always be set to true to enable scripting events. The Updateperiod defines how often data on the page is refreshed.

maketable function

maketable(startchan, numchans)

The maketable function is a general purpose function that creates a DHTML table. It creates the table based on parameters provided and initializes the LineStat class.

Onload function

The declaration for the page references the onload event, which initializes the applet:

<script language="JScript" for="window" event="onload()">
 linestat.addEvent("LineName");
 linestat.addEvent("Status");
 linestat.addEvent("ControlName");
 linestat.addEvent("ChannelTime");
 linestat.addEvent("ControlTime");
 linestat.startStatusUpdates(1,4);
</script>

This code enables the events for changes in the LineName, Status, ControlName, ChannelTime, and ControlTime fields.

startStatusUpdates

It then initiates status updates by calling the startStatusUpdates function for channels 1 to 4.

Table declaration

The table declaration is declared with the id 'table1', and contains rows for each channel, and columns for each data type. Each cell has an id, such as Status1, or Linename2, so that it can be identified and modified in the applet events.

onSetStatus event

<script language="JScript" for="linestat" event="onSetStatus(chnl, status)">
 onSetStatus(chnl, status);
</script>

Above is the event handler for the onSetStatus event from the applet. It in turn calls the onSetStatus function, declared as follows:

function onSetStatus(chnl, status)

{

   var objid;

   objid = "Status" + chnl.toString(10);

   var obj = document.all(objid);

   if (obj!= null)

      obj.caption = status;

}

This code finds the object associated with the Status field for the appropriate channel by using the ID (such as Status1) to reference the HTML object model:

   var obj = document.all(objid);

The text for this cell is then changed using the caption property:

obj.caption = status

where status is the data provided by the applet event.

HTML body elements

The body of the HTML page contains two elements, the lstat java applet and a table to display the data.

Lstat applet

The applet declaration is identical to the other examples and has been described previously.

Table definition

The table provides 3 columns, for average call duration, call count and total call count, and 4 rows, for channels 1 to 4. Each cell in the table has an ID, which is used to reference the cell when updating the data. Shown below is one row from this table:

<TR>
 <TD>Channel 1: <span ID="CallDuration_chnl1">0</span></TD>
 <TD><span ID="totalCallCount_chnl1">0</span></TD>
 <TD>Total: <SPAN ID="totalCallCounts">0</span></TD>
</TR>

The &nbsp; and <b> elements are for formatting only and have been removed from the sample above for clarity.

SCRIPTING:

refreshData

function refreshData()

{

   linestat.getChannelData(1,4)   //get channels 1 to 4

   linestat.getTotalData();   

}

This function calls the getChannelData function in the lstat applet which requests a data update from the server. When the data arrives, the onSetChannelCallDuration will be called. Similarly, the getTotalData function is called, which will result in an onSetTotalCallDuration event.

Onload event

The body declaration for the page references the onload event, which calls the refreshData function, and the setInterval function. This performs a one-time update of the required data, and sets up a timer to call refreshData every 5 seconds.

<body onload="refreshData();setInterval('refreshData(),5000);">

<h2> Call Statistics Example - basic measurements</h2>

settextvalue

This is a utility function that sets a value to an HTML element, given a HTML id and a new value.

onSetChannelCallDuration event

This event is called by the lstat applet when new call duration data is received from the server. In this implementation, the new values are set into the table using the settextvalue function.

<script language="JScript" for="linestat" event="onSetChannelCallDuration(chnl, avgval, minval, maxval, last, total)">
 settextvalue("CallDuration_chnl" + chnl, avgval)
 settextvalue("totalCallCount_chnl" + chnl, total)
</script>

onSetTotalCallDuration event

This event is called by the lstat applet when new data for total call duration is received from the server. It is used to update the table in the same way as onSetChannelCallDuration.

<script language="JScript" for="linestat" event="onSetTotalCallDuration(avgval, minval, maxval, last, total)">
 //set total call count
 settextvalue("totalCallCounts", total)
</script>