Enterprise Console v10 - HelpSystems...Halcyon Enterprise Console v10.3 User Guide - 5 - About the...

Halcyon Enterprise Console

v10.3 User Guide

Copyright

Copyright HelpSystems, LLC. All rights reserved.

www.helpsystems.comUS: +1 952-933-0609Outside the U.S.: +44 (0) 870 120 3148

IBM, AS/400, OS/400, System i, System i5, i5/OS, Power Systems, and iSeries are trademarks or registered trade-marks of International Business Machines Corporation in the United States and/or other countries.

Windows and Windows Server are registered trademarks of Microsoft Corporation in the United States and/or other countries.

Java is a registered trademark of Oracle and/or its affiliates

All other product and company names are trademarks of their respective holders. For third-party conditions and disclaimers. see the Release Notes in the Product Directory.

Table of Contents
About the Enterprise Console 5
What is it?.......................................................................... 5What does it do?................................................................ 5What are the components?................................................ 5

SQL Requirements and supported versions........................... 6

Connection & Porting 7Connecting to a different server other than the local machine ............................................................................. 7Porting Requirements ........................................................ 8

Passwords and User Names 9Default User Name and Password .................................... 9Changing Passwords......................................................... 9Resetting Passwords....................................................... 10Expired Passwords.......................................................... 11Disconnection while Logged In ........................................ 11Users and Administrators ................................................ 11Adding a New User.......................................................... 12Editing User Details ......................................................... 13Deleting a User ................................................................ 13

Device Manager 15Overview ................................................................................... 15The Device Manager Display .................................................... 16

Defined Devices Panel ......................................................... 16Messages Panel ................................................................... 16

Defining Devices ....................................................................... 17Adding a Device ................................................................... 17

General Settings.............................................................. 17Advanced Settings........................................................... 19SNMP Settings ................................................................ 20

Editing Devices..................................................................... 21Deleting Devices................................................................... 21

Managing Device Groups.......................................................... 22Adding a Device Group ........................................................ 22

General Tab - Information................................................ 22Advanced Tab - Connection ............................................ 23Advanced Tab - Notes ..................................................... 23

Editing Device Groups.......................................................... 23Deleting Device Groups........................................................ 23

Managing Device Types............................................................ 24Adding a Device Type .......................................................... 24Editing a Device Type........................................................... 26Deleting Device Types.......................................................... 26Duplicating Device Types ..................................................... 26

Managing Applications .............................................................. 27Adding a new Application ................................................ 27Creating a Client Access Application............................... 28

Device Manager Options........................................................... 29Logging............................................................................ 29SQL Settings ................................................................... 30Importing and Exporting Devices..................................... 30Copying Devices.............................................................. 31

Device Manager Messages Panel........................................ 32

Enterprise Console 33Overview ................................................................................... 33The Enterprise Console Display................................................ 34

The Four Default Panels of the Enterprise Console............. 34Inquiry Alerts.................................................................... 34Informational Alerts.......................................................... 35Devices............................................................................ 36Details/Action History/Message/Command ..................... 38

User Status........................................................................... 41Logging off the Enterprise Console ................................. 42

Working with Alerts 43Overview ................................................................................... 43

Alert Status........................................................................... 43Selecting Alerts .................................................................... 43Grouping Alerts .................................................................... 44

Setting up alert grouping ................................................. 44Display of Grouped Alerts ............................................... 44

Closing Grouped Alerts ........................................................ 45View Alert Details ................................................................. 45

Copying Alert Details ....................................................... 46Expanding/Collapsing All................................................. 47Print ................................................................................. 47Alert Details Navigation ................................................... 47

Adding Alert Comments ....................................................... 47Second Level Help Text ....................................................... 48Copying Alerts for use in Third Party Applications ............... 48

Copy Alert Detail ............................................................. 48Copy Alert Summary ....................................................... 49Copy Alert XML ............................................................... 49

Replying to Inquiry Alerts ..................................................... 49Alerts received via forwarding systems................................ 50Launching applications directly from Alerts .......................... 50Sending Alerts to Third Party Helpdesk Applications........... 51

Sending an alert as an Email .......................................... 53Sending an alert as an SMS............................................ 53

Acknowledging Alerts ........................................................... 53Purging Alerts....................................................................... 54Closing Alerts ....................................................................... 56

Closing alerts received from Power/System i devices..... 56Deleting Alerts ...................................................................... 56

Enterprise Console Options 57Overview .............................................................................. 57

Options Tab - General ..................................................... 58Options Tab - Command ................................................. 58Options Tab - Advanced .................................................. 59Display Tab – Display ...................................................... 60Display Tab - Default Colors............................................ 61Audio ............................................................................... 62Audio Tab – Sounds ........................................................ 62Audio Tab - Speech ......................................................... 63

Changing Passwords ........................................................... 63Reloading Devices .................................................................... 65Reloading Address Book .......................................................... 65

Enterprise Server Options 66Overview ................................................................................... 66General Settings ....................................................................... 67

General Tab - General..................................................... 67General Tab - Device....................................................... 68General Tab - Users page ............................................... 68

Alert Settings............................................................................. 69Alerts Tab - Alerts ............................................................ 69Alerts Tab - Archive page ................................................ 70Alerts Tab - Alert Types page .......................................... 71Editing Alert Types .......................................................... 72Alerts Tab - Source Types page ...................................... 72Adding a new Source Type ............................................. 74Editing Source Types ...................................................... 74Deleting Source Types .................................................... 74

Rules......................................................................................... 75

GuideTOC.fm)

Holding/Releasing Rules ................................................. 75Copying Rules ................................................................. 75

Adding/Editing Rules ............................................................ 76Rule Tab - Rule................................................................ 76Rule Tab - Default Display ............................................... 77Rule tab – Alert Message ............................................... 78Rules Tab - Advanced ..................................................... 81Adding Rule Criteria......................................................... 83

Adding/Editing Rule Criteria ................................................. 84Criteria tab - Criteria ........................................................ 84Setting Alert Detail Criteria for iSeries Alerts ................... 86Setting Alert Detail Criteria for Server Manager Alerts .... 87Setting Alert Detail Criteria for SNMP Trap Alerts ........... 88Setting Alert Detail Criteria for Syslog Messages ............ 88Criteria tab - Device Selection ......................................... 89Rules Tab - Actions.......................................................... 90Escalating the Priority of Pending Alerts.......................... 91Add Action For [Action] .................................................... 91Creating a Rule for Message ID Specific Events ............. 95

Actions ...................................................................................... 96Connection Monitor ................................................................... 98

Connection Monitor - Connection Monitor ....................... 98Ping Monitor ............................................................................ 100

Ping Monitor - Ping Monitor ........................................... 100Ping Monitor Tab - Device Selection.............................. 101

Syslog Monitor.........................................................................102Syslog Monitor Tab – Syslog Monitor ............................ 102Syslog Message Facilities ............................................. 103Syslog Message Severities............................................ 104Forwarding Syslog Messages from a Linux Device....... 104

System Monitor ....................................................................... 105System Monitor Tab – System Monitor .......................... 105System Monitor Tab - Device Selection......................... 106

Advanced Settings .................................................................. 107Advanced Tab - Email/SMS Default settings ................. 107Advanced Tab - Helpdesk Defaults................................ 108Advanced Tab - Instant Alert.......................................... 110Advanced Tab - SQL Server page ................................. 110Advanced Tab - Messages Page....................................111Advanced Tab - Licenses page...................................... 112

Enterprise Server Options - Additional Options....................... 114Exporting Data ............................................................... 114Importing Data ............................................................... 114

Device Dialog ..................................................................... 115View Device Dialog (Read-only Mode) .......................... 115

Enterprise Console - Appearance 116Enterprise Console - Appearance ........................................... 116

Show Options ................................................................ 116Panel Options ................................................................ 116Auto-Arrangement of Console Windows........................ 116Highlighting Devices ...................................................... 116Stretch and Shrink ......................................................... 117Drag and Drop ............................................................... 117Maximize and Hide ........................................................ 117Resizing Fonts ............................................................... 117

Selecting Columns for View and Ordering......................118Saving Layout Settings...................................................118Color Schemes...............................................................118

Working with Enterprise Console Panels ............................119Adding Panels to the Enterprise Console...................... 120Editing Enterprise Console Panels................................ 125Deleting Enterprise Console Panels.............................. 126

Working with Enterprise Console Layouts.......................... 126Adding a new Layout..................................................... 126Saving new Layouts ...................................................... 126

Enterprise Console - Quick Configuration Changes .......... 127

Instant Alert 129Overview ................................................................................. 129Server Options ........................................................................ 130

Server Options - Options Tab ........................................ 130General page................................................................. 130Logging page................................................................. 131Purge page.................................................................... 131Enterprise Server page ................................................. 132Interfaces page.............................................................. 133

Adding Interfaces ............................................................... 134Adding a GSM Interface ................................................ 135Adding a NPort Interface ............................................... 139Adding a SMTP Interface .............................................. 141

Address Book.......................................................................... 144Adding a Contact to the Instant Alert Address Book ..... 144

Call Schedules ................................................................... 147Creating a Schedule...................................................... 147

Broadcast Groups .............................................................. 149Creating a Broadcast Group.......................................... 149Address Book Options................................................... 151Editing Contacts, Schedules and Broadcast Groups..... 152Deleting Contacts, Schedules and Broadcast Groups .. 152Finding Contacts, Schedules and Broadcast Groups.... 152Renaming Contacts, Schedules and Broadcast Groups152

Message Sender ................................................................ 153Sending a Message....................................................... 153

Using Lotus Notes® (v7 or later) with Instant Alert ............ 154

Enterprise Console Archive 157Archive Viewer ................................................................... 157

About Archive Files ....................................................... 157Creating One Master Archive File ................................. 158Creating Multiple Archive Files...................................... 158Viewing an Archive File ................................................. 159

Working with Substitution Variables 160Overview ................................................................................. 160

Understanding Substitution Variables ................................ 160The basics ..................................................................... 160Using Substitution Variables within text......................... 161Adding Parameters to Substitution Variables ................ 161

Substitution Variable Parameters ....................................... 163Numeric Parameters ..................................................... 163String Parameters.......................................................... 164

About the Enterprise Console


What is it? The Halcyon Enterprise Console is a real-time focal point for managing cross-platform systems andsecurity alerts centrally.

What does it do? The Enterprise Console displays system and security related alerts from IBM i, Windows Servers, SNMPdevices, 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 alertsfrom 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 centrallyvia any networked machines which have the Enterprise Console application installed. Any number ofincoming connections can be handled simultaneously; the only limitation(s) are imposed by machinehardware 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 rules and actions for incoming alerts

• set up alerts display information

• specify Ping and Connection Monitor settings

• specify Syslog Monitor settings

• license Enterprise Server

• specify default email/SMS settings

• specify default helpdesk settings

• view system informational and diagnostic messages

• view and reset SQL Server settings

Enterprise Console As previously described, this is the application that connects to the Enterprise Server to manage receivedalerts 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 userprivileges can be set to restrict or enable operators to perform different tasks. If several users are on dutyand one person closes or replies to an alert, their action is broadcast to all other users.

Device ManagerThis application is a stand-alone GUI used for:

• manual entry of devices

• device categorization

Halcyon Enterprise Console v10.3 User Guide- 5 -


• launching default applications

• provide information regarding the SQL database connection

Instant AlertInstant Alert is used to:

• send text messages to mobile phones from the Enterprise Console

• send email messages from the Enterprise Console

• send messages to 3rd party helpdesk applications.

• set-up broadcast groups and call schedules to send messages to the appropriate on-call personnel.

SQL Requirements and supported versionsThis version of Enterprise Console requires SQL in order to receive alerts and to store the user detailsdefined within Enterprise Server Options. Due to the way in which alerts converse with the EnterpriseConsole, the software is not restricted by database limitation and therefore the following SQL versions aresupported:

• SQL Express 2008 - 32bit/64bit - recommended

• SQL Express 2012 - 32bit/64bit

• SQL Server 2005 - 32bit/64bit





For links to the express versions of SQL and instructions on how to download, install and configure SQL forEnterprise Console, please refer to the manual; Installing SQL Server Express Editions. This manual canalso be used as the reference for the configuration requirements when using a full version of SQL Server.


Connection & Porting


To launch the Enterprise Console select Windows | Start | All Programs | Halcyon | Enterprise Console |Enterprise Console.

Each time the Enterprise Console is launched, a Log In dialog is displayed. The user must then enter avalid user name and associated password as defined in Enterprise Server Options. Passwords are notcase sensitive.

Connecting to a different server other than the local machineIf more than one instance of Enterprise Console is installed on your network, a different server can beentered 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 shownas a default.

Enter the IP address of the Server on which the required instance of Enterprise Console is installed. ClickOK to connect.

Connection to servers on a remote networkIf the Server is installed at a remote location protected by a firewall, use the additional Route option tospecify the IP address of the firewall, so that the connection can be made successfully without blocking.Click OK to connect.

Porting RequirementsHalcyon products use Port 15000 on the iSeries to communicate between the iSeries and the EnterpriseServer. Add 1 to the port number for each additional environment on the same partition to which you alsowant to connect. For example, HALPROD = Port 15000, HALTEST = Port 15001, HALDR = Port 15002,and so on.

Implications of changing port assignmentChanging the communications port on an iSeries device that communicates with any other device will alsorequire 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 port15000 and you change the port of the Enterprise Server to 15005 you must also change the port on allcommunicating iSeries to 15005 in order for systems messages and replies to be sent and receivedcorrectly.

Note: Remember that any firewalls that are in place must have the new range of ports opened.


Passwords and User Names


Default User Name and PasswordWhen 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 asthe password. A message is then displayed advising the password has already expired and a newpassword must be entered.

Changing PasswordsPasswords are changed from within Enterprise Console Options. A password must be changed if it hasexpired, or a new password can be generated for security reasons.

To change a password:

1. Launch the Enterprise Console, log in, and click the icon from the menu options.2. From the drop-down menu choices, select Options. The Enterprise Console Options dialog is displayed.

Note: This set of options is different for the Enterprise Server Options accessed directly from the Enterprise Console menu ribbon.



3. In the bottom left hand corner of the Enterprise Console Options dialog, click Password. The ChangePassword dialog is displayed.

4. Enter your old password in the top box, then enter a new password and confirm.

5. 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 loggingin with the same user name).

Resetting PasswordsPasswords are reset from the Enterprise Server Options | General | Users page. Resetting a password is atemporary 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 | Users option from the list of options in theleft 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.

4. A confirm/cancel message option is displayed.

5. Click OK to confirm the reset password command.

The reset password is now also the current user name. A confirmation message is displayed to validatethe password has been reset against the specified user name.

6. 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).

7. Enter your current user name as the password.

A message is displayed advising the current password has expired and you are prompted to create anew one.

8. Click OK to display the Change Password dialog.

9. Enter your user name as the old password and enter a new password of your choice. The passworddialog closes and you now have access to the Enterprise Console.



Expired PasswordsWhen a password has expired, a new password must be created. The expiry period for the new passwordis specified on the Enterprise Server Options | General | Users page. This is a global setting and is appliedto 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.

Disconnection while Logged InIf you are disconnected abnormally and try to log in again, the system may assume you are already loggedin and prevents access.

To rectify this situation:

1. Select your user name in the Enterprise Server Options | General | User page and click Reset Status.

2. A confirmation message is displayed. Click Yes to confirm the status reset or No to cancel the request.

3. Keep the Enterprise Server Options open or click Cancel to close the Enterprise Server Options andreturn to the Enterprise Console.

Users and AdministratorsUsers are added, edited and deleted from Enterprise Server Options | General | Users page. User log ondetails (user name and a password) are required by each user or administrator each time they launch theEnterprise Console.

Multiple users and administrators can be added, but name/password combinations must be unique.

User and Administrator PrivilegesPrivileges can be assigned to each user according to the system access and control required by that user.See Editing User Details for more information.

Administrator privileges allow full control and typically, users can be granted a limited set of privileges, orfull 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 anadministrator 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

Adding a New UserNew users are added from Enterprise Server Options | General | Users page.

To add a new user:

1. Click Add User.

2. Populate the Add New User dialog with new user details, selecting the appropriate User Privileges andContact Details for the new user.

User Details

Name: Enter the name for the new user

Nickname: If required, enter the user’s nickname

User Privileges

Administrator: Select this option to give the new user administrator rights (all options)

Close: Allow this user the ability to close alerts (required if also Closing Inquiry Alerts - see below)

Reply: Allow this user the ability to reply to alerts

Delete: Allow this user the ability to delete alerts



Comment: Allow this user the ability to add comments to alerts

Command: Allow this user the ability to run commands against alerts

Purge: Allow this user the ability to purge alerts from the system

User Options

Close Inquiry Alerts: Select Yes to allow this user the ability to close inquiry alerts (user must already have the ability to close alerts). Select No to prevent the user from being able to perform this operation and warn the user of an invalid action. If they try and close multiple alerts in a single action, some of which are inquiry alerts, the inquiry alerts will not be closed and the user does not receive notification.

User Contact Details

Email: Enter the user’s email address

Phone: Enter the user’s land line number

Mobile: Enter the user’s mobile number

3. Click OK to accept the details and add the new user to the list of users displayed.

Note: 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 Changing Passwords for further details).

Editing User DetailsUser and administrator details are edited from Enterprise Server Options | General | Users page.

Note: 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 the required user from the list displayed on the General | Users page and click Edit User.

2. Edit the required details in the Edit User dialog (The fields are the same as when Adding a New User).

3. Click OK to accept the changes and return to the General | User page.

Deleting a UserUsers are deleted from the Enterprise Server Options | General | Users page.

To delete a user:

1. Select and highlight a user from the list displayed on the General | Users page.

2. Click Delete User

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.


Device Manager Overview

Device Manager

OverviewThe Device Manager is the component of Enterprise Console that is used for the manual entry of devices,device categorization and the launch of default applications.

Devices must be loaded or be present in the Device Manager before they are available for selection inother components of the Enterprise Console.

Select Windows Start | Halcyon | Device Manager to activate a Device Manager session.


Device Manager The Device Manager Display

The Device Manager DisplayBy default, the main window contains two panes:

• Defined Devices: default position is the top pane of the main window

• Messages: default position is the lower pane of the main window

Defined Devices PanelThis panel shows the details of any devices which have been manually added to the Device Manager. Bydefault, the Device Name, IP Address, Connection and Read Timeouts are displayed.

Messages PanelThis panel shows the details of any messages sent to, from or between devices listed in the DeviceManager. Date/Time and Message details are shown by default.

Re-arranging the displayEach pane can be minimized, closed or moved and resized as required. Information is listed in each panein table columns, the contents of each column can be can be arranged in ascending/descending order byclicking 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 ordeselecting the column(s) required.


Device Manager Defining Devices

Defining DevicesDevices can also be manually added to then be available for monitoring, display and notifications within theEnterprise Console.

Adding a DeviceEither click the Add Device icon from the toolbar or select Devices | Add Devices from the main menu.The Add Device dialog is displayed.

There are three separate areas into which information can be entered:

• General

• Advanced

• SNMP

General Settings

Information Page

GroupDevice Groups are used to be segregate groups of say, similar devices, or all devices belonging to aspecific department.

The Device Group (if used) can be specified using a selection from the drop-down menu. Groups areadded using the Tools | Manage Groups option. See Managing Device Groups for more information.

Name The Device name MUST be the same as the actual system name.

DescriptionEnter an accurate description by which the device can be identified.



Device TypeFrom the drop-down choice menu, select the device type. The following selections are available:

• AIX® Server

• Bridge

• Fax

• Hub

• Laptop

• Linux® Server

• Mail Server

• Modem

• PDA

• Power/System i

• Printer

• Proxy Server

• Router

• Scanner

• Server

• Switch

• Unix® Server

• Unknown

• Windows® Server

• Windows® Server 2003 Standard

• Workstation

Note: Bespoke devices can be added to this list by using the Device Types option from the Device Manager menu ribbon (see Managing Device Types for more information).

Network Host/AddressEnter the IP address of the device as it is registered in your network.

Display Page

ColorSpecify the Default color of the Device when displayed in the Enterprise Console.

LocationIf required, specify the physical geographical location of the network device.

Time ZoneIf required, enter the time differential to take account of the geographical location of the device. Forexample, with the host device based in the UK, devices in Paris, France, would have a time differential of+1.00 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 theincoming alert and an adjustment is made via the setting in this field on the receiving Enterprise Consoledevice prior to being displayed.



The ‘Use Current’ setting for this field automatically sets the time zone to the local setting derived from thedevice to which the alert is sent. This setting is useful for devices such as printers and those that sendSNMP Traps.

Note: 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 for more information.

Support Page The fields on this page are used to enter the details of any support information. None of the fields on thispage are mandatory.

Contact NameIf required (or known), enter the name of associated personnel responsible for this device.

CompanyIf applicable, enter the name of the associated company/division where the device is installed.

Associated Application NameSelect 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 thisdevice is actioned from the Enterprise Console.

Note: Please see Launching applications directly from Alerts.

Test Application Click to test launch the selected application associated with the device.

Advanced Settings

Timeout Page

Connection TimeoutThe Device Manager abandons its connection attempt after the time period (in seconds) specified in thisfield. The default setting is 120 seconds.

Read TimeoutThe entry in this field sets the read timeout limit between the Device Manager and the remote device. Thedefault setting is 120 seconds.

Connection Page

Alternative IP AddressClick Add to add one or multiple Alternative IP Addresses to account for devices with multi-IP addresscapability or those that have further IP Addresses linked to the main IP Address.

External InterfaceIf this device is located behind a firewall, enter an external IP address via which any connection can bemade to ensure that alerts are transmitted to the Enterprise Console. See Device Groups - Advanced Tab -Connection for more information.



Settings Page

User Name/PasswordIf required, enter a user name and password combination used to access this device.

Power i Systems Settings

Serial NumberEnter the serial number of the device.

Connect on PortThe field is not applicable to 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 Consoleconnects. 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 thePower/System i device.

If the Power/System i device is running multiple environments, you would add a device to the DeviceManager to represent each individual environment as the port setting would differ for each.

Notes PageUse this page to enter any free-text notes about the device. These notes can be used as a substitutionvariable when sending an alert from this device.

SNMP SettingsThese settings are used to define any SNMP capabilities of the device.

Options Page

SNMP Capable Check to enable the current device as being capable of sending SNMP messages and enable theremaining fields and SNMP pages on this dialog.

Object IDEnter a unique SNMP identifier for devices of this type.

Agent PortEnter the port identification number to which the device is connected.

VersionSelect the version of SNMP being used on the device.

CommunitySelect the identification of any community associated with the device.



Traps Page

Device is a Trap TargetCheck to indicate if the current device is a trap target, and therefore can receive trap messages.

Trap PortEnter the port number used for the trapping of messages.

Trap TypeSelect the type of trap for this device.

Click OK to add the device to the Device Manager.

Editing DevicesIt is possible to edit the details of any Device listed in the Defined Devices panel.

From the defined devices listed, click on the one that you want to edit.

From the Device Manager menu ribbon, select Edit Device icon . The Edit Device dialog is displayed.

Parameters that can be edited on this display are the same as those used when Adding a Device.

Deleting DevicesIt is possible to delete any Device listed in the Defined Devices panel.

From the defined devices listed, click on the one that you want to remove.

From the Device Manager menu ribbon, select the Delete Device icon .

When prompted, click Yes to confirm the request or No to cancel.


Device Manager Managing Device Groups

Managing Device GroupsDevices can be segregated into groups of say, similar devices, or all devices belonging to a specificdepartment. Devices can be displayed by Group in the Devices panel of the Enterprise Console.

Select Device Groups from the Device Manager menu ribbon to open the Device Groups dialog.

Adding a Device GroupClick Add to display the Add Device Group dialog. The Add Device Group dialog is displayed.

General Tab - Information

NameEnter a unique name by which to identify the device group.


Device Manager Managing Device Groups

DescriptionEnter text that accurately describes the device group.

ReferenceIf required, enter a reference, such as Department Account Number or Asset Number, for the device group.

Advanced Tab - Connection

RouteThe route field defines a series of IP addresses that are then used to connect to all the devices included inthis group.

Note: This can be an external IP address if required.

Use of the Route 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 addthe new connection route to the defined list.

Advanced Tab - NotesEnter any free-text notes relating to this device group.

Click OK to add the new Device Group.

Editing Device GroupsIt is possible to edit the details of any Device Group, other than the Default Device Group.

Open the Device Groups dialog by selecting Device Groups from the Device Manager menu ribbon.

From the Device Groups listed, click on the one that you want to edit.

Click Edit to open the Edit Device Group dialog. Parameters that can be edited on this display are the sameas those used when Adding a Device Group.

Deleting Device GroupsIt is possible to delete any Device Group, other than the Default Device Group.

Open the Device Groups dialog by selecting Device Groups from the Device Manager menu ribbon.

From the Device Groups listed, click on the one that you want to delete.

Click Yes to delete the Device Group or No to cancel the request.

Note: Deleting a Device Group does not delete the Devices within the Group.


Device Manager Managing Device Types

Managing Device TypesAny devices that you may have in your organization but that are not currently available from the DeviceType list can be added using the Manage Device Types option.

From the Device Manager menu ribbon select Device Types to display the Device Types dialog.

Adding a Device TypeClick Add to display the Add User-Defined Device Type Dialog.



DescriptionEnter a meaningful description used to identify the new device type.

Object IDIf the device is SNMP trap enabled, enter the unique object identity number in this field.

CategoryIf required, select a pre-defined category with which the device type is then associated. The followingcategories are available:

• Others

• Workstations

• Servers

• Hubs

• Routers

• Bridges

• Modems

• Printers

• Scanners

O/S TypeFrom the drop-down menu, select the type of Operating System that the device uses. The choices are:

• None

• AIX®

• i5/OS®

• Linux®

• UNIX®

• Windows®

IconFrom the drop-down choice menu, select an icon by which the device type is then identified.

Default Associated ApplicationFrom the drop-down choice menu, select an application with which the device type is associated bydefault. This can be overridden when adding a new device. Select from:

• None

• Device Web Page

• pcAnywhere

• Remote Desktop Connection

• VNC

Note: Additional applications are available from this parameter once that have been added using the Add Application options.

Click OK to add the new Device Type.



Editing a Device TypeIt is possible to edit the details of any Device Group, other than any of the Default Device Types.

Open the Device Types dialog by selecting Device Types from the Device Manager menu ribbon.

From the Device Types listed, click on the one that you want to edit.

Click Edit to open the Edit User Defined Device Type dialog. Parameters that can be edited on this displayare the same as those used when Adding a Device Type.

Deleting Device TypesIt is possible to delete any user defined Device Type.


From the Device Types listed, click on the one that you want to delete.

Click Yes to delete the Device Type or No to cancel the request.

Duplicating Device TypesDuplicating a Device Type allows you to quickly create Device Types with similar attributes which can thenbe edited at a later time.


From the Device Types listed, click on the one that you want to duplicate.

Click Duplicate. The selected Device Type is instantly duplicated and displayed in the list of Device Types,identifiable by ‘Copy’ after the Device Type name.


Device Manager Managing Applications

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.

To open the Manage Applications dialog select Applications from the Device Manager menuribbon.

Applications are programs that may be launched directly from an alert on the Enterprise Console whenreceived from any device associated with the selected Device Type.

Such programs are typically Remote Access or Web Page Interfaces from which diagnostic andconfiguration settings can be maintained.

Adding a new Application From the Manage Applications dialog, click Add. The Add Application dialog is displayed.

1. Enter a Description by which the application is identified within the Enterprise Console.

2. If the application is a web page enable Application is a Web Page.

3. Enter the directory path in which the application executable is stored. Use the icon to browse to a

directory path if required.

This field is not required if the ‘Application is a Web Page’ field is enabled.

4. Enter any Parameters required to launch the application upon opening (listed Substitution andEnvironmental Variables may be used). The Example field auto-completes based on the entry in thisfield.

5. Click OK to confirm and add the application.


Device Manager Managing Applications

Creating a Client Access ApplicationCreating a client access application is useful for when you need to directly access an IBM iSeries devicedirectly from within the Enterprise Console.

Note: 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.

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 theBrowse button to search for and automatically enter the file path. Note that if you use the Browse optionyou 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.

Note: See Launching applications directly from Alerts for more information on how to use the application, once it has been created.


Device Manager Device Manager Options

Device Manager OptionsDevice Manager options are used to specify logging and view SQL database settings.

From the Device Manager menu, select Options. The current Logging and SQL settings are shown in aquick view format.

LoggingLogging of messages allows you to perform housekeeping and fault-finding analysis. The informationrecorded may also be useful to Halcyon’s Technical Support team should an issue arise that requiresfurther investigation.

Quick access to Logging functionalityTo quickly turn on (or off) the Logging functionality of Device Manager, click the Log Informational and/orLog Diagnostic options within the menu panel. The options are instantly turned on or off depending on theaction taken.

Extended options for Logging functionalityTo set additional parameters for the Logging functionality, click the extension arrows in the bottom right-hand corner of this panel. The Logging Settings dialog is displayed.

Save to Log FileCheck to enable the saving of device information to a log file.

Log File NameThe default setting for this field is DevManager.Log. This can be overwritten if required with your ownchoice. The log file is saved in the directory C:\Program Files\Halcyon\Device Manager\Logs unlessotherwise specified.

Maximum Log SizeEnter a value that indicates the maximum size, in kilobytes, of the log file. The default setting is 1024Kb.



Note: If both Informational and Diagnostic messages are saved, it is advised that you increase this value.

Log Informational MessagesClick to log all messages relating to the operation of the Device Manager.

Log Diagnostic MessagesClick to log all Device Manager diagnostic messages.

SQL SettingsSQL settings allow you to quickly view, but not amend, the details of the SQL instance and database nameto which the Device Manager is connected.

Extended view of SQL Database settingsTo view additional SQL Database settings, click the extension arrows in the bottom right-hand corner ofthis panel. The SQL Settings dialog is displayed. Once viewed, click OK to close this dialog.

Note: The settings on this dialog are for informational purposes only. No amendments can be made from this display.

Importing and Exporting Devices It is possible to import and export devices to and from this instance of Device Manager if you aretransferring this instance of Device Manager to another PC. The process allows you to save the deviceconfiguration to a file, which you can save to an external source such as a network drive or memory stick.The file can then be imported onto the new machine at a later time/date. This saves you time and effort inre-defining the devices a second time on a different machine.

Exporting DevicesTo export the current device configuration:

From the top-left corner of the Device Manager menu options click . Alternatively, click the icon inthe menu bar and select Export Devices from the drop-down menu.

The Select Export File dialog is displayed.



The default file path to which to save the exported settings file is:

C:\Program FIles\Halcyon\Device Manager\Backup

The file name defaults to the name of:

Devices-yyyy-dd-mm-hhmmss-msc.dsf.

The .DSF extension represents Device Settings File.

Click Save to save the devices with the default settings otherwise enter you own file path and/or file nameprior to exporting.

Importing DevicesTo import the current device configuration:

From the top-left corner of the Device Manager menu options click . Alternatively, click the icon inthe menu bar and select Import Devices from the drop-down menu.

You are prompted to confirm the import of devices. Click Yes to continue.

The Select Import File dialog is displayed.

Navigate to the path to where the exported .DSF file is saved. The default file is:

C:\Program FIles\Halcyon\Device Manager\Backup

Click Open to import the devices with the default settings otherwise enter your own file path and/or filename prior to importing.

Copying DevicesYou can copy a device directly from the Defined Devices panel allowing you to create an instant duplicate.The copied device can then be edited to change one or more parameters to make it unique. This facility isuseful if you have lots of similar devices that need adding but may only differ by, for example, IP Address.



To copy a device:Select a device from those listed in the Defined Devices panel so that it is highlighted.

From the Clipboard panel on the Device Manager menu ribbon, select the Copy icon .

Now click the Paste icon . An instant copy of the selected device is now displayed in the DefinedDevices Panel, identified by ‘Copy’ after the device name. Both the copied and original device are shown inred to draw attention that edits and renaming conventions need to be applied.

Device Manager Messages PanelThe Device Manager Messages panel is used to display warning and error messages regarding failedconnections or porting issues with devices in the Defined Devices panel.

Additionally, if Logging of Informational and /or Diagnostic messages has been enabled, these messagesare also displayed within this panel.


Enterprise Console Overview

Enterprise Console

OverviewEnterprise Console is the application that connects to the Enterprise Server to manage received alertswhich 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 EnterpriseServer) 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 allother users.

Enterprise Server is a service used to receive alerts from a variety of sources and allows users to managethem centrally via any networked machines which have the Enterprise Console application installed. Anynumber of incoming connections can be handled simultaneously; the only limitation(s) are imposed bymachine hardware limitations (processor speed, memory, etc.)

Logging onto the Enterprise ConsoleEnter a valid user name and password to log-on to the Enterprise Console and click OK.

Routing OptionsThis option allows you to use the integral network manager facility to connect to a server that is situatedbehind a firewall.

To make use of this facility, click Options on the Log In dialog, to expand the current view.

Note: See Connection and Porting for more information.


Enterprise Console The Enterprise Console Display

The Enterprise Console DisplayAlert details, device identities, device details, action histories and associated alert messages aredisplayed, by default, in four panels contained within the main Enterprise Console window. Each panelwithin the display can be repositioned within the window or floated on the desktop and resized as required.See Enterprise Console - Appearance for more information.

User privileges also affect which functions are available from the layout (privileges are set in the EnterpriseServer Options | General | User | Add-Edit User dialog). Context menus are available to show/hide thecolumn options for all panels.

The Four Default Panels of the Enterprise ConsoleThe four default panels of the Enterprise Console are split into:

• Inquiry Alerts

• Info Alerts

• Devices

• Details/Action History/Messages/Command

Inquiry AlertsIn its default format, this panel displays messages that have been directed to Inquiry Alerts from a ruleaction setting in Enterprise Server Options.



The alerts within this panel are usually those that require some form of action to be taken on the part of theuser.

The name of this panel can be changed in order to make it more meaningful to your organization. See AlertPanels for more information.

Informational AlertsIn its default format, this panel displays messages that have been directed to Info Alerts from a rule actionsetting in Enterprise Server Options.

The alerts within this panel are usually those that provide information to the user.

The name of this panel can be changed in order to make it more meaningful to your organization. See AlertPanels for more information.

Note: On upgrade from a previous version, the Enterprise Console will revert to the setting of two panels labelled Inquiry Alerts and Informational Alerts, regardless of how these panels were previously setup. A warning of this change is provided during the upgrade process.

Alert Panel NavigationBoth alert panels display their information across nine columns.

Selection IdentifierThe first column is used as a secondary indicator of which alert has been selected. In addition to the alertbeing highlighted, a ‘>’ mark is inserted in this column against the selected alert.

Alert Type IdentifierThe second column is used to display the alert type icon associated with the alert. See Alerts Tab - AlertTypes page for a full list of possible icons that may be displayed in this column.

Comment IdentifierThe third column is used to display the comments icon to indicate any alert that has a comment raisedagainst it.

Date/TimeDisplays the date and time at which the alert was received by the enterprise server. This may be the localdate and time of the enterprise server when the alert was received or remote date and time from the devicesending the alert depending on the setting in Enterprise Server Options | Alerts | Log Alerts Using.

StatusDisplays the current status of the alert. The icon against an alert in this column signifies that the alertis an Inquiry alert. See Replying to Inquiry Alerts for more information.

Note: See Alert Status for more information regarding the possible entries in this column.



DeviceDisplays the name of the device from which the alert was received.

AddressDisplays either the device host name or IP Address dependent on how the device was defined withinDevice Manager.

DescriptionUsed to identify any device that was used to forward the alert to the Enterprise Console. See Alertsreceived via forwarding systems for more information.

SourceDisplays the name of the Halcyon monitor, source system or third party application that generated the alert.The following Halcyon products do not generate alerts and therefore do not interface with EnterpriseConsole:

• Message Communicator

• Performance Analyzer

• Spooled File Manager

• Disk Space Manager

• Authority Swapper

• Document Management System

• Record & Playback

• Exit Point Manager

• Password Reset Manager

Note: See Alerts Tab - Source Types page for more information.

MessageDisplays the alert text as defined in the rule criteria that generated the alert.

Note: See Rule tab – Alert Message for more information.

DevicesThe Devices panel shows all the current devices that have been defined using the Device Manager.



By default, the devices are displayed by Status (i.e. those needing urgent attention are shown at the top ofthe list), although it is possible to change the sequence by clicking on any of the other four columnheadings. For example, to change the sequence to display by alphabetical device name, click the Namecolumn heading.

Device Panel NavigationAll of the following columns are available for selection by clicking the ‘*’ in the top left corner of this panel,above the Selection Identifier column.

Selection IdentifierThe first column is used as a secondary indicator of which device has been selected. In addition to thedevice being highlighted, a ‘>’ mark is inserted in this column against the selected device.

NameDisplays the name of the device as a child of the parent Device Group in which it is defined.

DevicesDisplays the number of devices contained within each Device Group, both when the Group is expanded orwhen individual devices are hidden in this panel.

AddressDisplays the Host Name or IP Address together with the connection port of the device.



Object IDIf SNMP compatible and defined, displays the unique SNMP identifier of the device.

Connect TimeoutDisplays the current connection timeout period for each listed device.

Read TimeoutDisplays the current read timeout period for each listed device.

DescriptionDisplays the description of the device as defined within Device Manager.

StatusDisplays the current status of each device and Device Group. By default, devices are listed by status withthose considered to be in critical condition, listed first within this panel.

A symbol registered against any device in this column signifies that this device has at least one highseverity alert currently logged against it. This provides a quick and easy way to view which devices needattention. The more high severity alerts logged against a device, the worse the status condition becomes.

Alert PercentageDisplays, in graphical tabular format, how many alerts the device has open at the current time as apercentage of all open alerts.

Details/Action History/Message/Command There are four different detail options available for selection in this panel. Each is accessible by clicking therelevant menu tab at the bottom of the panel.



Details PanelThis panel has a dual purpose and can be used to display the details of any device selected from theDevices panel or the details of an alert selected from any of the alert panels.

For IBM i devices, this panel shows details of the following (other devices vary by device and operatingplatform):

• Device: As taken from the field properties in Device Manager

• Device Information: including serial number, model, feature code, processor group, processors, etc.

• Environment: Name and details of the Halcyon environment

• IPL Settings: Details of last IPL and other IPL settings

• CPU, Disk, ASP, Storage properties

• Cache Battery Information: If IBM i is equipped with cache battery

• Installed Products: Details of all Halcyon products installed

For alerts, this panel shows:

• Alert Type: The Alert Type assigned to the alert

• Date, Time, Source Type, Error Message text:

• Device: Name of the device which raised the alert

• Device Details: Details of the device which raised the alert

• Rule Details: Full details, including criteria of the rule that raised the alert

Additionally, any user comments that have been added to the alert can be displayed from within this option.

If required, use the vertical scroll bar to view further details, such as the rule that raised the alert and anyadditional message information.

Action History PanelThe Action History panel shows what has happened to the alert since it was first logged on the EnterpriseConsole.



Selection IdentifierThe first column is used as a secondary indicator of which action has been selected. In addition to theaction being highlighted, a ‘>’ mark is inserted in this column against the selected action.

Success IdentifierDisplays an icon to indicate the success of the action.

Date/TimeDisplays the date and time at which the action was processed.

StatusDisplays the current status of the action.

ActionDisplays the type of action that was performed.

DetailsDisplays a full description of the action that was performed.

Messages PanelThe Messages panel shows details of any system messages that may have been generated as a result ofConsole activity. The messages within this panel are consistent, regardless of the alert or device that hasbeen selected in any other panel.

Date/TimeDisplays the date and time at which the message was generated.

FromDisplays the name of the device from which the message was received.



MessageDisplays full text of the message.

Command PanelThe Command panel is used to send system messages to other users.

In the text box, at the bottom of this panel type /help to see a list of commands that can be sent.Alternatively, type a message that can be sent to one or more of the other console users listed in the rightpane of this panel.

The following commands can be entered (commands are not case-sensitive):

User StatusAvailability of users across the network is remotely monitored and messages can be exchanged betweenall connected users.

The availability status of users can be set individually by each user. Click the User Status icon in theEnterprise Console menu ribbon and select one of the available options:

• I am Available

• 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)

Command Notes

/AWAY without message

/AWAY ATLUNCH

with a message, for example ‘At Lunch’

/CLS clears the command screen

/DATE returns the Enterprise Server date

/HELP display list of available commands

/LICENSE displays licensing information

/MSG sends message

/TIME returns the Enterprise Server time

/VERSION returns the Enterprise Console version

/PING pings a server

/NICK sets the user's nickname

/MSGTO sends a message to a specific user (can use eitherthe username or nickname)

/WHOIS returns user info for a specified user, can useeither the username or nickname



Although the status is updated and distributed automatically, this function requires a manual change to bemade by each user to be accurate.

Logging off the Enterprise ConsoleTo Log Off the Enterprise Console, click the Log Off icon . You are now prompted to confirm theaction.

Click Yes to Log Off the Enterprise Console and No to cancel the request.


Working with Alerts Overview

Working with Alerts

OverviewAlerts are generated as a result of rules that you have set up to monitor your network for any issues orproblems. When alerts (that have an action of Send Enterprise Console Alert) are received they can bedisplayed in one of two panels on the Enterprise Console. These panels are initially labeled Inquiry Alertsand Info Alerts, although these labels can be changed in Enterprise Server Options:

• Inquiry Alerts - messages that have been directed to the Inquiry Alerts panel from a rule action setting inEnterprise Server Options.

• Info Alerts - messages that have been directed to the Info Alerts panel from a rule action setting inEnterprise Server Options.

By default, when a new rule is set up using Enterprise Server Options, the setting displays the alert in theInquiry Alerts panel of the Enterprise Console. This setting may be changed by editing the rule inEnterprise Server Options.

Icons used when working with alerts are displayed from the Home option on the Enterprise Console toolbar.

Alert StatusAlerts can have one of the following statuses:

AcknowledgedThe alert has been acknowledged and for iSeries alerts only, all outstanding actions against the alert havebeen cancelled.

ClosedThe 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.

ConsoleIndicates that an alert has been closed\replied to from the Enterprise Console. The alert remains visibleuntil the console action has completed. Any pending actions are cancelled when a user closes or replies toan alert.

ErrorThe alert is open but one or more actions have failed.

OpenThe alert is open and has one or more actions against it.

Selecting AlertsThere are various methods by which alerts can be selected:

Single AlertsAn alert can be selected simply by clicking directly on the message line in either the Inquiry or Info Alertspanel.



Multiple AlertsMultiple Alerts can be selected by holding down the Crtl key and left-clicking on individual lines.

Consecutive AlertsGroups of consecutive alerts can be selected by holding down the SHIFT key and left-clicking on the firstalert required for selection in the group and then left-clicking the last alert required for selection. All alerts inthe group are now selected.

Select All AlertsTo select all alerts in either panel, click on the required panel title bar and click the Select All Alerts icon

from the Enterprise Console menu ribbon.

All alerts in the chosen panel are now selected. To de-select all the alerts, click on a single alert within thepanel. Only this alert is now selected.

Grouping AlertsOn occasions, host systems can legitimately generate hundreds or thousands of messages which Halcyonthen processes and routes through to the Console. This is often described as a message storm.

The Enterprise Console has the ability to group alerts associated with a message storm within a single rowon the display, with just the most recent alert visible. The main advantage of this feature is that it lessensthe likelihood of important other alerts getting missed or scrolling off the bottom of the screen.

In order to be included in a group, alerts need to be from the same device and have identical alert text.

Setting up alert groupingAlert grouping is set on a ‘per panel’ basis. In order to activate the grouping of alerts, each panel to whichyou want to apply alert grouping must be edited and the Group Alerts option selected.

Note: See Editing Enterprise Console Panels and Group Alerts for more information.

Display of Grouped AlertsThe first screenshot below shows a panel within the Enterprise Console where alert grouping has not beenset. Note that all the alerts carry the same information.



When alert grouping has been activated, only one alert line appears on the display, but is marked with a ‘+’symbol in the far left column, indicating that more than one alert exist on this line. Click ‘+’ to expand thegroup.

Closing Grouped AlertsGrouped alerts can be closed individually or as a group. The grouping mechanism simply controls themethod in which the alerts are displayed. For example, you can close a group of alerts directly from thesingle displayed alert or you can expand the group and close the alerts individually. Additionally, you canstill use SHIFT and select a series of adjoining alerts.

View Alert DetailsDouble-click an alert listed in either of the alert panels to display the full details of the individual alerts in theAlert Details dialog.

Alternatively, click on an alert to select and then click the View Details icon from the Enterprise Console menu ribbon.

The Alert Details dialog is the enlarged version of the Details panel displayed by default in the bottom right-hand corner of the Enterprise Console.



Alert information is displayed in a tree view within collapsible categories. Right-click anywhere in theDetails panel of this dialog to display a context menu that provides options to Copy, Expand/Collapse Alland Print from the current information displayed.

Copying Alert DetailsTo copy any part of the alert detail, single-click and use the mouse to highlight the text that you want tocopy. Right-click and select Copy from the pop-up menu. The selected text can now be pasted into anythird party application.



Expanding/Collapsing AllThe default view of the Alert Details dialog is to show the Expanded details of the alert. Right-click andselect Collapse All from the pop-up menu to show just the banner headings of the Alert Details. Right-clickagain and select Expand All to display the full Alert Details once more.

PrintRight-click anywhere in the Alert Details dialog and select Print to open the standard Windows print dialog.Alternatively, click Print from the navigation bar at the bottom of this panel.

Note: Ensure that the view is in Expand All mode when the Print option is selected otherwise just the banner heading of the Alert Details dialog are printed.

Alert Details NavigationFour buttons along the bottom of the window allow you to navigate sequentially through alert details of allthe alerts in the selected panel (forward, using Next and backward, using Previous). You can also moveand move to the First or Last Alert Details in the selected panel.

Click Close in the navigation bar to exit the Alert Details dialog.

Adding Alert CommentsComments can be used to add any miscellaneous text to an alert in order to provide more information toany other Enterprise Console users.

Comments can be added to any selected alert in one of two ways:

• Select the Add Comment icon from the Enterprise Console menu ribbon

• Right-click on the alert and select Add Comment from the drop-down menu

The top panel of this dialog, provides details of the alert. Enter any free text comments in the Commentspanel which will then be available against the alert.

Click OK to confirm the Comments entry.



Once added, the comment icon is displayed next to the alert to make other users aware that comment texthas been added. Multiple comments can be added to a single alert.

Entered comments can be viewed in the Alert Details dialog (see View Alert Details).

Second Level Help TextSecond level help text can be displayed for applicable iSeries alerts. This information is can assist you inrectifying the problem that caused the alert to be generated.

If second level help text is available it is displayed as an Additional Information panel within the AlertDetails dialog of the relevant iSeries alert.

Copying Alerts for use in Third Party ApplicationsInformation held within an alert can be copied and exported (as a Paste command) into a third partyapplication, such as Microsoft® Notepad.

To copy alert information, select an alert, or multiple alerts and click the Copy icon . There are threeoptions that can be used for copying alert information.

Copy Alert DetailThis 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).



2. Click the Copy icon and select Detail from the drop-down menu. The alert detail is now copied andready for pasting into a third party application.

Copy Alert SummaryThis option copies just the following items of the alert:

• Date/Time

• Device

• Inquiry

• Product

• Source

• Text

• Type

To copy the alert summary:


2. Click the Copy icon and select Summary from the drop-down menu. The alert detail is now copiedand ready for pasting into a third party application.

Copy Alert XMLThis option copies the alert detail as in the Copy Detail function but in XML format.

To copy the alert detail in XML format:


2. Click the Copy icon and select XML from the drop-down menu. The alert detail is now copied andready for pasting into a third party application.

Replying to Inquiry AlertsInquiry alerts that arrive from iSeries devices must have a reply sent instead of being closed, (the CloseAlert option is unavailable for these types of alert). This process is used to send a recognized messageback to the iSeries.

Inquiry alerts are indicated by the Question Mark symbol in the Status column of the alert detail.

To reply to an Inquiry alert:

1. Select the alert and either:

• Click the Reply icon from the Enterprise Console menu ribbon

• Right-click on the alert and select Reply from the drop-down menu

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 systemsThere may be instances where a direct connection cannot be made between the IBM i device and theEnterprise Console. In such instances it is possible to route the data via another IBM i device that doeshave a direct connection.

Note: A guide on how to configure data forwarding is provided in the relevant Halcyon software suite or individual product user reference documentation. 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 alertoriginated and not the device(s) that were used for the forwarding. The Description column providedescriptive text of the device and is used for identifying originating systems of forwarded alerts.

When an alert is received from a device that is not in direct connection with the Enterprise Console, thedescription column displays both the originating and forwarding device(s).

Note: Please note that this feature is not the same as the Forward Alert action.

Printing AlertsIndividual 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:

• Click the Print icon from the quick access menu options

• 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 bespecified.

Launching applications directly from AlertsWhen an alert is received at the Enterprise Console it is possible to launch a remote desktop session to thedevice/application directly from the Enterprise Console, providing it was not sent from the device on whichEnterprise Console is running.

Such sessions can take the form of, for example; Remote Desktop, VNC, PCAnywhere (Client Accesswhen logging on to an iSeries machine).

Note: In order to use this functionality the device must have an existing application association relationship created within Device Manager - Managing Applications.



To launch an application directly from an alert:

1. Right-click on the alert from either the Inquiry or Info panel

2. From the drop down menu select Select Launch Associated Application or click the Launch AssociatedApplication icon from the Enterprise Console manu ribbon.

Sending Alerts to Third Party Helpdesk ApplicationsAlerts can be sent to third party Helpdesk applications by using either Email or SMS to transmit themessage detail.

To send an alert as an email:

1. Select the required alert (multiple selections are permitted) and either:

• Right click on the alert and select Send Alert As | Helpdesk Email from the drop-down menu

• Click the Send Alert As icon and select Helpdesk Email from the drop-down menu.

The Send Helpdesk Email dialog is displayed.



1. Check the From option to allow an entry in this field enabling the receiving party to identify the originatorof the message. It is also a requirement of some helpdesk applications that a recognized originatingaddress is supplied, otherwise the email message can be rejected. The entry in this field must be in aformat acceptable to the third party application.

2. Enter a valid To address (either that of the helpdesk application inbox or an address pre-defined in theInstant Alert Address Book, opened by clicking the address book icon .)

3. The Subject field is automatically completed from the alert, although this can be overwritten if desired.



4. The Content of the email is based upon a selection of substitution variables An example of the text asdefined by the substitution variables is shown. The Content entry is automatically created from the alertbut can be amended if required, using the substitution variables listed.

5. Click OK to send the email message to the helpdesk application.

Sending an alert as an Email

1. Follow the same routine as that for Sending Alerts to Third Party Helpdesk Applications, steps 1-4(Selecting Email from the Send Alert As drop-down menu).

2. Select either Alert as HTML, which sends the alert details exactly as displayed in the Example panel ofthis dialog or Use Text Below to send the email as the substitution variables defined in the Contentpanel.

Note: Substitution variables can be amended, deleted and added to when using the ‘Use Text Below’ method.

3. Click OK to send the email to the selected recipient(s)

Sending an alert as an SMS

1. Follow the same routine as that for Sending Alerts to Third Party Helpdesk Applications, steps 1-4(Selecting SMS from the Send Alert As drop-down menu).

2. The Content of the SMS is based upon a selection of substitution variables An example of the text asdefined by the substitution variables is shown. The Content entry is automatically created from the alertbut can be amended if required, using the substitution variables listed.

3. Click OK to send the SMS to the selected recipient(s)

Acknowledging AlertsYou can only acknowledge alerts with a status of Open. You cannot acknowledge a closed alert. Theacknowledging of alerts is optional, and allows users in multiple environments to take ownership ofindividual alerts.

Note: When acknowledging alerts received from iSeries devices, all pending actions set against the rule criteria that generated the alert are cancelled.

You can acknowledge that an alert has been received by the Enterprise Console by either clicking theAcknowledge icon in the Enterprise Console menu ribbon or by right-clicking and select Acknowledgefrom the pop-up menu. This action can be taken against an individual or group of alerts.

Acknowledging an alert changes the status to ACKNOWLEGED.

When you select to Acknowledge an alert, the Acknowledge Alert dialog is displayed. You may entercomments referring to the reason for the acknowledgement although this is not mandatory. Click OK toacknowledge the alert.



Purging Alerts Purging alerts allows you to remove ALL alerts, regardless of status, by panel, device or both. Purgedalerts are archived and are viewable via the Enterprise Console Archive Viewer.

Alerts are purged using the Purge dialog.

Select the Enterprise Console Options icon from the quick access menu in the top-right corner of thedisplay.

From the drop-down menu select Purge.

You can then select the kind of alerts to purge relevant to selected devices.



Alerts to PurgeSelect whether to purge just Inquiry Alerts, Info Alerts or Both.

Devices to PurgeSelect whether to purge alerts from the Selected devices from the list (see Device Selection below),Unknown Devices or All Devices.

Unknown devices are those devices for which alerts exist on the Enterprise Console but for which theDevice no longer exists within Device Manager. These alerts are indicated by a symbol in the alertdetail on the Enterprise Console main display.

Device SelectionClick against a device to select it for the purging of alerts. Multiple devices can be selected.

Click OK to purge alerts with the criteria specified.

Note: See also Purge in Enterprise Server Options - Advanced Tab - SQL Server for information on how to quickly clear the SQL database tables.



Closing AlertsAlerts remain on the Enterprise Console until they are closed (at which point they disappear from the liveconsole but can still be viewed using the Enterprise Console Archive Viewer).

To close an alert:

1. Either:

• Select the Close icon from the Enterprise Console menu ribbon.

• Right-click on the alert and select Close 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 theclosure of the alert and click OK. The alert is removed from the Enterprise Console.

Closing alerts received from Power/System i devicesIf you are closing an alert that has been generated by a Power/System i device, the close request is sent tothe Power/System i device and the connection then closed. The status of the alert changes to CONSOLEand it remains in this status until the Power/System i device connects back with a response.

Deleting AlertsThe delete alert action allows users with the appropriate authority to remove alerts from the EnterpriseConsole panels without the need to add comments or reply.

Note: See User and Administrator Privileges for more details.

Single or groups of alerts can be deleted in one go by selecting the alert(s) to be deleted and then clicking Delete from the Enterprise Console menu ribbon or by using right-click and selecting Delete from the pop-up menu.

You are then prompted to confirm the deletion.

No connection is made back to the originating system and so does not filter through to forwarded alerts.


Enterprise Console Options Overview

Enterprise Console Options

OverviewEnterprise Console Options provide additional operating and connection parameters for the EnterpriseConsole. Enterprise Console Options should not be confused with Enterprise Server Options which areused to set up and maintain rules, set user access rights and license software components.


From the drop-down menu select Options.

The Enterprise Console Options dialog is displayed.



There are three tabs available from this dialog:

• Options

• Display

• Audio

Options Tab - General The General panel of the Options tab is used to specify connectivity parameters.

Enterprise Server Settings

TCP Host/AddressEnter the TCP Host/Address details of the Enterprise Server device.

Connection Timeout The entry in this field sets the time within which the Enterprise Console must be connected to theEnterprise Server before timing out. The default setting for this field is 20 seconds.

Read Timeout 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 AutomaticallyCheck this option to automatically display the Login dialog box should the Enterprise Console beunexpectedly disconnected from the Enterprise Server.

Show Balloon Hint in System TrayCheck this option to display a balloon hint in the System Tray at the bottom of your screen if the EnterpriseConsole unexpectedly disconnects from the Enterprise Server.

Options Tab - Command This panel is used to set options for the Enterprise Console Command panel.

The Command panel is displayed in the Enterprise Console by clicking the Command tab (displayed aspart of the Details/Action History/Messages/Command panel as shown below.

The following options are available on the (Enterprise Console Options dialog) Command page:



Command Settings

Maximum Lines In Command PanelThis 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 ReceivedCheck this option to set the Command panel to pop up automatically whenever a new message isreceived.

Hide New Messages When In ‘Do Not Disturb’ ModeCheck this option to specify that any new Command messages arriving at a user console are hidden whilethey have an active mode of ‘Do Not Disturb’.

Options Tab - Advanced This panel is used to set the Anti-Idle settings. These prevent connection dropout during times of non-activity.

Anti-Idle Settings

Enable Anti-Idle ModeOpens the Anti-Idle options when selected.

Send Anti-Idle command every xx minutesThe time, in minutes, between which anti-idle commands are issued. The default setting is 5 minutes.

Anti-Idle Response TimeoutThe time, in minutes, after which the Anti-Idle routine becomes dormant due to connection failure.



Display Tab – Display This panel 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 Settings

Highlight New Alerts In BoldCheck to enable any incoming alerts to the Enterprise Console to be displayed in bold.

Highlight Devices with Critical AlertsCheck to enable the Flash mode for the device status if the highest priority alert for that device has an alerttype that can flash when displayed in the Enterprise Console.

Confirmation Settings

Display Delete Confirmation Dialog for Closed AlertsCheck to enable the display of a message prompt to confirm or cancel the deletion of closed alerts.

Display Log off Confirmation DialogCheck to enable the display of a message prompt to confirm or cancel the log off action.



Miscellaneous Settings

Log Diagnostic MessagesCheck to enable the display of diagnostic messages in the Message panel. The default setting is notchecked.

Show Message Panel When Error ReceivedCheck to enable the message panel to be displayed as the visible panel in the Details section when anerror message is received.

If Application Minimized Or Not Active When New Alert ReceivedCheck an option to determine the action to be taken if the Enterprise Console is minimized or not activewhen 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 ColorsThis panel is used to specify default window color(s) for the default alert status colors.

Colors are selected from drop-down combo boxes associated with each option. When is selected, theWindows® Color dialog is displayed allowing you to define a custom color for each option.

Defining custom colorsTo define a custom color from the Windows® Color dialog, click Define Custom Colors to expand the dialogand 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.

Alert Status ColorsThese options are used to specify status colors for the following alert types:

• Open/Acknowledged 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 isdisplayed. Alternatively it is possible to have the alert read out as speech when it arrives at the EnterpriseConsole. To allow the speech function to work, the Microsoft Speech API (SAPI) version 5.1 runtime mustbe installed. This is included in the Enterprise Console installation.

Additionally, in order for the speech or sound to be played, each rule must also have an action of PlaySound on Alert or Speak on Alert set. See Enterprise Server Options | Rules | Actions for more information.

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

Enable Sound ActionCheck to be able to select a sound option.

Sound FileEnter the directory path or click the Browse icon to navigate to your own preferred sound file. MP3 filesare compatible with this option. Click the Play icon to play the selected file. Click the Stop icon toend play.

VolumeUse the slider control to set the volume level at which the sound is played.

Repeat ContinuouslyCheck to have the sound played repeatedly until either Mute Sound icon or F12 is pressed.



Audio Tab - Speech

Speech

Enable Speak ActionCheck to be able to select a speech option.

SpeakerSelect the voice variant that you wish to announce the alerts from the choices available in the drop-downbox. Click the Play icon to test the current settings.

Speak First Incoming AlertThis setting governs the action taken when simultaneous alerts arrive at the Enterprise Console. Check tohave just the first of the simultaneous alerts announced. Leaving this field unchecked results in all alertsbeing announced.

Speech Settings

VolumeUse the slider bar to control the volume level of the speech.

SpeedUse the slider bar to control the speed at which the speech is spoken.

Changing Passwords Enterprise Console passwords are changed in the Change Password dialog available from the EnterpriseConsole Options dialog. This facility allows you to change the password for the current user only.


From the drop-down menu select Options and click Password as indicated in the screenshot overleaf.



The Change Password dialog is displayed.

Enter the Old Password, followed by the New Password and reenter to Confirm New Password. The newpassword and confirmation must match exactly. Click OK to confirm the change of password for the currentuser.

Resetting PasswordsPasswords are reset from the Enterprise Server Options General Tab | Users | Reset Password. SeeResetting Passwords for more information.


Enterprise Console Options Reloading Devices

Reloading DevicesIf you add or change the configuration of devices you can use the Reload Devices option direct from theEnterprise Console without having to open Enterprise Server Options. Once activated, the Devices panelof the Enterprise Console is updated with the changes made.

To use the Reload Devices option select Tools | Reload Devices option from the Enterprise Consolemenu ribbon.

Reloading Address BookIf you add entries to the Instant Alert address book while the Enterprise Console is open you can use theReload 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 ribbon.


Enterprise Server Options Overview

Enterprise Server Options

OverviewEnterprise Server Options is a standalone application used to specify, edit and change Enterprise Serversettings; for example, message logging, user access rights, rules, alert, ping and connection monitorsettings. These settings are entered via tabs displayed in the navigation pane of the main panel.

Enterprise Server options is accessed via Windows Start | All Programs | Halcyon Applications | EnterpriseConsole | Server Options.

Alternatively, Enterprise Server Options can be accessed from within the Enterprise Console from Tools |Server Options .

Note: Enterprise Server Options are not available when the Enterprise Console is viewed from a client device.


Enterprise Server Options General Settings

General SettingsThe general settings options are used to determine the type and location of log file messages, devicedetails and user settings.

General Tab - General

Message Logging

Note: All log files are saved with an extension of .hlf.

Log Informational MessagesCheck to log all messages relating to the operation of the Enterprise Server.

Log User CommandsCheck to log all commands entered by users in the Enterprise Console Command Panel.

Log Diagnostic MessagesCheck to log all system diagnostic messages.

Log Incoming Alert DataCheck to log all alert messages that have an action of Send Enterprise Console assigned.

Server Details

Show Server Name in CaptionCheck to enable the input of a specific server name.

NameType a name that then appears in the Enterprise Console Window Title Bar.


Enterprise Server Options General Settings

General Tab - Device

Device Location

Load From Host/AddressType 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 theaddress and reload devices.

Connection TimeoutWhen the Enterprise Server needs to communicate with a remote device (one of the devices it has sent analert 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 systeminformation or load devices.

Read TimeoutThe entry in this field sets the read timeout limit between the Enterprise Console and the remote device.The default setting is 5 seconds.

Legacy IBM Power/System i Support settingsFor iSeries connections (only visible in specially licensed versions) it is possible to state the port on whichto listen for iSeries connections and the port on which outgoing connections to the iSeries are made. Thisonly applies to Power/System i devices running Halcyon Legacy software.

Note: 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.

Listen for Connections on PortSpecify the port number on which incoming iSeries alerts are received. The default setting is 10000.

Connect to iSeries on PortSpecify the port number on which outgoing connections to iSeries devices are made. The default setting is9000.

General Tab - Users pageThe Users page allows you to add, edit and delete users and reset password information for users asdescribed in the chapter Passwords and User Names.


Enterprise Server Options Alert Settings

Alert Settings

Alerts Tab - Alerts

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.

Alerts

Always Close Alerts LocallyCheck to enable the ability to close alerts locally even if an error occurred while trying to close or reply to analert on the originating remote device.

Broadcast New Alerts Every nn SecondsThis setting allows you to specify the time interval (in seconds) between new alerts being broadcast, actingas a time delay between alerts being generated and forwarded.

Log Alerts UsingThis setting allows you to choose whether alerts are logged using the local date and time at which theEnterprise Console received the alert or the remote date and time of the device from which the alert wassent.

Note: 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 for more information regarding this setting.

Alert PanelsThese options allow you to select the icons displayed in the alert panels one and two of the EnterpriseConsole and to set the associated panel captions.

Panel OneSelect the icon and caption for panel one, (by default, the top panel displayed in the Enterprise Consoleand to where all alerts generated by monitors within the Central Configuration Manager are displayed). Thedefault settings are a red flag icon and a caption of Inquiry Alerts.



Panel TwoSelect the icon and caption for panel one, (by default, the middle panel displayed in the Enterprise Consoleand to where all alerts generated by rules created within Enterprise Server Options are displayed). Thedefault settings are a yellow flag icon and a caption of Info Alerts.

Alerts Tab - Archive pageOptions on the Archive page allow you to define archive settings for closed/replied or purged alerts.

Archive Settings

Save Alerts To Archive FileCheck to enable the saving of alerts to archive files.

Alerts to ArchiveSelect 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

Create Archive FilesSelect the frequency (Daily, Weekly or Monthly) with which Archive files are created. Files are created onthe first day of each choice.

Archive DirectorySpecify the file path and directory name used to contain archived files. Alternatively, browse to the requiredpath 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 NameSpecify the archive file name. This can be entered manually; automatically (using substitution variables) ora combination of both.

Note: 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.

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.

Note: 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) anArchive Error is recorded. This is displayed in the Enterprise Console | Alert Details page. This informationis only available for Closed alerts.

Alerts Tab - Alert Types pageThe 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 alertsraised 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 theEnterprise 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 MoveDown to re-position it in the priority list.



Editing Alert Types

To edit an alert type:

Note: 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 pageSource types indicate from which element of your network enterprise that the alert was sent. Options onthe Source Types page allow you add, edit and delete source types. These are displayed in the SourceTypes table.



The following Halcyon Source Types are included by default:

• Audit Journal Monitor*

• Central Configuration Manager

• Connection Monitor

• Custom Journal Monitor*

• Custom Monitor*

• Device Monitor*

• Distribution Queue Monitor*

• Enterprise Console

• Exit Point Manager*

• External Interface

• HA-MX Monitor*

• Heartbeat Monitor**

• Inactivity Monitor*

• Instant Alert

• Job Log Monitor*

• Job Monitor*

• Job Queue Monitor*

• Job Scheduler*

• Message Monitor*

• MQ Monitor*

• Object Monitor*

• Output Queue Monitor*

• Performance Monitor*

• Ping Monitor

• Pool Monitor*

• Restricted Tasks Monitor*

• Server Manager

• Syslog Monitor

• System Monitor

• Task Supervisor*

• TCP/IP Monitor*

• Trap Receiver

• Unix/Open Systems

• Unknown

• User Profile Monitor*

*IBM i sources

**IBM i Legacy source



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 EnterpriseConsole.

5. Click OK to confirm and save the new Source Type.

Editing Source TypesEditing Source Types uses the same parameters as when adding Source Types (see above).

Deleting Source TypesUser Defined Source Types (indicated by a user icon) are deleted by selecting a Source Type from the listand clicking Delete Source Type.

Note: System default Source Types are specific to Halcyon applications and cannot be deleted.


Enterprise Server Options Rules

RulesRules allow you to monitor for message or events across your network enterprise and specify what actionto take should any message or event occur.

Each rule is split into three separate areas:

• Rule definition

• Criteria definition

• Action definition

Options on the Rules page allow you to define (add, edit, delete and hold/release) rules, selection criteriaand actions for the logs you wish to monitor.

Details of rule settings are available to view in the alert details panel of the Enterprise Console, for any alertgenerated by the respective rule.

Note: See View Alert Details for more information.

Summary details of currently defined rules and rule sequence numbers are displayed in a four-columntable.

Seq The sequence number of the rule. This number defines the order in which rules are examined when a new alert is received.

Description The user-defined description of the rule.

Log Messages A ‘Yes’ in this column indicates which rule messages are logged. When rule messages are not logged, the cell is left empty.

Held This column indicates which rules are Held by displaying . When rules 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 RulesThe Hold Rule/Release Rule button allows you to Hold/Release rules selected in the Rules table.

Held rules are not checked against any new alerts found by the system and remain held until released(even if the application is restarted).

Copying Rules Copying a rule is a quick way of creating a new rule with many required attributes already in place, allowingyou to make one or two adjustments to then create a unique rule.

To copy a rule:

1. From the Rules Summary panel, select the rule to be copied with a single click so that it is highlighted



2. Right-click on the rule and select Copy Rule from the pop-up menu. The Add New Rule dialog isdisplayed

3. Click OK to produce an exact copy of the existing rule (labelled as 'Copy of...' in the Rules section of theRule page)

Adding/Editing Rules Adding or Editing Rules provides access to a new series of dialogs and options available when undertakingeither of these actions. These are the same regardless of whether you are adding or editing a rule.

When you select the Add option, the first dialog displayed is the Add New Rule dialog. (replaced by the EditRule dialog when editing).

Rule Tab - Rule The settings in this panel are used to determine sequence, action processing and activity of the rule.

Rule Settings

SequenceThe setting in this field defines the order in which rules are examined. Enter a unique sequence number tospecify the sequence position of the rule. Identical sequence numbers are automatically prevented fromentry.

Log Rule MessagesCheck this option if you suspect that the rule is not performing as expected. By selecting this option,diagnostic messages are written to the Message Log File (see Message Logging on the General Tab. Notethat the Save to Log File and Log Diagnostic Messages options must both be selected).



Note: All log files are saved with an extension of .hlf.

DescriptionType a descriptive text for the new rule. This could be a summary of what the rule’s intended use, forexample; Warnings Received - Weekends Only.

Action

Action if Alert ReceivedIf this option is selected, action(s) is (are) taken if the alert is received within the Rule Active time rangespecified below.

Action if Alert Not ReceivedIf this option is selected, action(s) is (are) taken if the alert is not received within the Rule Active time rangespecified. This option is useful for time critical jobs.

Error TextA user-defined message that is activated when Action If Alert Not Received is enabled.

Rule Active

Mon-SunAllows you to select/deselect on which day(s) the rule is active. The default setting is active every day.

From - ToAllows you to specify a time range between which the monitor should scan for events matching this rulesequence. Hours can span over midnight, for example, 22.00 - 03.00 hours.

Rule Tab - Default DisplayThese settings configure the default panel, alert type, background and font colors for alerts that have beenprocessed against this rule for display purposes in the Enterprise Console.



Alert Display settings

Display in PanelSelect in which of the two alert panels, any alerts raised by this rule appear.

Override Alert TypeCheck to enable the display of an alternative alert type when an alert is triggered by the rule. Onceenabled, select an alternative alert type from the drop-down list.

Background Color settingsThis section allows you to determine the background color of any alert messages raised by this rule. Onlyone option is allowed.

Note: Use Custom... to specify a color that is not available in the background color list.

Default Background ColorThis setting keeps the default background color of the alert as defined in Enterprise Console Options |Display | Default Colors | Alert Status option.

Device Background ColorThis setting keeps the default background color of the device as defined in Device Manager | Add Device |Display | Color option.

Selected ColorThis setting allows you to set your own color choice as the background of any alert messages raised by thisrule.

Flash Background ColorSelect this option to flash the background color of the alert when displayed in the Enterprise Console.

Font Color settingsThis section allows you to determine the font color of any alert messages raised by this rule. Only oneoption is allowed.

Default Font ColorThis setting retains the default font color as specified in Enterprise Console Options | Default Colors option.

Selected Font ColorThis setting allows you to set your own color choice as the font color used in any alert messages raised bythis rule.

Rule tab – Alert Message The Alert Message page is used to provide alternative text details for alerts, allowing you to provide greaterclarity and meaning to the alert when received.

Note: The actual alert information remains the same so that any matching rule information is captured prior to the text being changed.



Alert Message settings

MessageEnter free text and/or use the Alert, Device and Details variables (as displayed) to generate alternative textonce matching rule criteria has been proven.

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 asubstitution variable to select and insert in the Message or Alert Text Box at the current cursor position.


Using Pipes with Alert TextAlert text can be reformatted by using pipes to change the number of decimal places reported, removewhite space and so on.

For example, to change the text of an alert reporting a numerical value of 1784.238175 so that it onlyreports two decimal places use the parameter &N|p2|; resulting in the alert text changing to 1784.24.

Note: For a full list of available parameters see Substitution Variable Parameters.

Using Substitution Variables with Alert Detail informationFor alerts that generate detail information (such as SNMP Traps), use the ‘&DetailsName’ variable toreplace 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 the corresponding entry in the right hand column.

This feature is particularly useful when used for SNMP trap alerts as the Enterprise Console has noautomatic way of recognizing which object in the trap payload actually represents the error message.

For example, in the SNMP Trap example overleaf:



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 substitutionvariable. 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 thevariable. 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 informationIn the previous example, a matching SNMP MIB (Management Information Base) file was used to mapSNMP OIDs to object names. Without this data, the incoming trap would have been displayed as a seriesof unique numbers such as: OID 1.3.6.1.4.1.14867.1.1.2.2.1.

If there is no MIB available for the SNMP trap that you are receiving, you can still use substitution variablesto 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.

To decide on which information you should capture in order to get the most meaningful results in the alerttext, setup a test rule first and see what is generated. From this information you can then determine thedetails that you want to capture and set the substitution variables accordingly.

Note: For more information on using Substitution Variables within Enterprise Console, see Working with Substitution Variables.

Rules Tab - Advanced The Advanced settings allow you to specify the method of counting alerts from this rule and the processingsettings applied.



Rule Count Method

Alert Count MethodThis setting allows you to specify the method by which alerts raised by this rule are counted.

• Rule The standard rule counter is incremented each time an alert is processed against this rule regardless of the alert’s source or text.

• Source A distinct source counter is incremented each time an alert is processed against this rule depending on the alert’s source.

• Text A distinct text counter is incremented depending on the alert’s message text.

Alert Count ExamplesAssume the following actions have been defined:

Assume the following alerts have been received:

Seq Action Perform Action For Action Type

10 Action 1 1 Alert Change Display Settings

20 Action 2 1 Alert Send Email

30 Action 3 1 Alert Send SNMP Trap

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



If the Alert Count Method is Rule then:

• Action 1 will be performed against the alert ‘10:00 Test Alert 1’ (Rule Counter=1)



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)



Rule Processing Settings This option suspends the rule according to the options defined below. It is good practice to use theseoptions to prevent multiple alerts of the same message being delivered:

Automatically Suspend RuleCheck to enable the Rule Suspension options.

Until Triggered X TimesSpecify how many times the rule is triggered before it is activated. The count can also be within a timeframe.

Within x MinutesAppends a time limit to the Until Triggered x Times option.

For x Minutes When Triggered x TimesDefines how many minutes the rule is suspended for after it has been triggered a (user) specified numberof times.

Adding Rule Criteria Options on the (Add New Rule/Edit Rule dialog) Criteria page allow you to define (add, edit, delete) ruleselection criteria. These are the qualifications that the rule must meet if an alert is to be raised.

Details of rule criteria are displayed in a five-column table (Select/Omit, Alert Kind/Alert Type/Source/Text).Table column order can be rearranged by click-dragging columns to the required position and informationin each column can be sorted (ascending/descending) by clicking on a column title.

Note: 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 rule.

Rule criteria is added in the Add New Criteria dialog and edited in the Edit Criteria dialog. These dialogsare displayed by clicking Add Criteria or Edit Criteria (edit is enabled for any selected item(s) displayed inthe table). Options on both dialogs are identical.

Click Add Criteria to create a new selection criterion for the rule.



Adding/Editing Rule CriteriaClick Add Criteria to create a new selection criterion for the rule.

Criteria tab - Criteria These options also apply to the Edit Criteria dialog.

Criteria Details settingsChoose whether to select or omit this rule from action processing.

• Select Check this option to select this rule for action processing.

• Omit Check this option to omit this rule (only) from action processing. Events matching similar selection criteria in other rules may be selected for processing.

Alert KindChoose the alert kind option for this rule.

• Inquiry

• Non Inquiry

• Both

Alert TypeDefine the alert type level for this rule based on selected conditional parameters (equals, less than, greaterthan, etc.). Priority is taken from the Alert Type table on the - Alerts Tab - Alert Types page.



Examples: (assuming default alert type priority has been kept):

Source TypeDefine the source type based on conditional parameters (equal to, not equal to).

Examples:

Alert TextEnter the alert text based on conditional parameters (equals, less than, greater than, etc.). Wildcardcharacters can be used when defining the ‘Alert Text’. This option is selected via the drop-down list.

Search Text From Position ... For ... CharactersAllows you to fine tune your search for specific alert text by specifying a starting position from which tosearch and for a specified number of characters.

Alert DetailsThe Alert Details area is used to set textual information for incoming alerts as shown in the example below:

Details TextDefine the details text. This can be generic or free text but can use specific textual values that varydepending on the type of alert rule that is being defined. Wildcard characters can be used when definingthis text.

Note: 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

Parameter Alert Type Result

= Any Type All Alert Types are selected

> Error All alert types with a higherpriority of error are selected

= Critical Only critical alerts are selected

Parameter Source Type Result

= Any Type All Source Types are selected

<> Ping Monitor All Source Types except PingMonitor are selected

= Ping Monitor Only the Ping Monitor SourceType is selected



Details ValueDefine the details value based on conditional parameters (equals, less than, greater than, etc.) when usedin combination with entry in the Details Text field. Wildcard characters can be used when defining thedetails value.

Wildcard Characters settingsThe wildcard characters area is used to define characters which are then used as substitutes for searchspans or single characters.

Use ... As A Substitute For Zero or more CharactersEnter the character you wish to use as a substitute for this search span.

Use ... As A Substitute For A Single CharacterEnter the character you wish to use as a substitute for a single character.

Setting Alert Detail Criteria for iSeries AlertsWhen setting alert detail criteria for alerts originating from IBM iSeries devices, specific string and integervalues can be set.

String ValuesThe following string values are valid when entering Details Text for alerts originating from IBM iSeriesdevices:

• 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 thatunexpected results may be generated.

Textual Details Value entries should match the entry in the Details Text field together with the selectedoperator. For example, to specify alert detail criteria for a specific message ID, you may enter somethingsimilar 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 ValuesThe following integer values are valid when entering Details Text for alerts originating from IBM iSeriesdevices:

• Severity

• Rule Sequence

• Selection Sequence

All operators can be applied to integer values. An example of specifying alert detail criteria, with an integervalue, 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 alsopasses other specified criteria.

Setting Alert Detail Criteria for Server Manager AlertsWhen setting alert detail criteria for alerts originating from the Server Manager, specific string values canbe set.

String ValuesThe following values are valid when entering Details Text for Server Manager alerts. The operator value isusually set to equal to ‘=’.

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 Valid Details Value

Event Type Error, Audit Success, Information, Warning

Source Halcyon SNMP Manager

Category No specific value required

Event ID Any valid Event ID number

User No specific value required

Message Any valid message as displayed in the Windows EventLog. The use of wildcards is recommended



Details Text: Message

Details Value: = *Service: esInterface failed: NetMan*

In the above example, an alert is generated for any Server Manager Event Type with a value of error, thatalso passes other specified criteria.

Setting Alert Detail Criteria for SNMP Trap AlertsAlert detail criteria for SNMP trap alerts can be specified in one of two ways, dependent on whether theincoming trap has been assigned with a valid MIB definition, instead of the basic OID value. Operatorvalues are usually set to equals ‘=’.

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 1.3.6.1.4.1.14867.1.1.2.2.3.0

Details Value: = MainServer

In the above example, an alert is generated for SNMP Trap OID 1.3.6.1.4.1.14867.1.1.2.2.3.0 with a valueof 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 alloperators can therefore apply.

Setting Alert Detail Criteria for Syslog MessagesWhen setting alert detail criteria for alerts originating from Syslog messages, specific string values can beset.

String ValuesThe following values are valid when entering Details Text for Syslog message alerts. The operator value isusually set to equals ‘=’.


Facility *user*



Examples of specifying alert detail criteria for Syslog messages may be similar to:

Details Text: Facility

Details Value: = *user*

Details Text: Severity

Details Value: = *error*

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.

Note: See Syslog Message Severities for more information.

Criteria tab - Device Selection The Device Selection page determines the devices from which you can receive alerts for the requiredcriteria. Devices must have previously been loaded using the Device Manager in order for them to beavailable 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 theAvailable 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 Devicestable.

Devices shown in the Available Devices are loaded from the Device Manager as defined on the mainoptions General | Device | Device Location page.

This section allows you to locate and specify available devices on the network by category. Each categoryallows selection of items from a drop-down list, (the contents of the Device Type and Device categoriesreflect available devices on your network).

Severity *error*

Raw Text *This is a test message

(Raw Text is the actual message that is received prior toformatting)




The categories comprise:

• Device Group: Device groups are collections of similar devices, such as all those that belong to aspecific 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 bydefault. 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 defaultitems and any other items identified on your network, which are added to this list automatically.

Hide Selected DevicesThis checkbox allows you to view only those devices not already listed in the Selected Devices table. Thisavoids 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 aselected 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 Devicestable.

Click OK to apply the Criteria.

Rules Tab - Actions The options on the (Add New Rule | Edit Rule dialog) Actions Page allow you to define (add, edit anddelete) actions. Any number of actions can be defined for each rule and these actions are processed in turnif the rule selection criteria match the alert.



Action details are displayed in a five-column table (Seq, Delay, Action, #Alerts and Parameters). Tablecolumn 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 AddAction 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-downlist.

Escalating the Priority of Pending AlertsActions are listed in the Actions For Rule table by priority of sequence number and within each actionsequence group, the time delay specified.

Actions within each sequence group can be escalated individually, by selecting an action and clicking theup/down arrows 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 subsequentrelationships between actions (within the same sequence).

Add Action For [Action]Click Add Action to open the Add Action For...(Action) dialog.



Action Details

Action SequenceEither directly type or use the choice buttons to select the action sequence number required. Thissequence number does not have to be unique. If there are two or more sequence numbers with the samevalue, 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 everytime, both actions would be assigned the same sequence number so both actions are executed for thesame alert.

Action TypeAction types are selected from the Action Type drop-down combo box. When an action type is selected, anadditional 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.

The following action types can be selected:

Action Selected

Description of Action Additional Option Displayed

Change Display Settings

Changes display settings for received alerts

Display - options on this page are detailed in Default Display.

ExecuteCommand

Executes a commandwhen an alert is received

Command - An example of variables contenttype is displayed in the read-only Example:text box as you enter each variable.

The exact content displayed is defined by yoursystem, network configuration and localconditions such as the date and time.



Hold Alert Rule

Holds the specified ruleand prevents it beingselected for action

Rule - options on this page allow you to selectan existing rule to hold.

Log Only (No Action)

No action is take, the alertis logged as received

None.

Play Sound At Console

Plays a sound when analert is received

None- the default sound is played

Send Console Action

Closes or replies to analert on the originatingremote console

Console - options on this page allow you toclose the alert or reply to the alert with a user-defined message.

Speak at Console

Plays a spoken messagewhen an alert is received

Speech - options on this page allow you toinclude the device name, speak alert only orspeak user-defined text.

Send Instant Alert Message

Sends a message to otherusers on the networkwhen an alert is received -the message text cancontain substitutionvariables

Message - this page has two sections:Recipients and Message.

• Recipients: allows you to enter the networkusers to receive the message (you need tohave their user names available).

• Message: allows you to input the text to besent, and/or enter Substitution Variableslisted in a table below the Text: text box.

An example of variables content type isdisplayed in the read-only Example: text boxas you enter each variable.

The exact content displayed is defined by yoursystem, network configuration and localconditions such as the date and time.

Raise Helpdesk Ticket

Sends an Instant AlertMessage to nominatedrecipients when an alert isreceived

Helpdesk - opens the helpdesk page, allowingyou to generate an email message based upona mixture of text and substitution variables.This can then be used to raise a ticket on a 3rdparty helpdesk application.

Release Alert Rule

Releases the specifiedrule previously held by theHold Alert Rule option

Rule - options on this page allow you to selecta held rule and release it.

Reset Alert Count

Resets the alert count of arule

Rule - options on this page allow you to selectan existing rule and reset the alert count.



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. Pleaserefer to Advanced Rule Settings - Rule Count Method for more details.

CommentsAdd any comments you would like added to the status of this alert.

Click OK to apply the action.

Click OK on the Add New Rule dialog to create the rule.

Note: Use the Edit Rule option from the main Rule dialog display to amend any settings, criteria or actions for this rule.

Forward Alert Forwards all alerts raisedby the rule to anotherinstance of EnterpriseServer. Forwarded alertsare displayed with anadditional icon andextended information inthe Alert details panel inthe Console.

Forward - options on this page allow you todefine the server to which the alerts areforwarded.

Routing information is defined per device ordevice group in Device Manager.

If an alert is forwarded from a device that doesnot currently exist in the receiving serverdevice list, a temporary device is added untilthe alert is closed.

If an alert is received from an iSeries deviceand then forwarded onto another console, thereceiving console must have the routinginformation of the forwarding device in orderthat a reply can be sent back to the iSeriesdevice.

Send SNMPTrap

Sends an SNMP trap Send SNMP Trap - options on this page allowyou to select a device and view deviceattributes.

If a device is not currently available, a new onecan be added from the Device Manager.

Device details can be reviewed in the ViewDevice dialog displayed by clicking Details inthe 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.

Purge Alert Removes the alert fromthe Enterprise Console

Purge Alert - Closes the alert on the Consolebut does not close it on an iSeries device.



Set as DefaultClick Set as Default to set the currently displayed action (change as required prior to setting) as the defaultaction when creating new rules.

Creating a Rule 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 IBM i. This section shows you how to create a rule that monitors and reports to theEnterprise Console on a specific or any generic messages raised.

To create a rule for Message ID Specific Events:

1. From Windows Start select Programs | Halcyon | Enterprise Console | Server Options

2. Select the Rules tab and click Add Rule

3. Keep all defaults and enter a Description for the new rule

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 onwhich 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 - DeviceSelection more details. Click OK

9. Select the Actions tab and click Add Action

10.From the drop-down menu choice select Send Console Action as the Action Type

11.Click OK to Add the Action

12.Click OK again to add the Rule

13.With the rule selected in the main display, click Release Rule

14.Click Apply to save the settings


Enterprise Server Options Actions

Actions The Actions tab of Enterprise Server Options is used to set global options for rule actions.

Outstanding Actions settings

Process Outstanding Actions on StartupSelect this option to specify whether any pending actions are executed upon starting a new session ofEnterprise Console.

Cancel The Following Action Types On StartupSelect this option to activate the following action types that can then be canceled (or not) when theEnterprise Console service is restarted. This allows you, for example, to leave outstanding Console actionsto be processed upon restart.

Log Select to cancel all outstanding log actions on restart

Display Select to cancel all outstanding display actions on restart

Sound Select to cancel all outstanding sound actions on restart

Speak Select to cancel all outstanding speech actions on restart

Message Select to cancel all outstanding message actions on restart

Command Select to cancel all outstanding command actions on restart


Enterprise Server Options Actions

Reset Rule Alert Counters on StartupSelect this option to reset all rule counters back to zero when starting a new session of Enterprise Console.

The system remembers the current count of all active rules so for example, if a counter has an action ofsending a message on the third instance of being raised and the current count is two, the system will resetthis setting back to zero if this option is selected.

Forward Action settings

Resend Alert If Forward Action FailsSelect this option to ensure that any alerts that are raised with the forward action, are resent if the initialforwarding action fails.

Resend IntervalSpecifies the time delay (in minutes) in re-sending forwarding alerts.

Resend Retry CountSpecifies the number of times that the resend action is attempted.

SNMP Traps settings

Resend Traps If Alert Stays OpenSelect this option to ensure that any alerts that are raised with the SNMP Trap action are resent if the initialSNMP Trap alert stays open.

Resend IntervalSpecifies the time delay (in minutes) in re-sending SNMP Trap alerts.

Resend Retry CountSpecifies the number of times that the resend action is attempted.

Console Select to cancel all outstanding console actions, such as Close, on restart

Send Trap Select to cancel all outstanding Send Trap actions on restart

Reset Select to cancel all outstanding Reset actions on restart

Hold Filter Select to cancel all outstanding Hold Filter actions on restart

Release Filter Select to cancel all outstanding Release Filter actions on restart

Help Desk Select to cancel all outstanding Help Desk actions on restart

Forward Select to cancel all outstanding Forward actions on restart

Purge Select to cancel all outstanding Purge actions on restart


Enterprise Server Options Connection Monitor

Connection MonitorThe Connection Monitor allows you to monitor IBM i connections. The Handshake Interval setting fromwithin the Remote Locations menu option on the IBM i device specifies the frequency with which thisdevice connects to the Enterprise Console.

Therefore, if the Handshake Interval field entry is set to 5, the IBM i Device attempts to connect to theEnterprise Console every five minutes. The lower the number the greater the frequency with which thecontact is made, thus giving a faster indication of an error should connection be lost.

Enable the Connection Monitor to indicate that the Enterprise Console is active whenever the IBM i deviceconnects. If no communication is received from the IBM i device within any sixty minute period (+ 2 minutegrace period) an alert is generated with the text as defined in the Alert Text field.

Connection Monitor - Connection Monitor

Enable Connection MonitorClick to enable the Connection Monitor and associated settings.

Continue Alerting For Failed Connection ChecksCheck this box to ensure that the connection monitor alerts when it is not possible to make contact with anydevice on which the Server Manager software is installed.

Note: A Device may be reporting as Status - OK in the Devices panel of the Enterprise Console but this may be because no alerts have been received as the connection has been lost. Enabling this option means that alerts are generated if a connection is unable to be made.


Enterprise Server Options Connection Monitor

Alert TextDefault alert text (Connection Check Not Received From Device &N/&A - Please Investigate) is displayedin this field. This text can be edited as required. You can also add alert and device variables to clarify thedetails 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.


Substitution VariablesConnection 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)

These variables can be added to the error message as required to identify the name and/or address ofdevices whose connections are monitored.


Enterprise Server Options Ping Monitor

Ping Monitor These options allow you to ping devices (selected in the Device Selection page) at regular intervals. If adevice ping is unsuccessful, an error alert is generated with the error text as specified in the Alert Text field.

Ping Monitor - Ping MonitorThe following options are available on the Ping Monitor page:

Enable Ping MonitorClick 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 toadjust 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. Eitherovertype the current entry or use the up/down arrows to adjust the setting. The default setting is 2000milliseconds.

Ping AttemptsThis setting defines how many attempts are made to successfully connect with the device before the alertis raised. Either overtype the current entry or use the up/down arrows to adjust the setting. The defaultsetting is 4 attempts.


Enterprise Server Options Ping Monitor

Time-to-LiveThis setting specifies the IP packet time-to-live value. The packet is valid only for the number of router hopsspecified by this parameter.

The time-to-live value acts as a "hop counter". The counter is decremented each time the packet passesthrough a router or gateway.

Limiting the validity of the datagram by the number of hops helps to prevent internet routing loops. If thevalue reaches 0 then the packet is dropped and the ping will time-out

Success PercentageThis setting determines the percentage of attempts required to be successful in order to prevent an alertbeing generated. For example, with this field set to 100% and Ping Attempts set to 4, it would only take onefailure to generate a success percentage of 75% and therefore raise an alert. Either overtype the currententry or use the up/down arrows to adjust the setting. It is advised that the success percentage is a multipleof the setting in the Ping Attempts field. The default setting is 100%.

Alert TextThis is the text message used to report a ping error (default is: Unable to Ping Device &N/&A – PleaseInvestigate {&E}. This text can be edited as required. You can also add alert, device and ping variables toclarify the details of the message.



Substitution VariablesPing Monitor substitution variables comprise:


• Device Variables (such as Name, IP Address, Group Name and so on)

• Ping Variables (such as Ping Attempts, Failed Attempts and so on)


Ping Monitor Tab - Device Selection The following options are available on the Device Selection page (accessed via the Ping Monitor and theAdd New Criteria dialog).

Note: Please refer to the Criteria tab - Device Selection section for details on the Device Selection fields.


Enterprise Server Options Syslog Monitor

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.

Syslog Monitor Tab – Syslog Monitor

Enable Syslog MonitorClick to enable the Syslog Monitor.

Alert TextThis 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.



Substitution VariablesSyslog substitution variables comprise:


• Device Variables (such as Name, IP Address, Group Name and so on)

• Ping Variables (such as Facility, Severity, Message and so on)




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)










Syslog Message Severities

Forwarding Syslog Messages from a Linux DeviceIn order to be able to forward syslog messages to the Enterprise Console from a Linux device, the followingconfiguration 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

For example: *.* @ENTCON

5. Restart the syslog service using the command:

/etc/rc.d/init.d/syslog restart

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


Enterprise Server Options System Monitor

System MonitorThe System Monitor is used to send a Halcyon specific request to any identified remote system NetworkManager. If no response is received, an alert is raised. This is useful to ensure that all of your systems areconstantly being monitored and highlights any connection or power issues that may be affecting a remotesystem.

System Monitor Tab – System Monitor

Enable System MonitorClick to enable the System Monitor and associated settings.

Interval: - MinutesThis option sets the monitoring interval in minutes. Either overtype the current entry or use the up/downarrows to adjust the setting. The default setting is 60 minutes.

Connect AttemptsThis setting defines the number of connection attempts that are made on each check to deem if the remoteNetwork Manager is answering. For slow machines it is recommended that the setting is increased tohandle any lack of response in inter-connectivity. The default setting is 1 attempt.

Alert TextThis is the text message used to report a system monitoring issue. This text can be edited as required. Youcan also add alert, device and specific system monitor variables to clarify the details of the message.



Enterprise Server Options System Monitor


System Monitor Tab - Device Selection The following options are available on the Device Selection page of the System Monitor.

Note: Please refer to the Criteria tab - Device Selection section for details on the Device Selection fields.


Enterprise Server Options Advanced Settings

Advanced Settings The Advanced tab of Enterprise Server Options provides access to Instant Alert and SQL Settings, LicenseInformation, Helpdesk Integration, Send Alert defaults and Messages.

Advanced Tab - Email/SMS Default settingsThe Email/SMS Defaults page is used to specify defaults used when sending alerts to via email or SMS.

Specify Send Alert as Email/SMS DefaultsClick to enable the ability to specify send alert as email/SMS defaults.

FromClick to enable the entry of the sender details. Any emails/SMS messages that are sent via the ‘Send AlertAs’ option from the Enterprise Console, default to being from the entry in this field.

To Enter the recipient details to where the email/SMS message is sent. Any emails/SMS messages that aresent 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 email userscan be selected.

Note: See Address Book for more information regarding the Instant Alert Address Book.



SubjectEnter the default text for the email/SMS subject title. This could be something simple such as ‘EnterpriseConsole Alert’ to identify the origins of the message.

ContentThe content can be made up from typed text, substitution variables listed at the bottom of this dialog, or amixture 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

ExampleDisplays a textual example of the current entries in the Subject and Content fields.


Substitution VariablesUse the substitution variables to assist in the building of the message content. Send Alert as Email/SMSsubstitution variables comprise:


• Device Variables (such as Name, IP Address, Group name and so on)

Advanced Tab - Helpdesk Defaults The Helpdesk Defaults page is used to specify defaults used when sending alerts to third party helpdeskapplications.

If a rule is triggered with the action of Raise Helpdesk Ticket, or right-click | Send Alert As | Helpdesk Emaildirectly from an Enterprise Console Alert is selected, the default information entered in this dialog can beused to generate an email that when received by the third party helpdesk application, can automaticallyraise a ticket.



Entries made on this screen are subsequently displayed as defaults whenever the Send Alert As |Helpdesk Email option is selected from the Enterprise Console.

Specify Helpdesk DefaultsCheck to enable the ability to specify helpdesk defaults.

FromCheck to enable the entry of an email address from which the email is sent.

Note: This is a mandatory requirement of some helpdesk applications.

To Enter the email address to which the email is sent. This is usually a generic helpdesk address.

SubjectEnter the text for the email subject title. The default entry is Enterprise Console Alert.



BodyThe email body can be made up from typed text, substitution variables listed at the bottom of this dialog, ora mixture of both. Most helpdesk applications require the information to be in a specific format so that theycan successfully generate the helpdesk ticket. Please refer to your helpdesk application softwaredocumentation for specific requirements.

ExampleDisplays a textual example of the entry in the Body field.

Substitution VariablesUse the substitution variables to assist in the building of the helpdesk body text.

Advanced Tab - Instant Alert

The following options are available on the Instant Alert page:

Select ServerThis 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 fromwhich the Instant Alert Device can be selected is displayed. The device on which Enterprise Console isinstalled is listed by default.

2. Highlight the required device and click Select. The selected device is now installed as the Instant AlertServer.

Clear ServerClick to remove the currently displayed device as the Instant Alert Server.

Verify ServerClick to test the connection between the current device and the Instant Alert Server.

Advanced Tab - SQL Server pageThe SQL Server page is used to display the current details of the SQL Server package being used.



RefreshUse the Refresh option to update the SQL details shown on this display.

PurgeUse Purge to clear all alerts, actions and pending alerts from the SQL database tables. This quickly clearsthe tables should the Enterprise Server become swamped with alerts.

Advanced Tab - Messages PageThe messages page is used to display any system messages generated by the Enterprise Server Optionsprogram. These can be used as an audit trail showing all actions undertaken since the Enterprise ServerOptions program was opened.



Click Clear to delete the current messages from this display.

Advanced Tab - Licenses pageThe licenses page of Enterprise Server Options shows the current licensing configuration of your networkenterprise for Enterprise Console.

Editing licensesYou 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 LicenseUsing Reset License removes the licensing from the selected component. It must be re-licensed before itcan be used again.



.


Enterprise Server Options Enterprise Server Options - Additional Options

Enterprise Server Options - Additional OptionsThere are five buttons available at the bottom of the Enterprise Server Options dialog.

About buttonClick to display version and ownership details of the Enterprise Server Options software. AvailableWindows Physical Memory is also displayed.

Import/Export buttonClick the Import/Export button to import or export current Enterprise Server Options settings from onedevice to another.

Exporting DataSettings exported from Enterprise Server Options include:

• User data

• Defined rules

To export Enterprise Server Options settings:

1. From the Windows Start menu select Start | Programs | Halcyon | 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 andfile 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 DataBy 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 tousing the Import functionality.

To import Enterprise Server Options settings:

1. From the Windows Start menu select Start | Programs | Halcyon | 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 existingdata.


Enterprise Server Options Enterprise Server Options - Additional Options

Reset buttonClick to restore the original Server Settings to this installation. You are prompted to confirm this action.

Apply buttonClick to apply any changes to the Enterprise Server Options. If clicked without any settings havingchanged, the following dialog is displayed:

Close buttonCloses the Enterprise Server Options dialog. If you have not saved any changed options, you areprompted to do so prior to closing.

Device DialogThe Device Dialog is used to view, add and edit system devices and operates in read-only or read/writemode according to the application from which the dialog is accessed (Enterprise Server Options or DeviceManager).

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 Rules | Criteria, Ping Monitor,Syslog Monitor and SNMP Traps pages by clicking View Details (active when a device is selected from theassociated list).

No changes can be made when in view only mode. For detailed information regarding the pages, optionsand fields within the Device Dialog, please refer to the section Device Manager – Adding a Device.


Enterprise Console - Appearance Enterprise Console - Appearance

Enterprise Console - Appearance

Enterprise Console - AppearanceThere are a variety of methods that you can employ to suit your personal viewing preferences whenaccessing the Enterprise Console. From the Enterprise Console menu bar, select Appearance. Theassociated tool icons are now displayed in the Enterprise Console menu ribbon.

Show OptionsThese options allow you to define how alerts are displayed within Enterprise Console. From the EnterpriseConsole menu ribbon, select the Show icon .

The following options can be selected or deselected as required.

• Link Alert Columns: Select this option to duplicate any changes made to column ordering or resizing inone alert panel to the second alert panel. Deselected, the ordering or resizing only applies to the alertpanel in which it is actioned

• Empty Groups: Select this option to display any Groups in the Devices Panel that do not actually containany devices

• Column Headers: Select this option to display column headers at the top of each column within eachpanel

• Device Color: Select this option to display the color of each device as defined in Device Manager whendisplayed in the Enterprise Console

• Source Color: Select this option to display the color of each source type as defined in Enterprise ServerOptions - Alerts - Source Types when displayed in the Enterprise Console

• Status Color: Select this option to display the Default Status color of each alert as defined in EnterpriseConsole Options - Display - Default Colors when displayed in the Enterprise Console

Panel OptionsThese options allow you to define which panels are displayed in the Enterprise Console:

• Alert Panel 1 (identified by user-defined name): Displays the alerts that have been defined to bedisplayed in this panel

• Alert Panel 2 (identified by user-defined name): Displays the alerts that have been defined to bedisplayed in this panel

• Devices: Displays the Groups and names of Devices as defined in Device Manager

• Details: Displays the details of any alert selected in either of the two alert panels

• Action History: Displays the action history against any alert selected in either of the two alert panels

• Messages: Displays any messages generated by Enterprise Console

• Command: Allows interaction between other users of the Enterprise Console

Auto-Arrangement of Console WindowsThis 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 View | Arrange Windows icon to initialize.

Highlighting DevicesUse the Highlight Devices icon to highlight the status of any devices within the Device panel ofEnterprise Console.



Stretch and ShrinkIndividual 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 pointerchanges to a ‘Move Border’ shape or

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.

Drag and DropIt 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.

Note: This takes practice to achieve the desired result. Use Appearance | Layout | Default Layout from the Enterprise Console menu ribbon to return to the default display setting.

Note: 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.

Note: Enterprise Console remembers the last panel setting as used by the user and defaults to that display upon opening.

Maximize and HideMaximize and Hide functions allow you to remove or fully display single panels within the main Enterpriseconsole window.

Click the expand icon on the panel title bar to maximize the view of any panel (the arrow orientationchanges depending on the panel. Click the reverse icon image to return to the previous view.

Click the close icon on the panel title bar to remove the panel from view. Use Appearance | Layout |Default Layout from the Enterprise Console menu ribbon 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 ownrequirements. Fonts across all windows or panels can be changed simultaneously by selecting Fonts | LinkPanels and Fonts | Link Windows. All displayed text is then resized when either the increase font ordecrease font option is selected. If these options are not selected, the font is resized in the selected panelonly.

Use the Reset Fonts option to return all fonts to the default setting.

Increasing Font SizeTo increase the font size of either all the Enterprise Console text, or the text of the selected panel, click theincrease font icon from the Enterprise Console Fonts menu ribbon

Decreasing Font SizeTo decrease the font size of either all the Enterprise Console text, or the text of the selected panel, click thedecrease font icon from the Enterprise Console Fonts menu ribbon.



Selecting Columns for View and OrderingTo reduce (or increase) the number of columns displayed in any of the four panels, right-click on a columnheading 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 nextto each column that you wish to remove. The tick mark disappears to indicate that the column is no longerselected. 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 ispossible to define column ordering and set a default width size per column.

Column OrderingYou 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 thebottom 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 figureinto this box to amend the selected column size.

Saving Layout SettingsModified settings can be saved as named layouts using the Layout | Save Layout option from theEnterprise Console menu ribbon.

Multiple layouts can be saved and reused, or the default (non-editable) layout can be selected at anytime.Saved layouts are available from Layout .

Color SchemesThe Enterprise Console uses the standard Windows color schemes that can be applied to change theappearance of ALL components of Enterprise Console.

Use the vertical scroll bar to display a selection of schemes from which a choice can be made oralternatively click on the icon to expand the window to display all available schemes in one panel.



Working with Enterprise Console PanelsYou are not limited to the four display panels within the Enterprise Console default view. It is possible toadd, edit and delete your own panels on this display and customize the view to the requirements of yourown organization.

From the status bar at the bottom of the display, click View.

A new menu is displayed.

Click Edit Mode to open a new series of menu panel options at the top of the Enterprise Console display.



Adding Panels to the Enterprise ConsoleAdding a panel to the Enterprise Console allows you to define and control the information displayed withinthe panel and from which devices the information originates.

To add a panel, click Add Panel icon from the Edit Tools | Layouts menu bar. The Add Panel dialogopens.

The Add Panel dialog is split into four separate tabs.

Panel tabThe following parameters are available for completion and selection on the Panel tab of the Add Paneldialog.

Panel Details

CaptionEnter the text that you want to appear in the heading of this panel.

IconFrom the drop-down menu, select the icon that you want to use to identify this panel.



Alert Selection

Alert KindChoose the alert kind option for this rule.

• Inquiry

• Non Inquiry

• Both

Alert TypeDefine the alert type level for this rule based on selected conditional parameters (equals, less than, greaterthan, etc.). Priority is taken from the Alert Type table within Enterprise Server Options Alerts Tab - AlertTypes page.

Examples: (assuming default alert type priority has been kept):

Source TypeDefine the source type based on conditional parameters (equal to, not equal to).

Examples:

Alert TextEnter the alert text based on conditional parameters (equals, less than, greater than, and so on). Wildcardcharacters can be used when defining the ‘Alert Text’. This option is selected via the drop-down list.

Search From Position Use the settings in this parameter to specify that any characters defined in the alert text can be found withina specified range in order for alert to be displayed within this panel.

For example, entering ‘J’ in the Alert text and specifying Search From Position 1 for 3 Characters will causeany alert with the letter ‘J’ in the first 3 characters of the alert text to be displayed in this panel.

Note: The search is case-sensitive.

Parameter Alert Type Result

= Any Type All Alert Types are selected

> Error All alert types with a higherpriority of error are selected

= Critical Only critical alerts are selected

Parameter Source Type Result

= Any Type All Source Types are selected

<> Ping Monitor All Source Types except PingMonitor are selected

= Ping Monitor Only the Ping Monitor SourceType is selected



Devices tabThe Device Selection page determines the devices from which you can receive alerts. Devices must havepreviously been loaded using the Device Manager in order for them to be available for selection in thisscreen.

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 theAvailable 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 Devicestable.

Devices shown in the Available Devices are loaded from the Device Manager as defined on the mainoptions General | Device | Device Location page.

This section allows you to locate and specify available devices on the network by category. Each categoryallows selection of items from a drop-down list, (the contents of the Device Type and Device categoriesreflect available devices on your network).



The categories comprise:

• Device Group: Device groups are collections of similar devices, such as all those that belong to aspecific 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 bydefault. 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 defaultitems and any other items identified on your network, which are added to this list automatically.

Show/ Hide Selected This button allows you to view only those devices not already listed in the Selected Devices table. Thisavoids duplicating device information in both tables.

View Details The View Details button is used to open the View Device dialog, allowing you to view the attributes of aselected device. Options for this dialog are detailed in the View Device Dialog topics.

Deselect All/Select AllThe Deselect All/Select All buttons are used to deselect or select all devices listed in the Available Devicestable.

Display tabThe Display tab is used to set definitions for how alerts are displayed within this panel.

Alert Display Settings

Display Device ColorSelect this option to display the color of each device as defined in Device Manager when alerts aredisplayed in this panel within the Enterprise Console.

Display Source ColorSelect this option to display the color of each source type as defined in Enterprise Server Options - Alerts -Source Types when alerts are displayed in this panel within the Enterprise Console.

Display Status ColorSelect this option to display the default status color of each alert as defined in Enterprise Console Options- Display - Default Colors when alerts are displayed in this panel within the Enterprise Console.



Show Alerts From Unknown DevicesSelect this option to display alerts from unknown devices for alerts that are displayed in this panel withinthe Enterprise Console.

Unknown devices are those devices for which alerts exist on the Enterprise Console but for which the Device no longer exists within Device Manager. These alerts are indicated by a symbol in the alert detail on the Enterprise Console main display.

Column Headers

Display Column HeadersSelect this option to display column headers at the top of each column within each panel.

Grouping

Group AlertsSelect this option to indicate that any alerts in this panel that have identical criteria are grouped togetherand displayed as a single alert within this panel on the Enterprise Console. This alert can then beexpanded to view the group of identical alerts beneath. The purpose of this functionality is to reduce thepossibility of the Enterprise Console being hit by a ‘message storm’ where a source can produce multiplealerts with the same criteria. See Grouping Alerts for more information.



Advanced tabThe Advanced tab is used to used to define characters which are then used as substitutes for search spansor single characters.

Use ... As A Substitute For Zero or more CharactersEnter the character you wish to use as a substitute for this search span.

Use ... As A Substitute For A Single CharacterEnter the character you wish to use as a substitute for a single character.

Once the parameters have been entered for the new panel, click OK. The panel is then automaticallyadded to the current Enterprise Console view, from where it can be resized and repositioned.

Editing Enterprise Console PanelsEditing an existing panel within the Enterprise Console allows you to define and control the informationdisplayed within the panel and from which devices the information originates.

To add a panel, click the Edit Panel icon from the Edit Tools | Layouts menu bar. The Edit Paneldialog opens.

Note: You must be in View | Edit Mode in order to Edit the existing panels. See Working with Enterprise Console Panels for more information on how to enter this mode.

The Edit Panel options are exactly the same as when adding a new panel to the Enterprise Console.Please refer to Adding Panels to the Enterprise Console for more information regarding the availableparameters that can be edited.



Deleting Enterprise Console PanelsShould an existing panel become surplus to requirements it can be deleted from the Enterprise Consoleview.

To remove a panel from the Enterprise Console, click the Delete Panel icon from the Edit Tools |Layouts menu bar.

Note: You must be in View | Edit Mode in order to Delete an existing panel. See Working with Enterprise Console Panels for more information on how to enter this mode.

Once the Delete Panel action has been requested, you are prompted to confirm the request.

Click Yes to confirm the deletion or No to cancel and return to the Enterprise Console previous state.

Working with Enterprise Console LayoutsWorking with Enterprise Console layouts allows you add, save and select layout views. This enables you tohave multiple views of the same or different information displayed in a way that is convenient to you.Switching layout view enables another user to have this information displayed in their own preferreddisplay format.

Adding a new LayoutWhen you add a new layout to the Enterprise Console, you are essentially starting with a blank canvas.Therefore you must first add a new panel to this otherwise empty layout.

Note: Please see Adding Panels to the Enterprise Console for more information.

To change the design of an existing layout, reposition the panels within the Enterprise Console as required. Then select Layout | Save As to save the new configuration. This new layout view is then available from the Layouts drop-down menu.

To begin the process of Adding a new Layout, click the New Layout icon from the Edit Tools | Layoutsmenu bar.

Note: You must be in View | Edit Mode in order to Delete an existing panel. See Working with Enterprise Console Panels for more information on how to enter this mode.

Once New Layout is selected you are immediately taken to the Add Panel dialog from where parameterdetails can be completed to define the panel configuration. Further panels can then be added to the newlayout as required.

Saving new LayoutsOnce the new layout has been created and configured, you can save it for use at a later date. Failure tosave the layout means that any changes that you have made are lost.

Click the Save Icon to open the Save Layout As dialog.



Enter a name for the new layout and click OK. The new layout is saved and is available for selection fromthe Layouts drop-down menu.

Save AsIf you have made changes to an existing layout and want to save the same information but with a differentlayout view, use the Save As option .

Failure to save the layout means that any changes that you have made are lost.

Enterprise Console - Quick Configuration ChangesIt is possible to make quick configuration changes to the Enterprise Console by using Options from themenu bar.

This opens the Options ribbon from where quick configuration changes to the Enterprise Console can beactioned.

The following configuration changes can be made from the options contained within this ribbon.

New Alerts In BoldSelect this option to enable any incoming alerts to the Enterprise Console to be displayed in bold text.

Flash BackgroundSelect Flash Background to have the Alert background color flash on and off repeatedly in the EnterpriseConsole display. Clear the selection to stop any alerts that have been generated by rules that are pre-configured to flash the background color from flashing.



Note: In order to work correctly, this also needs to be pre-configured on a rule-by-rule basis when setting up new rules using Enterprise Server Options, by specifying a background color other than white and selecting Flash Background Color. See Background Color settings and Flash Background Color for more information.

On New AlertThis setting specifies the action that is taken whenever a new alert reaches the Enterprise Console.

• Activate: If the Enterprise Console is minimized or not the window that currently has focus, selecting thisoption brings the Enterprise Console to the front of the display.

• Flash: Selecting this option causes the Enterprise Console window panel to flash on and off repeatedly.

• No Action: No action is taken when a new alert is received by the Enterprise Console.

Log Off Confirmation DialogSelect to enable the display of a message prompt to confirm or cancel a request to log off the EnterpriseConsole.

Delete Confirmation DialogSelect to enable the display of a message prompt to confirm or cancel a request for the deletion of closedalerts.

Log Diagnostic MessagesSelect to enable the logging of all system diagnostic messages in the file server.hlf within (in defaultinstallations) C:\Program Files(X86)\Halcyon\Enterprise Console\Logs.

Show Message Panel On ErrorSelect to cause the message panel to be displayed as the visible panel in the Details section whenever anerror message is received.

Alert Status ColorsThese four options allow you to change the currently defined alert colors for each of the following fourstatuses.

• Open/Acknowledge

• Error

• Console

• Closed

Use the drop-down menu next to each color to select a new color schema or click to open the customcolor dialog from where a new color of your choice can be defined and applied.

AudioClick the Audio button to open menu options allowing you to define sound settings on the EnterpriseConsole.

Note: More information for the parameters contained within the Audio options is available within Audio Tab – Sounds and Audio Tab - Speech.


Instant Alert Overview

Instant Alert

OverviewInstant Alert is the component used to send text messages or emails from the Enterprise Console tohelpdesk applications, email addresses or mobile phones. If you use a GSM data terminal for the purposeof 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 anylocal time zone setting, providing that the device has been configured to specify a time zone other than thecurrent local setting and that alerts are logged using the Remote/Date Time setting.

See Device Manager - Time Zone

See Alert Settings - Log Alerts Using

Instant Alert comprises three components:

• Server Options

• Address Book

• Message Sender


Instant Alert Server Options

Server OptionsThe 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 | Instant Alert | Server Options.

Server Options - Options TabFive pages are available from within Instant Alert Server Options - Options.

General pageThis page is used to define the Device Location details and Purge Settings.

Device LocationLoad recognized network devices from a known host (by entering the host IP address and clicking Load).

Connection TimeoutSpecify a time (in seconds) in which the connection to the selected device must be made before timing out.

Read TimeoutSpecify a time (in seconds) in which data must be read from the device before timing out.

Clear Pending MessagesEnable this option to ensure that any pending messages are cleared when Instant Alert is started. This isuseful if a high volume of messages have been generated as the result of an error but are no longerrequired for information purposes, for example, test messages.



Logging pageUse the Logging options to specify the Informational and/or Diagnostic messages information you wish tosave to the default log file of IA.log (you can override this filename if you wish).

Save To Log FileClick to enable the logging of Instant Alert Informational and Diagnostic messages (these fields becomeenabled once this option is enabled).

Message log files are stored by default in:

C:\Program Files\Halcyon\Instant Alert\Logs

Maximum Log SizeThe Maximum Log Size states the maximum size of the file. The default setting is 10240KB but this mayneed to be increased if both Informational and Diagnostic messages are being saved.

Log Informational messagesClick to enable the logging of any Instant Alert information messages that are generated.

Log Diagnostic messagesClick to enable the logging of any Instant Alert diagnostic messages that are generated.

Purge pageThe purge page of Instant Alert Server Options is used to set time periods after which various types ofInstant Alert messages are purged.



Purge Closed Messages AfterUse 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 AfterUse 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 AfterUse this option to specify the number of days after which any messages that are still in pending status areremoved from the system. the default setting is 7 days.

Enterprise Server pageThis page is used to specify on which server the Enterprise Server is installed - this ensures any problemswith the Instant Alert product are transmitted to the Enterprise Server machine, and then on to theEnterprise Console.

Note: The entry on this page is usually selected as part of the Enterprise Console installation process.



Select ServerClick to open the Select Device dialog from where an new device, on which an instance of EnterpriseServer is installed, can be selected to replace the existing entry.

Clear ServerClick to clear the current server details from this display. A new device must be chosen in order for InstantAlert to interact again with Enterprise Server.

Interfaces pageThis page shows the various interfaces currently defined on the system. When Instant Alert is open for thefirst time this screen is empty.



Click Add to add a new interface. The Select Interface to Add dialog is displayed.

Adding InterfacesThere are three types of interface that can be used with Halcyon Instant Alert.

• GSM Interface

• NPort Interface

• STMP Interface

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.



Note: 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 When adding a GSM Interface, there are five pages of parameters to complete. From the Instant AlertServer Options dialog select Interfaces. Click Add and select GSM Interface.

GSM Interface - General page

1. Enter the Description of the GSM Interface (or leave as the default entry).

2. If this interface is going to be the Primary Interface leave Backup unchecked. Only check the Backupoption if this interface is intended as a secondary interface should another defined Interface (GSM orotherwise) fail.

3. Select whether to add a Date and Time and/or Message Reference prefix to any message sent via thisinterface.



GSM Interface - Advanced page

1. Select the Advanced side-menu option.

2. Select the New Message Processing option required. Select Process Immediately to send the messagethe instant it is raised or select Process Every nn Minute (where nn is the time interval) to batch processall messages received between the specified interval.

3. If required, specify the Delay Between Messages (in milliseconds).

4. Specify the time, in minutes, that a connection attempt to the GSM interface is retried, should theinterface be found to be in error.



GSM Interface - Logging page

1.Select the Logging side-menu option.

2. Click Save to Log File to enable the logging options for this GSM interface.

3. Set the Maximum Log Size for any Informational and/or Diagnostic messages that are logged for theGSM Interface.

4. Specify whether to save Informational and/or Diagnostic messages for this GSM interface.

GSM Interface - Error page

1. Select the Error side-menu option.



2. Click Retry Sending Messages In Error to enable the retry of any messages that end in an error.

3. In the Retry Count field, specify the number of the retries that are allowed in conjunction with the RetryInterval setting before the attempt is deemed unsuccessful.

4. Specify the Retry Interval in either seconds or minutes.

GSM Interface - Settings page

1. Select the Settings side-menu option.

2. Enter the Port Number for this GSM interface.

3. Select the Transmission Rate Speed. If using a TC65 GSM terminal use 115200. For all other GSMterminals use 19200.

4. Specify the Command Timeout in seconds. This is the time allowed for the Communications Port torecognize that a command is being sent.

5. Use the Truncate Message To option to limit the message size to the specified number of pages but beaware that this may result in vital information being omitted from messages.

6. Check Use Concatenation Mode to enable the joining of successive messages when the number ofcharacters per message exceeds the permissible length.

7. Specify the Character Type in which messages are sent via this GSM interface.

• 7-bit: Uses the ASCII character set

• UCS2: Double Byte Character used for non-basic text

• Automatic: Attempts to translate a UCS2 message into 7-bit.

Note: Note that any messages sent in UCS2 use double the characters so a 160 character text will only contain 80 readable characters.

Click OK to confirm and add the new GSM interface.



Adding a NPort InterfaceWhen adding a NPort Interface, there are five pages of parameters to complete. From the Instant AlertServer Options dialog select Interfaces. Click Add and select NPort Interface.

NPort Interface - General page

1. Enter the Description of the NPort Interface (or leave as the default entry).

2. If this interface is going to be the Primary Interface leave Backup unchecked. Only check the Backupoption if this interface is intended as a secondary interface should another defined Interface fail.

3. Click Prefix Date And Time To Message to prefix any messages sent from this device with the date andtime at the point that the message is sent.

4. Click Prefix Message Reference To Message to prefix any message sent from this device with themessage reference.

NPort Interface - Advanced page

Note: Please refer to the GSM Interface - Advanced page for details of parameters on this page.

NPort Interface - Logging page

Note: Please refer to the GSM Interface - Logging page for details of parameters on this page.

NPort - Error page

Note: Please refer to the GSM Interface - Error page for details of parameters on this page



NPort - Settings page


2. Enter the unique IP Address and Port Number (defaults to Port 4001) for this NPort interface.

3. Select the Transmission Rate Speed. If using a TC65 GSM terminal use 115200. For all other GSMterminals use 19200.

4. Specify the Command Timeout in seconds. This is the time allowed for the Communications Port torecognize that a command is being sent.

5. Use the Truncate Message To option to limit the message size to the specified number of pages but beaware that this may result in vital information being omitted from messages.

6. Check Use Concatenation Mode to enable the joining of successive messages when the number ofcharacters per message exceeds the permissible length.

7. Specify the Character Type in which messages are sent via this GSM interface.

• 7-bit: Uses the ASCII character set

• UCS2: Double Byte Character used for non-basic text

• Automatic: Attempts to translate a UCS2 message into 7-bit.

Note: Note that any messages sent in UCS2 use double the characters so a 160 character text will only contain 80 readable characters.

Click OK to confirm and add the new NPort interface.



Adding a SMTP InterfaceWhen adding a SMTP Interface, there are six pages of parameters to complete. From the Instant AlertServer Options dialog select Interfaces. Click Add and select SMTP Interface.

SMTP - General page

1. Enter the Description of the SMTP Interface (or leave as the default entry).

2. If this interface is going to be the Primary Interface leave Backup unchecked. Only check the Backupoption if this interface is intended as a secondary interface should another defined Interface fail.

3. Click Prefix Date And Time To Message to prefix any messages sent from this device with the date andtime at the point that the message is sent.

4. Click Prefix Message Reference To Message to prefix any message sent from this device with themessage reference.

SMTP Interface - Advanced page

Note: Please refer to the GSM Interface - Advanced page for details of parameters on this page.

SMTP Interface - Logging page

Note: Please refer to the GSM Interface - Logging page for details of parameters on this page.



SMTP- Server page

1. Select the Server side-menu option. On first opening there is no device indicated so Unknown Device isdisplayed.

2. Click Select Server to select the server to be used from SMTP messages/ (this device must havealready been loaded using the Device Manager). Highlight the required device and click Select.

SMTP - Error page

Note: Please refer to the GSM Interface - Error page for details of parameters on this page.

SMTP - Settings page




2. To enter a specific Name and Email Address from which the SMTP messages are sent, click OverrideFrom Name/Address and complete the From Name and Email Address fields respectively. Alternatively,leave unchecked to generate message settings from the actual device.

3. If the server requires authentication in order to send messages, click Server Requires Authenticationand enter the User Name and Password required to access the server.

Click OK to confirm and add the new interface.

Server Options - Advanced TabUse the Advanced Tab of Instant Alert Server Options to view details of the SQL Server Settings and thecurrent Licensing options governing this product.

SQL Server pageThe SQL Server page of Instant Alert - Advanced Settings, allows you to view, but not amend, the currentsettings of the SQL Server.

From the Advanced Tab menu options, select SQL Server.

License pageThe License page shows the Summary details of the License currently authorizing this product. It ispossible to Edit the details of the current license directly from this page if required and uses the sameparameters and functionality as used within Enterprise Server Options. See Enterprise Server Options -Editing licenses for more detailed information.


Instant Alert Address Book

Address BookThe Instant Alert Address Book 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 Email) can be specifiedfor each contact. This default can be overridden by the message type selected from within EnterpriseServer Options.

Adding a Contact to the Instant Alert Address BookTo add a new contact to the Instant Alert Address Book click Add from the Instant Alert menuribbon. From the drop-down choice menu, select Contact. The Add New Contact dialog is displayed.



This dialog comprises five separate pages:

Details page

NameSelect a Prefix for the contact name from the drop down list. Note that on changing this prefix, the figureicon alters accordingly.

Enter the full name (First and Second name) of the contact.

NicknameIf required, enter the nickname by which the contact is known.

BirthdayIf required, enter the birthday date of the contact.

AnniversaryIf required, enter the anniversary date of the contact.

Default Message TypeSelect the default method of sending a message to this contact. This can either be Email or SMS.

Contact Numbers pageThis shows the details of all contact numbers currently held in the Address Book for the contact.

Adding a contact numberFrom the Contact Numbers panel, click Add to enter new contact details.



NumberEnter the mobile telephone number on which the person can be contacted.

Number TypeCurrently only SMS is available in this field.

Service ProviderNot used in this release.

SMS TypeSelect either Normal or Flash as the SMS message type. Flash messaging is a method of sending SMSmessages to any phone, even if it is locked.

ActiveSpecify 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 thensent as soon as the phone becomes available again.

Setting a Contact Number as a DefaultFrom the Contact Numbers panel and within the list of displayed Contact Numbers, highlight an entry andclick Set As Default to use that number as the main contact number for the selected contact.

Email Addresses page This shows the details of all email addresses currently held in the address book for the contact.

Adding an email addressFrom the Email Addresses panel, click Add to enter a new email address.



Enter the email address for the contact and click OK.

Setting an Email Address as a DefaultFrom the Email Addresses panel and within the list of displayed Email Addresses, highlight an entry andclick Set As Default to use that number as the main contact number for the selected contact.

Company pageEnter the required Company Details for the Contact. These fields are self-explanatory.

Home pageUse 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.

Call SchedulesA call schedule is a method of ensuring that the correct person is contacted, at the right time, in the event ofan alert being raised.

Note: An existing schedule cannot be a member of another schedule.

Creating a Schedule To add a new contact to the Instant Alert Address Book click Add from the Instant Alert menuribbon. From the drop-down choice menu, select Schedule. The Add New Schedule dialog is displayed.

Details page

NameEnter the name by which the new schedule is identified throughout Instant Alert and Enterprise Console.

DescriptionEnter a meaningful textual description of the new schedule.



Click the Items menu option to add items to this schedule.

Items pageThis list all of the items contained within this schedule. One the first opening of this page the panel is blankas no items have been added.

Click Add to create a new item for this schedule. The Add New Schedule Item dialog is displayed.

Day/Date From From the drop-down list, select a day of the week from which this schedule item is active. To specify anactual date, select (Date) from the list and then use the calendar to choose the required date.

Time FromSpecify the time on the selected day/date that this schedule item becomes active.



Day/Date ToFrom the drop-down list, select a day of the week to which this schedule item is active. To specify an actualdate, select (Date) from the list and then use the calendar to choose the required date.

Time ToSpecify the time on the selected day/date that this schedule item ceases to be active.

Contiguous Time RangeClick Contiguous Time Range to specify that this schedule item runs continuously between the dates andtimes specified. For example, entering Monday, 09:00:00 and Friday 16:59:59 would mean that thisschedule item would be available CONTINUOUSLY between those times. Leaving this option uncheckedmeans that this schedule item would be available Monday between 09:00:00 and 16:59:59, Tuesdaybetween the same time and so on...(Saturday and Sunday would be excluded from this example).

MemberFrom the drop-down list select the Member to which this schedule item applies.

Click OK to add this schedule item to the current schedule.

Broadcast GroupsA broadcast group can be defined as a team of people who have an interest in a specific function orroutine. For large organizations it may be that many people are involved in very specific routines across adepartment.

In smaller organizations it is likely to be one or two people that have the responsibility of running allroutines.

Note: Broadcast groups cannot be members of other broadcast groups.

Creating a Broadcast GroupTo add a new contact to the Instant Alert Address Book click Add from the Instant Alert menuribbon. From the drop-down choice menu, select Broadcast Group. The Add New Broadcast Group dialogis displayed.

Details page

NameEnter the name by which the new broadcast group is identified throughout Instant Alert and EnterpriseConsole.

DescriptionEnter a meaningful textual description of the new broadcast group.



Click the Members menu option to add specific members to this broadcast group.

Click Select Members to create a new broadcast group. The Select Members dialog is displayed.



From the Available list of members, click on the member that you wish to add to this broadcast group sothat it is highlighted. Click to select the member, whose name now appears in the Selected list.

De-selection is a reversal of this process.

Multiple members can be selected in one of two ways:

• To select all the available members for a single broadcast group click . You do not need to click onthe members first.

• To select a continuous block of members, click on the first member in the list, hold down the shift keyand click on the last member in the list. All members between the mouse-clicks are now selected andcan be transferred between panels in a single movement.

• To select members that are not in a continuous block, keep a finger on the Ctrl key while you click oneach member to select. Once finished, click . All members that were selected with each mouse-clickare now transferred between panels in a single movement.

Click OK to create the broadcast group.

Address Book OptionsUse the Instant Alert Address Book Options to specify details of the server on which Instant Alert isinstalled, together with any connection timeout settings.

The Address Book options are available from the address book icon on the Address Book menu barand selecting Options from the drop-down menu.

The Halcyon Address Book Options dialog is displayed.



Host/AddressEnter the IP Address of the server on which Instant Alert is installed.

Connection TimeoutInstant Alert abandons its connection attempt after the time period (in seconds) specified in this field.

Read TimeoutSpecify a time (in seconds) in which data must be read from the device before timing out.

Click OK to set the Instant Alert Server options.

Editing Contacts, Schedules and Broadcast GroupsTo edit the details of an existing contact, schedule or broadcast group select the required member from theAddress Book panel so that it is highlighted. Click the Edit icon .

The parameters available for editing are the same as those used when Adding a Contact to the InstantAlert Address Book, Creating a Schedule or Creating a Broadcast Group

Deleting Contacts, Schedules and Broadcast GroupsTo remove the details of an existing contact, schedule or broadcast group select the required member fromthe Address Book panel so that it is highlighted. Click the Delete icon .

When prompted, click Yes to confirm the action and remove the member from the Address Book or click Noto cancel the request.

Finding Contacts, Schedules and Broadcast GroupsIf you have a large number of members in your address book, use the Find facility to search for a specificmember.

Click the Find icon to open a new dialog into which you can enter the details of the member that youwant to find. Click OK to begin the search.

Renaming Contacts, Schedules and Broadcast GroupsIf you want to rename an existing member in your address book, use the Rename facility to quickly providean alternative name for a specific member.

Click the Rename icon to open a new dialog into which you can enter the new name by which thismember will then be identified. Click OK to confirm the amendment.



Message SenderHalcyon Instant Alert Message Sender is a utility allowing text messages to be sent across the network tospecified recipients.

The Instant Alert Message Sender can be used to send messages by either email or SMS to contacts in theAddress Book and is similar in looks and functionality as many third party email applications.

To open the Message Sender program select Windows Start | Programs | Halcyon | Instant Alert | MessageSender. The Halcyon Message Sender dialog is displayed.

Sending a MessageTo send a basic message:

1. Complete the To Address field or use the icon to display the list of members currently held in theAddress Book.

2. Enter the title of the message in the Subject field

3. Enter the body text of the message in the Message field.

4. Click the envelope icon to send as an Email message, or click the mobile phone icon to send asan SMS message. Click both icons to send as both an email 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 either select View | Show Options or click to display additional options which can be completed as follows:



DateThe default is today's date. Enter or select the required date from the drop-down selection. If the dateselected is earlier than today, the message is sent as soon as Send Message is clicked. If a later date isselected, the message is held until the date and time are reached.

TimeThe default is the time at which Message Sender was opened. Enter or select the required time from thedrop-down selection. If the time selected is earlier than now, the message is sent as soon as SendMessage is clicked. If a later time is selected, the message is held until the date and time are reached.

CountSelect the number of times you require this message to be sent.

IntervalSelect the interval, in minutes, between which messages are sent. This setting is only used if the Countfield is increased from 1.

Click Send Message to send.

Using Lotus Notes® (v7 or later) with Instant AlertIt is possible to use Lotus Notes® (V7 or later) with Instant Alert providing that the correct configuration isapplied. 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 tofinalize 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 installationof 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.

5. Double click on Halcyon Instant Alert Server. When the properties dialog is displayed, click the Log Ontab.

6. Select This Account and enter HALCYONIA with the associated password specified when the useraccount 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 | Instant Alert | Server Options.

9. Select Interfaces from the Options tab. Click Add. From the Select Interface to Add dialog select NotesInterface and click OK.



10.Configure the Notes® Interface according to your operating environment. In the Settings menu optionenable 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

11.Close the Instant Alert Server Settings and open the Address Book from Windows® | Start | Halcyon |Instant Alert | Address Book.

12.Click Add to add a new contact. Add Name details and then select Email Address from the Contactmenu and click Add to display the Select Type to Add dialog.

13.Select Notes® User Name and click OK to display the Add Email Address dialog.

14.Enter the required Notes® Email Address in the format User/Domain. Click OK to add the Notes® EmailAddress. Click OK on subsequent screens to close and add the contact.

15.Repeat steps 12-14 to add further Notes® Email Addresses as required.

16.Use Windows® Start | Halcyon | Instant Alert | Message Sender to send a test message to the Notes®

contact to ensure successful configuration.


Enterprise Console Archive Address Book

Enterprise Console Archive

Archive ViewerThis utility is used to view Enterprise Console Archive (.eca) files created by the system.

The content of archive files is specified on the Enterprise Server Options | Alerts | Archive page. Once a filehas been created, it can be saved to the default directory (the directory in which Enterprise Server OptionsECServOpt.exe file is installed) or a user-specified directory.

Note: The Enterprise Console Archive Viewer is not available when the Enterprise Console is viewed from a client device.

About Archive FilesArchive files contain a record of closed, replied and deleted alerts. Files can be generated daily, weekly ormonthly. Different (discrete) files can be generated if you wish to save alerts archive details within specifictime periods, or one file can be generated which is updated with the most recent alert details.

Alert details are generated for replied, closed and deleted alerts only, at the time which the response to thealert was actioned.

Note: There is no limit to the size of files that can be created, however, if you save all of the information into one file and your system is likely to generate many alerts, the file may eventually become very large and therefore time consuming to navigate.



Creating One Master Archive File This procedure allows you to record alert details in one master file which is updated at the frequencyspecified in the Create Archive Files drop-down combo box. New information is appended to the contentsof the existing file each time the file is generated.

Once these settings have been specified, an updated file is created automatically until the settings aremodified.

To create one master archive file:

1. Launch Enterprise Server Options and select Alerts | Archive.

2. Check Save Alerts to an Archive File to activate archive file creation.

3. Specify which alerts you wish to archive in the Alerts To Archive options.

4. Select the frequency with which you want to save replied, closed and deleted alerts to this archive file.

5. Specify a Directory and Path to which the archive file is saved. If a directory and path is not specified,the file is saved to a default directory (the directory in which eso.exe is installed).

The directory can be created on any accessible machine on your network, so the file does not have to belocalized. If the directory is shared across your network, the archive file can be accessed by all users ifrequired.

6. Specify an archive file name only. Do not add time details to the file name.

7. Click OK to accept and save these settings.

Creating Multiple Archive Files This procedure allows you to record alert details for specified, sequential periods (daily, weekly ormonthly), creating a new file for each period.

Once these settings have been specified, new files are created automatically until the settings aremodified.

To create multiple archive files:

1. Launch Enterprise Server Options and select Alerts | Archive.

2. Check Save Alerts to an Archive File to activate archive file creation.

3. Specify which alerts you wish to archive in the Alerts To Archive options.

4. Select the frequency with which you want to create a new archive file with replied, closed and deletedalerts.

5. Specify a Directory and Path to which the archive files are saved. If a directory and path is not specified,the files are saved to a default directory (the directory in which eso.exe file is installed).

The directory can be created on any accessible machine on your network, (archive files do not have tobe localized). If the directory is shared across your network, the archive files can be accessed by allusers if required.

6. Specify the file name for the archive files and add period details using the Substitution Variables options.

These details are added to each file name as it is generated (spaces can be added between thevariables to clarify the names).

Note: To ensure each file has a unique file name, at least two substitution variables should be added to the file name. An example of the file name in full is displayed in the Example read-only text box.



7. Click OK to accept and save these settings.

Viewing an Archive File Archive files are viewed by launching the Enterprise Console Viewer from Windows Start | Halcyon |Enterprise Console | Archive Viewer and selecting a file from the list of .eca files displayed in the SelectArchive To Open dialog. The contents of the selected archive file are opened into the viewer utility.

To view archive file details:

1. Launch the Enterprise Server Archive Viewer form Windows Start | Programs | Halcyon | EnterpriseConsole | Archive Viewer.

The Select Archive To Open dialog is displayed allowing you to choose an archive file to view.

2. Select a file from the .eca files listed and click Open.

The file is opened into the Enterprise Server Archive main window.

3. Double-click on any of the alert details listed to view individual alert details in the Alert Details window.

4. Use the navigation buttons to scroll back and forward through the available records.


Working with Substitution Variables Overview

Working with Substitution Variables

Overview Substitution variables are used to insert information or text within an existing piece of text. Differentvariables allow you to determine the text or detail that you wish to insert and at which point. Thecommonest use of substitution variables is when allowing you to format the text of alerts sent to theEnterprise Console or Instant Alert to be forwarded as SMS messages or emails.

All substitution variables begin with an ampersand (&) and are usually case-sensitive. When a substitutionvariable is used, the program searches for an ampersand and if found, compares the following text againsta list of valid variables. If a match is made, the existing text is replaced with the substitution variable. Anynon-matching text is left in its original condition.

When using substitution variables throughout the Enterprise Console and associated programs, anyentries that are made correctly are highlighted in green and those that will result in an error are highlightedin red.

ExampleIn the following substitution variable:

‘User &NA is not authorized to file &FN in folder &FL’

where:

&NA equals User Name

&FN equals File Name

&FL equals Folder Directory and Name

may produce the following text:

‘User John is not authorized to file Payroll.dat in folder C:\Program Files\

Retaining an ampersand in the existing textIf you already have an ampersand in the existing text that you wish to retain when using substitutionvariables, simply insert a double ampersand to instruct the program that you wish to retain the originalentry instead of using a substitution variable.

An example of how this works in practice can be seen below:

Text entered as

‘Drives C, D && E are working normally’ would result in

‘Drives C, D & E are working normally’

Understanding Substitution Variables

The basicsIn their most basic form, substitution variables are 2-character combinations. However, they can be of anylength and longer variables are often required when 2 characters are not enough to differentiate onevariable from another.

Generally, when a variable is used in a piece of text it is directly followed a break character such as aspace, comma, period and the like. This is demonstrated in the example below:

‘An error has occurred for Device &Name. Please Investigate.’

where:

&Name equals Backup



produces the following text:

‘An error has occurred for Device Backup. Please investigate.’

In the above example, the use of the period tells the program where the substitution variable ends so that itcan correctly insert the replacement text.

Substitution variables can also be placed directly next to each other as shown in the next example whichalso demonstrates how substitution variables can be used in file naming conventions:

‘HECArchive_&DD&MM&YYYY.eca’

where:

&DD equals Day

&MM equals Month

&YYYY equals Year

may produce something similar to:

‘HECArchive_18June2009.eca

Using Substitution Variables within textIn the previous sections, we explored entering substitution variables as standalone items, but there may beoccasions when you need to use a substitution variable that is immediately followed by more text.

The following example uses variables called ‘&Type’ which returns a value of ‘Run’, and ‘&Name’, whichreturns a value of ‘Backup’.

‘&Typetime Error Logged for System &Name’

Entered in this format, the following is returned:

‘&Typetime Error Logged for System Backup’

By using this format, entering the variable ‘&Type’ immediately followed by the word ‘time’, results in anerror as the program is looking for the substitution variable ‘&Typetime’, which doesn’t exist.

In order for the program to differentiate between where the substitution variable ends and the text begins, apipe character followed by a semi-colon ‘|;’ (without quotes) must be inserted between the end of thevariable and the start of the text.

Therefore, by using the previous example:

‘&Type|;time Error Logged for System &Name’ now results in:

‘Runtime Error Logged for System Backup’

The ‘|;’ signifies the end of a variable and that any text that immediately follows the semi-colon (and up tothe next ampersand or break character) should be inserted as entered. The pipe and semi-coloncharacters are also used when adding parameters to substitution variables.

Adding Parameters to Substitution VariablesParameters can be added to substitution variables to further enhance or manipulate the values that aresubstituted in the text.

Parameters are added in the same way as when inserting substitution variables within text, in that you adda pipe character ‘|’ (without quotes) to the end of the variable. You can then add further parameters, eachseparated by ‘|’, finishing with ‘|;’ when you have entered the full substitution variable with the requiredparameters. This combination tells the system engine when to start and end processing of the substitutionvariable with parameters.



ExamplesIn the following examples, the substitution variable ‘&UN’ is used to return the text of ‘Administrator’.

If the basic form of the substitution variable was used:

‘User &UN has logged on’ would return:

‘User Administrator has logged on’

However, by using parameters you can display the user name in upper case. To do this, add the ‘u’parameter. (a full list of parameters can be found in Substitution Variable Parameters). This would affectthe previous example as follows:

‘User &UN|u|; has logged on’ returning:

‘User ADMINISTRATOR has logged on’

To add multiple parameters and change the appearance of the substitution variable even further you couldspecify:

‘User &UN|u|+5|; has logged on’.

This substitution variable entry would now return:

‘User ADMIN has logged on’

This is because the variable now has the parameters of firstly converting the user name to upper case andthen returning just the first five characters of the user name.

Note: Substitution variables can return either string or numeric values. While applying each parameter, the program checks to see if the varaible result is numeric. If it is, then only numeric parameters can be applied from that point onwards. To override this behavior and treat the numeric result as a string, the ‘s’ parameter can be used.

See the Substitution Variable Parameter tables overleaf for more details.



Substitution Variable Parameters

Numeric Parameters

Parameter Description Example Value Variable Result

f Returns the fractional part of afloating-point number

N=1784.23 &N|f|; 0.23

I Returns the integer part of a floating-point number

N=1784.23 &N|i|; 1784

pn Formats the variable to n decimalplaces from 0-9

N=1784.238175 &N|p2|; 1784.24

‘kb’

‘mb’

‘gb’

‘tb’

‘pb’

‘eb’

Converts a number representingbytes into the respective storage unit.

The result is the decimalrepresentation of the byte value (i.e.divided by 1000)

N=10273460156234512340 &N|kb|;

&N|mb|;

&N|gb|;

&N|tb|;

&N|pb|;

&N|eb|;

10273460156234512.34

10273460156234.51234

10273460156.23451234

10273460.15623451234

10273.46015623451234

10.27346015623451234

‘kib’

‘mib’

‘gib’

‘tib’

‘pib’

‘eib’

Converts a number representingbytes into the respective storage unit.

The result is the binary representationof the byte value (i.e. divided by 1024)

N=10273460156234512340 &N|kib|;

&N|mib|;

&N|gib|;

&N|tib|;

&N|pib|;

&N|eib|;

10032675933822765.9570

9797535091623.79487991

9567905362.91386218741

9343657.58097056854239

9124.66560641657084218

8.91080625626618246307

+n

+&v

Adds the number n to the variableresult, or adds the value of variable &vto the result

N1=356

N2=78

&N1|+45|;

&N1|+&N2|;

401

434

-n

-&v

Subtracts the number n to the variableresult, or subtracts the value ofvariable &v to the result

N1=356

N2=78

&N1|-45|;

&N1|-&N2|;

311

278

*n

*&v

Multiplies the number n to the variableresult, or multiplies the value ofvariable &v to the result

N1=356

N2=78

&N1|*45|;

&N1|*&N2|;

16020

27768

/n

/&v

Divides the number n to the variableresult, or divides the value of variable&v to the result

N1=356

N2=78

&N1|/45|;

&N1|/&N2|;

7.91111111111111111111

4.56410256410256410256



String Parameters

Parameter Description Example Value Variable Result

t Trims any spaces from the beginningand end of the variable result

S=’ Error Occurred ‘ &S|t|; ‘Error Occurred’

tl Trims any spaces from the beginningof the variable result

S=’ Example text’ &S|tl|; ‘Example text’

tr Trims any spaces from the end of thevariable result

S=’Example text‘ &S|tr|; ‘Example text’

l Converts the variable result to lowercase

S=’Example Text’ &S|l|; ‘example text’

u Converts the variable result to uppercase

S=’Example text’ &S|u|; ‘EXAMPLE TEXT’

p Converts the variable result to propercase. i.e. the first letter of each word isa capital followed by lower casecharacters

S=’EXAMPLE text’ &S|p|; ‘Example Text’

P The same as the ‘p’ parameter butpreserves any existing capital letters

S=’EXAMPLE text’ &S|P|; ‘EXAMPLE Text’

n- Removes the first n characters fromthe variable result

S=’Example text’ &S|3-|; ‘mple text’

-n Removes the last n characters fromthe variable result

S=’Example text’ &S|-3|; ‘Example t’

n+ Returns the first n characters from thevariable result

S=’Example text’ &S|4+|; ‘Exam’

+n Returns the last n characters from thevariable result

S=’Example text’ &S|+4|; ‘text’

‘s’- Removes all characters up to andincluding s from the beginning of thevariable result

S=’Example text’ &S|’ple’-|; ‘ text’

-’s’ Removes all characters from s to theend of the variable result

S=’Example text’ &S|-’ple’|; ‘Exam‘

‘s’+ Returns all characters up to andincluding s from the beginning of thevariable result

S=’Example text’ &S|’ple’+|; ‘Example’

+’s’ Returns all characters from s to theend of the variable result

S=’Example text’ &S|+’test’|; ‘ple text’

s Instructs Enterprise Console that thevariable result should be treated as astring

N=1784.23 &N|s|-4|; ‘178’


AB/EC103UG/041316

Enterprise Console v10 - HelpSystems...Halcyon Enterprise Console v10.3 User Guide - 5 - About the...

Documents

Transcript of Enterprise Console v10 - HelpSystems...Halcyon Enterprise Console v10.3 User Guide - 5 - About the...