WorkMan Agent+ShellAPI

Shell API

This feature requires a specific license and can be purchased seperately

It is included in the +WebAPI version.

Configuration

This must be configured manually in the registry. This is a sample of an registry-file

 [HKEY_CURRENT_USER\Software\WorkMan\WorkManAgent]
 "UseShellAPI"="TRUE"
 "ShellApp"="c:\\phonetest.bat"
 "ShellParams"="%VMID% %CALLERID% %CALLEDID%"
 "ShellWindow"=dword:00000001

UseShellAPI TRUE means it's being used. FALSE means it's not.

ShellApp is the shortcut to the application, excluding the parameters!

ShellParams is the parameters being sent to the application and the value %VMID% is used when the callerid triggers a call with extended information (e.g. VoiceMail Pro on IP Office) where %VMID% is the ID entered by VoiceMail Pro, %CALLERID% is caller id and %CALLEDID% is of course Called ID.

ShellWindow is how the window will be displayed, following integer-values exists:

 SW_HIDE = 0;
 SW_SHOWNORMAL = 1;
 SW_NORMAL = 1;
 SW_SHOWMINIMIZED = 2;
 SW_SHOWMAXIMIZED = 3;
 SW_MAXIMIZE = 3;
 SW_SHOWNOACTIVATE = 4;
 SW_SHOW = 5;
 SW_MINIMIZE = 6;
 SW_SHOWMINNOACTIVE = 7;
 SW_SHOWNA = 8;
 SW_RESTORE = 9;
 SW_SHOWDEFAULT = 10;
 SW_MAX = 10;

PhoneManager Integration

The registry value UsePhoneManager indicates a TRUE or FALSE value if WorkMan Agent should try to detect PhoneManager for it's settings.

The string registry value PhoneManagerIni can contain the env-variable %USERNAME% to search in different paths e.g:

 C:\Documents and Settings\%USERNAME%\UserID.ini

The string key PhoneManagerAutoRefresh can be set to TRUE or FALSE depending if you want to do automatic refresh of TAPI-device from Phone Manager or not. If you are using Phone Manager this is default to TRUE.

Additionally the cardinal entry PhoneManagerTimerInterval can be used to set seconds between each Phone Manager check. Minimum value is 20 seconds.

Samples

Firefox

The following launches firefox with parameters to our testpage.

 [HKEY_CURRENT_USER\Software\WorkMan\WorkManAgent]
 "UseShellAPI"="TRUE"
 "ShellApp"="firefox"
 "ShellParams"="http://www.workmansoft.net/test/testvar.php?vmid=%VMID%&callerid=%CALLERID%&calleid=%CALLEDID%"
 "ShellWindow"=dword:00000001

Testing

You can easily test this using a bat-script e.g. something like this:

 @echo off
 echo ID %1 
 echo CallerID %2
 echo CalledID %3
 pause

Note that you need to restart WorkMan Agent for the new settings to be valid.