halcyonsoftware enterprise console v8.7 user reference

Transcription

1 halcyonsoftware enterprise console v8.7 user reference

2 About this Reference Guide This Reference Guide provides instructions and reference information for the setup and operation of Halcyon Enterprise Console, Device Manager and Instant Alert modules. For installation information please refer to the document; Enterprise Console Installation Guide. Copyright Copyright Halcyon Software Limited. All rights reserved. i5/os, AS/400 and OS/400, IBM, IBM i, System i and iseries 400 are trademarks of International Business Machines. All other trademarks are respective of their own companies. This document is intended as a guide to using Halcyon software. This documentation contains Halcyon proprietary and confidential information and may not be disclosed, used, or copied without the prior consent of Halcyon Software Limited, or as set forth in the applicable license agreement. Users are solely responsible for the proper use of the software and the application of the results obtained. Although Halcyon Software Limited has tested the software and reviewed the documentation, the sole warranty for the software may be found in the applicable license agreement between Halcyon Software Limited and the user. Publication Revision: February 2012 Company Information Head Office Halcyon Software Limited 5 The Forum Minerva Business Park Lynch Wood Peterborough Cambridgeshire United Kingdom PE2 6FT Tel: +44 (0) For details of your local office or reseller, please visit and access the Contact Us, Support or Partners options.

3 Table of Contents About this Reference Guide Copyright Company Information About the Enterprise Console 1 What is it? What does it do? What are the components? Connection & Porting 3 Connecting to a different server other than the local machine Porting Requirements Passwords and User Names 5 Default User Name and Password Changing Passwords Resetting Passwords Expired Passwords Disconnection while Logged In Users and Administrators Adding a New User Editing User Details Deleting a User Device Manager 10 Overview Discovered Devices Panel Defined Devices Panel Messages Panel Automatic Detection of Devices Manual Addition of Devices General Settings Advanced Settings SNMP Settings Managing Device Groups General Tab - Information Advanced Tab - Connection Advanced Tab - Notes Managing Device Types Managing Applications Creating a Client Access Application Device Manager Options Enterprise Console 24 Overview The Display The Four Panels of the Enterprise Console. 26 Changing the display User Messages Command panel Alerts 31 Overview Alert Status Selecting Alerts View Alert Details Adding Alert Comments nd Level Help Text Copying Alerts for use in 3rd Party Applications. 34 Copy Detail Copy Summary Copy XML Replying to Inquiry Alerts Alerts received via forwarding systems Launching applications directly from Alerts. 36 Sending Alerts to 3rd Party Helpdesk Applications Sending an alert as an SMS Acknowledging Alerts Purging Alerts Closing Alerts Closing alerts received from Power/System i devices Deleting Alerts Enterprise Console Options 41 Overview Options Tab - General page Options Tab - Command page Options Tab - Advanced page Display Tab Display page Display Tab - Default Colors Audio Audio Tab Sounds page Audio Tab - Speech page Changing Passwords Reloading Devices Reloading Address Book Enterprise Server Options 47 Overview General Settings General Tab - General page

4 General Tab - Device General Tab - Users page Alert Settings Alerts Tab - Alerts page Alerts Tab - Archive page Alerts Tab - Alert Types page Editing Alert Types Alerts Tab - Source Types page Editing Source Types Deleting Source Types Filters Holding/Releasing Filters Copying Filters Adding/Editing Filters Filter Tab - Filter page Filter Tab - Default Display page Filters tab Alert Message page Filters Tab - Advanced page Adding Filter Criteria Adding/Editing Filter Criteria Criteria tab - Criteria page Setting Alert Detail Criteria for iseries Alerts 64 Setting Alert Detail Criteria for Server Manager Alerts Setting Alert Detail Criteria for SNMP Trap Alerts Setting Alert Detail Criteria for Syslog Messages Criteria tab - Device Selection page Filter Tab - Actions page Escalating the Priority of Pending Alerts. 70 Add Action For [Action] Creating a Filter for Message ID Specific Events Actions Settings Connection Monitor Connection Monitor working with Halcyon Legacy software Connection Monitor - Connection Monitor page Ping Monitor Ping Monitor page Ping Monitor Tab - Device Selection Syslog Monitor Syslog Monitor Tab Syslog Monitor page 79 Syslog Message Facilities Syslog Message Severities Forwarding Syslog Messages from a Linux Device Advanced Settings Advanced Tab - /SMS Default settings page Advanced Tab - Helpdesk Defaults page. 83 Advanced Tab - Instant Alert page Advanced Tab - SQL Server page Advanced Tab - Messages Page Advanced Tab - Licenses page Enterprise Server Options buttons Exporting Data Importing Data Device Dialog View Device Dialog (Read-only Mode).. 88 Instant Alert 89 Overview Server Options General page Logging page Purge page Enterprise Server page Interfaces page Adding Interfaces Adding a GSM Interface Adding a NPort Interface Adding a SMTP Interface Address Book Adding a Contact to the Instant Alert Address Book Finding Contacts Creating a Schedule Creating a Broadcast Group Address Book Options Message Sender Sending a Message Using Lotus Notes (v7 or later) with Instant Alert Enterprise Console Archive 104 Archive Viewer About Archive Files Creating One Master Archive File Creating Multiple Archive Files Viewing an Archive File Working with Substitution Variables 107 Overview Understanding Substitution Variables The basics

5 Using Substitution Variables within text. 109 Adding Parameters to Substitution Variables 109 Substitution Variable Parameters Numeric Parameters String Parameters

6 C HAPTER 1ABOUT THE ENTERPRISE CONSOLE CHAPTER What is it? The Halcyon Enterprise Console is a real-time focal point for managing crossplatform systems and security alerts centrally. What does it do? The Enterprise Console displays system and security related alerts from System i, Windows Servers, SNMP devices, Linux, UNIX and AIX. Once the alerts have been received the user has the ability, via the console, to automate and escalate actions in order to respond. The Enterprise Console allows user to add comments and provides the ability to centrally manage alerts from all your managed systems. Color coded options help identify different Servers and/or different types of alert. What are the components? Enterprise Server This is a service used to receive alerts from a variety of sources and allows users to manage them centrally via any networked machines which have the Enterprise Console application installed. Any number of incoming connections can be handled simultaneously; the only limitation(s) are imposed by machine hardware limitations (processor speed, memory, and so on). Enterprise Server Options This application is used to specify, edit and change Enterprise Server settings. The Enterprise Server Options is used to: specify user access rights set up filters and actions for incoming alerts set up alerts display information About the Enterprise Console 1-1

7 specify Ping and Connection Monitor settings specify Syslog Monitor settings license Enterprise Server Enterprise Console As previously described, this is the application that connects to the Enterprise Server to manage received alerts which are displayed on any machines which have the Enterprise Console application installed. Any number of users can be connected, although each must have a unique user name. Individual user privileges can be set to restrict or enable operators to perform different tasks. If several users are on duty and one person closes or replies to an alert, their action is broadcast to all other users. Device Manager This application is a stand-alone GUI used for: auto-discovery of networked devices by poll, walk or broadcast manual entry of devices device categorization launching default applications Instant Alert Instant Alert is used to send text messages to mobile phones from the Enterprise Console. messages can also be sent, including the ability to send messages to 3rd party helpdesk applications. Broadcast groups and schedules can be set up so messages are sent to the appropriate on-call personnel. A message log is provided to monitor the status of messages. 1-2 Enterprise Console

8 C HAPTER 2CONNECTION & PORTING CHAPTER To launch the Enterprise Console select Windows Start All Programs Halcyon Applications Enterprise Console Enterprise Console. Each time the Enterprise Console is launched, a Log In dialog is displayed. The user must then enter a valid user name and associated password as defined in Enterprise Server Options. Passwords are not case sensitive. Connecting to a different server other than the local machine If more than one instance of Enterprise Console is installed on your network, a different server can be entered or selected at the point of log-in. From the Log-In dialog box, click Options >>. The Server Details options are displayed. The TCP/IP address of the currently associated server is shown as a default. Enter the IP address of the Server on which the required instance of Enterprise Console is installed. Click OK to connect. Connection & Porting 2-3

9 Connection to servers on a remote network If the Server is installed at a remote location protected by a firewall, use the additional Route option to specify the IP address of the Firewall, so that the connection can be made successfully without blocking. Click OK to connect. Porting Requirements Legacy Products Halcyon Legacy products use Ports on the iseries to communicate between an external server such as another iseries and Port to communicate with the Enterprise Server. If these ports are already in use by another third party application, then Halcyon s use of these ports can be modified by editing the data area HDS400/ HDSPRT. For example, if you edited the data area to from 9000 then Halcyon products use ports through New Generation Products Halcyon New Generation products use Port on the iseries to communicate between the iseries and the Enterprise Server. Add 1 to the port number for each additional environment on the same partition to which you also want to connect. For example, HALPROD = Port 15000, HALTEST = Port 15001, HALDR = Port 15002, and so on. Note: Implications of changing port assignment Changing the communications port on an iseries device that communicates with any other device will also require the same change of port on the device(s) with which it communicates. If you have a network of iseries devices that previously communicated with the Enterprise Server via port and you change the port of the Enterprise Server to you must also change the port on all communicating iseries to in order for systems messages and replies to be sent and received correctly. Remember that any firewalls that are in place must have the new range of ports opened. 2-4 Enterprise Console

10 C HAPTER 3PASSWORDS AND USER NAMES CHAPTER Default User Name and Password When the Enterprise Console is first launched the following default user name and password is applied: User Name: Administrator Password: Administrator When a new user is added, a default password (the text used for the user name) is created automatically. When a new user first launches the Enterprise Console the current user name must initially be entered as the password. A message is then displayed advising the password has already expired and a new password must be entered. Changing Passwords Passwords are changed from within Enterprise Console Options. A password must be changed if it has expired, or a new password can be generated for security reasons. To change a password: 1 Launch the Enterprise Console, log in, and select Tools Options from the menu bar. 2 Click Password to open the Change Password dialog. 3 Enter your old password in the top box, then enter a new password and confirm. 4 Click OK to accept and save the new password. This is the password you must enter the next time you launch the Enterprise Console (if you are logging in with the same user name). Passwords and User Names 3-5

11 Resetting Passwords Passwords are reset from the Enterprise Server Options Users page. Resetting a password is a temporary measure, allowing you to update an existing user s password if they ve forgotten it. To reset a password: 1 Launch Enterprise Server Options, and select the General User option from the list of options in the left pane. 2 Select an existing user and if necessary set an expiry date. This date is applied to the password you have to create when you next log on. 3 Click Reset Password. A confirm/cancel message option is displayed. 4 Click OK to confirm the reset password command. The reset password is now also the current user name. A confirmation message is displayed to validate the password has been reset against the specified user name. 5 Launch the Enterprise Console and enter your user name and password. At this stage the password is the same as your current user name (see step 4 above). 6 Enter your current user name as the password. A message is displayed advising the current password has expired and you are prompted to create a new one. 7 Click OK to display the Change Password dialog. 8 Enter your user name as the old password and enter a new password of your choice. The password dialog closes and you now have access to the Enterprise Console. Expired Passwords When a password has expired, a new password must be created. The expiry period for the new password is specified on the Enterprise Server Options General User page. This is a global setting and is applied to all further passwords until changed. If you are prompted to change an expired password: 1 Click OK when prompted to display the Change Password dialog. 2 Enter your current password as the old password. 3 Enter a new password of your choice. 4 Click OK to close the dialog and return to the Enterprise Console. 3-6 Enterprise Console

12 Disconnection while Logged In If you are disconnected abnormally and try to log in again, the system may assume you are already logged in and prevents access. To rectify this situation: 1 Select your user name in the Enterprise Server Options General User page and click Reset Password. 2 Keep the Enterprise Server Options open or click Cancel to close the Enterprise Server Options and return to the Enterprise Console. Users and Administrators Users are added, edited and deleted from Enterprise Server Options General User page. User log on details (user name and a password) are required by each user or administrator each time they launch the Enterprise Console. Multiple users and administrators can be added, but name/password combinations must be unique. User and Administrator Privileges Privileges can be assigned to each user according to the system access and control required by that user. Administrator privileges allow full control and typically, users can be granted a limited set of privileges, or full privileges specified from the privilege options available. There are six areas of system privilege that can be granted to a user. If the user is entered as an administrator then access rights to these six areas are granted automatically. Close: Gives the user the ability to close alerts Reply: Gives the user the ability to reply to alerts (where applicable) Delete: Gives the user the ability to delete alerts Comment: Gives the user the ability to add a comment to alerts Command: Gives the user the ability to use the Command facility of the Enterprise Console Purge: Gives the user the ability to purge alerts Passwords and User Names 3-7

13 Adding a New User New users are added from Enterprise Server Options General User page. To add a new user: 1 Click Add User. Note: Note: 2 Populate the Add New User dialog with new user details. 3 Click OK to accept the details and add the new user to the list of users displayed. At this stage the password for the new user is the same as the user name, but must be changed when you log on to the Enterprise Console (see Passwords above for further details). Editing User Details User and administrator details are edited from Enterprise Server Options General User page. You cannot change a user name from this option. To change a user name, you must delete the user and add a new user. To edit user details: 1 Highlight a user from the list displayed on the General User page and click Edit User. 2 Edit the required details in the Edit New User dialog. 3 Click OK to accept the changes and return to the General User page. Deleting a User Users are deleted from the Enterprise Server Options General User page. To delete a user: 1 Select and highlight a user from the list displayed. 2 Select Delete User on the General User page. 3-8 Enterprise Console

14 A message is displayed asking you to confirm deletion: 3 Click Yes to delete the user details and remove the user details from the list displayed. Passwords and User Names 3-9

15 C HAPTER 4DEVICE MANAGER CHAPTER Overview The Device Manager is the component of Enterprise Console that is used for network auto-discovery, the manual entry of devices, device categorization and the launch of default applications. Figure 4.1 Halcyon Device Manager 4-10 Enterprise Console

16 Devices must be loaded or be present in the Device Manager before they are available for selection in other components of the Enterprise Console. Select Windows Start Halcyon Applications Device Manager to activate a Device Manager session. The Device Manager Display By default, the main window contains three panes: Discovered Devices - default position left pane of the main window Defined Devices - default position right pane - of the main window Messages - default position lower pane - of the main window Discovered Devices Panel This panel shows the details of any devices discovered by using one of the automatic detection routines. By default, the Device Name and IP Address are displayed. Defined Devices Panel This panel shows the details of any devices which have been manually added to the Device Manager. By default, the Device Name, IP Address, Connection and Read Timeouts are displayed. Messages Panel This panel shows the details of any messages sent to, from or between devices listed in the Device Manager. Date/Time and Message details are shown by default. Re-arranging the display Each pane can be minimized, closed or moved and resized as required. Information is listed in each pane in table columns, the contents of each column can be can be arranged in ascending/descending order by clicking any column title to toggle the view. Column positions can also be rearranged by dragging any column horizontally to a new position. Columns can be added to or removed from each pane by right clicking a column bar and selecting or deselecting the column(s) required. Automatic Detection of Devices Use the Device Discovery feature to automatically detect the presence of devices across your network. The Device Discovery feature is accessed from Start Programs Halcyon Applications Device Manager Devices Discover Devices. The Device Discovery dialog is displayed. Device Manager 4-11

17 Figure 4.2 Discovering Devices Discovery Criteria Poll Select this option to poll (connect to) a single address, range or subnet (defined in the Poll Type setting). Poll Type (if Poll selected as the Discovery Type) Single Address Range Subnet Device Manager attempts connection to the entered IP Address. Device Manager attempts connection to all IP Addresses between the entered range. Device Manager attempts connection across a sub network identified by a user identified IP Address. Typically, a subnet may represent all the machines at one geographic location, in one building, or on the same local area network Walk Use this option to start discovery from a known TCP/IP address for a specified sequential depth up to a maximum of 9999 addresses. Starting Address (if Walk selected as the Discovery Type) Enter the IP Address from which the discovery of sequential IP addresses commences Enterprise Console

18 Walk Depth (if Walk selected as the Discovery Type) Enter the number of connections to devices that are attempted when using Walk as the automatic detection method. Broadcast Use this option to broadcast for devices from a specified TCP/IP address. Address (if Broadcast selected as the Discovery Type) Enter the IP Address from which the broadcast is made. Terminate After (all Discovery Types) The period (in seconds) after which the discovery session is terminated. Click Start to begin the Automatic Discovery of devices using the selected method. Click Stop to end the session early, otherwise the discovery ceases when the Terminate After threshold is reached. Devices that are discovered using any one of the above means are displayed in the Discovered Devices pane of this window and subsequently in the same named panel of the main Device Manager window. Manual Addition of Devices Devices can also be manually added to the Enterprise. Either click the Add Device icon (see left) from the toolbar or select Devices Add Devices from the main menu. The Add Device dialog is displayed. Figure 4.3 Add Device Device Manager 4-13

19 There are three separate areas into which information can be entered: General Advanced SNMP General Settings Information Page Group Device Groups are used to be segregate groups of say, similar devices, or all devices belonging to a specific department. The Device Group (if used) can be specified using a selection from the dropdown menu. Groups are added using the Tools Manage Groups option. See Managing Device Groups on page Name The Device name MUST be the same as the actual system name. Description Enter an accurate description by which the device can be identified. Device Type From the drop-down choice menu, select the device type. The following selections are available: AIX Server Bridge Hub Laptop Linux Server Mail Server Modem PDA Power/System i Printer Proxy Server Router Scanner Server Switch Unix Server Unknown 4-14 Enterprise Console

20 Windows Server Windows Server 2003 Standard Workstation Note: Bespoke devices can be added to this list by using the Tools Manage Device Types option from the Device Manager menu bar (see Managing Device Types on page 4-19). Network Host/Address Enter the IP address of the device as it is registered in your network. Display Page Color Specify the Default color of the Device when displayed in the Enterprise Console. Location If required, specify the physical geographical location of the network device. Time Zone If required, enter the time differential to take account of the geographical location of the device. For example, with the host device based in the UK, devices in Paris, France, would have a time differential of to GMT. The settings for this field are derived from the Windows time zone defaults, as found in Windows Start Control Panel Date and Time. When an alert is received from a device located in a different time zone, the time is extracted from the incoming alert and an adjustment is made via the setting in this field on the receiving Enterprise Console device prior to being displayed. The Use Current setting for this field automatically sets the time zone to the local setting derived from the device to which the alert is sent. This setting is useful for devices such as printers and those that send SNMP Traps. Ensure that the time settings on the remote device are correct prior to activating this feature otherwise timing inaccuracies of alert data can occur. Note: Any changes to the Time Zone settings in this field override any pre-existing settings on devices running Server Manager. Note: Please see Log Alerts Using on page Support Page The fields on this page are used to enter the details of any support information. None of the fields on this page are mandatory. Contact Name If required (or known), enter the name of associated personnel responsible for this device. Device Manager 4-15

21 Company If applicable, enter the name of the associated company/division where the device is installed. Associated Application Name Select an application which is then associated with a device (for example wireless configuration software). The entry in this field is then used if the Launch Associated Application from an alert received from this device is actioned from the Enterprise Console. Note: Please see Launching applications directly from Alerts on page Test Application Used to test launch the selected application associated with the device. Advanced Settings Timeout Page Connection Timeout The Device Manager abandons its connection attempt after the time period (in seconds) specified in this field. The default setting is 120 seconds. Read Timeout The entry in this field sets the read timeout limit between the Device Manager and the remote device. The default setting is 120 seconds. Connection Page Alternative IP Address Alternative IP Addresses can be added, via the Add button, in order to account for devices with multi-ip address capability or those that have further IP Addresses linked to the main IP Address. External Interface Should this device sit behind a firewall, enter an external IP address via which any connection can be made to ensure that alerts are transmitted to the Enterprise Console. See Device Groups - Advanced Tab - Connection on page 4-19 Settings Page User Name/Password Enter a user name and password combination used to access this device. Serial Number Enter the serial number of the device. This field is only displayed if the device is a Power/System i 4-16 Enterprise Console

22 Connect on Port Field only displayed if the device is a Power/System i. The field is not applicable to Power/System i devices running Halcyon Legacy software or Power/System i devices that are not running Halcyon Software solutions. The entry in this field specifies the port number on the Power/System i to which the Enterprise Console connects. This value must match the Port Value in the *SYSTEM Location of the Power/System i device. This value can be found as the top entry in Configuration Menu > Work with Remote Locations on the Power/System i device. Figure 4.4 Identifying Port Number on Power/System i Device If the Power/System i device is running multiple environments, you would add a device to the Device Manager to represent each individual environment as the port setting would differ for each. Notes Page Use this page to enter any free-text notes about the Device. SNMP Settings These settings are used to define any SNMP capabilities of the device. SNMP Page SNMP Capable Check to enable the current device as being capable of sending SNMP messages and enable the remaining fields and SNMP pages. Object ID Enter a unique SNMP identifier for devices of this type. Agent Port Enter the port identification number to which the device is connected. Version Select the version of SNMP being used on the device. Community If required, select the identification of any community associated with the device. Device Manager 4-17

23 Traps Page Device is a Trap Target Check to indicate if the current device is a trap target, and therefore can receive trap messages. Trap Port Enter the port number used for the trapping of messages. Trap Type Select the type of trap for this device. Click OK to add the device to the Device Manager. Managing Device Groups Devices can be segregated into groups of say, similar devices, or all devices belonging to a specific department. Devices can be displayed by Group in the Devices panel of the Enterprise Console. Select Tools Manage Groups to display the Device Groups dialog.click Add to display the Add Device Group dialog. Figure 4.5 Add Device Group General Tab - Information Name Enter a unique name by which to identify the device group. Description Enter text that accurately describes the device group Enterprise Console

24 Reference If required, enter a reference, such as Department Account Number or Asset Number, for the device group. Advanced Tab - Connection Note: Route The route field defines a series of IP addresses that are then used to connect to all the devices included in this group. This can be an external IP address if required. Use of this function allows Enterprise Console alerts to be passed between firewalls. Click Add to open the Add Route Entry dialog into which a new IP Address can be entered. Click OK to add the new connection route to the defined list. Figure 4.6 Adding a Route Entry Advanced Tab - Notes Enter any free-text notes relating to this device group. Managing Device Types Any devices that you may have in your organization but that are not currently available from the Device Type list can be added using the Manage Device Types option. From the Device Manager menu bar select Tools Manage Device Types and click Add to display the Add User-Defined Device Type Dialog. Device Manager 4-19

25 Figure 4.7 Adding a User-defined Device Type Description Enter a meaningful description to be of the new device type. Object ID If the device is SNMP trap enabled, the unique object identity number should be entered in this field. Category If required, select a pre-defined category with which the device type is then associated. O/S Type From the drop-down menu, select the type of Operating System that the device uses. The choices are: None AIX i5/os Linux UNIX Windows 4-20 Enterprise Console

26 Icon From the drop-down choice menu, select an icon by which the device type is then identified. Default Associated Application From the drop-down choice menu, select an application with which the device type is associated by default. This can be overridden when adding a new device. Managing Applications Applications associated with device types are defined and managed from the Manage Applications dialog. This allows you to add applications and edit or delete existing applications. Figure 4.8 Adding a new application Adding a new Application: 1 From the Windows Start menu select Start Programs Halcyon Applications Device Manager 2 From the menu bar select Tools Manage Applications Device Manager 4-21

27 3 Click Add to open the Add Application dialog. 4 Enter a Description for the application 5 If the application is a web page enable Application is a Web Page 6 Enter the directory path in which the application executable is stored 7 Enter any Parameters required to launch the application upon opening (listed Substitution and Environmental Variables may be used). The Example field auto-completes based on the entry in this field 8 Click OK to confirm and add the application. Note: Creating a Client Access Application Creating a client access application is useful for when you need to directly access an IBM iseries device directly from within the Enterprise Console. The IBM emulator software must be running on the same device as that on which the Device Manager component of Enterprise Console is installed. You must also create a separate.ws file for each iseries device that you wish to add. It is recommended that you name each of these as the system name.ws to ensure that you connect to the correct device. Note: To create a Client Access Application: 1 From the Device Manager menu bar select Tools Manage Applications 2 Click Add to open the Add Application dialog 3 Enter Client Access System Name as the Description 4 In the Executable field, either type the path of where the required emulator.ws file is stored or use the Browse button to search for and automatically enter the file path. Note that if you use the Browse option you need to change the search parameters to look for All Files and not just Program files. 5 Click OK to confirm and add the client access application. See Launching applications directly from Alerts on page 6-36 for more information on how to use the application, once it has been created. Device Manager Options Device Manager options are used to specify logging and SNMP Discovery settings. Logging Page Save to Log File Check to enable the saving of device information to a log file Enterprise Console

28 Note: Log File Name The default setting for this field is DevManager.Log. This can be overwritten if required with your own choice. The log file is saved in the directory C:\Program Files\Halcyon\Device Manager\Logs unless otherwise specified. Maximum Log Size Enter a value that indicates the maximum size, in kilobytes, of the log file. The default setting is 1024Kb. If both Informational and Diagnostic messages are saved, increase this value Figure 4.9 Device Manager Options Log Informational Messages Click to log all messages relating to the operation of the Device Manager. Log Diagnostic Messages Click to log all Device Manager diagnostic messages. Discovery Page (for SNMP enabled devices) Host/Address Enter the Host Name/IP Address of the SNMP Managing device. Refresh Interval Select the time period, in seconds, that the SNMP connection is refreshed. SNMP Community If required, enter the name of the SNMP Community on which devices may be operating. SNMP Port Enter the Port Number on which SNMP Devices on this network communicate. Device Manager 4-23

29 C HAPTER 5ENTERPRISE CONSOLE CHAPTER Overview Enterprise Console is the application that connects to the Enterprise Server to manage received alerts which are displayed on any machines which have the Enterprise Console application installed. This Graphical User Interface (GUI) is the central point used to display alerts (received from the Enterprise Server) to administrator and/or operator responsible for any issues. Any number of users can be connected simultaneously, although each must have a unique user name. Individual user privileges can be set to restrict or enable operators to perform different tasks. If several users are on duty and one person closes or replies to an alert, their action is broadcast to all other users. Enterprise Server is a service used to receive alerts from a variety of sources and allows users to manage them centrally via any networked machines which have the Enterprise Console application installed. Any number of incoming connections can be handled simultaneously; the only limitation(s) are imposed by machine hardware limitations (processor speed, memory, etc.) Logging onto the Enterprise Console Enter a valid user name and password to log-on to the Enterprise Console and click OK. Routing Options This option allows you to use the integral network manager facility to connect to a server that is situated behind a firewall. To make use of this facility, click Options on the Log In dialog, to expand the current view Enterprise Console

30 Select or enter the IP Address(es) of the server(s) to which you wish to connect. Enter the IP address of the route by which the connection is made. Click OK. Once entered, the information is stored so that future logons can use the same criteria if required. The Display Alert details, device identities, device details, action histories and associated alert messages are displayed in four panels contained within the main Enterprise Console window. Each panel within the display can be repositioned within the window or floated on the desktop and resized as required. Figure 5.1 Enterprise Console Main Display Modified settings can be saved as named layouts using the Window Save Layout As... menu option to save the settings. Multiple layouts can be saved and reused, or the default (non-editable) layout can be selected at anytime. User privileges also affect what functions are available from the layout (privileges are set in the Enterprise Server Options General User Add- Edit User dialog). Context menus are available to show/hide the column options for all panels. Enterprise Console 5-25

31 The Four Panels of the Enterprise Console The four panels of the Enterprise Console are split into: Inquiry Alerts Info Alerts Devices Details/Action History/Messages/Command Inquiry Alerts In its default format, the Inquiry Alerts panel displays messages that have been directed to the Inquiry Alerts panel from a filter action setting in Enterprise Server Options. These are usually alerts that require some form of action to be taken on the part of the user. The name of this panel can be changed. Info Alerts In its default format, the Info Alerts panel displays messages that have been directed to the Info Alerts panel from a filter action setting in Enterprise Server Options. These are usually alerts that although still probably require user intervention are provided as information to the user. The name of this panel can be changed. Devices The Devices panel shows all the current devices that have been installed using the Device Manager. By default, the devices are displayed by Status (i.e. those needing urgent attention are shown at the top of the list), although it is possible to change the sequence by clicking on any of the other four column headings. For example, to change the sequence to display by alphabetical device name, click the Name column heading. If you have set up device groups, these can be displayed by selecting View Display Device Groups from the menu bar. Details This window is used to show the individual details relating to an alert selected from either the Inquiry or Info Alerts windows. There are four different detail options available for view: Details - Shows full details of the alert including Device, Key, Date and Time, Source and Error message text. Additionally, any user comments that have been added to the alert can be displayed from within this option. Action History - The Action History shows what has happened to the alert since it was logged on the Enterprise Console. Messages - Shows details of any system messages that may have been generated as a result of an action being taken. Command - Used to send system messages to other users 5-26 Enterprise Console

32 Changing the display There are a variety of methods that you can employ to suit your personal viewing preferences when accessing the Enterprise Console. Stretch and Shrink Individual panels of the Enterprise Console can be resized by using the stretch technique. As a result, other panel(s) on the display shrink to accommodate the new size. To use stretch and shrink: 1 Position the pointer over either the vertical or horizontal dividing bars between the panel. The pointer changes to a Move Border shape -. 2 Hold the left mouse button down and drag the border in the direction that you wish to resize. 3 Release the button when the desired position is reached. Note: Note: Note: Drag and Drop It is possible to reposition each of the panels to a new location within the display window. To use drag and drop: 1 Position the pointer over the title bar section of the panel that you wish to move. 2 Click and hold the left mouse button down and drag the panel to the desired position. 3 Once satisfied with the new layout, select Window Save Layout As to save the layout. This takes practice to achieve the desired result. Use Window Default Layout from the menu bar to return to the default display setting. Views are unique to the user. Therefore it is possible to have multiple instances of Enterprise Console showing different panel views (containing the same data) if more than one user is logged on simultaneously. Enterprise Console remembers the last panel setting as used by the user and defaults to that display upon opening. Maximize and Hide Maximize and Hide functions allow you to remove or fully display single panels within the main Enterprise console window. Click the expand icon (see left) on the panel title bar to maximize the view of any panel (the arrow orientation changes depending on the panel. Click the reverse icon image to return to the previous view. Enterprise Console 5-27

33 Click the close icon (see left) on the panel title bar to remove the panel from view. Use Window Default Layout from the menu bar to return to the default display setting. Resizing Fonts The text displayed within the Enterprise Console Screen can be resized to customize the view to your own requirements. All displayed text is resized when either the increase font or decrease font option is selected. Increasing Font Size To increase the font size of the Enterprise Console text click the increase font icon (see left). The text displayed in ALL windows increases in size. Decreasing Font Size To decrease the font size of the Enterprise Console text click the decrease font icon (see left). The text displayed in ALL windows decreases in size. Auto-Arrangement of Console Windows This feature is used when viewing multiple instances of the Enterprise Console on a single screen. Selecting this option automatically arranges multiple console windows into the optimized viewing display. Select Window Arrange Windows or click the Arrange Windows icon (see left) to initialize. Figure 5.2 Arranging Console Windows Selecting Columns for View and Ordering To reduce (or increase) the number of columns displayed in any of the four panels, right-click on a column heading to display the Column Selection pop-up menu for the selected panel. Active columns are indicated by a tick mark. To remove columns from the view, click on the checkbox next to each column that you wish to remove. The tick mark disappears to indicate that the column is no longer selected. Adding columns back into the display is a reverse of this procedure. From the Column Selection popup select More to display the Select Columns dialog. From this dialog it is possible to define column ordering and set a default width size per column Enterprise Console

34 Column Ordering You may change the order in which the columns are displayed within any of the four panels. To change column order: 1 In the select columns dialog click on the name of the column that you wish move so that it is highlighted. 2 Use Move Up (unless the column is at the top of the list) and Move Down (unless the column is at the bottom of the list) to re-position the column in the list. 3 Click OK to confirm. Width of selected column (in pixels) Select a column name from those listed to display the current column width in this box. Enter a new figure into this box to amend the selected column size. User Messages Availability of users across the network is remotely monitored and messages can be exchanged between all connected users. The availability status of users can be set individually by each user from the User... menu options or the drop-down icon toolbar (see left). The available options are: I am Available (only displayed when one of the following options active) I am Away I am on a Break I am at Lunch I am away from my Desk Do not Disturb (messages may be hidden when this option is selected) Although the status is updated and distributed automatically, this function requires a manual change to be made by each user to be accurate. Command panel In addition to default command options, text commands can be entered in the Command Chat edit box in the Details/Action History/Messages/Command window. This can be displayed by selecting the Command Panel icon (see left) from the toolbar. Enterprise Console 5-29

35 The following commands can be entered (commands are not case-sensitive): Command /AWAY /AWAY AT LUNCH /CLS /HELP /LICENSE /MSG /TIME /VERSION /PING /NICK ADMIN /MSG TEST MESSAGE /MSG TEST MESSAGE /MSGTO /WHOIS ADMIN Notes without message with a message, for example At Lunch clears the command screen display list of available commands displays licensing information sends message returns the Enterprise Server time returns the Enterprise Console version pings a server sets the user's nickname sends a message to all connected users sends a message to all connected users sends a message to a specific user (can use either the username or nickname) returns user info for a specified user, can use either the username or nickname 5-30 Enterprise Console

36 C HAPTER CHAPTER 6ALERTS Overview Alerts are generated as a result of filters that you have set up to monitor your network for any issues or problems. When alerts (that have an action of Send Enterprise Console Alert) are received they can be displayed in one of two windows on the Enterprise Console. These panels are initially labeled Inquiry Alerts and Info Alerts, although these settings can be changed in Enterprise Server Options: Inquiry Alerts - messages that have been directed to the Inquiry Alerts panel from a filter action setting in Enterprise Server Options. Info Alerts - messages that have been directed to the Info Alerts panel from a filter action setting in Enterprise Server Options. By default, when a new filter is set up using Enterprise Server Options, the setting displays the alert in the Inquiry Alerts panel of the Enterprise Console. This setting may be changed by editing the filter in Enterprise Server Options. Alert Status Alerts can have one of the following statuses: Open The alert is open and has one or more actions against it. Closed The alert has been closed or replied to, but could not be archived to the archive file. The Delete Error Message in the Alert Details indicates why the alert could not be archived (for example, the archive filename or directory is invalid or the archive file is in use). Only closed alerts can be deleted. Error The alert is open but one or more actions have failed. A l e r t s 6-31

37 Console Indicates that an alert has been closed\replied to from the Enterprise Console. The alert remain visibles until the console action has completed. Any pending actions are cancelled when a user closes or replies to an alert. Selecting Alerts There are various methods by which alerts can be selected: Single Alerts An alert can be selected simply by clicking directly on the message line in either the Inquiry or Info Alerts panel. Multiple Alerts Multiple Alerts can be selected by holding down the CRTL key and left-clicking on individual lines. Groups of Alerts Groups of consecutive alerts can be selected by holding down the SHIFT key and left-clicking on the first alert in the group and then left-clicking the last alert in the group. All alerts in the group are now selected. All Alerts To select all alerts in either panel, right-click on an alert within the required panel and choose Select All nn Alerts from the drop-down menu (where nn is the name of the chosen Alert panel). View Alert Details Full details of individual alerts are displayed in the Details panel of the Alert Details window, opened by double-clicking an alert listed in either of the alert panels. This is the enlarged version of the Details panel displayed by default in the bottom right-hand corner of the screen. Alert information is displayed in tree view within collapsible categories. Rightclick anywhere in the Details panel of this dialog to display a context menu that provides options to Expand/Collapse All and Print, the current information displayed Enterprise Console

38 Four buttons along the bottom of the window allow you to navigate through alert details sequentially (forward and backward) and move to the first or last set of details: Figure 6.1 Alert Navigation Adding Alert Comments Comments can be used to add any miscellaneous text to an alert in order to provide more information to any other Enterprise Console users. Comments can be added to any selected alert in one of three ways: Select the Add Comment icon (see left) from the toolbar Select Alerts Add Comment from the menu bar Right-click on the alert and select Add Comment from the drop-down menu Once added, the comment icon is displayed next to the alert to make other users aware that comment text has been added. Multiple comments can be added to any alert. Entered comments can be viewed in the Alert Details dialog (see View Alert Details ). 2nd Level Help Text 2nd level help text can be displayed for applicable iseries alerts. This information can assist you in rectifying the problem that caused the alert to be generated. If 2nd level help text is available it is displayed as a panel in the Alert Details dialog of the relevant iseries alert. Figure 6.2 Example of 2nd Level Help Text A l e r t s 6-33

39 Copying Alerts for use in 3rd Party Applications Information held within an alert can be copied and exported (as a Paste command) into a third party application, such as Microsoft Notepad. There are three options that can be used for copying alert information. Copy Detail This option copies the complete detail of the alert message. To copy the alert detail: 1 Select the alert(s) required, (multiple alerts can be selected) and right-click. 2 From the drop down menu that appears select Copy Detail. The alert detail is now copied and ready for pasting into a third party application. Copy Summary This option copies just the following items of the alert: Date/Time Device Inquiry Product Source Text Type Copy XML This option copies the alert detail as in the Copy Detail function but in XML format. Replying to Inquiry Alerts Inquiry alerts are indicated by the Question Mark symbol (see left) on the message line. Inquiry alerts that arrive from iseries devices must have a reply sent instead of being closed, (the Close Alert option is unavailable for these types of alert). This process is used to send a recognized message back to the iseries. To reply to an Inquiry alert: 1 Select the alert and either: Select the Reply [icon] from the toolbar Select Alerts Reply from the menu bar Right-click on the alert and select Reply from the drop-down menu 6-34 Enterprise Console

40 2 In the Reply to Alert dialog, type the required response. 3 Click OK. The inquiry alert is removed from the Enterprise Console. Alerts received via forwarding systems Note: There may be instances where a direct connection cannot be made between the IBM i device and the Enterprise Console. In such instances it is possible to route the data via another IBM i device that does have a direct connection. A guide on how to configure data forwarding is provided in the relevant Halcyon software suite user reference. Please refer to this document when creating data forwarding routines. From within the Enterprise Console, it is important to be able to identify the device from which the alert originated and not the device(s) that were used for the forwarding. In order to do this, the Description column must be enabled for view in the relevant alert panel of the Enterprise Console to which the alerts are forwarded. Note that this column can be enabled at anytime to provide descriptive text of the device but is essential for identifying originating systems of forwarded alerts. If not already enabled in the required alert panel, right-click the column heading bar of the panel and select Description from the pop-up menu. Figure 6.3 Selecting the Description column When an alert is received from a device that is not in direct connection with the Enterprise Console, the description column displays both the originating and forwarding device(s). A l e r t s 6-35

41 Figure 6.4 Description field showing data forwarding Note: Please note that this feature is not the same as the Forward Alert action. Printing Alerts Individual alert details can be generated in hard copy, directly from the message, via the Print command. Multiple selections are permitted. To print an alert: 1 Select the required message and either: Select File Print from the menu bar Right-click on the alert and select Print from the drop-down menu The standard Windows Print dialog is displayed from where the Printer and layout options can be specified. Launching applications directly from Alerts When an alert is received at the Enterprise Console it is possible to launch a remote desktop session to the device/application directly from the Enterprise Console, providing it was not sent from the device on which Enterprise Console is running. Such sessions can take the form of, for example; Remote Desktop, VNC, PCAnywhere (Client Access when logging on to an iseries machine). Figure 6.5 Launching an application directly from an alert 6-36 Enterprise Console

42 To launch a remote session: 1 Right-click the alert from either the Inquiry or Info panel 2 Select Launch Associated Application. In order to use this functionality the device must have an existing application association relationship created within Device Manager - Managing Applications. Sending Alerts to 3rd Party Helpdesk Applications Alerts can be sent to 3rd party Helpdesk applications by using either or SMS to transmit the message detail. Figure 6.6 Sending an alert as a Helpdesk A l e r t s 6-37

43 To send an alert as an 1 Select the required alert (multiple selections are permitted) and either: Select Alerts Send Alert As Helpdesk from the menu bar Right click on the alert and select Send Alert As Helpdesk from the drop-down menus The Send Helpdesk dialog is displayed. 2 Check the From option to enable an entry in this field enabling the receiving party to identify the originator of the message. It is also a requirement of some helpdesk applications that a recognized originating address is supplied; otherwise the message can be rejected. The entry in this field must be in a format acceptable to the third party application. 3 Enter a valid To address (either that of the helpdesk application inbox or an address pre-defined in the Instant Alert Address Book, opened by clicking the address book icon (see left). 4 The Subject detail field is automatically completed from the alert, although this can be overwritten if desired. 5 The substitution variables form the body of the text. An example of the text as defined by the substitution variables is shown. The Body Text entry is automatically created from the alert but can be amended if required, using the substitution variables listed. 6 Click OK to send the message to the helpdesk application. Sending an alert as an SMS Follow the same routine as that for Sending an alert as an message but either enter the SMS number in the To field or use an entry from the Instant Alert address book where SMS is set up as the message delivery default. Acknowledging Alerts Note: You can acknowledge that an alert has been received by the Enterprise Console by selecting Alerts Acknowledge (or right-click and select Acknowledge from the pop-up menu) against an individual or group of alerts. Acknowledging an alert changes the status to ACKNOWL. You can only acknowledge alerts with a status of Open. You cannot acknowledge a closed alert. The acknowledging of alerts is optional, and allows users in multiple environments to take ownership of individual alerts. When acknowledging alerts received from iseries devices, all pending actions set against the filter criteria that generated the alert are cancelled Enterprise Console

44 When you select to Acknowledge an alert, the Acknowledge Alert dialog is displayed. You may enter comments referring to the reason for the acknowledgement although this is not mandatory. Click OK to acknowledge the alert. Figure 6.7 Acknowledge Alert dialog Purging Alerts Note: Alerts are purged from the Purge dialog displayed by selecting Alerts Purge from the main menu. You can then select the kind of alerts to purge relevant to selected devices and click OK to execute the command. Purged Alerts are archived and are viewable via the Enterprise Console Archive Viewer. See also Purge in Enterprise Server Options - Advanced Tab - SQL Server for information on how to quickly clear the SQL database tables. Figure 6.8 Purging Alerts A l e r t s 6-39

45 Closing Alerts Alerts remain on the Enterprise Console until they are closed (at which point they disappear from the live console but can still be viewed using the Enterprise Console Archive Viewer. To close an alert: 1 Either: Select the Close icon (see left) from the toolbar Select Alerts Close from the menu bar Right-click on the alert and select Close Comment from the drop-down menu The Close Alert? dialog is displayed. 2 If required, and it is considered good housekeeping to do so, add a comment on the reason for the closure of the alert and click OK. The alert is removed from the Enterprise Console. Closing alerts received from Power/System i devices If you are closing an alert that has been generated by a Power/System i device, the close request is sent to the Power/System i device and the connection then closed. The status of the alert changes to CONSOLE and it remains in this status until the Power/System i device connects back with a response. Deleting Alerts Note: The delete alert action allows users with the appropriate authority to remove alerts from the Enterprise Console panels without the need to add comments or reply. See User and Administrator Privileges on page 3-7 for more details. Single or groups of alerts can be deleted in one go by selecting the alert(s) to be deleted and then using Alerts Delete. You are then prompted to confirm the deletion. No connection is back to the originating system and so does not filter through to forwarded alerts Enterprise Console

46 C HAPTER 7ENTERPRISE CONSOLE OPTIONS CHAPTER Overview Enterprise Console Options provide additional operating and connection parameters for the Enterprise Console. Enterprise Console Options should not be confused with Enterprise Server Options which are used to set up and maintain filters, set user access rights and license software components. Enterprise Console Options are accessed from either the Options icon (see left) on the toolbar or Tools Options from the menu bar. Figure 7.1 Enterprise Console Options Enterprise Console Options 7-41

47 There are three tabs: Options Display Audio Options Tab - General page The General page of the Options tab is used to specify connectivity parameters. Enterprise Server Settings TCP Host/Address Enter the TCP Host/Address details of the Enterprise Server device. Connection Timeout (Seconds) The entry in this field sets the time within which the Enterprise Console must be connected to the Enterprise Server before timing out. The default setting for this field is 20 seconds. Read Timeout (Seconds) The entry in this field sets the read timeout limit between the Enterprise Console and the Enterprise Server. The default setting is 10 seconds. Unexpected Disconnection Settings Show Login Dialog Automatically Check this option to automatically display the Login dialog box should the Enterprise Console be unexpectedly disconnected from the Enterprise Server. Show Balloon Hint in System Tray Check this option to display a balloon hint in the System Tray at the bottom of your screen if the Enterprise Console unexpectedly disconnects from the Enterprise Server. Options Tab - Command page This page is used to set options for the Command panel. The Command panel is displayed in the Enterprise Console by clicking the Command tab (displayed as part of the Details/Action History/Messages/Command window Enterprise Console

48 The following options are available on the (Enterprise Console Options dialog) Command page: Maximum Lines In Command Panel This setting defines the maximum number of lines to be displayed in the Command panel at any one time. The default setting is 100 lines. Show Command Panel When New Message Received Check this option to set the Command panel to pop up automatically whenever a new message is received. Hide New Messages When In Do Not Disturb Mode Check this option to specify that any new Command messages arriving at a user console are hidden while they have an active mode of Do Not Disturb. Options Tab - Advanced page The advanced page is used to set the Anti-Idle settings. These prevent connection dropout during times of non-activity. Enable Anti-Idle Mode Opens the Anti-Idle options when selected. Send Anti-Idle command every xx minutes The time, in minutes, between which anti-idle commands are issued. The default setting is 5 minutes. Anti-Idle Response Timeout The time, in minutes, after which the Anti-Idle routine becomes dormant due to connection failure. Display Tab Display page This page is used to specify the default status for alert highlights, confirmation settings and miscellaneous (window display) settings. Select the required check box(es) for required system display settings. Default selections are checked unless specified. Highlight New Alerts In Bold Check to enable any incoming alerts to the Enterprise Console to be displayed in bold. Highlight Devices with Critical Alerts Check to enable the Flash mode for the device status if the highest priority alert for that device has an alert type that can flash when displayed in the Enterprise Console. Display Delete Confirmation Dialog for Closed Alerts Check to enable the display of a message prompt to confirm or cancel the deletion of closed alerts. Display Log off Confirmation Dialog Check to enable the display of a message prompt to confirm or cancel the log off action. Enterprise Console Options 7-43

49 Log Diagnostic Messages Check to enable the display of diagnostic messages in the Message panel. The default setting is not checked. Show Message Panel When Error Received Check to enable the message panel to be displayed as the visible panel in the Details section when an error message is received. If Minimized Restore To Normal Size When New Alert Received Check an option to determine the action to be taken if the Enterprise Console is minimized or not active when an alert is received. This can ensure that you do not miss any important alerts. Activate window and bring to foreground Flash window and task bar button Take no action Display Tab - Default Colors This page is used to specify default window color(s) for the alert panels and specify default alert status colors. Colors are selected from drop-down combo boxes associated with each option. When Custom... is selected, the Windows Color dialog is displayed allowing you to define a custom color for each option. Defining custom colors To define a custom color, click Define Custom Colors to expand the dialog and manually define a color, or enter a known color number in either the HSL or RGB text boxes. The following options are available on the (Enterprise Console Options dialog) Default Colors page. Inquiry Alerts (Panel One) Window Color The color option selected in this field is used to define the window background color of the Inquiry Alerts panel (Panel One). Font Color The color option selected in this field is used to define the font color of the text in the Inquiry Alerts panel (Panel One). Info Alerts (Panel Two) Window Color The color option selected in this field is used to define the window background color of the Info Alerts panel (Panel Two) Enterprise Console

50 Font Color The color option selected in this field is used to define the font color of the text in the Info Alerts panel (Panel Two). Alert Status Colors These options are used to specify status colors for the following alert types: Open Alerts Error Alerts Console Alerts Closed Alerts Audio When receiving alerts into the Enterprise Console it is possible to have a sound played when the alert is displayed. Alternatively it is possible to have the alert read out as speech when it arrives at the Enterprise Console. To allow the speech function to work, the Microsoft Speech API (SAPI) version 5.1 runtime must be installed. This is included in the Enterprise Console installation. Additionally, in order for the speech or sound to be played, each filter must also have an action of Play Sound on Alert or Speak on Alert set. This is done in Enterprise Server Options Filter Actions. Message content is taken from the Enterprise Server Options setting specified in the Action Detail For... dialog. This can be the actual error message text as raised by the alert or user-defined bespoke text. Audio Tab Sounds page Enable Sound Action Check to be able to select a sound option. Play Beep For machines without a soundcard, use the Play Beep option which has been designed specifically for this type of device. Play Sound Enter the directory path or click the Browse icon (see left)to navigate to your own preferred sound file. MP3 files are compatible with this option. Repeat Continuously Check to have the sound played repeatedly until either Mute Sound icon or F12 is pressed. Audio Tab - Speech page Speech Enable Speak Action Check to be able to select a speech option. Enterprise Console Options 7-45

51 Speaker Select the voice variant that you wish to announce the alerts from the choices available in the drop-down box. Speak First Incoming Alert This setting governs the action taken when simultaneous alerts arrive at the Enterprise Console. Check to have just the first of the simultaneous alerts announced. Leaving this field unchecked results in all alerts being announced. Speech Settings Volume Use the slider bar to control the volume level of the speech. Speed Use the slider bar to control the speed at which the speech is spoken. Click the Play icon (see left) to test the current settings. Changing Passwords Enterprise Console passwords are changed in the Change Password dialog, displayed by selecting Tools Options from the main menu and clicking Password on the Enterprise Console Options dialog. Passwords are reset from the Enterprise Server Options General Tab Users Reset Password. Reloading Devices If you add or change the configuration of devices you can use the Reload Devices option direct from the Enterprise Console without having to open Enterprise Server Options. Once activated, the Devices panel of the Enterprise Console is updated with the changes made. To use the Reload Devices option select Tools Reload Devices option from the Enterprise Console menu bar. Reloading Address Book If you add entries to the Instant Alert address book while the Enterprise Console is open you can use the Reload Address Book option direct from the Enterprise Console without having to open Instant Alert. To use the Reload Address Book option select Tools Reload Address Book option from the Enterprise Console menu bar Enterprise Console

52 C HAPTER 8ENTERPRISE SERVER OPTIONS CHAPTER Overview Enterprise Server Options is a standalone application used to specify, edit and change Enterprise Server settings; for example, message logging, user access rights, filters, alert, ping and connection monitor settings. These settings are entered via tabs displayed in the navigation bar (left pane) of the main window. Figure 8.1 Enterprise Server Options Enterprise Server Options 8-47

53 General Settings Enterprise Server options is accessed via Windows Start All Programs Halcyon Applications Enterprise Console Server Options. Alternatively, Enterprise Server Options can be accessed from within the Enterprise Console from Tools Server Options. The general settings options are used to determine the type and location of log file messages, device details and user settings. All log files are saved with an extension of.hlf. General Tab - General page Log Informational Messages Check to log all messages relating to the operation of the Enterprise Server. Log User Commands Check to log all commands entered by users in the Enterprise Console Command Panel Log Diagnostic Messages Check to log all system diagnostic messages. Log Incoming Alert Data Check to log all alert messages that have an action of Send Enterprise Console assigned. Show Server Name in Caption Check to enable the input of a specific server name. Name Type a name that then appears in the Enterprise Console Window Title Bar. General Tab - Device Load From Host/Address Type a host name or TCP/IP address from which devices can be loaded for use in the Enterprise Console. Note that this address must have the Device Manager component installed. Click Load to confirm the address and reload devices. Connection Timeout When the Enterprise Server needs to communicate with a remote device (one of the devices it has sent an alert to) it abandons its connection attempt after the interval specified here. The Enterprise Server tries to connect to remote systems to close an alert, reply to an alert, gather system information or load devices. Read Timeout The entry in this field sets the read timeout limit between the Enterprise Console and the remote device. The default setting is 5 seconds Enterprise Console

54 Note: Legacy IBM Power/System i Support settings For iseries connections (only visible in specially licensed versions) it is possible to state the port on which to listen for iseries connections and the port on which outgoing connections to the iseries are made. This only applies to Power/ System i devices running Halcyon Legacy software. Porting requirements for Power/System i devices can be found in the Settings Page of the Advanced Tab available when adding a device using Device Manager. Alert Settings Listen for Connections on Port Specify the port number on which incoming iseries alerts are received. The default setting is Connect to iseries on Port Specify the port number on which outgoing connections to iseries devices are made. The default setting is General Tab - Users page The Users page allows you to add, edit and delete users and reset password information for users as described in the chapter Passwords and User Names. Note: Alerts Tab - Alerts page Options on the Alerts page allow you to define alert conditions, specify which date and time is logged (remote or local), select alert display icons and choose alert actions at startup. Always Close Alerts Locally Check to enable the ability to close alerts locally even if an error occurred while trying to close or reply to an alert on the originating remote device. Broadcast New Alerts Every nn Seconds This setting allows you to specify the time interval (in seconds) between new alerts being broadcast, acting as a time delay between alerts being generated and forwarded. Log Alerts Using This setting allows you to choose whether alerts are logged using the local date and time at which the Enterprise Console received the alert or the remote date and time of the device from which the alert was sent. This setting must be set to Remote Date and Time if the Time Zone setting of the Device is active, otherwise all alerts received from the device are displayed with the Local Date and Time setting from this field. See Time Zone on page 4-15 for more information regarding this setting. Enterprise Server Options 8-49

55 Alert Panels These options allow you to select the icons displayed in the alert panels one and two of the Enterprise Console and to set the associated panel captions. Panel One Select the icon and caption for panel one, (by default, the top panel displayed in the Enterprise Console and to where all alerts generated by monitors within the Central Configuration Manager are displayed). The default settings are a red flag icon and a caption of Inquiry Alerts. Panel Two Select the icon and caption for panel one, (by default, the middle panel displayed in the Enterprise Console and to where all alerts generated by filters created within Enterprise Server Options are displayed). The default settings are a yellow flag icon and a caption of Info Alerts. Alerts Tab - Archive page Options on the Archive page allow you to define archive settings for closed/ replied or purged alerts. Save Alerts To Archive File Check to enable the saving of alerts to archive files. Alerts to Archive Select the type of alerts that you wish to archive: Inquiry: Archive Inquiry Alerts only Info: Archive Info Alerts only Both: Archive both Inquiry and Info Alerts Note: Create Archive Files Select the frequency (Daily, Weekly or Monthly) with which Archive files are created. Files are created on the first day of each choice. Archive Directory Specify the file path and directory name used to contain archived files. Alternatively, browse to the required path and directory. The default setting is: C:\Program Files\Halcyon\Enterprise Console\Archive. If no path is specified in this field, the archive file is saved to whichever directory the executable file: eso.exe is held. File Name Specify the archive file name. This can be entered manually; automatically (using substitution variables) or a combination of both. It is recommended to include a day substitution variable when archive files are generated Daily or Weekly and a month substitution variable when archive files are generated Monthly. All archive files have a file extension of.eca Enterprise Console

56 Note: Note: When using substitution variables throughout Enterprise Console, any entries that are made correctly are highlighted in green and those that will result in an error are highlighted in red. It is recommended to include a day substitution variable when archive files are generated daily or weekly and a month substitution variable when archive files are generated monthly. All archive files have a file extension of.eca. If a file or directory name includes invalid characters (preventing the file or directory from being created) an Archive Error is recorded. This is displayed in the Enterprise Console Alert Details page. This information is only available for closed alerts. Alerts Tab - Alert Types page The Alert Type settings are used in the Enterprise Console Devices panel to indicate device status. Device Status (color/description/icon/flashing) is set to the alert type that has the highest priority of alerts raised for that device. For example, a device that has ten alerts with a low status, five at medium status, two at high status and one at critical status is shown as being in Critical status in the devices panel of the Enterprise Console, as this is the highest priority. The re-prioritizing of alert types can be achieved by selecting an alert type and using Move Up and Move Down to re-position it in the priority list. Figure 8.2 Alert Types Enterprise Server Options 8-51

57 Note: Editing Alert Types To edit an alert type: It is not possible to change either the Alert Type name or Alert Type icon. 1 Select the alert type from those listed so that it is highlighted 2 Click Edit Type. The Edit Alert Type [alert type name] dialog is displayed. 3 Change the Alert Type Status Color and/or overtype the existing Alert Type Status Text. 4 Check Flash to have the Alert Type flash on and off repeatedly in the Enterprise Console display. 5 Click OK to confirm and save. Alerts Tab - Source Types page Source types indicate from which element of your network enterprise that the alert was sent. Options on the Source Types page allow you add, edit and delete source types. These are displayed in the Source Types table. Figure 8.3 Source Types 8-52 Enterprise Console

58 Adding a new Source Type To add a new source type: 1 Click Add Source Type. The Add New Source Type dialog is displayed. 2 Type the Name of the new Source Type. 3 Type a Description that accurately reflects the new Source Type. 4 From the drop-down menu list select a color by which the Source Type is displayed in the Enterprise Console. 5 Click OK to confirm and save the new Source Type. Editing Source Types Editing Source Types is a similar process to that used when adding Source Types. Note: Deleting Source Types User Defined Source Types (indicated by a user icon) are deleted by selecting a Source Type from the list and clicking Delete Source Type. System default Source Types are specific to Halcyon applications and cannot be deleted. Filters Note: Filters allow you to monitor for message or events across your network enterprise and allow you to specify what action to take should any message or event occur. Each Filter is split into three separate areas: Filter definition Criteria definition Action definition Options on the Filter page allow you to define (add, edit, delete and hold/ release) filters, selection criteria and actions for the logs you wish to monitor. Details of filter settings are available to view in the alert details panel of the Enterprise Console, for any alert generated by the respective filter. See View Alert Details on page 6-32 for more information. Summary details of currently defined filters and filter sequence numbers are displayed in a four-column table. Enterprise Server Options 8-53

59 Figure 8.4 Filter Summary Seq The sequence number of the filter. This number defines the order in which filters are examined when a new alert is received. Description The user-defined description of the filter. Log Messages A Yes in this column indicates which filter messages are logged. When filters are not logged, the cell is left empty. Held This column indicates which filters are Held by displaying Yes. When filters are not held (released), the corresponding cell is left empty. Column order can be rearranged by click-dragging and information in each column can be sorted (ascending/descending) by clicking on a column title. Holding/Releasing Filters The Hold Filter/Release Filter button allows you to Hold/Release filter(s) selected in the Filters table (above). Held filters are not checked against any new alerts found by the system and remain held until released (even if the application is restarted). Copying Filters Copying a filter is a quick way of creating a new filter with many required attributes already in place, allowing you to make one or two adjustments to then create a unique filter. To copy a filter: 1 Select the filter to be copied with a single click so that it is highlighted 2 Right-click on the filter and select Copy Filter from the pop-up menu. The Add New Filter dialog is displayed. 3 Click OK to produce an exact copy of the existing filter (labelled as 'Copy of...' in the Filters section of the Filter page) Adding/Editing Filters Adding or Editing Filters provides access to a new series of dialogs and options available when undertaking either of these actions. These are the same regardless of whether you are adding or editing a filter Enterprise Console

60 When you select the Add option, the first dialog displayed is the Add New Filter dialog. (replaced by the Edit Filter dialog when editing). Figure 8.5 Adding a new Filter Note: Filter Tab - Filter page These settings are used to determine sequence, action processing and activity of the filter. Sequence The setting in this field defines the order in which filters are examined. Enter a unique sequence number to specify the sequence position of the filter. Identical sequence numbers are automatically prevented from entry. Log Filter Messages Check this option if you suspect that the filter is not performing as expected. By selecting this option, diagnostic messages are written to the Message Log File (see Message Log Options on the General Tab. Note that the Save to Log File and Log Diagnostic Messages options must both be selected). All log files are saved with an extension of.hlf. Description Type a descriptive text for the new filter. This could be a summary of what the filter s intended use, for example; Warnings Received - Weekends Only. Enterprise Server Options 8-55

61 Action Action if Alert Received If this option is selected, action(s) is (are) taken if the alert is received within the Filter Active time range specified below. Action if Alert Not Received If this option is selected, action(s) is (are) taken if the alert is not received within the Filter Active time range specified. This option is useful for time critical jobs. Error Text A user-defined message that is activated when Action If Alert Not Received is enabled. Filter Active Mon-Sun Allows you to select/deselect on which day(s) the filter is active. The default setting is active every day. From - To Allows you to specify a time range between which the monitor should scan for events matching this filter sequence. Hours can span over midnight, for example, hours. Filter Tab - Default Display page These settings configure the default panel, alert type, background and font colors for alerts that have been processed against this filter for display purposes in the Enterprise Console. Alert Display settings Display in Panel Select in which of the two alert panels, any alerts raised by this filter appear. Override Alert Type Check to enable the display of an alternative alert type when an alert is triggered by the filter. Once enabled, select an alternative alert type from the drop-down list. Note: Background Color settings This section allows you to determine the background color of any alert messages raised by this filter. Only one option is allowed. Use Custom... to specify a color that is not available in the background color list Enterprise Console

62 Default Background Color This setting keeps the default background color of the alert as defined in Enterprise Console Options Display Default Colors Alert Status option. Device Background Color This setting keeps the default background color of the device as defined in Device Manager Add Device Display Color option. Selected Color This setting allows you to set your own color choice as the background of any alert messages raised by this filter. Font Color settings This section allows you to determine the font color of any alert messages raised by this filter. Only one option is allowed. Default Font Color This setting retains the default font color as specified in Enterprise Console Options Default Colors option. Selected Font Color This setting allows you to set your own color choice as the as the font color used in any alert messages raised by this filter. Note: Filters tab Alert Message page The Alert Message page is used to provide alternative text details for alerts, allowing you to provide greater clarity and meaning to the alert when received. The actual alert information remains the same so that any matching filter information is captured prior to the text being changed. Alert Message settings Message Enter free text and/or use the Alert, Device and Details variables (as displayed) to generate alternative text once matching filter criteria has been proven. Note: An example of the current alert message text convention is displayed in the Example field. Within Enterprise Console, substitution variables are listed as hyperlinks. Click on the blue text of a substitution variable to select and insert in the Message or Alert Text Box at the current cursor position. When using substitution variables throughout Enterprise Console, any entries that are made correctly are highlighted in green and those that will result in an error are highlighted in red. Enterprise Server Options 8-57

63 Note: Using Pipes with Alert Text Alert text can be reformatted by using pipes to change the number of decimal places reported, remove white space and so on. For example, to change the text of an alert reporting a numerical value of so that it only reports two decimal places use the parameter &N p2 ; resulting in the alert text changing to For a full list of available parameters see Substitution Variable Parameters. Using Substitution Variables with Alert Detail information For alerts that generate detail information (such as SNMP Traps), use the &DetailsName variable to replace any entry in the left hand column of the details section of the Alert Detail (as viewed by double-clicking the alert within Enterprise Console) with its corresponding entry in the right hand column. This feature is particularly useful when used for SNMP trap alerts as the Enterprise Console has no automatic way of recognizing which object in the trap payload actually represents the error message. For example, in the SNMP Trap below: 8-58 Enterprise Console

64 The trap payload is shown in the details section headed PDU. The payload contains a list of objects (left-hand side) and a corresponding value (right-hand side). Any one of these PDU values can be used in the alert text by using the object name as a substitution variable. For the purpose of this example, the PDU value halesalerttext is used: When the trap is received, software scans the payload looking for an object with the same name as the variable. If found, it inserts the corresponding value into the alert text (in this case; Test Alert 1 ). Note: If this option is used with common or frequently occurring message text, be sure to specify other criteria to ensure that the alert message generated is correct for the actual alert received. Using Substitution Variables with SNMP OID information In the previous example, a matching SNMP MIB (Management Information Base) file was used to map SNMP OIDs to object names. Without this data, the incoming trap would have been displayed as a series of unique numbers such as: OID If there is no MIB available for the SNMP trap that you are receiving, you can still use substitution variables to override the alert text, simply by specifying the unique OID number as the variable name. Note: If you need to specify any variable that contains a space, such as OID information, ensure that the variable text is enclosed in quotation marks. Enterprise Server Options 8-59

65 Note: To decide on which information you should capture in order to get the most meaningful results in the alert text, setup a test filter first and see what is generated. From this information you can then determine the details that you want to capture and set the substitution variables accordingly. For more information on using Substitution Variables within Enterprise Console, see Working with Substitution Variables on page Filters Tab - Advanced page The Advanced settings allow you to specify the method of counting alerts from this filter and the processing settings applied. Alert Count Method This setting allows you to specify the method by which alerts raised by this filter are counted. Filter The standard filter counter is incremented each time an alert is processed against this filter regardless of the alert s source or text. Source A distinct source counter is incremented each time an alert is processed against this filter depending on the alert s source. Text A distinct text counter is incremented depending on the alert s message text. Alert Count Examples Assume the following actions have been defined: Seq Action Perform Action For Action Type 10 Action 1 1 Alert Change Display Settings 20 Action 2 1 Alert Send 30 Action 3 1 Alert Send SNMP Trap Assume the following alerts have been received: Time Alert Message Text Alert Source 10:00 Test Alert 1 Server Manager 10:05 Test Alert 2 Message Monitor 10:10 Test Alert 2 Message Monitor 8-60 Enterprise Console

66 If the Alert Count Method is Filter then: Action 1 will be performed against the alert 10:00 Test Alert 1 (Filter Counter=1) Action 2 will be performed against the alert 10:05 Test Alert 2 (Filter Counter=2) Action 3 will be performed against the alert 10:10 Test Alert 1 (Filter Counter=3) If the Alert Count Method is Source then: Action 1 will be performed against the alert 10:00 Test Alert 1 (Server Manager Counter=1) Action 1 will be performed against the alert 10:05 Test Alert 2 (Message Monitor Counter=1) Action 2 will be performed against the alert 10:10 Test Alert 1 (Message Monitor Counter=2) If the Alert Count Method is Text then: Action 1 will be performed against the alert 10:00 Test Alert 1 (Test Alert 1 Counter=1) Action 1 will be performed against the alert 10:05 Test Alert 2 (Test Alert 2 Counter=1) Action 2 will be performed against the alert 10:10 Test Alert 1 (Test Alert 1 Counter=2) Filter Processing Settings This option suspends the filter according to the options defined below. It is good practice to use these options to prevent multiple alerts of the same message being delivered: Automatically Suspend Filter Check to enable the Filter Suspension options. Until Triggered X Times Specify how many times the filter is triggered before it is activated. The count can also be within a time frame. Within x Minutes Appends a time limit to the Until Triggered x Times option. For x Minutes When Triggered x Times Defines how many minutes the filter is suspended for after it has been triggered a (user) specified number of times. Adding Filter Criteria Options on the (Add New Filter/Edit Filter dialog) Criteria Page allow you to define (add, edit, delete) filter selection criteria. These are the qualifications that the filter must meet if an alert is to be raised. Enterprise Server Options 8-61

67 Note: Details of filter criteria are displayed in a five-column table (Select/Omit, Alert Kind/Alert Type/Source/Text). Table column order can be rearranged by clickdragging columns to the required position and information in each column can be sorted (ascending/descending) by clicking on a column title. No sequence number is required as each entry is checked in turn until a match is found. Any number of selects or omits can be entered in each filter. Criteria are added in the Add New Criteria dialog and edited in the Edit Criteria dialog. These dialogs are displayed by clicking Add Criteria or Edit Criteria (edit is enabled for any selected item(s) displayed in the table). Options on both dialogs are identical. Click Add Criteria to create a new selection criterion for the filter. Adding/Editing Filter Criteria Click Add Criteria to create a new selection criterion for the filter. Criteria tab - Criteria page These options also apply to the Edit Criteria dialog. Criteria Details settings Choose whether to select or omit this filter from action processing. Select Check this option to select this filter for action processing. Omit Check this option to omit this filter (only) from action processing. Events matching similar selection criteria in other filters may be selected for processing. Alert Kind Choose the alert kind option for this filter. Inquiry Non Inquiry Both Alert Type Define the alert type level for this filter based on selected conditional parameters (equals, less than, greater than, etc.). Priority is taken from the Alert Type table on the - Alerts Tab - Alert Types page Enterprise Console

68 Examples: (assuming default alert type priority has been kept): Parameter Alert Type Result = Any Type All Alert Types are selected > Error All alert types with a higher priority of error are selected = Critical Only critical alerts are selected Source Type Define the source type based on conditional parameters (equal to, not equal to). Examples: Parameter Source Type Result = Any Type All Source Types are selected <> Ping Monitor All Source Types except Ping Monitor are selected = Ping Monitor Only the Ping Monitor Source Type is selected Alert Text Enter the alert text based on conditional parameters (equals, less than, greater than, etc.). Wildcard characters can be used when defining the Alert Text. This option is selected via the drop-down list. Search Text From Position... For... Characters Allows you to fine tune your search for specific alert text by specifying a starting position from which to search and for a specified number of characters. Alert Details The Alert Details area is used to set textual information for incoming alerts as shown in the example below: Enterprise Server Options 8-63

69 Note: Details Text Define the details text. This can be generic or free text but can use specific textual values that vary depending on the type of alert filter that is being defined. Wildcard characters can be used when defining this text. See the following for more information; Setting Alert Detail Criteria for iseries Alerts Setting Alert Detail Criteria for Server Manager Alerts Setting Alert Detail Criteria for SNMP Trap Alerts Setting Alert Detail Criteria for Syslog Messages Details Value Define the details value based on conditional parameters (equals, less than, greater than, etc.) when used in combination with entry in the Details Text field. Wildcard characters can be used when defining the details value. Wildcard Characters settings The wildcard characters area is used to define characters which are then used as substitutes for search spans or single characters. Use... As A Substitute For Zero or more Characters Enter the character you wish to use as a substitute for this search span. Use... As A Substitute For A Single Character Enter the character you wish to use as a substitute for a single character. Setting Alert Detail Criteria for iseries Alerts When setting alert detail criteria for alerts originating from IBM iseries devices, specific string and integer values can be set. String Values The following string values are valid when entering Details Text for alerts originating from IBM iseries devices: Message ID Message Queue Message File Program System User Number With string values, only operators = and <> are used. Other operators can be used, but note that unexpected results may be generated Enterprise Console

70 Textual Details Value entries should match the entry in the Details Text field together with the selected operator. For example, to specify alert detail criteria for a specific message ID, you may enter something similar to: Details Text: Message ID Details Value: = CPF9898 An alert is generated for any IBM iseries Message ID of CPF9898, that also passes other specified criteria. Integer Values The following integer values are valid when entering Details Text for alerts originating from IBM iseries devices: Severity Filter Sequence Selection Sequence All operators can be applied to integer values. An example of specifying alert detail criteria, with an integer value, for an IBM iseries alert may be similar to: Details Text: Severity Details Value: >= 80 An alert is generated for any IBM iseries message with a severity of greater than or equal to 80, that also passes other specified criteria. Setting Alert Detail Criteria for Server Manager Alerts When setting alert detail criteria for alerts originating from the Server Manager, specific string values can be set. Enterprise Server Options 8-65

71 String Values The following values are valid when entering Details Text for Server Manager alerts. The operator value is usually set to equals =. Details Text Event Type Source Category Event ID User Message Valid Details Value Error, Audit Success, Information, Warning Halcyon SNMP Manager No specific value required Any valid Event ID number No specific value required Any valid message as displayed in the Windows Event Log. The use of wildcards is recommended Examples of specifying alert detail criteria for Server Manager alerts may be similar to: Details Text: Event Type Details Value: = Error Details Text: Event ID Details Value: = 125 Details Text: Details Value: Message = *Service: esinterface failed: NetMan* In the above example, an alert is generated for any Server Manager Event Type with a value of error, that also passes other specified criteria. Setting Alert Detail Criteria for SNMP Trap Alerts Alert detail criteria for SNMP trap alerts can be specified in one of two ways, dependent on whether the incoming trap has been assigned with a valid mib definition, instead of the basic OID value. Operator values are usually set to equals = Enterprise Console

72 Therefore, the alert detail criteria for SNMP Trap alerts can be specified in a similar way as follows: With a mib definition: Details Text: halesalertdevicename Details Value: = MainServer With an OID definition: Details Text: OID Details Value: = MainServer In the above example, an alert is generated for SNMP Trap OID with a value of MainServer, that also passes other specified criteria. Each trap entry has an associated type, such as ASN1_OCTSTR or ASN1_INT. Types ASN1_INT, ASN1_COUNTER, ASN_GAUGE and ASN1_TIMETICKS are converted to integer values and all operators can therefore apply. Setting Alert Detail Criteria for Syslog Messages When setting alert detail criteria for alerts originating from Syslog messages, specific string values can be set. String Values The following values are valid when entering Details Text for Syslog message alerts. The operator value is usually set to equals =. Details Text Facility Severity Raw Text Valid Details Value *user* *error* *This is a test message (Raw Text is the actual message that is received prior to formatting) Enterprise Server Options 8-67

73 Examples of specifying alert detail criteria for Syslog messages may be similar to: Details Text: Facility Details Value: = *user* Details Text: Details Value: Severity = *error* Note: In the above example, an alert is generated for any Syslog Message Severity message with a value of *error*, that also passes other specified criteria. See These variables can be added to the error message as required to identify the name and/or address of devices whose connections are monitored. on page 8-80 for more information See Syslog Message Severities on page 8-81 for more information Criteria tab - Device Selection page The Device Selection page determines the devices from which you can receive alerts for the required criteria. Devices must have previously been loaded using the Device Manager in order for them to be available for selection in this screen. Information is listed in four columns: Group Device Type Device Address Column order can be rearranged by click-dragging and information in each column can be sorted (ascending/descending) by clicking on each column title. To load a device into the Selected Devices section of this page, simply click on the required device in the Available Devices section and click Add Device to move it into the Selected Devices section. The Clear All/Clear Selection buttons are used to clear all or selected devices from the Selected Devices table Enterprise Console

74 Devices shown in the Available Devices are loaded from the Device Manager as defined on the main options General Device Device Location page. This section allows you to locate and specify available devices on the network by category. Each category allows selection of items from a drop-down list, (the contents of the Device Type and Device categories reflect available devices on your network). Figure 8.6 Available Devices The categories comprise: Device Group: Device groups are collections of similar devices, such as all those that belong to a specific department. Device groups are set up and maintained in Device Manager. Category: Devices, such as servers that can be divided into specific types. Items listed here are by default. No other items can be added to this list. Device Type: Device types, such as proxy servers are listed on this drop down comprise a mix of default items and any other items identified on your network, which are added to this list automatically. Hide Selected Devices This checkbox allows you to view only those devices not already listed in the Selected Devices table (above). This avoids duplicating device information in both tables. The View Details button is used to open the View Device dialog, allowing you to view the attributes of a selected device. Options for this dialog are detailed in the View Device Dialog topics. The Deselect All/Select All buttons are used to deselect or select all devices listed in the Available Devices table. Click OK to apply the Criteria. Enterprise Server Options 8-69

75 Filter Tab - Actions page The options on the (Add New Filter Edit Filter dialog) Actions Page allow you to define (add, edit and delete) actions. Any number of actions can be defined for each filter and these actions are processed in turn if the filter selection criteria match the alert. Action details are displayed in a five-column table (Seq, Delay, Action, # Alerts and Parameters). Table column order can be rearranged by click-dragging and information in each column can be sorted (ascending/descending) by clicking on a column title. Actions are added and edited in the Action Detail For... dialog. This dialog is displayed by clicking Add Action or Edit Action (edit is enabled for any selected item(s) displayed in the table). The dialog title includes the name of the Action Type, this is user-selected from the Action Type: drop-down list. Escalating the Priority of Pending Alerts Actions are listed in the Actions For Filter table by priority of sequence number and within each action sequence group, the time delay specified. Actions within each sequence group can be escalated individually, by selecting an action and clicking the up/down arrows (see below) to reposition the action in the table: Actions can only be prioritized individually; it is not possible to prioritize multiple actions simultaneously. It is important to be aware that escalating or de-escalating the priority of any action also affects subsequent relationships between actions (within the same sequence). Add Action For [Action] Click Add Action to open the Add Action For...(Action) dialog. Action Sequence Either directly type or use the choice buttons to select the action sequence number required. This sequence number does not have to be unique. If there are two or more sequence numbers with the same value, all actions are executed for the particular occurrence of that alert. For example, if an alert is received which requires a command to execute and a log to be written every time, both actions would be assigned the same sequence number so both actions are executed for the same alert. Action Type Action types are selected from the Action Type drop-down combo box. When an action type is selected, an additional option is added to the navigation pane (except for Log Only and Play Sound at Console actions). These additional options allow you to enter information related to the Action Type selected Enterprise Console

76 The following action types can be selected: Action Selected Change Display Settings Execute Command Hold Alert Filter Log Only (No Action) Play Sound At Console Raise Helpdesk Ticket Release Alert Filter Reset Alert Count Description of Action Changes display settings for received alerts Executes a command when an alert is received Holds the specified filter and prevents it being selected for action No action is take, the alert is logged as received Plays a sound when an alert is received Sends an Instant Alert Message to nominated recipients when an alert is received Releases the specified filter previously help by the Hold Alert Filter option Resets the alert count of a filter Additional Option Displayed Display - options on this page are detailed in Default Display. Command - An example of variables content type is displayed in the read-only Example: text box as you enter each variable. The exact content displayed is defined by your system, network configuration and local conditions such as the date and time. Filter - options on this page allow you to select an existing filter to hold. None. None- the default sound is played Helpdesk - opens the helpdesk page, allowing you to generate an message based upon a mixture of text and substitution variables. This can then be used to raise a ticket on a 3rd party helpdesk application. Filter - options on this page allow you to select a held filter and release it. Filter - options on this page allow you to select an existing filter and reset the alert count. Enterprise Server Options 8-71

77 Send Console Action Speak at Console Send Network Message Closes or replies to an alert on the originating remote console Plays a spoken message when an alert is received Sends a message to other users on the network when an alert is received - the message text can contain substitution variables Console - options on this page allow you to close the alert or reply to the alert with a user-defined message. Speech - options on this page allow you to include the device name, speak alert only or speak user-defined text. Message - this page has two sections: Recipients and Message. Recipients: allows you to enter the network users to receive the message (you need to have their user names available). ² Message: allows you to input the text to be sent, and/ or enter Substitution Variables listed in a table below the Text: text box. An example of variables content type is displayed in the read-only Example: text box as you enter each variable. The exact content displayed is defined by your system, network configuration and local conditions such as the date and time Enterprise Console

78 Forward Alert Send SNMP Trap Forwards all alerts raised by the filter to another instance of Enterprise Server. Forwarded alerts are displayed with an additional icon and extended information in the Alert details panel in the Console. Sends an SNMP trap Forward - options on this page allow you to define the server to which the alerts are forwarded. Routing information is defined per device or device group in Device Manager. If an alert is forwarded from a device that does not currently exist in the receiving server device list, a temporary device is added until the alert is closed. If an alert is received from an iseries device and then forwarded onto another console, the receiving console must have the routing information of the forwarding device in order that a reply can be sent back to the iseries device. Send SNMP Trap - options on this page allow you to select a device and view device attributes. If a device is not currently available, a new one can be added from the Device Manager. Device details can be reviewed in the View Device dialog displayed by clicking Details in the Select Device window. If an application is associated with the device, the application can be launched by double-clicking its name in the Support pane. Enterprise Server Options 8-73

79 Delay Before Action... Minutes (not for Log Only actions) If required, specify a time delay before the action is active (default 0 minutes). Perform Action For All Alerts: The specified Action Type (above) is applied to all alerts. This Number of Alerts: Used to specify the number of alerts for which this action is performed. Please refer to advanced filter settings ñ Filter Count Method for more details. Comments Add any comments you would like added to the status of this alert. Note: Click OK to apply the action. Click OK on the Add New Filter dialog to create the filter Use the Edit Filter option from the main Filter dialog display to amend any settings, criteria or actions for this filter. Set as Default Click this button to set the currently displayed action (change as required prior to setting) as the default action when creating new filters. Creating a Filter for Message ID Specific Events There are many different events that are automatically generated if a specific event occurs during the day-to-day operation of the Power/System i. This section shows you how to create a filter that monitors and reports to the Enterprise Console on a specific or any generic messages raised. To create a filter for Message ID Specific Events: 1 From Windows Start select Programs Halcyon Applications Enterprise Console Server Options 2 Select the Filters tab and click Add Filter 3 Keep all defaults and enter a Description for the new filter 4 Select the Criteria tab and click Add Criteria 5 Enter Message ID in the Details Text field 6 Select the Details Value operand as = and enter either the specific message ID of the message on which you wish to filter or use the wildcard symbols * and? to filter for generic message ID s 7 Select the Device Selection option 8 Select the Device(s) from which you wish to receive details of any messages. See Criteria tab - Device Selection page more details. Click OK 9 Select the Actions tab and click Add Action 10From the drop-down menu choice select Send Console Action as the Action Type Enterprise Console

80 Actions Settings 11Click OK to Add the Action 12Click OK again to add the Filter 13With the filter selected in the main display, click Release Filter 14Click Apply to save the settings. Settings on this tab of Enterprise Server Options are used to set global options for filter actions. Outstanding Actions settings Process Outstanding Actions on Startup Select this option to specify whether any pending actions are executed upon starting a new session of Enterprise Console. Reset Filter Alert Counters on Startup Select this option to reset all filter counters back to zero when starting a new session of Enterprise Console. The system remembers the current count of all active filters so for example, if a counter has an action of sending a message on the third instance of being raised and the current count is two, the system will reset this setting back to zero if this option is selected. Forward Action settings Resend Alert If Forward Action Fails Select this option to ensure that any alerts that are raised with the forward action, are resent if the initial forwarding action fails. Resend Interval Specifies the time delay (in minutes) in resending forwarding alerts. Resend Retry Count Specifies the number of times that the resend action is attempted. SNMP Traps settings Resend Traps If Alert Stays Open Select this option to ensure that any alerts that are raised with the SNMP Trap action are resent if the initial SNMP Trap alert stays open. Resend Interval Specifies the time delay (in minutes) in resending SNMP Trap alerts. Resend Retry Count Specifies the number of times that the resend action is attempted. Enterprise Server Options 8-75

81 Connection Monitor The Connection Monitor allows you to monitor Power/System i connections. The Handshake Interval setting from within the Remote Locations menu option on the Power/System i device specifies the frequency with which this device connects to the Enterprise Console. Therefore, if the Handshake Interval field entry is set to 5, the Power/System i Device attempts to connect to the Enterprise Console. Enable the Connection Monitor to indicate that the Enterprise Console is active whenever the Power/System i device connects. If no communication is received from the Power/System i device within any sixty minute period (+ 2 minute grace period) an alert is generated with the text as defined in the Alert Text field. Note: Connection Monitor working with Halcyon Legacy software When working with Halcyon Legacy software and with the Connection Monitor enabled, the Connection Monitor is activated as soon as a connection check message is received. The Halcyon Network Manager sends a connection check message every 6 minutes (plus 4 minutes grace period). Once activated, an alert is raised for each device that has not sent a connection check message in the allocated timeframe. In both scenarios, systems that are deemed as Busy. i.e. sending a large quantity of alerts may not make the connection as per planned interval. Figure 8.7 Connection Monitor Settings 8-76 Enterprise Console

82 Connection Monitor - Connection Monitor page Note: Enable Connection Monitor Click to enable the Connection Monitor and associated settings. Alert Text Default alert text (Connection Check Not Received From Device &N/&A - Please Investigate) is displayed in this field. This text can be edited as required. You can also add alert and device variables to clarify the details of the message. An example of how the actual alert will be displayed if generated, based upon the text and variables used, is shown in the Example field. When using substitution variables throughout Enterprise Console, any entries that are made correctly are highlighted in green and those that will result in an error are highlighted in red. Substitution Variables Connection Monitor substitution variables comprise: Alert Variables (such as Date, Time, Source, Type and so on) Device Variables (such as Name, IP Address, Group name and so on) Ping Monitor These variables can be added to the error message as required to identify the name and/or address of devices whose connections are monitored. These options allow you to ping devices (selected in the Device Selection page) at regular intervals. If a device ping is unsuccessful, an error alert is generated with the error text as specified in the Alert Text field. Ping Monitor page The following options are available on the Ping Monitor page: Enable Ping Monitor Click to enable the Ping Monitor and associated settings. Interval: - Minute(s) This option sets the ping interval in minutes. Either overtype the current entry or use the up/down arrows to adjust the setting. The default setting is 60 minutes. Ping Timeout: - Milliseconds(s) This setting defines the time period after which any attempted ping is deemed to have failed. Either overtype the current entry or use the up/down arrows to adjust the setting. The default setting is 2000 milliseconds. Enterprise Server Options 8-77

83 Note: Ping Attempts This setting defines how many attempts are made to successfully connect with the device before the alert is raised. Either overtype the current entry or use the up/down arrows to adjust the setting. The default setting is 4 attempts. Time-to-Live This setting defines for how long each ping is deemed active. Either overtype the current entry or use the up/down arrows to adjust the setting. The default setting is 128 milliseconds. Success Percentage This setting determines the percentage of attempts required to be successful in order to prevent an alert being generated. For example, with this field set to 100% and Ping Attempts set to 4, it would only take one failure to generate a success percentage of 75% and therefore raise an alert. Either overtype the current entry or use the up/down arrows to adjust the setting. It is advised that the success percentage is a multiple of the setting in the Ping Attempts field. The default setting is 100%. Alert Text This is the text message used to report a ping error (default is: Unable to Ping Device &N/&A Please Investigate {&E}. This text can be edited as required. You can also add alert, device and ping variables to clarify the details of the message. An example of how the actual alert will be displayed if generated, based upon the text and variables used, is shown in the Example field. When using substitution variables throughout Enterprise Console, any entries that are made correctly are highlighted in green and those that will result in an error are highlighted in red. Substitution Variables Ping Monitor substitution variables comprise: Alert Variables (such as Date, Time, Source, Type and so on) Device Variables (such as Name, IP Address, Group Name and so on) Ping Variables (such as Ping Attempts, Failed Attempts and so on) These variables can be added to the error message as required to identify the name and/or address of devices whose connections are monitored. Ping Monitor Tab - Device Selection The following options are available on the Device Selection page (accessed via the Ping Monitor and the Add New Criteria dialog). Please refer to the Criteria tab - Device Selection page on page 8-68 section for details on the Device Selection fields Enterprise Console

84 Syslog Monitor The Syslog Monitor is used to capture system log information from identified devices (typically from UNIX and Linux servers) and forward it to the Enterprise Console. Figure 8.8 Syslog Monitor Settings Syslog Monitor Tab Syslog Monitor page Enable Syslog Monitor Click to enable the Syslog Monitor. Note: Alert Text This is the text message used to report a ping error (default is: &M). This text can be edited as required. You can also add alert, device and syslog variables to clarify the details of the message. An example of how the actual alert will be displayed if generated, based upon the text and variables used, is shown in the Example field. When using substitution variables throughout Enterprise Console, any entries that are made correctly are highlighted in green and those that will result in an error are highlighted in red. Enterprise Server Options 8-79

85 Substitution Variables Syslog substitution variables comprise: Alert Variables (such as Date, Time, Source, Type and so on) Device Variables (such as Name, IP Address, Group Name and so on) Ping Variables (such as Facility, Severity, Message and so on) These variables can be added to the error message as required to identify the name and/or address of devices whose connections are monitored. Syslog Message Facilities Numerical Code Facility 0 kernel messages 1 user-level messages 2 mail system 3 system daemons 4 security/authorization messages (note 1) 5 messages generated internally by syslogd 6 line printer subsystem 7 network news subsystem 8 UUCP subsystem 9 clock daemon (note 2) 10 security/authorization messages (note 1) 11 FTP daemon 12 NTP subsystem 13 log audit (note 1) 14 log alert (note 1) 15 clock daemon (note 2) 16 local use 0 (local0) 8-80 Enterprise Console

86 17 local use 1 (local1) 18 local use 2 (local2) 19 local use 3 (local3) 20 local use 4 (local4) 21 local use 5 (local5) 22 local use 6 (local6) 23 local use 7 (local7) Syslog Message Severities Numerical Code Severity 0 Emergency: system is unusable 1 Alert: action must be taken immediately 2 Critical: critical conditions 3 Error: error conditions 4 Warning: warning conditions 5 Notice: normal but significant condition 6 Informational: informational messages 7 Debug: debug-level messages Forwarding Syslog Messages from a Linux Device In order to be able to forward syslog messages to the Enterprise Console from a Linux device, the following configuration steps must be implemented: 1 Log on to the required Linux device as a super user. 2 Enter the command: vi/etc/syslog.conf to open the configuration file called syslog.conf 3 Enter *.* and press the Tab key 4 Enter the name of the host device on which Enterprise Server is running Enterprise Server Options 8-81

87 Advanced Settings For example: 5 Restart the syslog service using the command: /etc/rc.d/init.d/syslog restart The Advanced tab of Enterprise Server Options provides access to Instant Alert and SQL Settings, License Information, Helpdesk Integration, Send Alert defaults and Messages. Note: Note: Advanced Tab - /SMS Default settings page The /SMS Defaults page is used to specify defaults used when sending alerts to via or SMS. Specify Send Alert as /SMS Defaults Click to enable the ability to specify send alert as /sms defaults. From Click to enable the entry of the sender details. Any s/sms messages that are sent via the Send Alert As option from the Enterprise Console, default to being from the entry in this field. To Enter the recipient details to where the /sms message is sent. Any s/ SMS messages that are sent via the Send Alert As option from the Enterprise Console, default to being sent to the entry in this field. Click the Address Book icon to open the Instant Alert Address Book from where pre-defined users can be selected. See Address Book on page 9-95 for more information regarding the Instant Alert Address Book. Subject Enter the default text for the /sms subject title. This could be something simple such as Enterprise Console Alert to identify the origins of the message. Content The content can be made up from typed text, substitution variables listed at the bottom of this dialog, or a mixture of both. The message content can default to be either: HTML - message is generated in HTML format by default Use Text Below - message uses entered text as the default Example Displays a textual example of the current entries in the Subject and Content fields. When using substitution variables throughout Enterprise Console, any entries that are made correctly are highlighted in green and those that will result in an error are highlighted in red Enterprise Console

88 Substitution Variables Use the substitution variables to assist in the building of the message content. Send Alert as /SMS substitution variables comprise: Alert Variables (such as Date, Time, Source, Type and so on) Device Variables (such as Name, IP Address, Group name and so on) Advanced Tab - Helpdesk Defaults page The Helpdesk Defaults page is used to specify defaults used when sending alerts to third party helpdesk applications. If a filter is triggered with the action of Raise Helpdesk Ticket, or right-click Send Alert As Helpdesk directly from an Enterprise Console Alert is selected, the default information entered in this dialog can be used to generate an that when received by the third party helpdesk application, can automatically raise a ticket. Figure 8.9 Helpdesk Integration Enterprise Server Options 8-83

89 Note: Entries made on this screen are subsequently displayed as defaults whenever the Send Alert As Helpdesk option is selected from the Enterprise Console. Specify Helpdesk Defaults Check to enable the ability to specify helpdesk defaults. From Check to enable the entry of an address from which the is sent. This is a mandatory requirement of some helpdesk applications. To Enter the address to which the is sent. This is usually a generic helpdesk address. Subject Enter the text for the subject title. The default entry is Enterprise Console Alert. Body The body can be made up from typed text, substitution variables listed at the bottom of this dialog, or a mixture of both. Most helpdesk applications require the information to be in a specific format so that they can successfully generate the helpdesk ticket. Please refer to your helpdesk application software documentation for specific requirements. Example Displays a textual example of the entry in the Body field. Substitution Variables Use the substitution variables to assist in the building of the helpdesk body text. Advanced Tab - Instant Alert page Figure 8.10 Instant Alert Server page 8-84 Enterprise Console

90 The following options are available on the Instant Alert page: Select Server This is used to select the server on which the instance of Instant Alert is running. To select the Instant Alert Server: 1 From the Advanced Settings - Instant Alert page, click Select Server. The Select Device dialog from which the Instant Alert Device can be selected is displayed. The device on which Enterprise Console is installed is listed by default. 2 Highlight the required device and click Select. The selected device is now installed as the Instant Alert Server. Clear Server Click to remove the currently displayed device as the Instant Alert Server. Verify Server Click to test the connection between the current device and the Instant Alert Server. Advanced Tab - SQL Server page he SQL Server page is used to display the current details of the SQL Server package being used. Refresh Use the Refresh option to update the SQL details shown on this display. Purge Use Purge to clear all alerts, actions and pending alerts from the SQL database tables. This quickly clears the tables should the Enterprise Server become swamped with alerts. Advanced Tab - Messages Page The messages page is used to display any system messages generated by the Enterprise Server Options program. These can be used as an audit trail showing all actions undertaken since the Enterprise Server Options program was opened. Click Clear to delete the current messages. Advanced Tab - Licenses page The licenses page of Enterprise Server Options shows the current licensing configuration of your network enterprise for Enterprise Console. Enterprise Server Options 8-85

91 . Figure 8.11 Product License Editing licenses You may need to edit a license if you are running on the demonstration or periodic versions of the software. To edit a license: 1 Select the license that you wish to edit and click Edit License. The Product Code dialog is displayed. 2 Enter a new product code to update the license. The date in the Expiry Text field changes accordingly. 3 Click OK to confirm and continue. Reset License Using Reset License removes the licensing from the selected component. It must be re-licensed before it can be used again. Enterprise Server Options buttons There are five buttons available at the bottom of the Enterprise Server Options dialog About button Click to display version and ownership details of the Enterprise Server Options software. Available Windows Physical Memory is also displayed. Import/Export button Click the Import/Export button to import or export current Enterprise Server Options settings from one device to another Enterprise Console

92 Figure 8.12 Import/Export options dialog Exporting Data Settings exported from Enterprise Server Options include: User data Defined filters To export Enterprise Server Options settings: 1 From the Windows Start menu select Start Programs Halcyon Applications Enterprise Console Server Options 2 Click Import/Export in the Footer section of the Enterprise Server Options dialog. 3 Select Export and enter a Path and File Name or click the Browse icon (see left) to select a directory and file name to which the exported data is saved 4 Click OK to save the data in the named file and location. The file is saved with an extension of.eco Importing Data By importing settings from another instance of Enterprise Server Options, you overwrite any existing data. This action cannot be undone. You must have previously Exported Settings from an existing instance of Enterprise Server Options prior to using the Import functionality. To import Enterprise Server Options settings: 1 From the Windows Start menu select Start Programs Halcyon Applications Enterprise Console Server Options 2 Click Import/Export in the Footer section of the Enterprise Server Options dialog. 3 Select Import and click the Browse icon to select a directory and an.eco file. 4 Click Open to import the data into this instance of Enterprise Server Options and override any existing data. Enterprise Server Options 8-87

93 Reset button Click to restore the original Server Settings to this installation. You are prompted to confirm this action. Apply button Click to apply any changes to the Enterprise Server Options. If clicked without any settings having changed, the following dialog is displayed: Close button Closes the Enterprise Server Options dialog. If you have not saved any changed options, you are prompted to do so prior to closing. Device Dialog The Device Dialog is used to view, add and edit system devices and operates in read-only or read/write mode according to the application from which the dialog is accessed (Enterprise Server Options or Device Manager). View Device Dialog (Read-only Mode) Within Enterprise Server Options, the dialog (View Device Dialog) functions in read-only mode. The dialog is accessed via the Device Selection pages accessible from Filter Criteria, Ping Monitor, Syslog Monitor and SNMP Traps pages by clicking the View Details button (active when a device is selected from the associated list). No changes can be made when in view only mode. For detailed information regarding the pages, options and fields within the Device Dialog, please refer to the section Device Manager Adding Devices Enterprise Console

94 C HAPTER 9INSTANT ALERT CHAPTER Overview Instant Alert is the component used to send text messages or s from the Enterprise Console to helpdesk applications, addresses or mobile phones. If you use a GSM data terminal for the purpose of sending SMS to mobile phones, it must be installed on the same machine as Instant Alert. Broadcast groups and schedules can be set up so messages are sent to the appropriate on-call personnel. A message log is provided to monitor the status of messages. The date/time of any message sent through Instant Alert is automatically adjusted to take account of any local time zone setting, providing that the device has been configured to specify a time zone other than the current local setting and that alerts are logged using the Remote/Date Time setting. See Device Manager - Time Zone on page 4-15 See Alert Settings - Log Alerts Using on page 8-49 Server Options Instant Alert comprises three components: Server Options Address Book Message Sender The Instant Alert Server Options are used to configure various interfaces associated with Instant Alert. To open Instant Alert Server Options select Start All Programs Halcyon Applications Instant Alert Server Options. Instant Alert 9-89

95 Five pages are available from within Instant Alert Server Options. Figure 9.1 Instant Alert Server Options General page This page is used to define the Device Location details and Purge Settings. Device Location Load recognized network devices from a known host (by entering the host IP address and clicking Load). Connection Timeout Specify a time (in seconds) in which the connection to the selected device must be made before timing out. Read Timeout Specify a time (in seconds) in which data must be read from the device before timing out. Clear Pending Messages Enable this option to ensure that any pending messages are cleared when Instant Alert is started. This is useful if a high volume of messages have been generated as the result of an error but are no longer required for information purposes, for example, test messages. Logging page Use the Logging options to specify the Informational and/or Diagnostic messages information you wish to save to the default log file of IA.log (you can override this filename if you wish). Message log files are stored by default in: C:\Program Files\Halcyon\Enterprise Console\Logs 9-90 Enterprise Console

96 The Maximum Log Size states the maximum size of the file. The default setting is 10240KB but this may need to be increased if both Informational and Diagnostic messages are being saved. Log Informational messages Click to enable the logging of any Instant Alert information messages that are generated. Log Diagnostic messages Click to enable the logging of any Instant Alert diagnostic messages that are generated. Purge page The purge page of Instant Alert Server Options is used to set time periods after which various types of Instant Alert messages are purged. Purge Closed Messages After Use this option to select the number of days after which closed messages are removed from the system. The default setting is 30 days. Purge Error Messages After Use this option to specify the number of days after which error messages are removed from the system. The default setting is 30 days. Purge Old Pending Messages After Use this option to specify the number of days after which any messages that are still in pending status are removed from the system. the default setting is 7 days. Note: Enterprise Server page This page is used to specify which server the Enterprise Server is installed on - this ensures any problems with the Instant Alert product are transmitted to the Enterprise Server machine, and then on to the Enterprise Console. The entry on this page is usually selected as part of the Enterprise Console installation process. Interfaces page This page shows the various interfaces currently defined on the system. When Instant Alert is open for the first time this screen is empty. Click Add to add a new interface. Adding Interfaces There are three types of interface that can be used with Halcyon Instant Alert. GSM Interface NPort Interface STMP Interface Instant Alert 9-91

97 Note: Note: It is also possible to add a Lotus Notes interface if you have Lotus Notes Client installed on the machine on which Central Configuration Manager Server is installed. See Using Lotus Notes (v7 or later) with Instant Alert for more information. Instructions on how to attach and configure GSM and NPort NETGSM terminals to your network can be found in the Enterprise Console Installation Guide. Adding a GSM Interface Figure 9.2 Adding a GSM Interface 1 From the Instant Alert Server Options dialog select Interfaces. Click Add and select GSM Interface. 2 Enter the Description of the GSM Interface (or leave as the default entry). 3 If this interface is going to be the Primary Interface leave Backup unchecked. Only check the Backup option if this interface is intended as a secondary interface should another defined Interface fail. 4 Select whether to add a Date and Time and/or Message Reference prefix to any message sent via this interface. 5 Select the Advanced side-menu option Enterprise Console

98 6 Select the New Message Processing option required. Select Process Immediately to send the message the instant it is raised or select Process Every nn Minute (where nn is the time interval) to batch process all messages received between the specified interval. If required, specify the Delay Between Messages (in seconds). 7 Select the Logging side-menu option. 8 Use the Logging options to specify the Informational and/or Diagnostic messages information you wish to save and set the Maximum Log Size accordingly. 9 Select the Error side-menu option. 10Specify whether to Retry sending any messages that end in an error and if so, how many retries to attempt per second or minute, before a failure is returned. 11Select the Settings side-menu option. 12From the drop-down list, select the Port Number for this GSM interface. 13Select the Transmission Rate Bits Per Second. If using a TC-65 GSM terminal use For all other GSM terminals use Select the option for any message transmission sent via this interface. Use the Truncate option to limit the message size but be aware that this may result in vital information being omitted from the message. Check Use Concatenation Mode to enable the joining of successive messages when the number of characters per message exceeds the permissible length. 15Click OK to confirm and add the new interface. Adding a NPort Interface 1 From the Instant Alert Server Options dialog select Interfaces. Click Add and select NPort Interface. 2 Enter the Description of the NPort Interface (or leave as the default entry). 3 If this interface is going to be the Primary Interface leave Backup unchecked. Only check the Backup option if this interface is intended as a secondary interface should another defined Interface fail. 4 Select whether to add a Date and Time and/or Message Reference prefix to any message sent via this interface. 5 Select the Advanced side-menu option. 6 Select the Advanced side-menu option. 7 Select the New Message Processing option required. Select Process Immediately to send the message the instant it is raised or select Process Every nn Minute (where nn is the time interval) to batch process all messages received between the specified interval. If required, specify the Delay Between Messages (in seconds). 8 Select the Logging side-menu option. Instant Alert 9-93

99 9 Use the Logging options to specify the Informational and/or Diagnostic messages information you wish to save and set the Maximum Log Size accordingly. 10Select the Error side-menu option. 11Specify whether to Retry sending any messages that end in an error and if so, how many retries to attempt per second or minute, before a failure is returned. 12Select the Settings side-menu option. 13Enter the IP Address on which the NPort device is configured and ensure that the Port Number is set to Select the option for any message transmission sent via this interface. Use the Truncate option to limit the message size but be aware that this may result in vital information being omitted from the message. Check Use Concatenation Mode to enable the joining of successive messages when the number of characters per message exceeds the permissible length. 15Click OK to confirm and add the new interface. Adding a SMTP Interface 1 Enter the Description of the SMTP Interface. 2 If this interface is going to be the Primary Interface leave Backup unchecked. Select Backup only if this interface is going to be a secondary interface should another defined Interface fail. 3 Select whether to add a Date and Time and/or Message Reference prefix to any message sent via this interface. 4 Select the Advanced side-menu option. 5 Select the New Message Processing option required. Select Process Immediately to send the message the instant it is raised or select Process Every nn Minute (where nn is the time interval) to batch process all messages received between the specified interval. If required, specify the Delay Between Messages (in seconds). 6 Select the Logging side-menu option. 7 Use the Logging options to specify the Informational and/or Diagnostic messages information you wish to save and set the Maximum Log Size accordingly. 8 Select the Error side-menu option. 9 Specify whether to Retry sending any messages that end in an error and if so, how many retries to attempt per second or minute, before a failure is returned. 10Select the Server side-menu option Enterprise Console

100 Address Book 11Enter the Port Number on which the SMTP connection is made. Click Select Server to select the SMTP server. (this device must have already been loaded using the Device Manager). Highlight the required device and click Select. 12Select the Settings side-menu option. 13Select Override From Name/Address to enter a name and address from which the messages are received. Leave blank to generate message settings from the actual device. 14If the server requires authentication, enter the User Name and Password required to access the server. Click OK to confirm and add the new interface. This is used to add, edit and delete: Contacts and Contact Details Broadcast Groups Schedules This information must be entered manually and a default message type (SMS or ) can be specified for each contact. This default can be overridden by the message type selected from the Enterprise Server Options (but not from the Central Configuration Manager). Figure 9.3 Halcyon Address Book - Details Instant Alert 9-95

101 Adding a Contact to the Instant Alert Address Book Either select File Add Contact from the menu bar or click the Add icon. The Add New Contact dialog is displayed. This dialog comprises five separate pages: Details Page Name Select a Prefix for the contact name from the drop down list. Note that on changing this prefix, the figure icon alters accordingly. Enter the full name of the contact. Nickname If required, enter the nickname by which the contact is known. Birthday If required, enter the birthday date of the contact. Anniversary If required, enter the anniversary date of the contact. Default Message Type Select the default method of sending a message to this contact. This can either be or SMS. Contact Numbers Page This shows the details of all contact numbers currently held in the address book for the contact. Click Add to enter new contact details. Highlight an entry in the list and click Set As Default to use that number as the main contact number. Number Enter the mobile telephone number on which the person can be contacted. Number Type Currently only SMS is available in this field. Service Provider Not used in this release. SMS Type Select either Normal or Flash as the SMS message type. Flash messaging is a method of sending SMS messages to any phone, even if it is locked. Active Specifies the times between which this phone is active for the receipt of messages sent via Instant Alert. If the message is sent to the phone outside of the period when the phone is active, it is queued and then sent as soon as the phone becomes available again Enterprise Console

102 Addresses Page This shows the details of all addresses currently held in the address book for the contact. Click Add to enter a new address. Highlight an entry in the list and click Set As Default to use that address as the default. Company Page Enter the required Company Details for the Contact. These fields are selfexplanatory. Home Page Use the fields on the home page to enter details of the contact's home address. Again, these fields are self-explanatory. Click OK to add the new contact details to the Instant Alert Address Book. Finding Contacts If you have a large number of contacts in your address book, use the Find facility to search for a specific contact. Click the icon to open a new dialog into which you can enter the details of the contact that you wish to find. Click OK to begin the search. Creating a Schedule A schedule is a method of ensuring that the correct person is contacted in the event of an alert being raised. To create a new schedule: 1 From the menu bar select File Add Schedule. The Add New Schedule dialog is displayed. 2 Enter a Name and Description for the schedule 3 Select Items from the menu panel and click Add. The Add New Schedule Item dialog is displayed. 4 Select (or enter) the Dates and Times between which the schedule applies. 5 Select the Contact to which the schedule applies. 6 Click OK. The new schedule is displayed in the main address book panel. When selecting a schedule from the Address Book, the full detail of the selection is displayed in the right-hand pane of the Address Book window Creating a Broadcast Group A broadcast group can be defined as a team of people who have an interest in a specific function or routine. For large organizations it may be that many people are involved in very specific routines across a department. Instant Alert 9-97

103 In smaller organizations it is likely to be one or two people that have the responsibility of running all routines. See overleaf for details on how to create a broadcast group. To create a new broadcast group: 1 From the menu bar select File Add Broadcast Group. The Add New Broadcast Group dialog is displayed. 2 Enter a Name and Description for the broadcast group. 3 Select Members. Click Add to display the Select Members dialog. 4 Highlight the members required in the Available panel. Click the single arrow icon (see left) to move the highlighted selections into the Selected panel. Click the double arrow icon (see left) to move all members from the Selected panel into the Available panel. 5 Click OK to confirm the members selected. 6 Click OK to confirm the Broadcast Group. The new group is displayed in the Address Book panel. Address Book Options Use the Instant Alert Address Book Options to specify details of the server on which Instant Alert is installed, together with any connection timeout settings. These fields are also available in Instant Alert Server Options General Page. Open the Address Book options from Instant Alert Address Book Tools Options. The Halcyon Address Book Options dialog is displayed. Figure 9.4 Instant Alert Address Book Options Host/Address Enter the IP Address of the server on which Instant Alert is installed. Connection Timeout Instant Alert abandons its connection attempt after the time period (in seconds) specified in this field Enterprise Console

104 Read Timeout Specify a time (in seconds) in which data must be read from the device before timing out. Message Sender This is a utility allowing text messages to be sent across the network to specified recipients. Figure 9.5 Message Sender display The Instant Alert Message Sender can be used to send messages by either or SMS to contacts in the Address Book and is similar in looks and functionality as many third party applications. To open the Message Sender program select Windows Start Programs Halcyon Applications Instant Alert Message Sender. The Halcyon Message Sender dialog is displayed. Sending a Message To send a basic message: 1 Complete the To Address field or use the icon (see left) to display the list of contacts currently held in the Address Book. 2 Enter the title of the message in the Subject field 3 Enter the body text of the message in the Message field. Instant Alert 9-99

105 4 Click the envelope icon (see left) to send as an message, or click the mobile phone icon (see left) to send as an SMS message. Click both icons to send as both an and SMS simultaneously. 5 If required select the message Priority of Low, Normal or High. The default value is Normal. 6 Click Send Message to send. To send a message with additional options: Follow the steps 1-5 as above. From the menu bar select View Show Options to display additional options which can be completed as follows: Date The default is today's date. Enter or select the required date from the drop-down selection. If the date selected is earlier than today, the message is sent as soon as Send Message is clicked. If a later date is selected, the message is held until the date and time are reached. Time The default is the time at which Message Sender was opened. Enter or select the required time from the drop-down selection. If the time selected is earlier than now, the message is sent as soon as Send Message is clicked. If a later time is selected, the message is held until the date and time are reached. Count Select the number of times you require this message to be sent. Interval Select the interval, in minutes, between which messages are sent. (Only used if the Count field is increased from 1) Using Lotus Notes (v7 or later) with Instant Alert It is possible to use Lotus Notes (V7 or later) with Instant Alert providing that the correct configuration is applied. This can be done as follows: 1 Create a local user account called HALCYONIA on the server on which Instant Alert is installed. This represents the Lotus Notes user that is used solely for Halcyon Instant Alert. 2 Make user account HALCYONIA a member of the administrators group and then log into the account to finalize the creation of the profile. 3 Install Lotus Notes Client onto the same server on which Instant Alert is installed and the user account HALCYONIA was created. Please refer to your Lotus Notes documentation for guidance on installation of the client product. 4 Once Lotus Notes Client has been successfully installed, open the Halcyon Instant Alert Service from Windows Start Control Panel Administrative Tools Services Halcyon Instant Alert Server. Right-click on this service and select Stop from the drop-down menu Enterprise Console

106 5 Double click on Halcyon Instant Alert Server. When the properties dialog is displayed, click the Log On tab. Figure 9.6 Instant Alert Server Properties Log On 6 Select This Account and enter HALCYONIA with the associated password specified when the user account was created. Click Apply and then OK. 7 Right-click on the Halcyon Instant Alert Server service and select Start from the drop-down menu. 8 Open Instant Alert Server Options from Windows Start Halcyon Applications Instant Alert Server Options. 9 Select Interfaces from the Options tab. Click Add. From the Select Interface to Add dialog select Notes Interface and click OK. Figure 9.7 Adding Lotus Notes Interface Instant Alert 9-101

107 10Configure the Notes Interface according to your operating environment. In the Settings menu option enable Process Notes Messages (and SMTP Messages if you wish to continue using this format) and under Authentication Settings enter the password associated with Lotus Notes user HALCYONIA. Click OK to add the Interface Figure 9.8 Setting Notes Messages Processing 11Close the Instant Alert Server Settings and open the Address Book from Windows Start Halcyon Applications Instant Alert Address Book. 12Click Add to add a new contact. Add Name details and then select Address from the Contact menu and click Add to display the Select Type to Add dialog. Figure 9.9 Adding Notes Address Enterprise Console