MMS DATA SUBSCRIPTION SERVICES USER INTERFACE GUIDE

Transcription

1 MMS DATA SUBSCRIPTION SERVICES USER INTERFACE GUIDE VERSION: 2.01 DOCUMENT REF: PREPARED BY: MMSTDPD69 EMD DATE: 16 February 2010 Final

2 Copyright Copyright 2012 Australian Energy Market Operator Limited All rights reserved. This entire publication is subject to the laws of copyright and intellectual property rights. This publication may be printed for personal informational use as long as the copyright notices stay intact, but may not be re-distributed, re-sold, reproduced, stored in a retrievable system or transmitted in any form by any means, electronic, mechanical, photocopying, recording or otherwise, without the prior permission of the Australian Energy Market Operator Limited, except as permitted under the Copyright Act AEMO is not responsible for and will not be liable to any person in relation to the use of or reliance on any of the information contained in this document. Trademark Notices Microsoft, Windows and SQL Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Disclaimer This document is made available to you on the following basis: 1. Purpose - This document is provided to you for information purposes only. You are not permitted to commercialise it or any information contained in it. 2. Reliance - This document may be subsequently amended. Any reliance on this document is at your own risk. 3. Intellectual Property Australian Energy Market Operator (AEMO) is the owner of the copyright in this document. All rights are reserved. All material is subject to copyright under the Copyright Act 1968 (Commonwealth) and permission to copy it, or any parts of it, must be obtained in writing from AEMO. AEMO is the owner of all other intellectual property rights in this document and the information contained in it. You must not in any way, or by any means, store, reproduce or modify it without AEMO's express written consent. 4. No Warranty - Neither AEMO, nor any of AEMO advisers, consultants or other contributors to this document (or their respective associated companies, businesses, partners, directors, officers or employees) make any representation or warranty, express or implied, as to the currency, accuracy, reliability or completeness of this document, or the information contained in it. 5. No Liability - To the maximum extent permitted by law, neither AEMO, nor any of its advisers, consultants or other contributors to this document (or their respective associated companies, businesses, partners, directors, officers or employees) shall have any liability (whether arising from negligence or otherwise) in respect of your use of the information (including any reliance on its currency, accuracy, reliability or completeness) contained in this document. Distribution Commercial-in-confidence with NEM Participants This Document Identification Title: MMS DATA SUBSCRIPTION SERVICES USER INTERFACE GUIDE Version: 2.01 Document ID: MMSTDPD69 Responsible Department: EMD Notes: Documents made obsolete: The release of this document changes only the version of the MMS DATA SUBSCRIPTION SERVICES USER INTERFACE GUIDE. No documents are made obsolete by releasing this document.2.01 Version Release History Version Date By Notes Feb. 10 EMD Final Doc Ref: MMSTDPD69 v February 2010 Page ii

3 Contents 1 Introduction Purpose Audience Scope What s in this guide Related resources Organisation Conventions Context What Data Subscription Services is for How do you use Data Subscription Services Who can use Data Subscription Services Data Subscription Services requirements Accessing Data Subscription Services Viewing About Data Subscription Managing Data Model Changes and Subscriptions The Data Model Changes screen Downloading the current MMS Data Model Script Downloading the current version of the Data Model Loader Configuration Files Subscribing to all current MMS Data Model files not already subscribed to Subscribing to newly-offered Data Model files Subscribing to current MMS Data Model files that replace previous versions Unsubscribing from legacy files Subscribing To Files Viewing files available for subscription Filtering or searching for files Example searches Filtering by Collection and Package Viewing further file information Subscribing Viewing Subscribed to Files Unsubscribing From Files Viewing the MMS Data Catalogue...42 Doc Ref: MMSTDPD69 v February 2010 Page iii

4 9 Glossary Abbreviations Special Terms References...45 Doc Ref: MMSTDPD69 v February 2010 Page iv

5 1 Introduction 1.1 Purpose This document is a user interface guide providing instructions for using the Data Subscription Services interface of the Market Management Systems (MMS) Web Portal. 1.2 Audience The audience for this guide is: Registered NEM Data Subscription participants Data Subscription Agents as authorised by the registered participant AEMO 1.3 Scope This guide covers use of the Data Subscription Services menu options of the MMS Web Portal only. This guide does not include information about: how to use other menu options on the MMS Web Portal Refer to the relevant About section of the MMS Web Portal for information on other user interface guides and documentation. the content of the files that can be subscribed to using this application how to use the scripts to set up your own database or configure your pdrloader application how to obtain access to the software from within your organisation, see your organisation s participant administrator how to register for access to the MMS Data Subscription Services how to provide other users with access to your participant data at AEMO how to log in or out of the MMS Web Portal Refer to the References section on page 45 or the Related resources section on page 1 of this document for help with the above What s in this guide This guide describes how to: Download scripts to create or upgrade databases based on the current version of the MMS Data Model. Download the MMS Data Model Loader Configuration files to set up or upgrade the pdrloader configuration. Manage subscriptions to the files required to populate the MMS Data Model and other files of MMS-related data provided by AEMO that aren t part of the MMS Data model Related resources The resources listed in this section contain additional related information that may assist you. It is important to ensure that you are reading the current version of any document. MMS Data Interchange Guide Contains an overview of: Doc Ref: MMSTDPD69 v February 2010 Page 1

6 o the components for managing, monitoring and replicating data between AEMO s Wholesale Market Management Systems (MMS) and a NEM Participant Wholesale Market Data Store conforming to MMS Data Model (Participant MMS Database) o the AEMO-supported replication mechanism applicable to MMS, being Participant Data Replication (PDR) o subscribing to a data feed from AEMO, including files conforming to the MMS Data Model MMS Data Model Report Available from the AEMO website and in each MMS Data model script zip file, this document contains a detailed description on the structure and content of the MMS Data Model. It is organised by package, and for each package contains: o a summary list of the tables that make up the package, together with a brief description o entity diagrams, that show the relationship between the tables in the package o for each table, information about the source of the data, its visibility (whether the data is public or private), primary key columns, index columns, and a detailed description of each data item in the table MMS Data Model Package Summary Summarises the MMS Data Model report. For each package, it lists the tables in the package, together with a brief summary, and entity diagrams, available from the AEMO website and in each MMS Data model script zip file. MMS Data Model Implementation Note Contains detailed instructions on the setup of a database based on the MMS Data Model, available in each MMS Data model script zip file. MMS Data Model Upgrade Report Contains, for any version, a full description of any tables that have changed in that version and are available in each MMS Data model script zip file. MMS Data Model Loader Configuration Implementation Note Contains instructions for installing pdrloader configuration files, available in the MMS Data Model Loader Configuration zip file. MMS Replication Overview Contains an overview of the data replication process in the MMS systems. Replication Manager User Guide Contains general installation instructions, plus a detailed description of the user interface, for the Replication Manager product provided by AEMO. Participant Data Replication Loader User Guide Contains detailed instructions on options for setup and configuration of the pdrloader application 1.4 Organisation The guide is organised in the following way: Section 1 is an introduction to Data Subscriptions Services. Section 2 provides an overview of Data Subscriptions Services. Section 3 explains how to access the Data Subscription menu options of the MMS Web Portal. Doc Ref: MMSTDPD69 v February 2010 Page 2

7 Section 4 explains how to use the Data Model Changes section of Data Subscriptions Services. Section 5 explains how to subscribe to files. Section 6 explains how to view files you are subscribed to. Section 7 explains how to unsubscribe from files. Section 8 explains how to view the MMS Data Catalogue. Sections 9 and 10 provide a glossary and further references Conventions Conventions used to highlight important or useful information are: Important Note: important information. Note: notes, hints and tips. Doc Ref: MMSTDPD69 v February 2010 Page 3

8 2 Context 2.1 What Data Subscription Services is for AEMO provides several methods by which NEM participants can obtain market data generated by AEMO s MMS suite of applications. The most common method is by: 1. Obtaining the MMS data model scripts from the MMS Data Subscription Services for building and maintaining your own local database. Scripts are currently available for: o Microsoft SQL Server 2000 o Microsoft SQL Server 2005 o Oracle 9i o Oracle 10g The MMS Data Model is an industry standard database definition supplied and maintained by AEMO. It includes the database tables, indexes and primary keys. 2. Subscribing to the files containing the data you need, which you use to populate your local database. 3. Unsubscribing from any files that are no longer required. AEMO also makes available a small number of additional files that are not supported by the MMS Data Model. That is, the data model does not define tables for storing the data provided in these additional files. The MMS Data Subscription Services application also allows participants to subscribe and unsubscribe to these additional files. In the past, participants needed to contact the AEMO help desk to subscribe to or unsubscribe from receiving files. The MMS Data Subscription Services application allows participants to manage this for themselves. To assist with this management, the MMS Data Subscription Services application also has tools that allow participants to: View a catalogue of all available files. Easily identify the files they are currently subscribed to. For some file types, download sample files. 2.2 How do you use Data Subscription Services The MMS Data Model is updated in line with the release process for the MMS software. The MMS software release cycle is normally six monthly, and usually, in association with each release; there will also be changes to the MMS Data Model (e.g. new tables and/or new columns added to existing tables). Typically, you use the MMS Data Subscription Services in conjunction with the six monthly release cycle. To set up a database for the first time, you use the MMS Data Subscription Services to: Download the applicable current version of the MMS Data Model and use the scripts and information provided to create the database. Download the MMS Data Model Loader (Parser) Configuration file which is used to configure the pdrloader application to be able to read the MMS data files into the database. Subscribe to the files you need to populate your local database. Then, each six months after the release of the latest version of the MMS Data model, you use the MMS Data Subscription Services to: Doc Ref: MMSTDPD69 v February 2010 Page 4

9 o Download and then apply scripts to upgrade the existing database to the latest version of the MMS Data Model. o Download and install any new and updated MMS Data Model Loader (Parser) Configuration files. o Check to see whether there are any new files to subscribe to and, if necessary, subscribe to those files. o Check to see whether there are any redundant files that can be unsubscribed and, if there are any, after parsing the new version of the file at least once and loading data into the database, unsubscribe from the legacy files. MMS Data Subscription Services only provides access to the files you need to upgrade from the immediate previous version of the MMS Data Model to the current version. If you are upgrading from a version prior to the immediate past version, you will need to obtain the files needed to get to the immediate past version from the releases share on the participant file server. Note: participants also have access to Replication Manager, a Windows-based application, which is run locally at their own site. It enables you to activate or deactivate the loading of.csv files into the local MMS Data Model database. Refer to the Related resources section on page 1 of this document for information regarding the Replication Manager User Guide. It s important to note that this activation and deactivation is a different process from the subscribing and unsubscribing to file delivery through the MMS Data Subscriptions Services. Subscribing to a file through the MMS Data Subscriptions Services causes the file to be delivered to the participant site. However, for it to be loaded into the local database it must also be activated using the locallybased tool. Similarly, deactivating the loading of files into the database does not stop the delivery of the files. They will simply not be loaded. You need to unsubscribed using the MMS Data Subscriptions Services to stop the file being delivered. The AEMO systems keep an online archive of all generated files to which a participant is subscribed. If a participant deactivates a file load without unsubscribing, then that file will continue to be maintained in the AEMO archive and can be retrieved (and loaded into the local database) at a later date. If however, a participant unsubscribes from a file, then it is not possible at some time in the future for them to retrieve and load the file. Historical retrieval of a file requires a customised data extract which is a time-consuming process. File deactivation rather than unsubscribing therefore gives a participant greater flexibility in terms of access to historical data. 2.3 Who can use Data Subscription Services Users having access to the Data Subscription Services of the MMS Web Portal include: Registered NEM Data Subscription participants Data Subscription agents as authorised by the registered participant AEMO 2.4 Data Subscription Services requirements Data Subscription Services is part of AEMO s market software solution. It is accessed by using a Web browser. To use Data Subscription Services you will need: Microsoft Internet Explorer version 6 or later, although the recommended version is Microsoft Internet Explorer 7 a monitor capable of 1024 x 768 screen resolution access to NEMNet the URL of the website where the application is located on AEMO s network Doc Ref: MMSTDPD69 v February 2010 Page 5

10 A user ID and password provided by your system administrator, which is set up to have access to the MMS Data Subscription Services options. User accounts are created in the MSATS system. Doc Ref: MMSTDPD69 v February 2010 Page 6

11 3 Accessing Data Subscription Services This section assumes that you have already logged into the MMS Web portal, refer to the Web Portal Login User Guide if you require help to log in. The Data Subscription menu item on the MMS Web Portal is used to access the functions described in this document. To see the list of available options Place your cursor over the Data Subscription menu item. If you attempt to access any of these options when you are not acting for a registered Data Subscription service you can expect to see a warning, as follows: 3.1 Viewing About Data Subscription The About Data Subscription option contains a brief explanation of the Data Subscription Services. To view About Data Subscription 1. Place your cursor over Data Subscription. 2. Click About Data Subscription. Doc Ref: MMSTDPD69 v February 2010 Page 7

12 3. A window displays similar to the one below, providing a summary of the Data Subscription Services. Doc Ref: MMSTDPD69 v February 2010 Page 8

13 4 Managing Data Model Changes and Subscriptions This section of the guide assumes that you have already logged on and have displayed the Data Subscriptions menu option; for help refer to Accessing Data Subscription Services on page 7. Data Subscription services is designed so most functions can be performed by selecting the Data Model Changes menu. The Data Model Changes section only supports the management of subscriptions to files provided with the current and most recent version of the MMS Data Model. From this screen you can perform all the functions you need to maintain an existing local database based on the MMS Data Model up to date or to create and populate a database from scratch. You can: Download the current version of the MMS Data Model for the applicable database product to your desktop Download the current version of the Loader configuration files Manage subscriptions to files, including subscribing to new files and unsubscribing from redundant files once you have successfully loaded data from the files that replaced them 4.1 The Data Model Changes screen To view the Data Model Changes screen 1. On the Data Subscription menu, click Data Model Changes. 2. The Data Model Files Subscription screen displays. An example is shown below, although the latest version number changes with each update to the data model. The text in the Note at the top of the screen is updated with each release of the MMS Data Model. It always indicates the most recent version number, i.e. the one that can be downloaded using this option, and the previous version number. Doc Ref: MMSTDPD69 v February 2010 Page 9

14 This image was captured in December 2009, at which time version 4.12 was the current version, released in conjunction with the end of the 2009 release of MMS, and version 4.11 is the version it replaced. 4.2 Downloading the current MMS Data Model Script Only the most recent version of the MMS Data Model scripts are available via the MMS Data Subscriptions Service. They are contained in a zip file, which also includes documentation. Note: earlier versions are available in the Releases folder on the participant file share. At present, four database systems/versions are supported: Microsoft SQL Server 2000 Microsoft SQL Server 2005 Oracle 10g Oracle 9i To download the MMS Data Model script 1. On the Data Model Changes screen, click the link for the relevant database, e.g. in this example to download the scripts for Oracle 10g, click Get MMS Data Model Oracle10g v zip. 2. Depending on your PC s settings, you may see this screen. If you do, click Save to save the zip file. Doc Ref: MMSTDPD69 v February 2010 Page 10

15 3. Select a suitable local folder to save the file and then click Save again. When the zip file has downloaded you will see a message similar to the following: 4. When the download is finished, if you want to view or open the contents of the file, click Open Folder. 5. The folder where you saved the file opens and you can open the zip file to view its contents or extract all the files. The image above shows the contents of the zip file for Oracle 10g for version 4.9 of the MMS Data Model. Note that, as well as the required SQL scripts and batch files, the zip file includes the following key pieces of documentation: o MMS Data Model Installation Note o MMS Data Model Package Summary o MMS Data Model Report o MMS Data Model Upgrade Doc Ref: MMSTDPD69 v February 2010 Page 11

16 There is also a README file to read prior to starting any installation. 6. Having downloaded the relevant zip file you can do the following: o Upgrade an existing database or, if you are a new participant, create a new database using the files just downloaded o Download and install the relevant Data Model Loader Configuration files (see Downloading the current version of the Data Model Loader Configuration Files on page 12.) 7. You can now subscribe to any new files. If You subscribe to all available files You only subscribe to a subset of files Do this See Subscribing to all current MMS Data Model files not already subscribed to on page 14. First, choose the: See vn.n files not previously offered (and not already subscribed to) option to see the brand new files available with the new version of the MMS Data Model. (Unlike the first option, this option only lists new files, you haven t subscribed to, not all files you aren t subscribed to.) See Subscribing to newly-offered current MMS Data Model files not already subscribed to on page 20. Then choose the: See vn.n files that should replace previous versions that are currently subscribed to) option to see a list of new files that supersede previous files that you have currently subscribed to. See Subscribing to current MMS Data Model files that replace previous versions on page 23. Note: once any new files that replace existing files have been successfully processed at least once, any files that are being replaced can be unsubscribed. See Unsubscribing from legacy files on page 25. All of the above tasks can be managed from the Data Model Changes screen. 4.3 Downloading the current version of the Data Model Loader Configuration Files The MMS Data Model Loader Configuration zip file contains the configuration files that allow the pdrloader to read the data files into a database based on the MMS Data Model. Within the downloaded file there is a zip file containing the data required for setting up initial configuration files and a zip file containing the files required to upgrade an existing configuration. Doc Ref: MMSTDPD69 v February 2010 Page 12

17 To download the current version of the MMS Data Model Loader configuration 1. On the Data Model Changes screen, click the link to the loader configuration zip file. In the example below the file is Get MMS_Data_Model_Parser_Configuration_v4.9.1.zip. Note: the only version of the loader configuration available via the MMS Data Subscriptions Service is the most recent version. 2. Depending on your PC s settings, you may see this screen. 3. Click Save to save the zip file. 4. Select a suitable local folder to save the file and then click Save again. When the zip file has been downloaded you will see a message similar to the following: Doc Ref: MMSTDPD69 v February 2010 Page 13

18 5. When the download is finished, if you want to view the contents of the file, click Open Folder. 6. The folder where you saved the file opens for you to view the contents or extract the zip file. The image below shows the contents of the zip file for version of the Parser Configuration. As well as zip files that contain the files needed to do a complete configuration or to upgrade the existing configuration, there is also a documentation file the MMS Data Model Loader Configuration Implementation Note and a README.txt file that is read prior to starting any installation. 4.4 Subscribing to all current MMS Data Model files not already subscribed to This option is particularly useful for organisations that fully subscribe to all the available files for populating a local database based on the MMS Data model. It s designed for use whenever a new version of the MMS Data Model is released. It lists all the new files you need to subscribe to, including files that replace existing files. Note: it may not be the best option to use if your organisation only subscribes to a subset of the available data (e.g. only some of the packages) and they intend to continue this way. This is because as well as listing all the new files and any current version files that replace files currently subscribe to, it lists all the files not currently subscribed to and you previously decided not to subscribe to. This is also a useful option to use at any time if you were previously subscribed to a subset of data but have now decided to subscribe to the full MMS Data Model data set, as recommended by AEMO. Doc Ref: MMSTDPD69 v February 2010 Page 14

19 To see current version files that you have not subscribed to 1. On the Data Model Changes screen, click the See vn.n files that have not been subscribed to yet link. 2. The Subscribe Data Model Files screen displays the list of available files. It will look similar to the following example but the file names will be different. By default, all available files are selected. o The list contains all files available for the current version that you have not subscribed to. It includes new and replacement files and any other files. o The list represents the incremental file subscriptions you need to apply to your existing set of file subscriptions to have full coverage of the current MMS Data Model. o If you were fully subscribed to the previous version, it represents the new and replacement files added with the current version. o If you were not fully subscribed to all files from the previous version, it represents the new and replacement files added with the current version and any other unchanged files that you are currently not subscribed to. Doc Ref: MMSTDPD69 v February 2010 Page 15

20 If you see a screen that looks like this, it means that you are already fully subscribed to all available data model files. The information displayed about each file is described in the following table. Column Name Description DM Identifier (Data Model Identifier) Identifier Description If this is ticked, then the file will be subscribed to when you click Subscribe. A description of the contents of the file. The external name of the file, i.e. the name that is used as part of the published file name. The name that is internal to the MMS System that identifies the source of the data published in this file. To view additional information about the selected files 1. Click View Detail. Doc Ref: MMSTDPD69 v February 2010 Page 16

21 2. A description of the selected files displays with the internal identifier in the header and then the MMS Data Model Identifier and the description (i.e. the information that is on the previous screen). For further information, refer to the table above. The View Detail option displays the following information: Column Name Type Status Modification Date Sample Description Indicates the file type. At present, all files are of type csv (i.e. comma separated data in a plain text file with a.csv extension). The status field can be ignored in this form. An optional timestamp of when the file definition was last changed in the AEMO MMS systems. If a sample file is available, there is a link, which allows you to download a sample file. Click the link and click Open or Save. Doc Ref: MMSTDPD69 v February 2010 Page 17

22 If the sample file is small, you can choose Open and display the contents in a Browser window. (This happens automatically if you are not prompted to open or save the file.) When you are finished, click the Browser Back button to return to the list of selected files. If the sample file is large, it is recommended you choose Save and save the sample file in a local folder. Once you ve saved the file, you ll see this window: To open the folder where the file is saved, Click Open Folder. The sample file is selected by default. Double-click the file name to open the sample file. If you have Microsoft Excel installed, the file opens in Excel. Doc Ref: MMSTDPD69 v February 2010 Page 18

23 To return to Data Subscription, close Excel and then close the folder. 3. To return to the Subscribe Data Model Files screen, click << Back. To subscribe to the files 1. Select the files you are interested in (i.e. click on the check box beside the file to tick it). Do nothing if you want them all because they are all selected by default. To assist, you can use the select all checkbox to unselect all the items or click the checkbox again to select all items. 2. Click Subscribe. Doc Ref: MMSTDPD69 v February 2010 Page 19

24 3. Review the selected files and click Subscribe again. Click <<Back if you want to return to the previous screen and change your selection. 4. A message displays confirming your subscription. 5. Use the menu options to return to the Data Model Changes screen or to select another option. 4.5 Subscribing to newly-offered Data Model files This option allows you to see only those files that were introduced in the current version (i.e. files that do not have a legacy version) and that you are not subscribed to. This option is useful for participants that are only subscribed to a subset of the complete set of MMS Data Model files and are only interested in subscribing to whichever of the new files are relevant to their needs. This is the easiest way to identify and assess which files are needed, for example, if you use the See vn.n files that have not been subscribed to yet link, as well as seeing your newly-available files, all other files are also displayed. Note: all files listed are also available using the first option See vn.n files that have not been subscribed to yet. This option displays a subset of the first list. Doc Ref: MMSTDPD69 v February 2010 Page 20

25 To see the files introduced in this version that you are not subscribed to 1. On the Data Model Changes screen, click the See vn.n files not previously offered (and not already subscribed to) link. 2. The list will look similar to the following example but the file names will be different. By default, all displayed files are selected. The list only contains new files released with the current MMS Data Model version that do not replace existing files and that have not been subscribed to yet. If you see the following screen it means all new files introduced in the current version are already subscribed to. To return to the Subscribe Data Model Files screen, click << Back. Doc Ref: MMSTDPD69 v February 2010 Page 21

26 To subscribe to the files 1. Select the files you are interested in (i.e. click the check box beside the file to tick it). Do nothing if you want them all because they are all selected by default. To assist, you can use the select all checkbox to unselect all the items or click the checkbox again to select all items. 2. Click Subscribe. 3. Review the selected files and click Subscribe again. Click <<Back if you want to return to the previous screen and change your selection. 4. A message displays confirming your subscription. Doc Ref: MMSTDPD69 v February 2010 Page 22

27 5. Use the menu options to return to the Data Model Changes screen or to select another option. Note: you may also want to See vn.n files that should replace previous versions that are currently subscribed to, to check if there are any replacement files. See Subscribing to current MMS Data Model files that replace previous versions on page Subscribing to current MMS Data Model files that replace previous versions This option allows you to see the files released in the current version that should replace previous versions. The list is compiled by taking into account files the organisation is currently subscribed to and only showing updated versions of those files. The list is a filter, based on your current subscription settings. For example, if files a and b were both updated in the current version but you only subscribed to file a, when you select this option you only see the updated version of file a; you do not see the updated file b. This option is useful for participants that are only subscribed to a subset of the complete set of data model files. Such participants can obtain the new files by using the See vn.n files not previously offered (and not already subscribed to) link. Then using this option to identify which replacement files they need to subscribe to. Note: all files listed here are also available using the first option See vn.n files that have not been subscribed to yet. This option displays a subset of the first list. To see the files introduced in this version that replace files you are currently subscribed to 1. On the Data Model Changes screen, click the See vn.n files that should replace previous versions that are currently subscribe to link. Doc Ref: MMSTDPD69 v February 2010 Page 23

28 2. The list will look similar to the following example but the file names will be different. By default, all displayed files are selected. The list only contains files that belong with the current MMS Data Model version that replace legacy files you are currently subscribed to (from the previous or prior versions). If no files are found it means all available files are subscribed to or there are no files in the current version that replace files you are currently subscribed to. To return to the Subscribe Data Model Files screen, click << Back. To subscribe to the files 1. Select the files you are interested in (i.e. click on the check box beside the file to tick it). Do nothing if you want them all because they are all selected by default. To assist, you can use the select all checkbox to unselect all the items or click the checkbox again to select all items. 2. Click Subscribe. Doc Ref: MMSTDPD69 v February 2010 Page 24

29 3. Review the selected files and click Subscribe again. Click <<Back if you want to return to the previous screen and change your selection. 4. A message displays confirming your subscription. 5. Use the menu options to return to the Data Model Changes screen or to select another option. 4.7 Unsubscribing from legacy files This option is useful for all participants, whether you subscribe to the full data set or only a subset. It allows you to unsubscribe from legacy files that have become redundant with the release of the current MMS Data Model version. Note: it is recommended that you don t unsubscribe from any legacy files until after you have processed at least one new file of the type that the legacy file is replacing (i.e. loaded its contents into your local database). Choose this option after using either of the following options: See vn.n files that have not been subscribed to yet See vn.n files not previously offered (and not already subscribed to) See vn.n files that should replace versions that are currently subscribed to Doc Ref: MMSTDPD69 v February 2010 Page 25

30 To unsubscribe from legacy files 1. On the Data Model Changes screen, click the See vn.n files that can be unsubscribed from (Only do this after new versions have been processed through the Parser once) link. 2. The list will look similar to the following example but the file names will be different and contain only redundant files. By default, all displayed files are selected. If no files are found it means that you are not subscribed to any legacy files. All your file subscriptions are up to date. To return to the Subscribe Data Model Files screen, click << Back. 3. Select the files you want to unsubscribe from (i.e. click on the check box beside the file to tick it). Do nothing if you want to unsubscribe from them all because they are all selected by default. To assist, you can use the select all checkbox to unselect all the items or click the checkbox again to select all items. Doc Ref: MMSTDPD69 v February 2010 Page 26

31 4. Click Unsubscribe. 5. Review the selected files and click Unsubscribe again. Click <<Back if you want to return to the previous screen and change your selection. 6. Confirmation of your subscription cancellation displays. 7. Use the menu options to return to the Data Model Changes screen or to select another option. Doc Ref: MMSTDPD69 v February 2010 Page 27

32 5 Subscribing To Files This section describes how to use the Subscribe to Files screen, which allows you to subscribe to any files you are not currently subscribed to. From this screen you can subscribe to: Current version Data Model files (although you should subscribe to these using the options available via the Data Model Changes menu option described in Subscribing to all current MMS Data Model files not already subscribed to on page 14). Files that are not supported by the data model and so are not accessible via the Data Model Changes option. Legacy files compatible with the previous version of the data model that remain available until the release cycle after the one which made them redundant (e.g. files made redundant by a December data model update will remain available for subscription for the following six months, until the next June data model update). This section of the guide assumes that you have already logged on and have displayed the Data Subscriptions menu option; for help refer to Accessing Data Subscription Services on page Viewing files available for subscription To view files available for subscription 1. On the Data Subscription menu, click Subscribe to Files. 2. The Subscribe to Files screen displays, with a list of all files you are not subscribed to. Unlike subscriptions managed via the Data Model Changes option, none of the items are selected by default. Doc Ref: MMSTDPD69 v February 2010 Page 28

33 For each item on the list, the following information is displayed. Column Name Description Shows which items are selected. By default, no items are selected. To select an item click the check box to tick it. Clicking the check box in the header row selects all files. Data Model Identifier This column indicates whether or not the file is supported by the MMS Data Model. Yes = the data supplied in this file can be stored in a database created from an MMS Data Model script. No = the data provided in these files is not compatible with a database created from an MMS Data Model script. The name that is internal to the MMS System that identifies the source of the data published in this file. Files that have been replaced by a new version are renamed by adding _LEGACY to the end of the previous name, e.g. Note: This name is not the same as the Data Model Identifier. The Data Model Identifier can be seen by choosing the View Details option. (Note: see comment about Data Model Identifier in the Description section of this table.) Status Description Type Indicates the status of the file. The options are: Assignable means this is a current version file. Deprecated means this is a legacy file that was current for a previous MMS release. It will disappear from the list at the time the file is next updated. Visible means this file is available for subscription but the subscription cannot be managed using this MMS Data Subscription Services tool. Subscriptions can only be requested by contacting the AEMO Help Desk. A description of the contents of the file. This description is also updated once a file becomes a legacy version. In addition, if the Data Model Identifier name, which is not displayed on this screen, is different from the Identifier, then the Data Model Identifier name appears at the start of the description in italics, preceded by DM. Indicates the file type. At present, all files are CSV format (i.e. commaseparated data in a plain text file with a.csv extension). 5.2 Filtering or searching for files You can look for a specific file or group of files by filtering the list. Two filtering options are available: A combination of free text and/or the status of the file. A combination of Collection and Package. Doc Ref: MMSTDPD69 v February 2010 Page 29

34 Note: only one of the above filter options can be used at a time and searches are case insensitive (i.e. you don t need to use capital letters in keyword searches). To filter files by keyword 1. Type any part of the file s Identifier or Description in the Keywords field. You can type more than one group of letters in the Keywords field; in which case the search is treated as an OR search (i.e. it finds all files containing either of the strings of text you entered). 2. Click Refresh to update the list to match the selected filtering options. 3. The files returned will be those files matching the filter and files you are not subscribed to. If you try a search and no files are returned, it means you are already subscribed to all the files that match the filter conditions. To filter by keyword and/or status 1. Click the Status drop-down list and select a status. See the table above for a description of each status. Leaving the default option Any selects all files, regardless of their status. Doc Ref: MMSTDPD69 v February 2010 Page 30

35 2. Click Refresh to update the list to match the selected filtering options. This also cancels any previously selected files. 5.3 Example searches This example finds all files with a status of Assignable (i.e. all current files). Note: notice the MMS Data Model supports some of these files but not all of them. This example finds all files with the text Dispatch anywhere in the Identifier or the Description, where the status is Any. This example finds all files with the text public anywhere in the Identifier or the Description, where the status is Assignable. Doc Ref: MMSTDPD69 v February 2010 Page 31

36 This example finds all files with the text public or the text dispatch anywhere in the Identifier or the Description, where the status is Any. 5.4 Filtering by Collection and Package A Collection is a group of related files. A Package is a sub-set of the selected Collection. If you have chosen one of the data model collections, you will see a list of each data model package name. You select one of the packages to filter for all files categorised as belonging to a selected subject area. The packages displayed in the list correspond to the packages in the MMS Data Model documentation. Both of the key MMS Data Model documents (i.e. the MMS Data Model Report and the MMS Data Model Package Summary) are structured based on the packages and list the files in each package. To filter by Collection and Package 1. Click the Filter by package box to select it. The filtering options change to show the following. 2. Click the Collection drop down list and select an option from the list. Doc Ref: MMSTDPD69 v February 2010 Page 32

37 The table below describes what each collection contains. Collection Default Subscriptions for new participants Data Model versions Legacy Data Model Files Not in data model Description This configuration set is managed by AEMO and is the set of file subscriptions that are applied by default when a new participant is registered in the MMS systems. The current MMS Data Model and the most recently superseded data model will both be available. Selecting the current data model limits the package list box to display only those packages supported by the current data model. Selecting the previous data model limits the package list box to display only those packages supported by the previous data model. Superseded MMS Data Model files. Files supplied by AEMO that are not supported by the MMS Data Model (i.e. the data contained in the file cannot be stored in a database built from an MMS Data Model script. 3. Click the Package drop down list and select a package. A sample of the options is shown below. If the collection you selected is Not in data model then two packages are available, Old non data model format files and Not in data model, as shown below. Doc Ref: MMSTDPD69 v February 2010 Page 33

38 o Old non data model format files are files that have been deprecated and were originally in place to populate the Parser data model, which has now been discontinued. o Not in data model files are current version files that do not have a target table defined in the MMS Data Model database. To cancel the Collection/Package filtering, click the Filter by Package check box again to return to the filter by text/status and then click Refresh again. 4. Click Refresh to update the list to match the selected filtering options. This also cancels any previously selected files. 5.5 Viewing further file information To view further file information 1. Select the files you are interested in (i.e. click on the check box beside the file to tick it). To assist, you can use the select all checkbox to tick all the items or click the checkbox again to unselect all items). Doc Ref: MMSTDPD69 v February 2010 Page 34

39 2. Click View Detail to display a list of the selected files. Notes: if the Data Model Identifier displays Not Applicable, it means the MMS Data Model does not support data delivered in this file. There is no target table in the database for storing the data in the file. For a description of the information displayed here and instructions on how to view any sample files that may be available, see page Click <<Back to return to the previous screen. Doc Ref: MMSTDPD69 v February 2010 Page 35

40 5.6 Subscribing 1. Select the files you are interested in (i.e. click on the check box beside the file to tick it). To assist, you can use the select all checkbox to tick all the items or click the checkbox again to unselect all items. 2. Click Subscribe to subscribe to the selected files. Doc Ref: MMSTDPD69 v February 2010 Page 36

41 3. Review the selected files and click Subscribe again. Click <<Back if you want to return to the previous screen and change your selection. 4. A final confirmation screen displays. 5. Use the menu options to return to the Subscribe to Files screen or to select another option. Doc Ref: MMSTDPD69 v February 2010 Page 37

42 6 Viewing Subscribed to Files There is no specific option to view the files you are currently subscribed to but you can see them by choosing the Unsubscribe Files menu option. The files that will be listed for unsubscribing are the files you are subscribed to. Refer to the next section Unsubscribing From Files, for step-bystep instructions on how to view files on the Unsubscribe Files screen. Doc Ref: MMSTDPD69 v February 2010 Page 38

43 7 Unsubscribing From Files You can use the Unsubscribe Files menu option to: unsubscribe from any files you are currently subscribed to view the files you are subscribed to Note: If you wish to unsubscribe from files made redundant with the most recent release it is better to use the See vn.n files that can be unsubscribed from option, available from the Data Model Changes screen. It lists only the subset of legacy files, making it easier to identify the ones you want to unsubscribe from. The Unsubscribe Files menu option is better suited to a situation when you have a specific file or group of files you have decided you no longer need. This section of the guide assumes that you have already logged on and have displayed the Data Subscriptions menu option, for help refer to Accessing Data Subscription Services on page 7. To unsubscribe from specific files 1. On the Data Subscription menu, click Unsubscribe Files. 2. The Subscribed Files screen displays. By default, this screen lists all the files you are currently subscribed to and none of them are selected. For a description of the information displayed for each item, refer to the table on page Use the filter by text and/or status options to locate the file(s) you want to unsubscribe from. For help, refer to Filtering or searching for files on page 29. Doc Ref: MMSTDPD69 v February 2010 Page 39

44 Notes: whichever filter you select, it is only applied to files you are already subscribed to. To see examples of how this filter works, see page 31, which contains examples of text/status filters applied in the Subscribe to Files screen. The rules for this screen are the same. 4. Click the Status drop-down list and select a status or leave the default option Any which will select all files regardless of their status Refer to the table on page 28 for a description of each status. 5. Click Refresh to update the list to match the selected filtering options. This also cancels any previously selected files. To view more information about any files, refer to Viewing further file information on page Select the files you want to unsubscribe from (i.e. click on the check box beside the file to tick it). To assist, you can use the select all checkbox to tick all the items or click the checkbox again to unselect all items. 7. Click Unsubscribe to unsubscribe from the selected files. Doc Ref: MMSTDPD69 v February 2010 Page 40

45 8. Review the list and click Unsubscribe. Clicking <<Back cancels any filter but retains previously selected files. 9. Confirmation of subscription cancellation displays. 10. Use the menu options to return to the Unsubscribe Files screen or to select another option. Doc Ref: MMSTDPD69 v February 2010 Page 41

46 8 Viewing the MMS Data Catalogue The View Catalogue menu option allows you to: View the entire list of available files, whether or not your organisation is currently subscribed to them. View further file details. This menu option lists all files that are currently part of the suite of files of MMS data that AEMO makes available to participants. It includes functions to filter the catalogue by text and/or status. This section of the guide assumes that you have already logged on and have displayed the Data Subscriptions menu option; for help refer to Accessing Data Subscription Services on page 7. To view the entire list of MMS files 1. On the Data Subscription menu, click View Catalogue. 2. The Files Supplied by MMS screen displays. By default, this screen lists all available files. This includes files your organisation is subscribed to and files it is not subscribed to. For a description of the information displayed for each item, refer to the table on page 28. Note: if the Data Model identifier name, which is not specifically displayed on this screen, is different from the Identifier, it is included in the Description field in italics, preceded by DM. In the example above, the Data Model Identifier for the file with the Identifier AUCTION is IRAUCTION_CONFIG. Doc Ref: MMSTDPD69 v February 2010 Page 42