GnuGk Control Center 2.0 User Manual



Content




    For receiving information or to operate, you should be successful connect to gatekeeper.
    All actions and commands are assigned for currently selected gatekeeper.

    Warning: For correct and successful working of Control Center, the gnugk must be in routed mode.




Gatekeeper Configuration


    To enter in configuration edit mode press button or select MENU: Configuration -> Edit .... The Configuration edit dialog will appears on the screen:




    The configuration sections are separated in different groups. Each group is located in different tab. All standard parameters in each group are preloaded.
    Gnugk Control Center shows only usable parameters depending on version of gnugk. The parameters without values in current configuration are unchecked and greyed. Some parameters have preloaded enumerated values and you can select them from combobox when click on value column.


    For some section groups the configuration dialog is more complex. For facilitating you, the gnugk-cc shows the section depending of your current selection. Such groups are Authentication, Accounting and Neighbors (gnugk 2.2 only).





    To Add/Delete or Move parameter click on right mouse buton and select necessary command from menu. Note that you can delete only nonstandard parameter, which has been entered from you (like permanent endpoins, rewrite rules, etc).
    In groups Neighbors and EP::* you can add or delete a new sections by right click on section list. This is available if your gnugk version is 2.2.
    Moving the parameters up/down is useful for sections where the sequence is important (like Gatekeeper::Auth).






    After finishing, click on OK button. The Gnugk Control center will send a new configuration to gnugk and will forces reloading command.

    WARNING: You could not set a value for parameter containing space! Parameters,containing white spaces in itself are not sent to gatekeeper because gnugk don't accepts them. Such parameters must be edited directly in gnugk configuration file.



Backup/Restore configuration file


    To create the backup for gnugk configuration file, please select menu Configuration -> Backup configuration ... Gnugk-cc will save the current configuration in file, located Backup Config Directory. You can set the Backup Config Directory in a global option dialog. The Backup file will be named Gatekeeper_Description-YEAR-MON-DAY-HOUR-MINUTE-SEC.cfg.

    To restore the configuration, please select menu Configuration -> Restore configuration ... Select file to restore and click Open.
    Gnugk-cc will read the file and the confirmation dialog will appears on the screen:






    After setting the confirmation, Gnugk Control center will send the new configuration to gnugk and will force reloading command.

    WARNING: The parameters,containing white spaces in itself are not sent to gatekeeper because gnugk don't accept them. Such parameters must be edited directly in the gnugk configuration file.


Logging to Screen


    Gnugk-CC shows information for current events for each connected gatekeeper in Log panel.
    For change the logging options, please press button or select menu Gatekeepers -> Edit Gatekeeper. The edit gatekeeper dialog appears.
    In "Log to screen" tab you may select different events for logging. This option is available for every gatekeeper.








Logging to File


    Gnugk-CC can records different events to file. For each gatekeeper are created two log files: one for raw logs and other for CDR logs.
    These files are in folder selected in "Edit gatekeeper" dialog ("Log to file" tab).
    To change the logging options, please select menu Gatekeepers -> Edit Gatekeeper. The edit gatekeeper dialog appears.
    In "Log To File" tab you may select different events for logging.






    For each gatekeeper are created two log files: one for raw logs and other for CDR logs. These files are in folder selected in "Edit gatekeeper" dialog ("Log to file" tab).
    For every twenty-four hours, a different log file is generated. The file names are:
      For raw logs - gatekeeper_description-Raw-year-month-day.log
      Example: London-Raw-2004-09-04.log

      For CDR logs - gatekeeper description-CDR-year-month-day.log
      Example: London-CDR-2004-09-04.log

    The format for raw log is : Current time [TAB] raw message from gnugk[New line].

    2004.09.06 11:56:09Connection established
    2004.09.06 11:56:13 (gk)ACF|127.0.0.1:1720|6667_endp|9|111:dialedDigits|callgen:h323_ID|false
    2004.09.06 11:56:13 (gk)ACF|192.168.0.2:1720|1973_endp|9|111:dialedDigits|callgen:h323_ID|true
    2004.09.06 11:56:19 (gk)CDR|113|a1 6b e5 6d fa f0 18 10 8f 1a 00 01 29 79 4d 2a|4|Mon, 06 Sep 2004 10:56:15 +0200|Mon, 06 Sep 2004 10:56:19 +0200|127.0.0.1:1720|6667_endp|192.168.0.2:1720|1973_endp|111:dialedDigits|callgen:h323_ID|GK001
    2004.09.06 11:56:19 (gk)DCF|192.168.0.2|1973_endp|9|normalDrop
    2004.09.06 11:56:22 (gk)DCF|127.0.0.1|6667_endp|9|normalDrop


    The format for CDR log allows easy additional processing for call detail records. ( Excel or import in other applications) :

    CallNumber [TAB] Caller [TAB] CallerIP [TAB] Called [TAB] CalledIP [TAB] CallDuration [TAB] Unix ConnectTime [TAB] Unix DisconnectTime [TAB] ConnectTime string [TAB] DisconnectTime string [TAB] CallID [New line]

    CallNumberCallerCallerIPCalledCalledIPCallDurationUnix ConnectTimeUnix DisconnectTimeConnectTime stringDisconnectTime stringCallID
    113callgen127.0.0.1:1720111192.168.0.2:17204109446097510944609792004.09.06 10:56:15 (gk)2004.09.06 10:56:19 (gk)a1 6b e5 6d fa f0 18 10 8f 1a 00 01 29 79 4d 2a
    114callgen127.0.0.1:1720111192.168.0.2:17200010944609922004.09.06 10:56:32 (gk)e3 22 f8 6d fa f0 18 10 8f 1b 00 01 29 79 4d 2a




Monitoring and Alarms


    Gnugk-cc can send an alarm messages to you if some of criteria is out of condition.
    To use a notification alarms you must provide a SMTP and an e-mail address settings in Global program option dialog.

    To change the alarm options, please press button or select menu Gatekeepers -> Edit Gatekeeper -> Alarm Tab.









    Gnugk-CC will send a message if some of conditions bellow had a long run for given time period.

    Condition time - An e-mail notification will be sent if some of monitored conditions are true.

    Monitored condition:

    • Connection to gnugk
    • Registration to parent gatekeeper (if any)
    • ASR for calculation period
    • Active calls count
    • Registered endpoints count



Virtual Queues


    The Virtual Queues of gnugk are created in section CTI::Agents in configuration file.
    Gnugk-CC is an external application, that makes all necessary actions outside of gatekeeper for normal operation.
    When a call to virtual queue alias arrives, the GnuGk Control Center redirects the call to some endpoint from endpoints list or to given gateway on depend of your setting.

    To add or change a virtual queue, please go to menu Configuration -> Virtual Queues....




    • Alias - alias of Virtual Queue. If a call to this alias arrives, the gnugk is asking the Control Center for real alias, which must receive this call;
    • This is a prefix - if checked, the alias field is interpreted like a prefix;
    • Do NOT serve from this computer - If checked, the gnugk-cc will not serve this Virtual Queue;
    • Route To Alias - If selected, the gnugk-cc will route call to some endpoint from Forward To list;
    • Route To Gateway - If selected, the gnugk-cc will route a call to gateway given below. This option is available only for gnugk version 2.2;


    Route To Alias Options
    • Forward to - a list of aliases of real endpoints. The calls will redirected to these endpoints.
    • Forward strategy -> Only to registered alias - The calls are forwarded to given endpoint, only if it is registered in the gatekeeper;
    • Forward strategy -> Round Robin - the calls are forwarded to target aliases, where they are in rotation;
    • Forward strategy -> First available - the calls are forwarded to first available target alias;
    • If not available -> Do nothing - if there is not free target alias, gnugk-cc does nothing;
    • If not available -> Reject - if there is not free target alias gnugk-cc sends RouteReject to gnugk;
    • If not available -> Forward to - if there is not free target alias all calls are forwarded to Forward to (example: to MCU);


    Route To Gateway Options
    • Forward to - Route the call to this alias. If empty, gnugk-cc will use an original alias;
    • Gateway - Route the call via this gateway;


    To create a new Virtual Queue, please press "New" button.
    To delete this Virtual Queue, press "Remove" button.


Program Options


    To change the global program options, please select menu View -> Program options.








    Various Options

    • Auto Reconnect to GK After - if checked and value is more that zero, gnugk-cc will connect to gnugk automatically, if connection is lost (depends of gatekeeper setting);
    • Remove Finished Calls After - if checked gnugk-cc will clear finished calls from list automatically;
    • Virtual Queues Sync Time - The time period for synchronisation for internal status of virtual queues;
    • Logs Scrollback Lines - if lines in log panel reached this value, gnugk-cc will clear lines at the beginning;


    Alarms

    • Send Alarm E-Mail Messages - if checked gnugk-cc will send a notification alarms depending of other setting;
    • Mail To - e-mail recipient;
    • Mail From - e-mail sender;


    Backup directory

    • Backup Config Directory - gnugk-cc will save the backup files in this directory;