ifference between revisions of "EMO:The File Menu"

From EMO Wiki
Jump to navigation Jump to search
 
(50 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{#hidens:}}
 
{{#hidens:}}
 
The File Menu provides access to the following ''EMarketOffer'' features:
 
The File Menu provides access to the following ''EMarketOffer'' features:
−
*'''''Data Sources'''''
+
*'''''Database Connections''''' - ''set up and test connections to your local databases''
−
*'''''Map Settings'''''
+
*'''''File Inputs''''' - ''set up and check the status of grid and reserves data files''
 +
*'''''Map Settings''''' - ''customise the EMO map''
 
*'''''Save All Settings'''''
 
*'''''Save All Settings'''''
 
*'''''Open EMO Data Directory'''''
 
*'''''Open EMO Data Directory'''''
 
*'''''Exit'''''
 
*'''''Exit'''''
  
−
== The Data Sources Option ==
+
== The Database Connections Option ==
 
Please read in conjunction with the section on '''''[[EMO:Connecting to a Database Server|Connecting to a Database Server]]'''''.
 
Please read in conjunction with the section on '''''[[EMO:Connecting to a Database Server|Connecting to a Database Server]]'''''.
  
−
=== Data Source Concepts ===
+
=== Input Data Concepts ===
−
Input data can be sourced from file (see '''[[EMO:Data_Storage_Directory_Structure#Data_Files|Data Files]]'''), or from online database servers.
+
Input data is sourced from databases and from files (see '''[[EMO:Data_Storage_Directory_Structure#Data_Files|Data Files]]'''), or from online database servers.
  
 
==== The Database Connection Configuration ====
 
==== The Database Connection Configuration ====
 
''EMarketOffer'' supports multiple connections to multiple database servers.  Database connectivity is managed through the Database Connection Configuration (DCC).  A DCC contains a number of queries which obtain data from one or more databases.  While a DCC's queries can access data in more than one database on more than one database server, it is not possible to have more than one query handling data of the same type (e.g. only one query can return Price data, and only one query can return Demand data).  To overcome this limitation it is possible to define multiple DCCs.  Each configuration will define a different, but complete set of data access queries.  ''EMarketOffer'' can use only one DCC at a time, which together with the data files loaded from the '''''Inputs files directory''''', fully determine ''EMarketOffer's'' run-time data environment.
 
''EMarketOffer'' supports multiple connections to multiple database servers.  Database connectivity is managed through the Database Connection Configuration (DCC).  A DCC contains a number of queries which obtain data from one or more databases.  While a DCC's queries can access data in more than one database on more than one database server, it is not possible to have more than one query handling data of the same type (e.g. only one query can return Price data, and only one query can return Demand data).  To overcome this limitation it is possible to define multiple DCCs.  Each configuration will define a different, but complete set of data access queries.  ''EMarketOffer'' can use only one DCC at a time, which together with the data files loaded from the '''''Inputs files directory''''', fully determine ''EMarketOffer's'' run-time data environment.
 +
 +
==== The Database Connection ====
 +
A Database Connection is a set of data that describes the addressing, technical and security details required to a specific database on a specific database server. The details are combined in to a specific string format and used to access the required data.  A DCC must contain one connection string for every database to be addressed in the configuration.
 +
 +
----
 +
NOTE: Only one Connection per server is required in DCC.  Therefore if all your data is stored in the same database then all queries required to access data can use the same Connection.
 +
 +
=== Source Data Administration Window ===
 +
 +
==== Access ====
 +
 +
The '''Database Connections''' option in the '''Main Window File Menu'''.
 +
 +
==== Purpose ====
 +
To manage '''''Database Connection Configurations''''' (DCC).
 +
 +
==== Features ====
 +
{|class="wikitable"
 +
! Feature !! Purpose
 +
|-
 +
!Database Connections Configuration Selector
 +
|
 +
:To set the Current DCC from a drop down box of all currently available DCCs.
 +
|-
 +
!Open configuration Button
 +
|
 +
:Opens the DCC Window for the selected configuration
 +
|-
 +
!New Configuration Button
 +
|
 +
:Opens the New DCC Window Dialogue
 +
|-
 +
!Refresh All Cached Data Button
 +
|
 +
:Reloads all cached data (from file and database)
 +
|}
 +
 +
=== Database Connection Settings Window ===
 +
 +
==== Access ====
 +
Either through the '''Open Configuration Button''' or the '''New Configuration Button''', both on the '''''Source Data Administration Window'''''.
 +
 +
==== Purpose ====
 +
Specification of the database connection and query details used by a Database Connectivity Configuration (DCC).
 +
 +
==== Components and Features ====
 +
{|class="wikitable"
 +
! Component !! Feature !! Purpose
 +
|-
 +
! rowspan="5" | Function Panel
 +
|
 +
:''Test Button''
 +
|
 +
:Tests the validity of the DCC. Test results are displayed in the Status Box (see below)
 +
|-
 +
|
 +
:''Save Button''
 +
|
 +
:Saves the current set of configuration data to file.
 +
----
 +
:NOTE: Connection details changed through the interface will only remain effective for the current session. Unless saved using this button, future sessions will revert to the previously saved details.
 +
|-
 +
|
 +
:''Done Button''
 +
|
 +
:Closes the Data Connections Window retaining any unsaved changes for the current session only.
 +
|-
 +
|
 +
:''Date and Period Selector''
 +
|
 +
:Selects the Date and Trading Period for the data connectivity test.
 +
|-
 +
|
 +
:''Status Box''
 +
|
 +
:Shows the results of the last connectivity test
 +
|-
 +
! rowspan="8" |Database Panel
 +
|
 +
:''Add Button''
 +
|
 +
:Creates a new Database Connection
 +
|-
 +
|
 +
:''Delete Button''
 +
|
 +
:Delete an existing Database Connection
 +
|-
 +
|
 +
:''Name Field''
 +
|
 +
:Contains the name of the Database Connection used to reference the connection in the Query Panel
 +
|-
 +
|
 +
:''Connection Type Field''
 +
|
 +
:Determines the type of connection ''EMarketOffer'' will use for a specific connection.  Currently supported connections are:
 +
*OleDB
 +
*ODBC
 +
*Oracle
 +
*SQL
 +
:OleDB and ODBS are generic types and operate with most SQL compliant databases. The Oracle and SQL connection types are specific .net variants for the Oracle and Microsoft SQL server database type.  They provide performance superior to the generic connection types and should be used by preference where possible.
 +
|-
 +
|
 +
:''Connection String Field''
 +
|
 +
:Contains the Connection String required to access a database server
 +
|-
 +
|
 +
:''Date Brackets Field''
 +
|
 +
:Contains the symbol used by database server to identify dates within query strings (varies by server type)
 +
|-
 +
|
 +
:''Date Format Field''
 +
|
 +
:Defines how the database server interprets date formats
 +
|-
 +
|
 +
:''Error Field''
 +
|
 +
:Displays results from the last test operation that are specific to this Database Connection
 +
|-
 +
! rowspan="9" | Query Panel
 +
|
 +
:''Entity Type Field''
 +
|
 +
:Informs ''EMarketOffer'' which entity type a query will return data for (either 'Node' or 'Unit')
 +
|-
 +
|
 +
:''Connection Field''
 +
|
 +
:Defines the Connection String, named through the Database Panel which is used by the query
 +
|-
 +
|
 +
:''Query Field''
 +
|
 +
:Contains the text of the query used to access data
 +
|-
 +
|
 +
:''Date Field Field''
 +
|
 +
:Links the column containing the date in the query to ''EMarketOffer's'' date/time handler (allows you to use in-house column names)
 +
|-
 +
|
 +
:''TP Field Field''
 +
|
 +
:Links the Trading Period column in the query to ''EMarketOffer's'' date/time handler (allows you to use in-house column names)
 +
|-
 +
|
 +
:''Entity Field Field''
 +
|
 +
:Links the Entity column (defined in the Entity Type Field) in the query to ''EMarketOffer's'' Entity data handler (allows you to use column names from your in-house databases from queries)
 +
|-
 +
|
 +
:''Other Fields Field''
 +
|
 +
:Links additional columns in the query to ''EMarketOffer's'' Entity.trait data handler
 +
|-
 +
|
 +
:''Error Field''
 +
|
 +
:Displays the results of the last test operation specific to the query
 +
|-
 +
|
 +
:''Sent Query Field''
 +
|
 +
:Displays the actual text of the last query sent to test the database connection (provided as a feature to assist with trouble shooting during setup)
 +
|}
 +
 +
=== Creating A New Database Connection Configuration ===
 +
 +
==== Usage ====
 +
The ability to define multiple Database Connection Configurations allows you to create different data environments for different requirements and easily switch between these environments as needed.  Examples of different data environments include:
 +
*The standard (historical) market data in the corporate market database
 +
*A short-term model of a specific market scenario (suitable for business development projects)
 +
*An alternate data source for one or more data streams (e.g. Demand data from SCADA vs SPD Daily Demand)
 +
*A database on a portable computer (suitable for away trips and business presentations)
 +
*A training database of illustrative scenarios
 +
 +
<span style="color:#2E5894">
 +
'''>> To create a new Database Connection Configuration'''
 +
#Open the '''''External Data Administration Window''''' from the Data Source option of the '''''Main Window''''' File Menu
 +
#Open the New Connection Configuration Dialogue using the '''New Configuration Button'''
 +
#Enter the name for the new configuration in the '''Connection Configuration Name''' field
 +
#Chose whether to start the new configuration with a copy of the Current Configuration (saves much data re-rentry) or with a blank screen by selecting 'Yes' or 'No' in the ''Copy Current Connection Configuration'' field
 +
#Click '''OK Button''' to accept your entries and open the Database Connection Settings Window or the '''Cancel Button''' to reject entry and return to the '''''External Data Administration Window'''''
 +
 +
== The File Inputs Window ==
 +
 +
==== Access ====
 +
The '''File Inputs''' option in the '''Main Window File Menu.'''
 +
 +
==== Purpose ====
 +
Shows the status of grid and reserves data downloaded in csv files from the Energy Link web site.  Since 22-Jul-09 grid and reserves data has been sourced from the "SPD daily case final pricing solve" data files that are made available each day on the Electricity Authority's web site (reserves data is available from January 2010).  Each business day, Energy Link downloads the SPD daily case final pricing solves and extracts data that defines the grid, lince capacities, line re-ratings (which are typically line outages), equation constraints, variable line ratings and reserves parameters, by half hour for the entire day.  Sometimes provisional data is available but which is subsequently updated with final data.
 +
 +
Whenever you start EMO it automatically chceks for the latest data files on the Energy Link web site, but if you leave EMO running overnight then each subsequent day you need to check the File Inputs window for new data:  on the Download tab, click '''Check For New Files'''.
 +
 +
==== Tabs and Features ====
 +
{|class="wikitable"
 +
! Tab !! Feature !! Purpose
 +
|-
 +
! rowspan="3" |Download Tab
 +
|
 +
:''Check For New Files button''
 +
|
 +
:Click on this button to check for new data files
 +
|-
 +
|
 +
:''Web Site Configuration''
 +
|
 +
:The fields in the table under the Check For New Files button are used to configure access to the Energy Link web site:  these are set up for the default, but you may need to contact Energy Link for help with more complex configurations required in a corporate environment
 +
|-
 +
|
 +
:''Messages''
 +
|
 +
:The tree structure in this area shows what data is loaded:  expand the tree to view the messages.  Messages can also be copied to the clipboard by clicking the Copy Messages button.
 +
|-
 +
! rowspan="6" | Grid Tab
 +
|
 +
:''Open Grid Files Directory Button''
 +
|
 +
:Opens the folder which stores grid.  You'll most likely see folders for 'EMO', 'EM6' and 'Ellsoft'.  The EMO folder holds the grid files which are used from 22-Jul-09.  The other two folders hold older grid data.
 +
|-
 +
|
 +
:''Reload Grid Inputs button''
 +
|
 +
:Relaods the grid data from the files in the relevant data folder
 +
|-
 +
|
 +
:''Date and TP boxes''
 +
|
 +
:These show the date and trading period on the Main Window
 +
|-
 +
|
 +
:''Base Grid Source Table''
 +
|
 +
:This table shows the range of dates from the data file from which the displayed date's grid data is drawn from
 +
|-
 +
|
 +
:''Circuits Table''
 +
|
 +
:This table displays the data relating to lines for the displayed date.  Double click on any line to get more information including name, dates for which the displayed data is valid, the type of rating (SSW = summer, shoulder, winter;  VLR = variable line rating), and the value of the default ratings (click the Annual Ratings button) and any re-ratings that apply (click the Reratings button).
 +
|-
 +
|
 +
:''Messages''
 +
|
 +
:Messages in a tree structure.
 +
|-
 +
! Reserves
 +
|
 +
|
 +
:This window provides access to the reserves data folder and shows the valid date range based on the data files available to EMO.
 +
|}
 +
 +
== The Map Settings Menu Option ==
 +
 +
=== Access ===
 +
The Map settings option from the file Menu on the Main Window.
 +
 +
=== Purpose ===
 +
To configure the appearance of items appearing on the Map.
 +
 +
The Map Settings Window contains two panels accessed through tabs. The panels are:
 +
*Main Map Settings
 +
*Inset Map Settings
 +
 +
Both panels contain exactly the same setting types and options.
 +
 +
=== Editing ===
 +
 +
{|class="wikitable"
 +
|-
 +
|
 +
:''Numeric Field''
 +
|
 +
:Click on the required field and then type the required new number
 +
|-
 +
|
 +
:''Colour''
 +
|
 +
:Place mouse pointer over field to be edited and click on the "..." tab at the right of the cell to open the colour selector
 +
|-
 +
|
 +
:''Font''
 +
|
 +
:Place mouse pointer over field to be edited and click on the "..." tab at the right of the cell to open the font selector
 +
|-
 +
|
 +
:''Check Box''
 +
|
 +
:Simply click on the box to check/un-check
 +
|}
 +
 +
----
 +
NOTE: The reset button restores the Map Settings for the Main or Inset map types back to the default settings.
 +
 +
 +
== The Save All Settings Option ==
 +
''EMarketOffer'' saves changes to Forecast and Powerflow Case Definitions to file on closing.  The '''Save All Settings''' option saves any unsaved changes to file without shutting ''EMarketOffer'' down.  This feature should be used as a precaution in situations where extensive changes to Forecast and Powerflow Case Definitions are being made.
 +
 +
 +
== The Open EMO Data Directory Option ==
 +
This opens a standard Windows directory window containing the '''''EMO Data Directory''''' (location selected during the installation process).  The window provides easy access to important ''EMarketOffer'' data such as Forecast files and the Component Library.
 +
 +
== The Exit Option ==
 +
Selecting this option closes down ''EMarketOffer.''  In doing so the program will save all unsaved data and close all internal files.  Output files created and opened through ''EMarketOffer'' (e.g. output csv files) will remain open.
 +
 +
 +
[[Main Page|Home]]

Latest revision as of 12:50, 12 February 2014

The File Menu provides access to the following EMarketOffer features:

  • Database Connections - set up and test connections to your local databases
  • File Inputs - set up and check the status of grid and reserves data files
  • Map Settings - customise the EMO map
  • Save All Settings
  • Open EMO Data Directory
  • Exit

The Database Connections Option

Please read in conjunction with the section on Connecting to a Database Server.

Input Data Concepts

Input data is sourced from databases and from files (see Data Files), or from online database servers.

The Database Connection Configuration

EMarketOffer supports multiple connections to multiple database servers. Database connectivity is managed through the Database Connection Configuration (DCC). A DCC contains a number of queries which obtain data from one or more databases. While a DCC's queries can access data in more than one database on more than one database server, it is not possible to have more than one query handling data of the same type (e.g. only one query can return Price data, and only one query can return Demand data). To overcome this limitation it is possible to define multiple DCCs. Each configuration will define a different, but complete set of data access queries. EMarketOffer can use only one DCC at a time, which together with the data files loaded from the Inputs files directory, fully determine EMarketOffer's run-time data environment.

The Database Connection

A Database Connection is a set of data that describes the addressing, technical and security details required to a specific database on a specific database server. The details are combined in to a specific string format and used to access the required data. A DCC must contain one connection string for every database to be addressed in the configuration.

NOTE: Only one Connection per server is required in DCC. Therefore if all your data is stored in the same database then all queries required to access data can use the same Connection.

Source Data Administration Window

Access

The Database Connections option in the Main Window File Menu.

Purpose

To manage Database Connection Configurations (DCC).

Features

Feature Purpose
Database Connections Configuration Selector
To set the Current DCC from a drop down box of all currently available DCCs.
Open configuration Button
Opens the DCC Window for the selected configuration
New Configuration Button
Opens the New DCC Window Dialogue
Refresh All Cached Data Button
Reloads all cached data (from file and database)

Database Connection Settings Window

Access

Either through the Open Configuration Button or the New Configuration Button, both on the Source Data Administration Window.

Purpose

Specification of the database connection and query details used by a Database Connectivity Configuration (DCC).

Components and Features

Component Feature Purpose
Function Panel
Test Button
Tests the validity of the DCC. Test results are displayed in the Status Box (see below)
Save Button
Saves the current set of configuration data to file.
NOTE: Connection details changed through the interface will only remain effective for the current session. Unless saved using this button, future sessions will revert to the previously saved details.
Done Button
Closes the Data Connections Window retaining any unsaved changes for the current session only.
Date and Period Selector
Selects the Date and Trading Period for the data connectivity test.
Status Box
Shows the results of the last connectivity test
Database Panel
Add Button
Creates a new Database Connection
Delete Button
Delete an existing Database Connection
Name Field
Contains the name of the Database Connection used to reference the connection in the Query Panel
Connection Type Field
Determines the type of connection EMarketOffer will use for a specific connection. Currently supported connections are:
  • OleDB
  • ODBC
  • Oracle
  • SQL
OleDB and ODBS are generic types and operate with most SQL compliant databases. The Oracle and SQL connection types are specific .net variants for the Oracle and Microsoft SQL server database type. They provide performance superior to the generic connection types and should be used by preference where possible.
Connection String Field
Contains the Connection String required to access a database server
Date Brackets Field
Contains the symbol used by database server to identify dates within query strings (varies by server type)
Date Format Field
Defines how the database server interprets date formats
Error Field
Displays results from the last test operation that are specific to this Database Connection
Query Panel
Entity Type Field
Informs EMarketOffer which entity type a query will return data for (either 'Node' or 'Unit')
Connection Field
Defines the Connection String, named through the Database Panel which is used by the query
Query Field
Contains the text of the query used to access data
Date Field Field
Links the column containing the date in the query to EMarketOffer's date/time handler (allows you to use in-house column names)
TP Field Field
Links the Trading Period column in the query to EMarketOffer's date/time handler (allows you to use in-house column names)
Entity Field Field
Links the Entity column (defined in the Entity Type Field) in the query to EMarketOffer's Entity data handler (allows you to use column names from your in-house databases from queries)
Other Fields Field
Links additional columns in the query to EMarketOffer's Entity.trait data handler
Error Field
Displays the results of the last test operation specific to the query
Sent Query Field
Displays the actual text of the last query sent to test the database connection (provided as a feature to assist with trouble shooting during setup)

Creating A New Database Connection Configuration

Usage

The ability to define multiple Database Connection Configurations allows you to create different data environments for different requirements and easily switch between these environments as needed. Examples of different data environments include:

  • The standard (historical) market data in the corporate market database
  • A short-term model of a specific market scenario (suitable for business development projects)
  • An alternate data source for one or more data streams (e.g. Demand data from SCADA vs SPD Daily Demand)
  • A database on a portable computer (suitable for away trips and business presentations)
  • A training database of illustrative scenarios

>> To create a new Database Connection Configuration

  1. Open the External Data Administration Window from the Data Source option of the Main Window File Menu
  2. Open the New Connection Configuration Dialogue using the New Configuration Button
  3. Enter the name for the new configuration in the Connection Configuration Name field
  4. Chose whether to start the new configuration with a copy of the Current Configuration (saves much data re-rentry) or with a blank screen by selecting 'Yes' or 'No' in the Copy Current Connection Configuration field
  5. Click OK Button to accept your entries and open the Database Connection Settings Window or the Cancel Button to reject entry and return to the External Data Administration Window

The File Inputs Window

Access

The File Inputs option in the Main Window File Menu.

Purpose

Shows the status of grid and reserves data downloaded in csv files from the Energy Link web site. Since 22-Jul-09 grid and reserves data has been sourced from the "SPD daily case final pricing solve" data files that are made available each day on the Electricity Authority's web site (reserves data is available from January 2010). Each business day, Energy Link downloads the SPD daily case final pricing solves and extracts data that defines the grid, lince capacities, line re-ratings (which are typically line outages), equation constraints, variable line ratings and reserves parameters, by half hour for the entire day. Sometimes provisional data is available but which is subsequently updated with final data.

Whenever you start EMO it automatically chceks for the latest data files on the Energy Link web site, but if you leave EMO running overnight then each subsequent day you need to check the File Inputs window for new data: on the Download tab, click Check For New Files.

Tabs and Features

Tab Feature Purpose
Download Tab
Check For New Files button
Click on this button to check for new data files
Web Site Configuration
The fields in the table under the Check For New Files button are used to configure access to the Energy Link web site: these are set up for the default, but you may need to contact Energy Link for help with more complex configurations required in a corporate environment
Messages
The tree structure in this area shows what data is loaded: expand the tree to view the messages. Messages can also be copied to the clipboard by clicking the Copy Messages button.
Grid Tab
Open Grid Files Directory Button
Opens the folder which stores grid. You'll most likely see folders for 'EMO', 'EM6' and 'Ellsoft'. The EMO folder holds the grid files which are used from 22-Jul-09. The other two folders hold older grid data.
Reload Grid Inputs button
Relaods the grid data from the files in the relevant data folder
Date and TP boxes
These show the date and trading period on the Main Window
Base Grid Source Table
This table shows the range of dates from the data file from which the displayed date's grid data is drawn from
Circuits Table
This table displays the data relating to lines for the displayed date. Double click on any line to get more information including name, dates for which the displayed data is valid, the type of rating (SSW = summer, shoulder, winter; VLR = variable line rating), and the value of the default ratings (click the Annual Ratings button) and any re-ratings that apply (click the Reratings button).
Messages
Messages in a tree structure.
Reserves
This window provides access to the reserves data folder and shows the valid date range based on the data files available to EMO.

The Map Settings Menu Option

Access

The Map settings option from the file Menu on the Main Window.

Purpose

To configure the appearance of items appearing on the Map.

The Map Settings Window contains two panels accessed through tabs. The panels are:

  • Main Map Settings
  • Inset Map Settings

Both panels contain exactly the same setting types and options.

Editing

Numeric Field
Click on the required field and then type the required new number
Colour
Place mouse pointer over field to be edited and click on the "..." tab at the right of the cell to open the colour selector
Font
Place mouse pointer over field to be edited and click on the "..." tab at the right of the cell to open the font selector
Check Box
Simply click on the box to check/un-check

NOTE: The reset button restores the Map Settings for the Main or Inset map types back to the default settings.


The Save All Settings Option

EMarketOffer saves changes to Forecast and Powerflow Case Definitions to file on closing. The Save All Settings option saves any unsaved changes to file without shutting EMarketOffer down. This feature should be used as a precaution in situations where extensive changes to Forecast and Powerflow Case Definitions are being made.


The Open EMO Data Directory Option

This opens a standard Windows directory window containing the EMO Data Directory (location selected during the installation process). The window provides easy access to important EMarketOffer data such as Forecast files and the Component Library.

The Exit Option

Selecting this option closes down EMarketOffer. In doing so the program will save all unsaved data and close all internal files. Output files created and opened through EMarketOffer (e.g. output csv files) will remain open.


Home

Retrieved from "http://emo.energylink.co.nz/index.php?title=EMO:The_File_Menu&oldid=6054"