Erroneously Large EACAA Reporting Utility (ELERT) Technical Specification Version Number 2.0
Erroneously Large EACAA Reporting Tool Technical Specification Status : Final Version : 2.0 Date : 27 June 2013 Prepared by : Cognizant Approved by (Cognizant) : Project Manager ELEXON Limited 2013 Page 1 of 13
Table of Contents 1 Introduction... 3 1.1 Purpose... 3 1.2 Scope... 3 1.3 Amendment History... 3 1.4 Summary of Changes... 3 1.5 Changes Forecast... 3 1.6 References... 3 1.7 Abbreviations... 3 1.8 Intellectual Property Rights and Copyright... 4 2 High level design specification... 5 2.1 System Overview... 5 2.2 System Architecture... 5 2.3 System Structure... 5 2.4 User Interface Overview... 5 2.5 Report Output... 7 3 Interface Specification... 9 3.1 External Interfaces... 9 3.2 Internal Interfaces... 9 4 Database specification... 10 4.1 Referenced Database Objects... 10 5 ELERT Subsystem Specification... 11 5.1 Introduction... 11 5.2 Process Description... 11 ELEXON Limited 2013 Page 2 of 13
1 Introduction 1.1 Purpose 1.2 Scope This document is the Technical Specification for the Erroneously Large EACAA Reporting Tool (ELERT). Initially, this document was created as one of the deliverables for change CP1135, included in the November 2006 Business Requirements Solution (BRS) Version Final/3.0 (Document Reference 002TBR), and carried out as part of the November 06 Release. During the Party Agent Tech Upgrade 2013, this document was updated to provide the latest software details. This document is based on the structure for a Technical Specification defined in [PDTSPD]. 1.3 Amendment History Issue Details 0.1 First draft developed for Change CP1135 for the November 06 Release. 0.2 Following review by ELEXON. 0.3 Third draft with minor correction in section 2.5.2, this now refers to section 5.2 and not 3.2.1 1.0 Final issue 2.0 CP1383 - Updated for Tech Upgrade (Oracle DB upgrade from 10.2.0.3 to 11.2.0.3 and OAS upgrade from 10.1.2.2 to 11.1.1.6) 1.4 Summary of Changes Changes as indicated in the amendment history. 1.5 Changes Forecast Agreed Change Requests will be incorporated. 1.6 References Mnemonic Information Details [CTSPEC] Title: Common Subsystems Technical Specification [ELEUSGDE] Title: Erroneously Large EACAA Reporting Tool User Guide [NTSPEC] Title: NHHDA Technical Specification 1.7 Abbreviations AA EAC Annualised Advance Estimate of Annual Consumption ELEXON Limited 2013 Page 3 of 13
ELERT NHHDA Erroneously Large EACAA Reporting Tool Non Half Hourly Data Aggregator POSIX IEEE Portable Operating System Interface for Computing Environments 1.8 Intellectual Property Rights and Copyright The copyright and other intellectual property rights in this document are vested in ELEXON. These materials are made available to participants in the GB electricity industry to review and copy for the sole purpose of their participation in the electricity industry. All other commercial use is prohibited including downloading, copying, distributing, modifying, transmitting, publishing, selling or creating derivative works (in whatever format) from this document or in other cases use for personal academic or other non-commercial purposes. All copyright and other proprietary notices contained in the document must be retained on any copy you make. All other rights of the copyright owner not expressly dealt with above are reserved. No representation, warranty or guarantee is made that the information in this document is accurate or complete. While care is taken in the collection and provision of this information, ELEXON Limited shall not be liable for any errors, omissions, misstatements or mistakes in any information or damages resulting from the use of this information or action taken in reliance on it. ELEXON Limited 2013 Page 4 of 13
2 High level design specification 2.1 System Overview ELERT is a stand-alone UNIX utility. It reports on metering systems where the EAC or AA consumption falls outside certain tolerance values specified by ELEXON. 2.2 System Architecture ELERT conforms to the System Architecture which is specified in Section 2.2 of [CTSPEC]. In summary, this comprises: Server Client POSIX compliant Operating System, with an Oracle database, and software written in Pro*C and Shell scripts. The Reporting Tool does not include any client software. The Reporting Tool does not directly communicate with any external applications. 2.3 System Structure ELERT comprises a single UNIX Pro*C executable run directly from the command line by the users. A shell script, build.sh, is included in the software supplied which contains the commands to compile the source code if necessary. The commands included are: To build the C file from the Source Code use the Oracle precompiler command: $ORACLE_HOME/bin/proc u;serid=username/password sqlcheck=full iname=report.sc oname=report.c; To build the executable from report.c use the cc command: cc o report report.c memory.c utility.c L$ORACLE_HOME/lib - Lclntsh. The utility reads a plain text configuration file to determine the consumption limits to apply and produces a report of Metering Systems with consumption outside these limits. 2.4 User Interface Overview ELERT is run directly from the UNIX command line. The command takes the form of: report config.txt [options] where report is the Pro*C executable and config.txt is the configuration file containing the limits (see Section 3.2.1). The available options are shown below. -r Resume File -u Oracle User -p Oracle Password -s Partition ELEXON Limited 2013 Page 5 of 13
-o Output File -t Run Time (minutes) For further details on these options refer to the User Guide. ELEXON Limited 2013 Page 6 of 13
2.5 Report Output ELERT displays a message on the screen indicating the version and an output file with details of Metering Systems with consumption outside the limits specified. The version of the utility supplied with the November 06 release is 1.0 as the Reporting Tool had not been formalised prior to this release. As part of June 2013 Party Agent Technology Upgrade project, the version of this utility has been upgraded to 2.0. Hence, the message displayed will be: Erroneously Large EACAA Reporting Tool version 2.0. The reports contains a header followed by a set of records in comma separated format. See below for further details. 2.5.1 Report Header The report contains a header showing the number of partitions processed, the NHHDA, and the fields for the records in the body of the report as below. 16 Partitions in the database Data Aggregator,XXXX >GSP Group ID >Supplier >Data Collector >MSID >Measurement Class >Profile Class >SSC >Effective From Date >Effective To Date >First Settlement Date Affected >Last Settlement Date Affected >EAC/AA >TPR Consumption ----------- 2.5.2 Report Body The report body comprises a set of comma separated records showing details of Metering Systems with Consumption outside certain tolerances (see Section 5.2 for Processing Details). The fields are as indicated below. Report Body (fields separated by a comma) Field Field Name Type Comments 1 GSP Group Id text(2) Introduced as part of CP1135 2 Supplier Id text(4) 3 Data Collector Id text(4) 4 Metering System Id text(13) 5 Measurement Class Id text(1) 6 Profile Class Id text(1) ELEXON Limited 2013 Page 7 of 13
Report Body (fields separated by a comma) Field Field Name Type Comments 7 Standard Settlement Configuration Id 8 Effective From Settlement Date 9 Effective To Settlement Date 10 First Settlement Date Affected 11 Last Settlement Date Affected text(4) 12 EAC or AA text date/time date/time date/time date/time 12 Time Pattern Regime Id text(5) DD-MON-YYYY DD-MON-YYYY DD-MON-YYYY DD-MON-YYYY 13 Consumption Number 6 decimal places are shown 2.5.3 Report Footer The text Processing complete is output at the end of the report to indicate it has completed successfully. ELEXON Limited 2013 Page 8 of 13
3 Interface Specification 3.1 External Interfaces 3.1.1 Report output The output from ELERT is loaded into the Large EAC/AA System (LEA) at ELEXON. 3.2 Internal Interfaces 3.2.1 Configuration File (config.txt) A configuration file, typically named config.txt, is used to determine the consumption limits applied by the Reporting Tool. The structure of this file is shown below, note that the limits shown are for illustration only and do not match those used in the production environment. # Configuration file for report.c # lines starting # are comments # # Profile Lower Upper Lower Upper # Class EAC EAC AA AA 1 0 1600-500 1600 2 0 1600-500 1600 3 0 3200-100 3200 4 0 3200-100 3200 5 0 6400-200 6400 6 0 6400-200 6400 7 0 6400-200 6400 8 0 6400-200 6400 ELEXON Limited 2013 Page 9 of 13
4 Database specification The Large EACAA Reporting Tool uses the NHHDA database. Refer to [NTSPEC] for details of the Database specification. The Reporting Tool does not update any data held in the database. 4.1 Referenced Database Objects The utility reads data from the following tables ([PartitionNo] is the partition being read): cdb_system_parameter; ndb_register_cons_[partitionno]; ndb_ms_prs_dets_[partitionno]; ndb_data_agg_apps_[partitionno]; ndb_registrations_[partitionno]; ndb_dc_apps_[partitionno]. The utility also calls the database function ndb_partition_generic.f_get_no_partitions in order to determine the number of partitions in the database. ELEXON Limited 2013 Page 10 of 13
5 ELERT Subsystem Specification 5.1 Introduction ELERT comprises a single Pro*C executable which produces a report of MSIDs with consumption outside tolerance values specified by ELEXON. No other functionality is incorporated within the tool. ELERT reads data from an NHHDA database and stores the data read within linked lists in memory for processing. No data in the NHHDA database is updated as a result of running the tool. EACs/AAs are reported where any TPR for the EAC/AA exceeds the tolerance for its Profile Class. The tolerances to be applied are determined by ELEXON. A text file held on the UNIX box in the same directory as the executable specifies the tolerances (Section 3.2.1). ELERT should apply the same aggregation rules as used by the NHHDA application to determine which EACs and AAs are considered. Only EACs and AAs which would be included in an NHHDA aggregation run should be reported. There is no specific error handling in the tool. Where an error message is generated, for example if an Oracle error is raised, this will be reported to the standard error output on the UNIX box. If no EACs or AAs outside the tolerances are found no report is produced. 5.2 Process Description The utility reads the tolerance values held in the configuration file. The The NHHDA database is then read and a list of all Metering System IDs with EACs/AAs that fall outside the minimum tolerance values for all Profile Classes determined. For example, using the tolerances specified I the configuration file in Section 3.2.1, a list of all Metering System IDs with any EACs outside the range 0-1600, or any AAs outside the range - 100 to 1600 would be obtained. The utility reads all AAs and EACs for the Metering System IDs identified. Where an MSID has two EACs for a date range, the first EAC is treated as having ended when the second one starts. If this start date is later then the end date for the first EAC then the first EAC is treated as being invalid and removed from the set of EACs/AAs considered in subsequent processing. The utility checks the remaining set of EACs/AAs and generates an exception where any TPR for the EAC/AA falls outside the tolerance for its Profile Class. The exceptions are held in a linked list in memory by the executable. The utility checks the exceptions to see if any Consumption for an appointed Data Collector supersedes that in the exception. If this is the case the exception is removed. Details of the remaining exceptions are written to the report file. ELEXON Limited 2013 Page 11 of 13
The message Processing complete is written to the report file to indicate the utility has run successfully. ELEXON Limited 2013 Page 12 of 13