GnuGk Control Center 2.0 User Manual

License
1. Introduction to GnuGk Control Center
2. Running for first time

3. Interface Walkthrough

• GnuGk Control Center Navigation Overview
• Toolbar
• Navigation Bar
  • Gatekeepers Summary Info Mode
  • Gatekeeper Details Info Mode
  • Endpoints Info Mode
  • Calls Info Mode
  • Virtual Queues Info Mode
  • Configuration Info Mode
• Log Panel
• Menu

4. Using GnuGk Control Center
5. How To

GnuGk Control Center Navigation Overview

The screen is divided in four parts:


• Navigation Bar at top of the window.
• A list of working gatekeepers at left side.
• Main information panel - situated at right side of the screen. Displays information depending of selection on left panel.
• Log area - down of the window.

Toolbar

The navigation bar includes a toolbar for fast access to some commands and additional bar for fast navigation between different information panels.

Toolbar
• - Connect to gnugk - accessible only if currently selected gatekeeper is not connected to. ( MENU: Gatekeepers -> Connect to ... )
• - Disconnect from gnugk - accessible only if currently selected gatekeeper is connected. ( MENU: Gatekeepers -> Disconnect from ... )
• - Reread Gatekeeper Status - makes synchronization between internal status of gnugk and gnugk-cc. Accessible only if currently selected gatekeeper is connected. ( MENU: Configuration -> Read Status From ... )
• - Log To Screen Options - fast access to logging options for currently selected gatekeeper. ( MENU: Gatekeepers -> Edit gatekeeper ... Log To Screen Tab )
• - Alarm Options - fast access to alarm options for currently selected gatekeeper. ( MENU: Gatekeepers -> Edit gatekeeper ... Alarms Tab )
• - Edit gnugk configuration - Opens dialog for editing configuration file of current gnugk. Accessible only if currently selected gatekeeper is connected. ( MENU: Configuration -> Edit ... )
• - Send "Reload" command to gatekeeper - Forces gnugk to reload configuration file. Only accessible, if the currently selected gatekeeper is connected. ( MENU: Configuration -> Send Reload ... )
• - Unregister Endpoint - Unregisters currently selected endpoint. Accessible if information panel shows Endpoints List. ( MENU: Endpoints -> Unregister Endpoint ... )
• - Disconnect Call - Disconnects currently selected call. Accessible if information panel shows Calls List. ( MENU: Calls -> Disconnect Call ... )

The Second bar has two purposes. It shows important information about current gatekeeper. Second function is for fast switching between different modes of information panel.

• - Switch to Summary mode. In this mode the right panel shows summary information for gatekeepers.
  
  
  
  
  
  

  The columns in the information panel are: Gatekeeper Description of gnugk, entered in New Gatekeeper dialog. Hostname /IP IP address of gnugk, entered in New Gatekeeper dialog. Name Name of gnugk. This value is from section [Gatekeeper::Main] from configuration file. Running Running time of gnugk. Parent GK IP address and status of parent gatekeeper if any. Endpoints Count of currently registered endpoints. Calls A/C/T Current calls count - Active/Connected/Total. Last ASR ASR for last period. The calculation period can be changed in Edit Gatekeeper Dialog ( MENU: Gatekeepers -> Edit gatekeeper ). Total ASR ASR from starting of gnugk. Active Alarms Currently active alarms. Alarms can be changed in Edit Gatekeeper Dialog ( MENU: Gatekeepers -> Edit gatekeeper ).

  The gatekeeper icon is as follow: Not connected to gnugk. Connecting to gnugk. Connected to gnugk. Cannot connected to gnugk.

• - Switch to Gatekeeper mode. In this mode the right panel shows detailed information for currently selected gatekeeper.
  
  
  
  

• - Shows count of current registered endpoints. When you click the program switches to Endpoint mode. In this mode the right panel shows detailed information for registered endpoints.
  
  
  
  
  
  
  

  The columns in the information panel are: IP IP address of endpoint. h323id H323 alias. e164 E164 number(s), associated with this endpoint. Type Type of endpoint - terminal, gateway, other (gatekeeper, MCU, etc). Prefixes Prefixes for gateways. C(A/C/T) Calls count - Active/Connected/Total. Current call Current call - caller > called. Registration time Time of registration. Permanent Shows if permanent or not.

  The endpoint icon is as follow: Terminal Gateway Other (GK,MCU) Not in call Active call, caller, not connected Active call, caller, connected Active call, called, not connected Active call, called, connected Unregistered

• - Shows calls count (Active/Connected/Total). When you click the program switches to Calls mode. In this mode the right panel shows detailed information for current calls.
  
  
  
  
  
  
  

  The columns in the information panel are: Caller Caller's alias or e164 number. Called Called alias or e164 number. Duration Call duration. Caller IP Caller's IP address. Called IP Called IP address. Connect time Call start time. Disconnect time Call end time. Disengage Reason Disengage reason from gnugk. No The number of call from gnugk.

  The call icon is as follow: In-zone -> In-zone In-zone -> Out-of-zone Out-of-zone -> In-zone Out-of-zone -> Out-of-zone Active, connected Active, unconnected Ended Ended, unconnected

• - Switch to Virtual Queues mode. In this mode the right panel shows information for Virtual Queues.
  
  
  
  
  
  
  

  The columns in the information panel are: Virtual Queue H323 alias for the virtual queue. Forward to List of H323 aliases servicing the queue. Gateway Gnugk 2.2 only. Calls are routed to this gateway. Is Served Shows if served or not.

  The virtual queue icon is as follow: Served Not Served

• - Switch to configuration mode. In this mode the right panel shows the current configuration of gnugk.
  
  
  
  
  
  
  If you wish to change some configuration parameters, please double click on right panel.

• - Information area only. Shows ASR and calls count (Connected/Total), calculated for last period for current gatekeeper.
  
  

Log Panel

Gnugk-CC shows information for current events for each connected gatekeeper in Log panel. In "Edit Gatekeeper" dialog ("Log to screen" tab) you may select different events for logging. This option is available for every gatekeeper.

MENU: Gatekeepers

New gatekeeper Add a new gatekeeper to list. Edit gatekeeper ... Change an options for current gatekeeper. Remove gatekeeper Remove a gatekeeper from list - accessible only if currently selected gatekeeper is not connected. Connect to ... Connect to gnugk - accessible only if currently selected gatekeeper is not connected. Disconnect from ... Disconnect from gnugk - accessible only if currently selected gatekeeper is connected. Exit Quit from Gnugk Control Center

MENU: Configuration

Edit configuration Opens a dialog for editing configuration file of current gnugk. Accessible only if currently selected gatekeeper is connected. Read Status From ... This command makes synchronization between internal status of gnugk and gnugk-cc. Accessible only if currently selected gatekeeper is connected. Send Reload to ... Sends "Reload" command to gatekeeper - Forces gnugk to reload configuration file. Accessible only if currently selected gatekeeper is connected. Virtual Queues for ... Opens a dialog for manage of virtual queues. Accessible only if currently selected gatekeeper is connected. Backup configuration ... Backup the current gnugk configuration to file. Accessible only if currently selected gatekeeper is connected. Restore configuration Reads a backup file and sends the configuration to gnugk. Accessible only if currently selected gatekeeper is connected. Set trace level for ... Changes the trace level. Accessible only if currently selected gatekeeper is connected.

MENU: Endpoints

Unregister Endpoint ... Unregister the currently selected endpoint. Accessible when information panel shows Endpoints List. Unregister All Endpoints Unregister all registered endpoints. Accessible when information panel shows Endpoints List.

MENU: Calls

Disconnect Call Disconnects the currently selected call. Accessible when information panel shows Calls List. Disconnect All Calls ... Disconnect all calls from currently selected gatekeeper. Accessible when information panel shows Calls List.

MENU: View

Toolbar Show/Hide button bar. Navigation Bar Show/Hide additional navigation bar. Status Bar Show/Hide status bar. Icon Legend Show dialog with icon legend. Clear logs Clear Log panel. Program options Show dialog with global program options.