elprolog MONITOR-WebAccess Operation Manual

Transcription

1 elprolog MONITOR-WebAccess Operation Manual

2 2 - elprolog MONITOR-WebAccess

3 Table of Contents Used Symbols & Identification Codes 1. Introduction System Requirements Hosting Data Customer The Client Uses Its Own Internal Webserver The Client Uses Its Own Internal Webserver Hosting at ELPRO-BUCHS AG Installation & Configuration Installation - elprolog MONITOR-WebAccess Update - elprolog MONITOR WebAccess Installation - elprolog MONITOR-WebAccess ApplicationSettings.php General Program and Path Settings CustomSettings.php Parameters for the trend display of a single sensor Configuration - elprolog MONITOR WebUpload Configuration - elprolog MONITOR...12 FR IT IT ES ES 4. Application Functions Logger based view Sensor based view Layouts Sample.layout.php Parameter for Function: Layouts Trends Sample.trend.php Parameter for Function: Trends Alarmprotocols Representations Info Window Detail Window Indicators Line Pattern...22 elprolog MONITOR-WebAccess - 3

4 Index 5.5 Curve Colors Revision History 4 - elprolog MONITOR-WebAccess

5 Used Symbols & Identification Codes Information IMPORTANT INFORMATION OR WARNING Reference to further chapter Reference further resuming chapter [xxx / yyy / zzz; e.g Sample.trend.php Parameter for Function: Trends / Title / PC time] or document FR IT IT ES ES In the interest of our customers we reserve the right to make any changes resulting from technical advances. Therefore, schemes, descriptions and extent of delivery are subject to change without any notice! This manual is valid as of software release 2.x elprolog MONITOR-WebAccess - 5

6 Introduction 1. Introduction Version The software is delivered on a CD- ROM, labeled as follows: 2.x The ReadMe file shows the current version number of the software. elprolog MONITOR-WebAccess is used to evaluate currently measured values and states registered by elprolog MONITOR on any PC with network or internet access. To simplify the representation of the collected data, it is possible to display all the data points on building plans or photographs of local sites. 1.1 System requirements - Webserver with PHP 5.1 or higher - PC with Internet access and browser - elprolog MONITOR version 3.50 or higher. - Depending on the hosting type, elprolog MONITOR-WebUpload may be required "Administrator" rights are required to make a successful installation. 6 - elprolog MONITOR-WebAccess

7 Hosting 2. Hosting 2.1 Data 1. Computer with elprolog MONITOR and elprolog MONITOR-WebUpload. Logged data are transferred over the internal network or via FTP to the Webserver. 2. User inquiry of data on the Webserver over any Internet browser. 2.2 Customer The customer uses his/her own internal Webserver Prerequisite The scripts required for elprolog MONITOR-WebAccess are installed on the customer server. Data transfer Network The logged data are saved to the elprolog MONITOR folders. FTP Utility program elprolog MONITOR-WebUpload must be installed to enable data transfer via FTP. 3.4 Configuration - elprolog MONITOR-WebUpload Installation file on the CD: \elprolog MONITOR-WebUpload \Setup\setup.exe FR IT IT ES ES Requirements An available server with at least PHP 5.1 or higher and FTP access which is used to host elprolog MONITOR data. Administration rights for managing file authorizations and password protection. Manual installation of software elprolog MONITOR-WebAccess, 3. Installation & Configuration, (no setup, no Windows program). KNOWLEDGE OF WEBSERVER MANAGEMT IS REQUIRED. elprolog MONITOR-WebAccess - 7

8 Hosting The customer uses his/her own external Webserver Prerequisite The scripts required for elprolog MONITOR-WebAccess are installed on the customer server. Utility program elprolog MONITOR-WebUpload must be installed to enable data transfer via FTP. Configuration - elprolog MONITOR-WebUpload 3.4 Requirements An available server with at least PHP 5.1 and FTP access which is used to host elprolog MONITOR data. Administration rights for managing file authorizations and password protection. Manuelle installation of the Software elprolog MONITOR-WebAccess, 3. Installation & Configuration, (no setup, no Windows application). KNOWLEDGE OF WEBSERVER MANAGEMT IS REQUIRED. 2.3 Hosting at ELPRO-BUCHS AG Server ELPRO-BUCHS AG offers data hosting services to its customers. Prerequisite Utility program elprolog MONITOR-WebUpload must be installed to enable data transfer via FTP. 3.4 Configuration - elprolog MONITOR-WebUpload Security The Webserver with the customer data is located in a high-security data center in Switzerland. THE CUSTOMER IS NOT REQUIRED TO INSTALL THE SOFTWARE "ELPROLOG MONITOR-WEBACCESS". KNOWLEDGE OF WEBSERVER MANAGEMT IS REQUIRED. 8 - elprolog MONITOR-WebAccess

9 Installation & Configuration 3. Installation & Configuration 3.1 Installation - elprolog MONITOR-WebAccess To install elprolog MONITOR-WebAccess manually, copy all the files from the elprolog_monitor_webaccess CD into the appropriate data folder on your webserver. On the webserver, index.php should be defined as start file. 3.2 Update - elprolog MONITOR-WebAccess The following three actions have to be carried out for an update: - delete all files in the root and the directory "include" - Do not delete the directories config and data to keep the previous configuration - where appropriate add new entries in the ApplicationSettings.php manually into the already existing file 3.3 Configuration - elprolog MONITOR-WebAccess All configuration files are located in data folder "config" on the webserver. You can create any number of template files in the "config" folder. These files are recognized automatically and transferred to the menu. The easiest way to create a new layout or a new graph is to take one of the provided template files and to modify it to meet your own requirements. For the configuration of layouts and trends Sample.layout.php Parameter for Function: Layouts und Sample.trend.php Parameter for Function: Trends The file name of the template file provides the name of the layout or image respectively. Layouts and trends FR IT IT ES ES IN THIS CHAPTER " >>" MAKES REFERCE TO OTHER CHAPTERS WHICH SHOW GRAPHIC ELEMTS THAT REQUIRE PARAMETERIZATION. THE USED PARAMETERS ARE EXAMPLE VALUES ONLY ApplicationSettings.php General Program and Path Settings Comment General $Settings_GroupPath = "data/groups/"; $Settings_GroupPath = "data/groups/"; $Settings_AlarmPath = "data/alarms/"; $Settings_ApplicationHeader = "elprolog MONITOR-WebAccess"; $Settings_ApplicationLogo = "config/ ElproLogo.gif"; $Settings_Language = "English"; Group protocol Logger protocol Alarm protocol Information about path to the protocol files. All path information is relative to the WebAccess installation directory on the webserver Syntax of file path: Always end the path with / Title of the elprolog MONITOR WebAccess pages Logo file; top right Language; German, English, Françis elprolog MONITOR-WebAccess - 9

10 Installation & Configuration $Settings_SreenRefresh = 3; Screen update interval in minutes Sensor $Settings_STrend_SizeX = 800; $Settings_STrend_SizeY = 600; $Settings_STrend_Color = "#0000ff"; Length of the x-axis in pixels for a single sensor trend Length of the y-axis in pixels for a single sensor trend Curve color for the trend graph of a single sensor (default is blue, # 0000ff) >> 5.5 Curve colors Indicators $Settings_TooltipTrendNo = 50; $Settings_ArrowValues = 3; $Settings_ArrowValues = 10; Number of measured values used to represent the measured value trend graph in the detail window >> 5.2 Detail window Number of measured values used to calculate the trend arrow >> 5.3 Indicators Measured value is marked outdated if it is older than this timespan (in minutes). Additional representation parameters $Settings_ArrowValues = 3; $Settings_StartpageName = "My Layout" First page which is displayed by elprolog MONITOR- WebAccess at start: 1 = Logger based view 2 = Sensor based view 3 = Layout 4 = Trend Name of the group, layout or trend, that should be showen at start (without any extensions like ". csv", ". trend.php" etc.) CustomSettings.php Parameters for the trend graph of a single sensor Example of the settings of a sensor Comment Size and color of the graphic >> 4.5 Trends $Custom_SizeX["LLLLL_S"] = 1200; $Custom_SizeX["LLLLL_S"] = 400; $Custom_BackgroundColor["LLLLL_S"] = "#c0ffc0"; $Custom_GridColor["LLLLL_S"] = "#ffffff"; Length of x-axis in pixels Corresponds to the width of the trend graphic Length of y-axis in pixels Corresponds to the height of the trend graphic Background color of the trend graphic >> 5.5 Curve colors Color of the grid line in the trend graphic >> 5.5 Curve colors Curve definitions 10 - elprolog MONITOR-WebAccess

11 Installation & Configuration $Custom_SizeX["LLLLL_S"] = 0; $Custom_YAxisMin["LLLLL_S"] = 0; $Custom_LineColor["LLLLL_S"] = "#000000"; $Custom_LineWeight["LLLLL_S"] = 3; $Custom_YAxisLabel["LLLLL_S"] = "Temperature [ C]"; y-axis maximum value y-axis minimum value Trend line color >> 5.5 Curve colors Trend line weight y-axis label / unit Example: Temperature C Limit value Limits are always based on the y-axis. 2 independent limit values could be defined. $Custom_UpperLimit1Value["LLLLL_S"] = 30; $Custom_UpperLimit1Color["LLLLL_S"] = "#ffc0c0"; $Custom_UpperLimit1Pattern["LLLLL_S"] = BAND_RIDIAG; $Custom_LowerLimit1Value["LLLLL_S"] = 20; $Custom_LowerLimit1Color["LLLLL_S"] = "#ffc0c0"; $Custom_LowerLimit1Pattern["LLLLL_S"] = BAND_RIDIAG; $Custom_UpperLimit2Value["LLLLL_S"] = 35; $Custom_UpperLimit2Color["LLLLL_S"] = "#ff8080"; $Custom_UpperLimit2Pattern["LLLLL_S"] = BAND_SOLOD; $Custom_LowerLimit2Value["LLLLL_S"] = 15; $Custom_LowerLimit2Color["LLLLL_S"] = "#ff8080"; $Custom_LowerLimit2Pattern["LLLLL_S"] = BAND_SOLOD; Limit value 1 Upper limit value 1 Line color >> 5.5 Curve colors BAND_RIDIAG >> 5.4 Line Pattern Lower limit value 1 Line color >> 5.5 Curve colors BAND_RIDIAG >> 5.4 Line Pattern Limit value 2 Upper limit value 2 Line color >> 5.5 Curve colors BAND_SOLOD >> 5.4 Line Pattern Lower limit value 2 Line color >> 5.5 Curve colors BAND_SOLOD >> 5.4 Line Pattern FR IT IT ES ES Definition of: ["LLLLL_S"] - "LLLLL" is the logger ID - "S" is the sensor number elprolog MONITOR-WebAccess - 11

12 Installation & Configuration 3.4 Configuration - elprolog MONITOR-WebUpload Installation file on the CD:elproLOG MONITOR- WebUpload \Setup\ setup.exe After the installation, the following parameters can be configured: - FTP access data - Local paths for protocol files (as configured in elprolog MONITOR ) - Paths on the webserver Detailed information Operating Instructions elprolog MONITOR-WebUpload, SM3001E 3.5 Configuration - elprolog MONITOR These data (protocols) are the prerequisites for faultless functioning of elprolog MONITOR- WebAccess! The following 3 protocols must be activated in protocols must be activated in elprolog MONITOR: - Group protocol - Logger protocol - Alarm protocol A SEPARATED FOLDER MUST BE CREATED FOR EACH PROTOCOL. "ELPROLOG MONITOR-WEBACCESS" REQUIRES CONSTANT ACCESS TO THESE PROTOCOL FILES. Detailed information Operating Instructions elprolog MONITOR, SM3001E 12 - elprolog MONITOR-WebAccess

13 Application 4. Application 4.1 Functions Die folgenden Funktionen stellen elprolog MONITOR-WebAccess für die Auswertung der Daten zur Verfügung: 1. Logger based view All the information is shown in tabular form with the data logger name in the first column 2. Sensor based view All the information is shown in tabular form with the sensor name in the first column 3. Layouts Information about the position of the data points 4. Trends Graphical representation of the measured values 5. Alarmprotocols Information about exceptional events such as threshold violations, sensor errors... The mouse pointer on the info window opens the detail window. Click on the Info window to open the screen displaying trend graphs for the measured values ; 4.5 Trends. FR IT IT ES ES 4.2 Logger based view 1. Data logger name and status in accordance with definitions in elprolog CONFIG, as well as ID number of the data logger 2. Info window 5.1 Info window 3. Name of alarm contact D2 in accordance with definition in elprolog CONFIG 4. Status of the digital input D2 5. Inactive function elprolog MONITOR-WebAccess - 13

14 Application 4.3 Sensor based view 1. Sensor name in accordance with elprolog CONFIG Select the detail window with the cursor 5.2 Detail window By left-clicking the display changes to full screen mode 4.5 Trends 2. Measured value 3. Data logger name in accordance with elprolog CONFIG 4. ID number of data logger 5. Sensor number of data logger 14 - elprolog MONITOR-WebAccess

15 Application 4.4 Layouts 1. Indicator 2. Info window Building plan with indicators and Info / Detail windows FR IT IT ES ES 1. Info window 2. Detail window Photograph with Info / Detail window elprolog MONITOR-WebAccess - 15

16 Application Sample.layout.php Parameter for Function: Layouts Comment XXXXXX.layout.php File name XXXXXX corresponds to the title in the Layout menu. Comments may be separated by // (two) and added separately. Sensor $Layout_LoggerID[0] = 12345; $Layout_SensorNo[0] = 1; $Layout_XPos[0] = 500; $Layout_YPos[0] = 100; $Layout_Type[0] = 0; $Layout_TypeOption[0] = 12; Logger ID Sensor no x-position in pixel of the sensor in the layout x-position in pixel of the sensor in the layout Type of indicator which is used for sensor representation. The following types are available: 0 = Small Indicator 1 = Full Indicator 2 = Medium Indicator 3 = Large Indicator 4 = Complete Indicator 5 = Value Only 6 = Time Only 7 = Sensor Name Only 8 = Full Indicator With Time Example and illustration of the indicators >> 5.3 Indicators Used font size [0] The number in the square brackets [ ] must be increased by 1 for each further sensor. Initial value for the first Sensor is [0]. Background image $Layout_Background = "config/ SampleBackground.gif"; $Layout_BackgroundSizeX = 960 $Layout_BackgroundSizeY = 720 $Layout_BackgroundOffsetX = 0 $Layout_BackgroundOffsetY = 100 Background image with path These parameters are used to define the size and position of the backround image. x/y-size in pixel of the background image. x/y-position in pixel of the background image. Additional pictures in the layout $Layout_Image[0] = "config/ ElproLogo.gif" $Layout_ImageOffsetX[0] = 25 $Layout_ImageOffsetY[0] = 20 $Layout_ImageSizeX[0] = 900 $Layout_ImageSizeY[0] = 400 $Layout_ImageLink[0] = " Image with path These parameters are used to define the size and position of additional images. ImageOffset: x/y-position in pixel of the image. ImageSize: x/y-size in pixel of the image. URL to destination page 16 - elprolog MONITOR-WebAccess

17 Application $Layout_ImageTooltip[0] = "Go to ELPRO Homepage" Optional information when mouse is over the image in the layout. [0] The number in the square brackets [ ] must be increased by 1 for each further image. Initial value for the first image is [0]. 4.5 Trends Chart with several curves FR IT IT ES ES elprolog MONITOR-WebAccess - 17

18 Application Sample.trend.php Parameter for Function: Trends Example of a custom view (taken from the sample file) XXXXXX.trend.php Comment File name XXXXXX is also the title of the trend shown in menu. Comments may be separated by // (two) and added separately. Example: xxxxxxxxx // Comment Size of the chart $Trend_SizeX = 1000; $Trend_SizeY = 700; Length of x-axis in pixels Corresponds to the width of the trend graphic Length of y-axis in pixels Corresponds to the height of the trend graphic Optional color settings $Trend_BackgroundColor = "#000000"; $Trend_GridColor = "#ffff00"; Sensor $Trend_LoggerID[0] = 1234; Background color of the trend graphic >> 5.5 Curve colors Color of the grid line in the trend graphic >> 5.5 Curve colors Logger ID $Trend_SensorNo[0] = 1; Sensor no 1 till no 8 Digital input 1 and 2 are sensor No 9 and 10 $Trend_Color[0] = "#0000ff"; Trend line color >> 5.5 Curve colors [0] The number in the square brackets [ ] must be increased by 1 for each further sensor. Initial value for the first Sensor is [0]. Optional curve definitions $Trend_YAxisMin[0] = -20; $Trend_YAxisMax[0] = 40; $Trend_YAxisLabel[0]= "Temperature [ C]"; $Trend_LineWeight[0] = 3; Manuelle scaling of the y-axis; minimum value Manuelle scaling of the y-axis; maximum value y-axis label / unit Example: Temperature [ C] Trend line weight [0] The number in the square brackets [ ] must be increased by 1 for each further trend. Initial value for the first Sensor is [0]. Limit value Limits are always based on the y-axis Limit value 1 $Trend_UpperLimit1Value = 15; Upper limit value 1 $Trend_UpperLimit1Color = "#ff8000"; Line color >> 5.5 Curve colors 18 - elprolog MONITOR-WebAccess

19 Application $Trend_UpperLimit1Pattern = BAND_RDIAG; BAND_RDIAG >> 5.4 Line Pattern $Trend_LowerLimit1Value = 5; Lower limit value 1 $Trend_LowerLimit1Color = "#ff8000"; $Trend_LowerLimit1Pattern = BAND_RDIAG; Line color >> 5.5 Curve colors BAND_RDIAG >> 5.4 Line Pattern Limit value 2 $Trend_UpperLimit2Value = 25; Upper limit value 2 $Trend_UpperLimit2Color = "#ff8000"; $Trend_UpperLimit2Pattern = BAND_SOLID; Line color >> 5.5 Curve colors BAND_SOLID >> 5.4 Line Pattern $Trend_LowerLimit2Value = 0; Lower limit value 2 $Trend_LowerLimit2Color = "#ff8000"; $Trend_LowerLimit2Pattern = BAND_SOLID; Line color >> 5.5 Curve colors BAND_SOLOID >> 5.4 Line Pattern FR IT IT Diese Parameter werden nur zur Darstellung einer Grafik mit mehreren Sensoren benötigt. 4.6 Alarm Protocols ES ES 1. PC time when event occurred 2. Data logger time when event occurred 3. Information accordance with elprolog MONITOR 4. Sensor name in accordance with elprolog CONFIG 5. Data logger name in accordance with elprolog CONFIG 6. Name of group files in accordance with elprolog MONITOR 7. ID number of data logger 8. Sensor number of data logger elprolog MONITOR-WebAccess - 19

20 Representation 5. Representation 5.1 Info window 1. Data logger name with "full indicator" and "full indicator with time" as defined in elprolog CONFIG Select the detail window with the cursor 5.2 Detail window By left-clicking the display changes to full screen mode 4.5 Trends 2. Last measured value with trend arrow 3. Date and time 5.2 Detail window 1. Data logger name and status (complete indicator) in accordance with definitions in elprolog CONFIG as well as ID number of data logger 2. Sensor name and status (complete indicator) in accordance with definitions in elprolog CONFIG as well as sensor number of data logger 3. Last measured value with date, time and trend arrow 4. Trend curve By left-clicking the display changes to full screen mode 4.5 Trends 5.3 Indicators To represent sensor positions, indicators could be positioned in a layout elprolog MONITOR-WebAccess

21 Representation Status okay No alarm; external contact at the digital input / status message Trend arrow Acknowledged Deactivated; sensor or data logger / status message Communication error / status message No connection / status message Battery low Warning Sensor error; nc, uf, of / status message Alarm; limit value violation Alarm; external contact at the digital input / status message By cursor selecting an active trend indicator the detail window will be displayed 5.2 Detail window By left-clicking on the indicator the display changes to full screen mode 4.5 Trends Example of a confirmed message Alarm confirmed FR IT IT ES ES For the position parameters 3.3 Configuration - elprolog MONITOR-WebAccess Demo of the indicators - Layouts - Sensor Display Examples 1 and 2. elprolog MONITOR-WebAccess - 21

22 Representation 5.4 Line Pattern BAND_RDIAG = Right diagonal lines BAND_LDIAG = Left diagonal lines BAND_SOLID = Solid one color BAND_VLINE = Vertical lines BAND_HLINE = Horizontal lines 22 - elprolog MONITOR-WebAccess

23 Representation BAND_HVCROSS = Vertical/Hor crosses BAND_DIAGCROSS = Diagonal crosses FR 5.5 Curve colors At the following link, you find the tool shown below which is used for selecting the colors and setting the corresponding codes. Examples of colors IT IT red: bf green: 00b100 blue: 0000ff ES ES 1. This code is used as curve color elprolog MONITOR-WebAccess - 23

24 Representation Index A Alarmp protocol 12, 13, 19 ApplicationSettings.php 9 C CustomSettings.php 10 D Representation 6, 15, 20 Representation - Symbols 21 E elprolog MONITOR 12 elprolog MONITOR WebUpload 8, 12 F Functions 13 G Group protocol 12 I Indicator 20 Installation 6 K Configuration - elprolog MONITOR 12 Configuration - elprolog MONITOR-WebAccess 9 Configuration - elprolog MONITOR-WebUpload 12 L Layout 13, 16, 20 Logger based view 13 Logger protocol 12 M Measured values 14, 20, 21 P PHP 5 8 Protocols 12 S Sample.layout.php 16 Sample.trend.php 18 Sensor based view 13, 14 T Trends 13, 17 W Webserver 7, 8 Revision History Author Date Version Description A. Gubler st edition A.Gubler a several changes 24 - elprolog MONITOR-WebAccess

25 Representation FR IT IT ES ES elprolog MONITOR-WebAccess - 25

26 (Head Office) ELPRO-BUCHS AG Langäulistrasse 62 CH-9470 Buchs SG Switzerland For local representatives see: Operation Manual elprolog MONITOR-WebAccess