Instruction Exaquantum Engineering Guide Manual Volume 1 - Administration IM 36J04A15-01E SS vigilant Exaquantum YOKOGAWA @ IM 36J04A15-01E 1 Yokogtwa Febery 202007Exaquantum Engineering Guide ~ Volume 1 i Copyright and Trademark Notices © 2007 Yokogawa Electric Comporation All Rights Reserved All rights are reserved in this document, which is the property of Yokogawa Electric Corporation. Information contained herein is the property of Yokogawa Electric Corporation. Unless agreed in writing by Yokogawa Electric Corporation, the licensee shall not remove, release, disclose, reveal, copy, and extract all or part of the documentation, Trademark Acknowledgements Exaquantum, Exaope and CENTUM are trademarks of Yokogawa. Microsoft, Window's, Windows 2000, Windows ME, Windows XP, Windows Server 2003, Microsoft Word, Microsoft Excel, Microsoft Office 97, Microsoft Office 2000, Microsoft Office XP, Microsoft Office 2003, Visual Basic, Visual C+, SQL Server and ActiveX are cither rogistered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Exaquantum uses Microsoft SQL Server as part of an Integrated Value Added Solution. Adobe and Acrobat are registered trademarks of Adobe Systems Incorporated, and registered. ‘within particular jurisdictions, Ethernet is a registered trademark of XEROX Corporation. Basic Scripting Engine provided by Cypress Software Inc... Copyright 1993 ~ 2000, all rights reserved. ‘Symantec peAnywhere is a registered trademark of Symantec Corporation. All other company and product names mentioned in this manual are trademarks or registered trademarks of their respective companies. We do not use TM or ® to indicate trademarks or registered trademarks in this manualii Contents Highlights ‘The Highlights section gives details of the changes made since the previous issue of this document ‘Summary of Changes This is the 8th Edition of the document Detall of Changes ‘The changes are as follows. Chapter/Section/Page | Change (Chapter 4 New information added. Chapter 6 New information added. TB S004A15 GHB Eon ne 1 February 38250Exaquantum Engineering Guide ~ Volume 1 Exaquantum Document Set ‘The documents available for Exaquantum are: cvmmntmnenamcrnannen | ExaquantumPIMS Users Manual (1M 36J08A11-016) ) ExaquantumExplorer Users Manual Volume 1 ‘General information (M 36J04AT201E) Exaquantum/Explorer Usor's Manual Volume 2 ‘Custom Controls (M 36404412026) [ExaquantumExplorer User's Manual Volume 3 1 ‘Mierosoft Excel Reports (M 36104412036) [ExaquantumExplorer User's Manual Volume 4 ‘Advanced Configuration (M 36J04A12-04 ‘Exaquantum inetllaon Guide (mM 36,04A15-016) ) (exaquantum API Reference Manual iM 36J04a14 018) Exaquantum Engineering Guide Volume 1 ‘Administration (M 36J08A15-016) ‘Exaquantum Engineering Gulde Volume 2 [Network Configuration (IM 36J04A15-02E) ‘Exaquantum Engineering Guide Volume 3 ‘Support Toots (IM 36J04A15-026) Exaquantum Engineering Guide Volume 4 ‘Web Authoring (M 38J08A15-046) DART SOTE Eos eT oo BETOContents Table of Contents Chapter 1 Introduction 11 Intended Audience La 12. General H Chapter 2 Aggregation and Reporting Features .. 2.1 Aggregation Characteristics 22 2.2 Hourly Aggregations 24 23. Daily Offsets 25 24 Daily Ageregations 29 25 Summation Aggregation 243 26 Differential Summation Function, 214 Chapter 3 Site Work. 3.1 Pre Installation Checklist, 31 3.2 _ Site Readiness Checklist Prior to Exaquantum Site Installation 34 33. Re-configuring Exaquantum for Site 36 Chapter 4 Normal System Operation 4.1 Health Checks AL 42. Network Connection Health Check 42 43. Windows OS in Windows Domain ~ Time Synchronisation Health Check. 43 44 Memory Usage Health Check a4 4S Database Health Check 4s 46 Live Data Feed Health Check 47 4.7 Bvent Viewer Health Check 4 48 Password Policy: 4g 49° System Back Up 410 4,10 Starting and Stopping the Exaquantum Service 431 Chapter § OPC Gateways.. 5.1 OPC Data Qualities 53 5.2 Aggregation Result Data Qualities 53 53. Calculation Result Data Quality, 54 5.4 Changing the Quality Code for a Yokogawa Exaope 55 Chapter 6 System Evolution. 6.1 OPC Server Addition 61 62 Adding Clients 61 63 Disk Space Extension 61 TB S004A15 GHB Eon ne 1 February 38250Exaquantum Engineering Guide ~ Volume 1 y Chapter 7 Trouble Shooting 71 Event Viewer. 7 72 Database Checks. 74 7.3. Problems with Fxaquantum Installation 7 Chapter 8 Extending the System.. 8.1 Configuring Custors Library forthe Server Calculations 81 82 How to Register Components 81 83. Notes on Fields of the CaleLibrary Table 82Contents ‘This page intentionally left blank TB S004A15 GHB Eon ne 1 February 38250Exaquantum Engineering Guide ~ Volume 1 1 Chapter1 — Introduction 1.1. Intended Audience ‘The Exaquantum Engineering Guide contains tasks that need to be completed by users within your organisation that have Windows administrative privileges. The user(s) ofthis document must also be familiar with the following topies 4 Windows Domain security (Users, Groups, Permissions etc) + DCOM Settings 4 Microsoft Excel + Configuring Networking components This documentation therefore assumes that the person carrying out the procedures has knowledge and experience in the areas mentioned above. It also assumes that you have already completed the relevant Exaquantum course(s). 1.2 General ‘The Engincering Guide summarises what is considered by Yokogawa as to be the ‘good or best practice’ in the operation of an Exaquantum system. It is not intended that the methods or procedures detailed in this document represent the only approach to configuring, ‘monitoring and using an Exaquantum system, but rather the procedures described are proven, practical and effective. ‘This Engineering Guide has been divided into, Volumes and Chapters that detail various procedures and methods. Certain Volumes or Chapters may not be relevant to your Exaquantum system, Volume 1: Administration Chapter 1: Introduction Chaprer 2: Aggregation and Reporting Features Chapter 3: Site Work. Chapter 4: Normal System Operation Chapter 5: OPC Gateways Chapter 6: System Evolution Chapter 7: Trouble Shooting Chapter 8: Extending the System ‘Volume 2: Network Configuration Volume 3: Support Tools Volume 4: Web Authoring12 Chapter | Introduction ‘This page intentionally left blank TB S004A15 GHB Eon ne 1 February 38250Exaquantum Engineering Guide ~ Volume 1 21 Chapter 2 Aggregation and Reporting Features ‘This section gives details about how to create reports using the Aggregation Periods Exaquantum data is available in live (updating values, useful for monitoring current situations) and historical (past values, useful for an organisation's reporting needs). Caution ‘When creating reports itis important to understand how aggregations work, as itis very easy to select the wrong date and therefore display the wrong data, This section gives details and examples of hourly and daily aggregations, showing the potential difficulties involved and how to overcome them. ‘When tag values are updating every second, a report that listed all received data for any considerable length of time would have too many values to be easily interpreted by the user. To find specific data some filtering is required, e.g. the user may only be interested in the highest value or the average value. To assist report generation, Exaquantum uses Aggregations. An aggregation looks at data over a specified time (an aggregation period) and makes calculations based only on data within that aggregation period. Typical calculations are max, min, mean and sum. ‘These calculations are made at the end of the specified aggregation period. Typical aggregation periods are hour, day and shift, These aggregation periods can be used in Microsoft Excel reports that can cover any period Note: Some useful examples of Excel report templates are supplied with Exaquantum. For more information about reports, see the ExaquantunvExplorer User's Manual (IM 36]04A 12-018), A report will simplify data extraction. ‘This is best achieved by using a specified report start date and extracting the data automatically for all the other time periods by adding an amount of time to that date. The first value in a report may be reportdate, the second reportdate n+1, the third reportdate n+2, and so on, For example, a weekly report specifies a start date of day n and the report will know that the first value for the report is that of day n, the second value that of day +1, and so on.22 Chapter 2 Aggregation and Report Features 24 Aggregation Characteristics The following points summarise the way an aggregation works: 4 Aggregations perform calculations based on all data values within a specified aggregation period. The calculation is performed after the end of the aggregation period, once all data is received 4 To ensure data from the whole time period is included, the calculation is performed up to fone minute after the end of the aggregation period to allow for late arriving data, Most aggregations arc timestamped at the end of the aggregation period. For example: Hourly aggregation from 01:00:01 to 02:00:00 will be timestamped 02:00:00. Minimum and ‘Maximum aggregations arc timestamped at the time of occurrence. © Aggregations are stored using Universal Co-ordinated Time (UTC), but 4 Data requests are made in local time. ¢ Times are translated automatically by Exaquantum, An aggregation value remains ‘current’ in history until superseded by the value of the next aggregation, For Example: Aggregated value v1 is written to history at the end of an aggregation period and identified by a timestamp of 17. When the noxt aggregation is calculated, value v2 will be given the timestamp 12. Therefore requesting the value for the timestamp #1 will roturn value v/ and a request for 12 will return v2, If a request is made between those times, then the last value written to history before that point is returned. This is important in the understanding of how aggregations work and is summarised in Figure 2-1 which behaviour when aggregations are calculated every hour: Figure 2-1 Example of Aggregations Calculated Every Hour 15 pcctt7 Value \ L-- to p----! 00:00 01:00 02:00 Time TB S004A15 GHB Eon ne 1 February 38250Exaquantum Engineering Guide ~ Volume 1 ‘Timestamp New Value Current Value 00:00 (+2) 101) 10 00:20 10 00:40 10 01:00 (12) 15 (2) 15 01:20 Is Figure 2-1 shows that a request made with a timestamp of 00:40 will return the value 23 written at 00:00. This behaviour is very useful when it comes to creating reports, as willl be explained Iter. DART SOTE Eos eT oo BETO24 Chapter 2 Aggregation and Report Features 2.2 Hourly Aggregations Hourly aggregations are normally used for daily or weekly reports It is important to understand that each hourly aggregation has a start point and an end point but is only identified by its end point. The timestamp of a value is the end of the period. For example, we will look at hourly aggregations during the day 20° January 2000. The first hourly aggregation will begin at 00-00-01 and end at 01:00:00. The timestamp attached to this aggregation will be 20/01/00 01:00:00. ‘The second aggregation will begin at 01:00:01 and finish at 02:00:00. It will have a timestamp of 20/01/00 02:00:00. This continues until 23:00:00. ‘The final aggregation of the day is slightly different from the others. It begins at 23:00:01 and ends at 00:00:00 but it has a timestamp of 21/01/00 (00:00:00. Note: This effect can be misleading, Timestamps for the end of the day should be noted carefully. Working with Hourly Aggregations in Reports Normally the user specifies the start date of the report. The report will have the different hours pre-defined, the first row will return the first value, the second row will return the second value, and so on. Note: The Daily report templates supplied with Exaquantum use this structure. These reports are example templates and must be configured to the user's exact needs. ‘There are three factors to consider when configuring a Daily report using hourly aggregations 4 Report Label Final Hour # Offset Period Understanding Report Labels Each aggregation covers a period of one hour. Each value will be identified for the report reader by a label, normally a row or column heading, e.g. 05:00. Each label on the report is normally a fixed time. This would normally either be starting at 06:00 and ending 23:00 or starting at 07-00 and ending 00:00. Either can be argued to be correct, it depends whether you wish to show the start points or the end points of each aggregation period, Whichever labelling option is used the aggregation timestamp will be the same, For both options the first period will have the TB S004A15 GHB Eon ne 1 February 38250Exaquantum Engineering Guide ~ Volume 1 25 timestamp of 01:00, This would match the Iabel in the second option which is perhaps why this option is more common. It is possible to be very accurate and label your first value (00:00-010 01:00:00 but this is not normally done. ‘The Final Hour (23:01 - 00:00) ‘The last aggregation in the day will have a timestamp of one day later than all of the others. If relative report periods are used this will not cause a problem because the report will ask for the report date + 24 hours and therefore the correct value will be provided. However if absolute report periods are used, specifying 00:00:00 on the day of the report will actually retrieve the value for the previous day Note: If absolute report periods have to be used, the final hour must have a date that is one day ahead of the report date (REPORTDATE+1), 2.3 Daily Offsets A report does not need to start or finish at 00:00, it ean start or end at any specified time This is common in organisations where a nightshift may finish early in the morning, e.g 06:00, Note: Daylight Saving Time (DST) can cause problems if the end of the daily offset is between 02:00 and 04:00. I is likely that a report would cover the period up to the end of a shift rather than divide a shift in half. In this case you will need to specify a report time as well as a report date There are two ways to achieve this in a Microsoft Excel workbook: © Direct Timestamp Entry © Offset Calculation, Direct Timestamp Entry ‘The user is normally requested to enter a date from which the hours needed for the report are calculated. Ifa day begins at 06:00, the user could be asked to enter in the full time stamp, c.g. dd/mmvyy 06:00:00. The report would then add the data for the first hour 06:01 to 07:00 to the first row and add one hour to each row after that, Note: Ensure that your report is labelled correctly, starting at 07-00 for the first hour.2-6 Chapter 2 Aggregation and Report Features Offset Calculation ‘The Direct Timestamp Entry method relies on the user including the correct timestamp when. entering the date, This is unfriendly and inefficient since the offsct will be the same cach day. To include an offset within your Excel workbook, add the cells as shown: 1 Create a cell that asks the user to input the date of the report. 2. Format this cell so that it accepts only a date (dd/mnvyy}.. Excel will add a default time portion of 00:00:00. 3. Create a second cell that defines the offset period in hours, Our example needs to add 7 hours to the original date specified. This will change it from midnight dd/mnvyy 00:00:00 to dd/mmi/yy 07:00:00 thus returning data for the period 06:00:01 to 07:00:00 4 Format this cell so that it can only contain time (bih:mm:ss) and enter 07:00:00. The cell will show 0700. Create a third cell that adds the first wo calls. 6 Format this cell so that it contains time and date (dd/mmvyy h:mm:ss). Name this cell REPORTDATE, Use REPORTDATE for the first row of data, REPORTDATE:#1 for the second, and so ‘on, Refer to the Daily report templates for more information Note I: The REPORTDATE and the offset cells should remain hidden from the user. (Hint Use font and fill of the same colour). They should also be protected so that they cannot be deleted. You may wish to place these cells somewhere aut of the way of the main report body. Note 2: Using this format the user will enter the date they are interested in; the workbook will automatically retrieve the correct values. Daylight Saving Time Daylight Saving Time (DST) can also affect reports using hourly aggregations and it is important to understand how a report can be affected. The occasions When DST causes a problem are the two days on which the local clocks change, Exaquantum uses Co-ordinated Universal Time (UTC) to timestamp values. This time is “translated? into local time so that the user sces timestamps only in their local time, For example where local time is two hours ahead of UTC, i.c, 02:00 local time is 00:00 UTC. TB S004A15 GHB Eon ne 1 February 38250