Event Center (rev b) EVENT CENTER. VPI 160 Camino Ruiz, Camarillo, CA (Voice) (Fax)

Transcription

1 EVENT CENTER 1 VPI 160 Camino Ruiz, Camarillo, CA (Voice) (Fax)

2 All information in this manual is Copyright protected material by Voice Print International, Inc. As the registered end user of the Voice Print Digital Voice Logger, you are free to make and use as many copies of this manual as you like, so long as it is used for internal purposes only and is not transmitted in any manner whatsoever to any individual, organization or corporate entity not specifically named in your End User License Agreement. 2

3 Contents Event Center Reading the Event Log Event Center Setup Event Log Settings Display Columns Log File Export Alarm Notification Alarm Notification Setup Local Pop-Up Message Local Audio Alarm Remote Net-Pop Message Copy to System Log Pager Notification Notification Script Notification Reserved for future use Alarm Notification Defaults INDEX

4 1.0 Event Center Voice Print uses the Event Center to provide detailed information about system events and errors encountered by the logger. Key Features: Runs as a Windows NT/2000 service with over seven event types from error, warning to notify and by agent. Supports up to 15 notification types. You can customize notification to your specific environment. Choose from Local or network pop-up messages, local audio alarm, or to notify you of a specific event or group of events. Copy events to the Windows NT/2000 event log, pager, or script. If you feel procedures specific to your environment are needed, we have provided you with an interface with which you can execute a Windows batch or Visual Basic Script per each notification type. This can include domain wide or user net send messaging. Types of events logged: General System Information Agent Login / Logout Search Activity Archive Events Channel Activity Remote Client Interaction The Event Log is saved to disk every 2,000 messages and when Voice Print is shut-down. The Event Log is saved in the application directory (F:\Event Log) with the filename VP_Event.log. If this file is deleted, Voice Print will recreate the Event Log file the next time it is saved to disk. Unless it is otherwise needed, it is a good idea to delete the Event Log file during your normal system maintenance Reading the Event Log Every Event Log message is provided a category, timestamp, sub-system name, and a message. Example Message: INFO: 7/17/02 1:41:52 PM - Client Manager, Client ID: 0 Agent: 1 - Administrator - Terminated Connection. 4

5 The Event Log displays several categories of messages. They are as follows: INFO/GENERAL: General Information messages. Can be ignored. Example Message: Media Loaded, ID: 7, Ver: 2.5, App: Voice Print, Logger ID: 1 WARNINGS: Warning messages are used to present conditions which might become errors in the future but may still be corrected internally by Voice Print. Example Message: WARNING: 7/17/02 11:07:34 AM - Activity Timeout - Agent ID: 0001, Administrator ERRORS: Error messages are normally events which require user intervention of some type. For example, if the Archive Media becomes full and needs to be changed by the user, an error message is generated. Example Message: ERROR: 7/17/02 2:20:50 AM - Archive, UNABLE TO ARCHIVE CALLS AS SCHEDULED! No suitable archive media could be found. Check Archive Devices. Will Try Again Later. TRACE: Trace messages are used for problem resolution. Trace Events allow the user as well as Tech- Support personnel to gather more information about internal system activity. Example Message: TRACE: 7/17/02 1:57:01 PM - DB Access, Update Transactions DB Table Called... NOTE: Due to the large number of Trace Events generated by Voice Print, it is not recommended to log Trace Events unless directed to by Voice Print Technical Support (see paragraph 2.5). AGENTS: Agent messages show processes such as Agent ID, login, call searches and media reports. Example Message: 7/17/02 1:57:01 PM - Main, User Login - Agent ID: 0001, Administrator 5

6 NOTIFICATIONS: Alarm notifications include such warning alarms as change media, buffer failure, and archive failure. Notification alarms require user intervention. FILTER: Filter criteria will omit messages viewed in the Live Message screen of the Event Center. This can be a handy tool when narrowing down data to pinpoint a specific problem. However, even though you cannot view certain data, the information is still written to the event log. 6

7 SEARCH: Search criteria will include only message types selected in the Include Message Types check boxes. This can be a handy tool when narrowing down data to pinpoint a specific problem. 7

8 1.1.2 Event Center Setup Event Log Settings Under the Options drop down menu there is a selection for Event Log Settings. These settings control how events are written to the Event Center Log file. To access the Event Log Settings feature, select Options > Event Log Settings. Purge Log File The Purge Log File setting automatically deletes messages from the Event Log File older than X number of days selected. The default is set for 10 days. If you choose to disable event log management, all selected events will be written to the log file indefinitely. Be careful when choosing to disable event log management due to the increase in size of the log file. Log File Directory The default directory for the Event Center Log is F:\Event Log. It is not recommended to change the default directory unless directed to by a Voice Print Technician. 8

9 Events to Log Only events checked will be written to the event log. The events to select from are: Information Agent Events Errors Debug Trace Warnings Internal Trace Delete All Button The Delete All Button will delete ALL records in the event log file and the action cannot be reversed! If you need a backup before deleting the file, use the Log File Export feature described in paragraph

10 Display Columns By right clicking anywhere on the Event Center screen, a shortcut window will appear. The window allows you to clear all messages, select message types (i.e., General, Messages, etc.), and change your column display. To change the column display, select Display Columns and check or uncheck the following: Event Type Application Name Time Stamp Process Message 10

11 Log File Export You can create a backup or export a copy of All Applications or just the Event Center and Voice Print Server applications. Choosing Date/Time and Message Types will create a customized file. The export file format can be in either standard Event Center Log File format or Plain ASCII Text Files. A Process Name can be selected to be included with the export file. To access the Log File Export feature, select File > Export > Save As -OR- Send To Alarm Notification Besides Archive and Buffer alarms available in the Voice Print Server program, the Event Center gives you much more flexibility when creating alarm notifications. Alarm notifications can be created for the following events: Database Error: A critical error involving the Voice Print Database. Channel Error: A critical error involving the Channel Manager or one of the Channels. Buffer Alarm: A critical error involving the Buffer Device(s). 11

12 Archive Alarm: A critical error involving the Archiving Device(s). Unexpected Error: Voice Print uses this error when it encounters an unknown or unexpected critical error Alarm Notification Setup To setup Alarm Notifications, select Options > Alarm Notifications > Alarm Specific. Each event has it s own unique setting -OR- you can create defaults that can be used for all events (see paragraph ). Default settings can be applied to the currently selected event. Check the event you want to keep track of and select one or several Notification Options. To set-up each Notification Option, see paragraphs

13 If you decide to uncheck an event you will receive the following warning. Enabling the event again will apply the previously defined settings Local Pop-Up Message Local Pop-Up Messages will inform the Administrator of event errors. The messages will be in standard Windows pop-up message format Local Audio Alarm Microsoft standard audio wav files will alert you of an event error. Simply browse and select a wav file that best suits the event error. Select the preview button to test the alarm. To use the alarm, select the Enable radio button, then select OK. 13

14 Remote Net-Pop Message Remote Network Pop-Up Messages will inform the Administrator of event errors. The message will be in standard Windows Network pop-up message format. The exact Network Machine ID has to be used. In the Domain box, type NetworkMachineID (where NetworkMachineID is the name of the computer). Select the Test Now button to verify you have the correct Machine ID. To use the alarm, select the Enable radio button, then select OK Copy to System Log Copy the event error to the system log by simply selecting the Copy to System Log button. 14

15 Pager Notification To use the Pager Notification, enter the exact port number and initialization string for the modem type. Select how many seconds to take place before a Force Hangup occurs. Enter a pager number. Select the Test Now button to verify the modem/pager are working correctly. To use the alarm, select the Enable radio button, then select OK. 15

16 Notification If you have setup the Voice Print Server to your default MAPI , all you need to do is provide the address to notification alarms. You can also use SMTP. Enter the exact Host ID, User ID, Reply to preference (if desired), and a Timeout in seconds. Select the Test Now button and it will send a notification to the address you specified. To use the alarm, select the Enable radio button, then select OK. 16

17 Script Notification Another feature for messaging an event is assigning a Windows batch or script alarm. Windows Script alarms have very low memory requirements and are ideal for both interactive and non-interactive scripting needs. Supported scripts are Visual Basic Scripting (VBScript) or JavaScript (JScript). Scripts are created and controlled by the user. The use of script alarms provides enormous advantages and enables almost unlimited functionality for notification. You can run complete procedures of any size, page multiple people, notify someone or groups of people anywhere on the network and run any application program or utility program. Please visit the Microsoft Windows Script Technologies Home Page for a comprehensive web site dedicated to Microsoft s scripting technologies and complete documentation for JScript, VBScript, Windows Script Host, Windows Script Components, Remote Scripting, Script Control, and Script Debugger. You can download the latest versions of JScript and VBScript, as well as updates and enhancements to other Microsoft scripting technologies. After you have created your windows script, simply enter or browse for the script name and add parameters as necessary. The Timeout window is the maximum time in seconds a script is permitted to run. A value of zero equals no time limit. Select the Test Now button to verify the script is working correctly. To use the alarm, select the Enable radio button, then select OK. 17

18 Reserved Reserved for future use Alarm Notification Defaults To setup Alarm Notification Defaults, select Options > Alarm Notifications > Defaults. To save time, use the Default Notification Options to apply the same default notifications for all events. This eliminates having to select each event individually to apply defaults. Select the Apply to All button followed by the OK button to overwrite the current settings for all registered applications. To make changes to a specific application or event, use the Alarm Notification Setup (see paragraph ). 18

19 Index A AGENTS 5 Alarm Notifiation Defaults 18 Alarm Notification 11 Alarm Notification Setup 12 Application Name 10 Archive Alarm 12 B Buffer Alarm 11 C Channel Error 11 Copy to System Log 14 D Database Error 11 Delete All button 9 Display Columns 10 E Notification 16 ERROR 5 Event Center 4 Event Center Setup 8 Event Log Settings 8 Event Type 10 Events to Log 9 F FILTER 6 I INFO 5 L Local Audio Alarm 13 Local Pop-Up Message 13 Log File Directory 8 Log File Export 11 M MAPI 16 Message 10 N NOTIFICATIONS 6 P Pager Notification 15 Process 10 Purge Log File 8 R Reading the Event Log 4 Remote Net-Pop Message 14 S Script Notification 17 SEARCH 7 SMTP 16 T Time Stamp 10 TRACE 5 U Unexpected Error 12 W WARNING 5 19