1 INSTALLATION AND DESCRIPTION ifix Alarm History Viewer Version 1.0 File: Documentation - ifix Alarm History Viewer - Version 1.0 Revision: 1.0 Date: 01/11/12 Inh.: Dipl.-Ing. Bernhard Wurm An der Landwehr 6 D Frankfurt am Main Phone: +49 (0) Fax: +49 (0)
2 Contents 1 Specification of ifix Alarm History Viewer System requirements Installation Licensing Configuration Configuration of the software Defining the size ConnectionString of the SQL-Database Configuration of the dynamic columns Configuration of coloured expressions Handling of ifix Alarm History Viewer Overview Grid Grouping Sorting Filtering Visibility of columns Hide unneeded columns Unhide hidden columns Printing Printing settings Export function Send displayed data via Representations Help Error Handling Log path Log file name Format The error button Glossary Appendix Lists List of Figures List of Tables Tables Abbreviation table Colour table Documentation - ifix Alarm History Viewer - Version 1.0 Seite 2 von 23
3 1 Specification of ifix Alarm History Viewer The software ifix Alarm History Viewer is used to display alarms and events that result in "Proficy ifix (V4.0 and above) and which are stored in a Microsoft SQL Server database. ifix Alarm History Viewer can be used in two different types of display modes: 1. As a normal window: The menu and all buttons are operable. The operator can resize the window and choose its position. 2. As a simplified window: The menu, the buttons and the typical window-header are missing. The administrator can configure within the configuration file the position and the size of the window. ifix Alarm History Viewer also includes the following options: Free selection of the time period. Choose the number of displayed alarms and events retrospectively of the current time. Automatic data update with a configurable cycle time. Always on Top -option. Print the content shown in the data grid. Export data to various formats such as *.xls, *.xlsx, *.pdf, *.html, *.png etc. Sorting and grouping the data in the data grid. Expressions can be highlighted by a various number of colours. 2 System requirements For the functionality of ifix Alarm History Viewer, the following software is required: Software Version Comments Microsoft.NET Framework 3.5 SP1 Software Version Comments Proficy ifix 4 and above MS SQL Server 2000, 2005, 2008 / 2008 R2 and above Windows XP, 7, Server 2003, X86/x64 Server 2008, Server 2008 R2 ifix Alarm-ODBC Service You need a correct configuration of the ifix SCU. Table 1: Software requirements Documentation - ifix Alarm History Viewer - Version 1.0 Seite 3 von 23
4 3 Installation 1. Insert the installation CD with the title ifix Alarm History Viewer in the CD drive. 2. You can start the installation by double-clicking the setup.exe file, which is located in the folder Setup. A wizard guides you through the installation. 3. After the installation process, the software is installed on your PC. 4. Microsoft.NET Framework 3.5 should be installed on your PC. Please check if the following path exists: C:\Windows\Microsoft.NET\Framework\v3.5\ 4 Licensing The software can be used without restrictions for over ten days. After these ten days, you need to purchase a software license, for further use of ifix Alarm History Viewer. The following steps will help you with the licensing: 1. Start ifix Alarm History Viewer. 2. Following window opens: Figure 1: Licensing 3. A requirement for the licensing is the MachineID. In case the MachineID has not been selected, you need to copy it with a click on the Copy to clipboard -button. 4. Send an with the copied MachineID to We will generate a license file and send it back to you within 24 hours. Documentation - ifix Alarm History Viewer - Version 1.0 Seite 4 von 23
5 5. The file, we will send you back, is called ifixahd.license. Figure 2: License file 6. Please make sure that ifix Alarm History Viewer is closed, before copying the license file to your installation path. 7. Save the license file into the installation path of ifix Alarm History Viewer. 8. Please start ifix Alarm History Viewer. The licensing procedure is complete. You can use the software now without any time restrictions. 5 Configuration You have to configure some settings before using ifix Alarm History Viewer. 5.1 Configuration of the software In the installation path of ifix Alarm History Viewer you will find a XML-file named IFixAlarmHistoryViewer.exe.config, which can be opened via Microsoft Notepad. You can configure the software settings under the element <usersettings>. Setting Name Type Description SQLDBConnectionstring String ConnectionString of the SQL-Database (see chap ). TableName String Tablename of the ifix alarms. RefreshCycle Int Data update time in seconds. TrimColumns Bool This function removes any extra blanks out of the Data-Grid, once it has been set to true. Once TrimColums has been set to false, these blanks will remain. Notice: In the database table, most entries, including empty cells, have several extra blanks. This can possibly affect the sorting / grouping in the Data-Grid. PositionX Int X-position of the grid ( simplified window mode only). PositionY Int Y-position of the grid ( simplified window mode only). Width Int Width of the grid ( simplified window mode only). High Int Height of the grid ( simplified window mode only). Language String Configure the language of ifix Alarm History Viewer by using de for German or en for English. If you don t set any string for language, ifix Alarm History Viewer will use English as the default language. The Timestamp will be set by the system preferences. Table 2: Configuration of the software Documentation - ifix Alarm History Viewer - Version 1.0 Seite 5 von 23
6 5.1.1 Defining the size To configure the size of the simplified window mode, you have to open the XML-file IFixAlarmHistoryViewer.exe.config, which is located in the installation path of ifix Alarm History Viewer. Following variables have to be configured: Setting Name Type Description PositionX Int X-position of the grid ( simplified window mode only). PositionY Int Y-position of the grid ( simplified window mode only). Width Int Width of the grid ( simplified window mode only). High Int Height of the grid ( simplified window mode only). Table 3: Defining the size The next picture can help you to choose the right position for ifix Alarm History Viewer. Figure 3: Defining the size The picture shows you a monitor with a screen resolution of 1600x1200. If you want to configure ifix Alarm History Viewer like in the picture above, you have to set the following values: Setting Name Type Value PositionX Int 425 PositionY Int 740 Width Int 750 Hight Int 450 Table 4: Configuration of the size Documentation - ifix Alarm History Viewer - Version 1.0 Seite 6 von 23
7 5.1.2 ConnectionString of the SQL-Database The connection string is built using the following SQL Server authentication: Data Source=VM-GS-IFIX\SQLEXPRESS;Initial Catalog=Master;User ID=admin;Password=sqlpassword Parameter Data Source Initial Catalog User ID Password Description Host name, on which the SQL Server is installed. If you re using a SQL Express database, you have to append \SQLEXPRESS at the end of the data source. Name of the database. Name of the database user. Password of the database user. Table 5: ConnectionString of the SQL-Database 5.2 Configuration of the dynamic columns In the installation path of ifix Alarm History Viewer you will find an XML-file named MappingSpalten.xml. In this file the columns of the grid (table view) are configured and mapped to the columns of the SQL-Table. Here you can configure other names for the columns of the databasetable. Item name Type Nullable Description SQLZeitBezugsSpalte No SQLSpaltenName String No You have to enter a column name of the database-table. The type of this column has to be DateTime. Spalte No GridSpaltenName String No Column name in the grid of the software. SQLSpaltenName String No Column name in the database grid. InGridDarstellen Bool No You can choose, by entering the values true or false, if you want to show the column in the grid of ifix Alarm History Viewer or not. IstDatumZeit Bool No Here, you have to define, if the column of the databasetable has the type DateTime? Possible values: true/false Table 6: Configuration of the dynamic columns There have to be at least one item of <SQLZeitBezugsSpalte> and one item of <Spalte>. Every column, which should be shown in the grid of ifix Alarm History Viewer, must be configured here. Documentation - ifix Alarm History Viewer - Version 1.0 Seite 7 von 23
8 5.3 Configuration of coloured expressions In the installation path of ifix Alarm History Viewer you will find an XML-file named MappingFarben.xml. This file allows you to configure values which should get coloured. Item name Type Nullable Description Spalte Yes SQLName String No Column name of the database table. Option No Wert String No Value, where the colours should be applied. SchriftFarbe String No Font colour. Look at the appendix for further information. HintergrundFarbe String No Background colour. Look at the appendix for further information. Table 7: Configuration of coloured expressions An item of <Spalte> can contain more items of <Option>. This means, that you can configure several colour definitions for a column. The XML-file contains several items of <Spalten>, so you can define several columns with various options. Figure 4: MappingFarben.xml example Notice: The expressions that are entered in the file MappingFarben.xml are case-sensitive. This means that a distinction is made between upper and lower letters! For expressions without a colour definition, the default text is written in black and the background is white. In the above picture, this example is given for ESIGNATURE. Look at the appendix for further information. Documentation - ifix Alarm History Viewer - Version 1.0 Seite 8 von 23
9 6 Handling of ifix Alarm History Viewer 6.1 Overview ifix Alarm History Viewer contains a grid (table view) and a control panel, which is placed over the grid. In the control panel you can query a time period or a number of alarms and events. Figure 5: ifix Alarm History Viewer - Overview Button Description ifix Alarm History Viewer runs in the foreground, if the checkbox is activated. The query will refresh automatically, if the checkbox is activated. You can configure the interval in IFixAlarmHistoryViewer.exe.config. If the checkbox is activated, the width of the column will be extracted and the scrollbar will be displayed. A preview mask for printing and exporting will be displayed. You can switch the displayed mode of ifix Alarm History Viewer by clicking the button in the left lower corner. Choose the type of the query. The selection applies to the automatic refresh. Manuel query of alarms and events. Opens the help file. Table 8: Explanation of the buttons Documentation - ifix Alarm History Viewer - Version 1.0 Seite 9 von 23
10 6.2 Grid The grid provides a variety of grouping, sorting and filtering options Grouping You can group columns by left-clicking on the desired column header and dragging it to the top of the grid. It doesn t matter how many columns you want to group. One possible grouping is shown in the following image: Figure 6: Grouping columns To ungroup, drag the column header or the column headings back to the other columns Sorting To sort a column, press as usual on the column header. The sorting will be indicated by a small triangle in the column header. Figure 7: Sort columns Documentation - ifix Alarm History Viewer - Version 1.0 Seite 10 von 23
11 6.3 Filtering To filter data in a column, move the mouse pointer to the upper right corner of the desired column, till a funnel-shaped icon appears. Click on the icon with the left mouse button. There will appear expressions, after which the contents of the column can be filtered. Figure 8: Filter data in columns To remove the filter, just click in the lower left corner on the x-symbol. The filter will be eliminated and the remaining data will be displayed again. Figure 9: Remove the filter function 6.4 Visibility of columns You can hide or show columns, which you don t need or which you need in the normal window display Hide unneeded columns To hide a column, just click the right mouse button on the column header and select the menu item Remove This Column. Figure 10: Hide unneeded columns Documentation - ifix Alarm History Viewer - Version 1.0 Seite 11 von 23
12 6.4.2 Unhide hidden columns To unhide a hidden column, click the right mouse button on any column header and select the menu item Column Chooser. Figure 11: Unhide hidden columns A new window will open where the hidden columns are displayed. Figure 12: Selection of columns which should be unhidden Drag the column that you want to have displayed again, back to the main window to the other columns. This step can be repeated so often, until all column names are shown in the main window again. You can close the "customization"-window by clicking on the "x" icon. Documentation - ifix Alarm History Viewer - Version 1.0 Seite 12 von 23
13 6.5 Printing To ensure a clear document, we recommend hiding unneeded columns and also adjusting the column width. Press the Print / Export -button, to see the print preview: Figure 13: "Print / Export"-button A preview will be created: Figure 14: Preview Notice: If you have used the grouping function, all collapsed groups will be folded out so that all data is shown. To print the file just click on the Print -button or open the menu item File -> Print. Figure 15: Print with the "Print"-button Notice: The file will be printed immediately. The next chapter will show you the advanced printing settings. Documentation - ifix Alarm History Viewer - Version 1.0 Seite 13 von 23
14 6.5.1 Printing settings Setting up the page layout The page layout can be set up under the menu item File -> Page Setup or by clicking the Page Setup -button. Figure 16: Setting up the page layout (1/2) The page can be set up in the next window: Printer selection and advanced settings Figure 17: Setting up the page layout (2/2) The printer can be configured by clicking on File -> Print or by clicking the Print -button. Figure 18: Printer selection and advanced settings (1/2) Documentation - ifix Alarm History Viewer - Version 1.0 Seite 14 von 23
15 In the following window the printer can be selected and configured. In addition, the number of copies and the area can be specified. By clicking on Print, the data from the preview will be printed. Figure 19: Printer selection and advanced settings (1/2) 6.6 Export function ifix Alarm History Viewer offers you to export your data via the Print / Export -button. The current version supports the following file types: *.pdf *.html *.mht *.rtf *.xls *.xlsx *.csv Text Pictures (*.png, *.jpg, *.bmp, *.wmf, *.gif, *.tiff, *.emf) To use the export function, first configure your column view in the main window as desired. Then click on the Print / Export -button. You will see the preview window. Documentation - ifix Alarm History Viewer - Version 1.0 Seite 15 von 23
16 Figure 20: Preview In the main menu of this preview window, you can use the menu item File -> Export Document -> (select your desired file type) to export the file. Figure 21: Export opportunities Documentation - ifix Alarm History Viewer - Version 1.0 Seite 16 von 23
17 6.7 Send displayed data via You can also send the data displayed in the preview window via . In the main window of ifix Alarm History Viewer click on the Print / Export -button to see the preview window. Then, open the menu item File -> Send via and choose the desired file type. Figure 22: Send displayed data via Once the settings have been made, your client starts with the exported file as an attachment. You can now compose an . Documentation - ifix Alarm History Viewer - Version 1.0 Seite 17 von 23
18 6.8 Representations In Section 6.1 we have already mentioned the fact that the software can be operated in two different window modes. You can switch between these two representations over the small button in the left bottom corner. The normal window mode: The control bar is displayed. The window is freely sizable. The data can also be exported or printed. Figure 23: "normal" window mode The simplified window mode without setting options: The control bar is hidden. The window is not adjustable. Figure 24: "simplified" window mode Documentation - ifix Alarm History Viewer - Version 1.0 Seite 18 von 23
19 7 Help In the normal window mode you can access the help file by clicking on the question mark -button. Figure 25: Help The help file is corresponding to the content of this document. 8 Error Handling All errors and information are daily stored in a log file (CSV format) under the directory logs. You can analyze the data with standard software such as Microsoft Excel or Notepad. 8.1 Log path The log files are located, depending on the Windows version you are using, in one of two locations: C:\Users\<YourUsername>\AppData\Local\IFixAlarmHistoryViewer\Logs\ or from Windows 7 and above: C:\Documents and Settings\<YourUsername>\Local Settings\Application Data\ IFixAlarmHistoryViewer\Logs\ 8.2 Log file name The file name is composed as follows: \Logs\IFixAlarmHistoryViewer-<YYYY>-<MM>-<DD>.log Explanation: YYYY = Year, four numbers. MM = Month, two numbers. DD = Day, two numbers. Documentation - ifix Alarm History Viewer - Version 1.0 Seite 19 von 23
20 8.2.1 Format The general format of an entry in the log file looks like this: <Application>;<Message Type>;<ID>;<Version>;<Computer>;<Timestamp >;<Module>,<Message> Tag <Application> <Message Type> <ID> <Version> <Computer> <Timestamp> <Module> <Message> Description Software name (here IFixAlarmHistoryViewer). Message Type. ID-number of the event (optional). Version number of the software. Computer name. Time, on which the event took place. YYYY.MM.DD hh:mm:ss.mi (e.g.: :05:12.210) Module, where the event took place. Message. Table 9: Log file - format 8.3 The error button When an error is logged into the log file, a red button will appear in the lower right corner. By pressing the button the signal disappears. Figure 26: The error button Documentation - ifix Alarm History Viewer - Version 1.0 Seite 20 von 23
21 9 Glossary Client: ConnectionString: A client is a host which sends a service request to a server. The connection string is used to connect to the database. It is composed of the database, the tables, the user name and the user password. Database: Data-Grid: A database is a system for electronic data management. A Data-Grid represents data from a database in a grid. Editor: False: Software; integrated in Microsoft. See Notepad. The condition was not met or should not be met. Grid: Similar views as you know from Microsoft Excel. Can be filled with data. Host: A computer system with an associated operating system with a client or a server. Log file Notepad: Contains an automated created protocol of the processes. Software; integrated in Microsoft. Proficy ifix: Server: Software; developed by GE Intelligent Platforms. You can monitor and control technological processes with it. The software runs under Microsoft Windows. A server processes and answers the questions of a client service. In many cases a server contains a database. SQL: Structured Query Language. Standardized query language for relational databases. True: The condition was met or should be met. Wizard: A wizard guides the user in performing certain program functions through individual steps. Documentation - ifix Alarm History Viewer - Version 1.0 Seite 21 von 23
22 10 Appendix 10.1 Lists List of Figures Figure 1: Licensing... 4 Figure 2: License file... 5 Figure 3: Defining the size... 6 Figure 4: MappingFarben.xml example... 8 Figure 5: ifix Alarm History Viewer - Overview... 9 Figure 6: Grouping columns Figure 7: Sort columns Figure 8: Filter data in columns Figure 9: Remove the filter function Figure 10: Hide unneeded columns Figure 11: Unhide hidden columns Figure 12: Selection of columns which should be unhidden Figure 13: "Print / Export"-button Figure 14: Preview Figure 15: Print with the "Print"-button Figure 16: Setting up the page layout (1/2) Figure 17: Setting up the page layout (2/2) Figure 18: Printer selection and advanced settings (1/2) Figure 19: Printer selection and advanced settings (1/2) Figure 20: Preview Figure 21: Export opportunities Figure 22: Send displayed data via Figure 23: "normal" window mode Figure 24: "simplified" window mode Figure 25: Help Figure 26: The error button List of Tables Table 1: Software requirements... 3 Table 2: Configuration of the software... 5 Table 3: Defining the size... 6 Table 4: Configuration of the size... 6 Table 5: ConnectionString of the SQL-Database... 7 Table 6: Configuration of the dynamic columns... 7 Table 7: Configuration of coloured expressions... 8 Table 8: Explanation of the buttons... 9 Table 9: Log fle - format Documentation - ifix Alarm History Viewer - Version 1.0 Seite 22 von 23
23 10.2 Tables Abbreviation table ODBC SCU SQL Open Database Connectivity System Configuration (Proficy ifix) Structured Query Language Colour table Name Blue Yellow Green Orange Red Black White Display Text Text Text Text Text Text Text Notice: The black background colour used in the colour table is only used for readability. For more colours, please visit the following link: Documentation - ifix Alarm History Viewer - Version 1.0 Seite 23 von 23
Web Portal User Guide Version 6.0 2013 Pitney Bowes Software Inc. All rights reserved. This document may contain confidential and proprietary information belonging to Pitney Bowes Inc. and/or its subsidiaries
Monitoring Network DMN User Manual Table of contents Table of contents... 2 1. Product features and capabilities... 3 2. System requirements... 5 3. Getting started with the software... 5 3-1 Installation...
Richmond SupportDesk Web Reports Module For Richmond SupportDesk v6.72 User Guide Contents 1 Introduction... 4 2 Requirements... 5 3 Important Note for Customers Upgrading... 5 4 Installing the Web Reports
GE Healthcare Life Sciences UNICORN start 1.0 User Manual Table of Contents Table of Contents 1 Introduction... 1.1 Important user information... 1.2 User documentation... 1.3 UNICORN start overview...
Powered by Table of Contents Web Mail Guide... Error! Bookmark not defined. 1 Introduction to Web Mail... 4 1.1 Requirements... 4 1.2 Recommendations for using Web Mail... 4 1.3 Accessing your Web Mail...
Yosemite Server Backup User s Guide Part number: First edition: October 2010 Legal and notice information Copyright 2004, 2012 Barracuda Networks, Inc. Under copyright laws, the contents of this document
Configuration Manager en Installation and operation manual Configuration Manager Table of Contents en 3 Table of contents 1 Using the Configuration Manager help 5 1.1 Finding information 5 1.2 Printing
TheFinancialEdge Reports Guide for Accounts Payable 041813 2013 Blackbaud, Inc. This publication, or any part thereof, may not be reproduced or transmitted in any form or by any means, electronic, or mechanical,
Installation / Backup \ Restore of a Coffalyser.Net server database using SQL management studio This document contains instructions how you can obtain a free copy of Microsoft SQL 2008 R2 and perform the
Liebert Nform Infrastructure Monitoring Software User Manual - Version 4 TABLE OF CONTENTS 1.0 ABOUT LIEBERT NFORM................................................1 1.1 How Do You Contact Emerson Network
USER'S MANUAL AXIS Camera Station About this document This manual is intended for administrators and users of AXIS Camera Station and is applicable for software release 3.40 and later. It covers configuration
IDEP FOR WINDOWS USER MANUAL Version 2011 BE National Accounts Institute National Bank of Belgium External statistics Boulevard de Berlaimont 14 B-1000 Brussels Table of contents 1 INTRODUCTION.... 1 1.1
Volunteer Impact Standard Edition Version 3.9 Administrator s Guide Revised: 15 April 2012 TELEPHONE North America: (800) 844-1545 Australia: 1-800-359-067 New Zealand: (04) 889 0403 United Kingdom: (0800)
user s manual MultiViewer Network Software For Novus Digital Multiplexers series NV-DVR900 / NV-DVR1600 TABLE OF CONTENTS 1. FOREWORD...3 1.1 Main characteristics...3 1.2 PC Hardware & Software Requirements...4
Version 10.3 End User Help Files GroupLink Corporation 2014 GroupLink Corporation. All rights reserved GroupLink and everything HelpDesk are registered trademarks of GroupLink Corporation. The information
Welcome to Tableau Server As a companion to Tableau Desktop Professional Edition, Tableau Server allows you and others to share discoveries through an interactive and collaborative web experience. People
LogMeIn Backup User Guide Contents About LogMeIn Backup...4 Getting Started with LogMeIn Backup...5 How does LogMeIn Backup Work, at-a-glance?...5 About Security in LogMeIn Backup...5 LogMeIn Backup System
Aras Corporation 2005 Aras Corporation. All rights reserved Notice of Rights All rights reserved. Aras Corporation (Aras) owns this document. No part of this document may be reproduced or transmitted in
GoldMine Premium Edition Administrator Guide Version 9.0 Rev: 90-04-26-10 5675 Gibraltar Drive Pleasanton, CA 94588 USA TEL: 800.776.7889 www.frontrange.com Copyright 2010 FrontRange Solutions USA Inc.
SEO Toolkit 2 Manual Last changed $D Table of Contents Overview...1 Features Overview...2 Program Versions...3 Licence information...4 System Requirements...5 Before Starting...6 Registering...7 Entering
Guide DonorPerfect Online SofterWare, Inc. DonorPerfect Online September 2010 Table of Contents Table of Contents INTRODUCTION...3 Choosing Email and/or Letter Receipting... 3 Workflow... 3 Regenerating
System 800xA Tools System Version 5.1 Power and productivity for a better world TM System 800xA Tools System Version 5.1 NOTICE This document contains information about one or more ABB products and may
Guide to Using AMS 4.0 Marking Software Guide to Using AMS 4.0 Marking Software Contents System Requirements...2 Software Installation...2 Selecting the Output Device and Changing Settings...2 Definitions...
NovaBACKUP User Manual NovaStor / May 2014 2014 NovaStor, all rights reserved. All trademarks are the property of their respective owners. Features and specifications are subject to change without notice.