Ellserve Wiki - User contributions [en]

Reporting

2014-06-27T04:17:11Z

WoodsM: /* Saving Report Definitions */

__NOTOC__
Ellserve reporting is designed to output data in user-defined formats either to screen in html format or as a downloadable csv file.

Useful report definitions can be stored for later use using the same [[Date Picker Configuration#Using the date picker|absolute/relative date settings]] used in on-screen controls.

{| class="wikitable" style="text-align: left; color: black; width: 700px;"
!'''Access'''
|
:The Reporting section is accessed by clicking on the "Reporting" tab in the '''[[Ellserve:Header Banner |Header Banner]] [[File:RepBanner.PNG|center|500px|Frame|Report Tab]]'''
|-
!'''Purpose'''
|
:The Reporting section provides to the tools required to create a '''[[Glossary#Report|Report]]''' and previously saved Report Definitions..
|}

====Reporting data====
The following data types can be included in reports:

* [[Time Series Data|Time series (monthly)]]
* [[Descriptive Data|Descriptive (account and ICP properties)]]
* [[User Defined]]
* [[Summarised]]

''Note: A feature to download invoice [[Source Data|source data]] is provided separately in the [[Invoice Browser|invoice browser control]].''

====Reporting functions====
=====[[Report Definition]]=====

=====[[Saving Report Definitions]]=====

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]

Glossary

2014-06-27T03:09:26Z

WoodsM: /* Usage */

==Account==
The consumption element against which a bill is raised. The simplest accounts will have a single tariff for a single commodity at a single site (e.g. a single electricity meter (ICP) on an anytime tariff). More complex accounts may have more than one tariff (e.g. a single electricity ICP with separate day and night tariffs), it is also possible for one account to have more than one commodity (e.g. dual fuel, gas and electricity metering at the same address provided by the same retailer), and more than one ICP for the same commodity.

==Account Name==
A supplier provided identifier for an [[Glossary#Account|account]], typically a unique numeric identifier

==Budget==
A user-agreed and fixed set of related monthly data recording expected monthly cost and consumption values over a determined period of time (typically financial year).

==Commodity==
A consumable associated with quantity based invoicing, such as natural gas or electricity.

==Commodity Group==
A set of commodities that can be usefully reported as a group (e.g. the energy commodity group contains all commodities for which consumption can be converted to kWh units)

==Control==
A self-contained, data display element that can be placed on any location on any configurable web page. The standard template widgets are:
* Data Table
* Graph
* Summary Table
* Invoice Browser
* ICP Information Browser
* Account Information Browser
* Document Browser
* Notes Browser
* Budget Tracker

==Data==
The data in Ellserve is either:
* A data stream: time-series data captured (after validation) from
** invoices (e.g. account costs or ICP consumption), or
** external databases (e.g. climate data)
* User-specific reference(e.g. reporting groups)
* Quantised by month: reporting data aggregated from input and system generated data streams to a monthly value.

== Definition ==
A certain set of defined constraints, i.e. the required constraints for a particular report.
== Display Control ==
A section of the web page used to display, and possibly to edit, Ellserve data. A Display Control shows data in table, report or graphical form

==Forecast==
A continually updated set of system-generated monthly data of the expected monthly cost and consumption values for a period of 18 months into the future.

==Invoice==
A document detailing the charges made by a supplier for supply of a commodity.

==Invoice Amount Due==
The total to be paid to the supplier with regard to an individual invoice - this includes any balance bought forward from previous invoices or any non-typical charges made on the invoice.

==Invoice Charge==
The total of charges related to the supply of a commodity on a bill (excluding balances bought forward and non-standard charges. Typically charge and amount due are the same, but may differ if balances are bought forward as may happen for instance if a late payment resulted in the loss of a prompt payment discount.

==Invoice Due Date==
The date in which the payment detailed in an invoice is due to be paid to the supplier.

==Invoice Number==
An identifier used by a supplier to uniquely identify an [[Glossary#Invoice|invoice]]. Invoice identification can be complex: the supplier may use a single identifier when referring to a statement of several hundred individual invoices or may not use any identifier at all, but rely on invoice date.

''Note: "N/A" will appear in any invoice number field where no such number has been provided.

==Invoice Status==
The status of an invoice within Ellerve. An invoice may be:
* Live: The single, legitimate description of cost and consumption over the invoice period
* Retired: A superseded copy of an invoice, retained to allow for a complete record of invoices processed by Ellserve.

''Note: An invoice may be retired for many reasons, however, unless an account was mistakenly invoiced after being closed
'' all retired invoices will be associated by at least one live invoice.

==Monthly Data==
Ellserve reporting uses data aggregated to calendar month intervals.

Monthly data is either
* Account-independent:
** Climate data
* Account-specific:
** Invoice count
* Account-specific & consumption-based:
** Consumption
** Cost (excluding GST)
** Cost (including GST)
** Emissions

'''Monthly Value Types'''
{|class="wikitable" style="text-align: left; color: black;"
! Width="100"|'''Value Type'''
! Width="175"|'''Applies to'''
! Width="750"|'''Definition'''
|-
| align="center" | '''[[#Normalisation|Normalised]]'''
| align="center" | Account-specific &
consumption-based data
| Values allocated to the month in which related consumption actually took place.
E.g. That portion of June consumption in a July invoice would be aggregated to June's normalised consumption values.
|-
| align="center" | '''Invoiced'''
| align="center" | Account-specific &
consumption-based data
| Values allocated to the month in which related consumption was invoiced (by invoice date).
E.g. That portion of June consumption in a July invoice would be aggregated to July's invoiced consumption values.
|-
| align="center" | '''Forecast'''
| align="center" | Account-specific &
consumption-based data
| Values allocated to the month in which actual consumption is expected to take place.
''Note: Forecast values are updated as new invoice data is received.
|-
| align="center" | '''Projected'''
| align="center" | Account-specific &
consumption-based data
| A specialised data form that integrates normalised and forecast data to allow for single 'expected' values for any month where,
for whatever reason, the invoice record is incomplete.
|-
| align="center" | '''Budgeted'''
| align="center" | Account-specific &
consumption-based data
| A set of user-agreed 'expected' values for future months.
''Note: Unlike forecast and projected data, budgeted values, are permanently fixed
''i.e. they are not updated as new invoice data is received.
|}

==Normalisation==
The process of data standardisation to allow meaningful interpretation and comparison with other data. Data maybe normalised in several different ways; however in Ellserve the term “normalised” when applied to cost or consumption implies that invoiced data has been “spread” over the period during which actual consumption took place (thereby avoiding a consumption spike for a month in which more than one invoice is issued).

==Projection==
A continually updated set of system-generated monthly data of the expected monthly cost and consumption values where actual data stream values for a month are incomplete. Incomplete actual data may occur:
* For individual accounts where invoicing periods do not match calendar months
* For account groups where, in a given month, invoicing an account may complete, partial or absent.
Projected data values for an account are calculated by subtracting actual values from forecast values. Where an account’s actual values are based on incomplete invoicing, a falsely positive variance between Actual and Forecast data will occur. Projected data uses Forecast data to fill in the gap created by missing Actual data, eliminating falsely positive variances and allowing earlier detection of valid variances than would be otherwise possible. Where an account is full y invoiced for a month the Projected value is equal to Actual value.

==Report==
A set of Data returned by Ellserve

==Usage==
A term indicating a quantity of a commodity used (sometime associated with a specific activity or application - e.g. 100kWh space heating usage)

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]

Customising Ellserve

2014-06-27T03:09:02Z

WoodsM: /* Configuring Display Controls */

__NOTOC__
====[[Introduction to Site Configuration]]====

====[[Adding or Removing Pages on the Carousel]]====

====[[Configuring a Page]]====

====Configuring Display Controls====
To see how to configure display controls go to [[Common Display Control Features]]

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]

Configuring a Page

2014-06-27T03:08:42Z

WoodsM:

[[File:Page1.png|right|600px|Frame|Newly Created Page]]
Newly created pages appear as tabs on the Carousel named "New (n)".

New pages contain no display controls.

'''>> To configure a page:'''
[[File:Page2.png|right|600px|Frame|Page Configuration Panel]]
* Open the page configuration panel by clicking on the cog icon in the page's [[Ellserve:Carousel|carousel]] tab.
* Enter a name for the page in the name field
* Select controls to add to the page from the drop down list
* Use the arrow icons to define the order in which controls appear on the page (top of the list = first on the page)
* Use the cross icon to delete unwanted page controls


[[File:Page3.png|right|500px|Frame|Page Configuration Panel]]

The control types that can be added to a page are:

* [[Ellserve:Data Table|Data Table]]
* [[Ellserve:Graph|Graph]]
* [[Ellserve:Summary Info|Summary Info]]
* [[Ellserve:Invoice Browser|Invoice Browser]]
* [[Ellserve:Account Information|Account Information]]
* [[Ellserve:Document Browser|Document Browser]]
* [[Ellserve:Budget Tracking|Budget Tracking]]
* [[Ellserve:Documents|Documents]]
* [[Ellserve:Notes|Notes]]

''Note: When a new control is added to a page it is given a generic name.
'' Controls can be individually named using the control's configuration panel.

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Customising Ellserve | ►Customising Ellserve]]

Adding or Removing Pages on the Carousel

2014-06-27T03:08:13Z

WoodsM:

[[File:CarouselCog.png|right|700px|Frame|Site Configuration Cog Icon]]
[[File:Site Config Panel.png|right|400px|Frame|Site Configuration Panel]]
Users with a configurable login can modify the [[Ellserve:Standard Configuration|standard configuration]] by adding or removing [[Ellserve:Carousel|carousel]] page tabs. For example an energy manager may find a page of charts showing the consumption data over different time periods useful for comparison purposes, while a budget manager may require a page dedicated to financial performance.

'''>> To add a page to the data section:'''

* Click on the site configuration cog icon in the [[Ellserve:Carousel|carousel]] to open the site configuration panel.
* Click on the add new page (cross) icon - a new, unnamed page tab will appear in the [[Ellserve:Carousel|carousel]].
* Position the new page on the carousel using the page order control arrows (the page at the top of the list will appear as the left-most tab on the [[Ellserve:Carousel|carousel]]).


'''>> To delete a page from the data section:'''

* Click on the associated delete page icon.

''Note: Use the cog icon on the new tab to name the page and add display controls.''

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Customising Ellserve | ►Customising Ellserve]]

Introduction to Site Configuration

2014-06-27T03:07:50Z

WoodsM: /* De/Activating Configurability */

__NOTOC__
====Controls====
The presentation of data on-screen is managed through display elements called controls. There are two types of control: configuration controls and display controls.

====Configuration Controls====
Configuration controls used to create the structure of the website at two levels:
* '''Section configuration''': determines the number and order of tabbed pages visible in the data section
* '''Page configuration''': determines the number and order of display controls on a single page

====Display Controls====
[[Display Controls]] are shown in the Data Page, each display control provides a display of Ellserve data. Individual controls are configurable from within the control

[[File:Configset.png|right|550px|Frame|Configurability Setting]]

====Saving Configuration Changes Between Sessions====
At the time of creation Individual login are associated with a default configuration based on the [[Ellserve:Standard Template|Standard Template]].
and are specified as '''configurable''' or '''not configurable'''. A user with a non-configurable template can only modify those in-session settings allowed under their login, and will always return to the same defaults with every new login.

Changes made to the default configuration by users with a configurable template are saved against the login ID and are persistent between sessions. A change made to the default configuration against one login ID does not affect the templates of other Login IDs.

====De/Activating Configurability====
Where a login allows the configurabiltiy status for a login ID can be changed.

'''>> To toggle the configurability status for a login:'''

* Select the “Sites Settings” tab in the Settings Section.
* Use the selector to select mode (selecting 'Not Configurable' will cause all cog icons to disappear from the site and access to the defaults settings panel will be removed.


''Note: this option is only available to users with configurable logins. It will temporarily''
''disable access to default setting panels and render the cog icon invisible.''

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Customising Ellserve | ►Customising Ellserve]]

Delete Groups

2014-06-27T03:07:11Z

WoodsM:

[[File:Delete Groups.PNG|right]]
This allows you to delete Ellserve Groups.

'''>> To delete an Ellserve Group''' select the required group from the drop down list, and then press the "Delete" button.

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Settings | ►Settings]]
[[Account Groups | ►Account Groups]]

Change Groups

2014-06-27T03:06:49Z

WoodsM:

[[File:Change Groups.PNG|right]]
This area allows you to upload new or modified Ellserve Group Data.

'''>>To upload Ellserve Group Data''' simply click on "Choose File" and select the csv data file which you wish to upload. Once this is selected click on "Upload" to upload the file.

Note: If you upload a modified version of already existing Group Data, Ellserve will only update the cells which have been modified,
those that are deleted from the modified copy will still exist in Ellserve.
I.e. you can download Group Data, delete the data you don't want modified, do your modifications and then upload it again and the
only thing different will be the modifications you made.

For further information see '''[[Ellserve:Data|FAQ's]]'''

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Settings | ►Settings]]
[[Account Groups | ►Account Groups]]

Get Group Data

2014-06-27T03:06:30Z

WoodsM:

[[File:GGD.PNG|right]]
This area is used to download Account Groups Data from Ellserve as a CSV file.

'''>> To download Account Groups Data:'''

*Select which Group Type you want to download data for using the Group Type drop down box
*Select whether or not you want to include Closed Accounts in the data by either checking or unchecking the ''Include Closed Accounts'' box
*Select the range of dates for which you want to download data using the Date selector. Click on the "plus" tab to open the Date Selector. Here you can choose to either:
**Select a range of dates for which to take data from by clicking on the calendar tabs and selecting the required "Date From" and "Date To" values. Be sure to click save to confirm your selection.
[[File:DDS.PNG|right]]
:*Alternatively you can set it up to take data from a time period relative to the current date. This is done by clicking on the "cog" icon beside either Date From or Date To and checking "Relative" in the pop up ''Date Range Options'' box. Take the example to the right, the "Relative" box is checked for the ''Date From'' field. The ''Date From'' field now contains a drop down box containing the options "Month", "Quarter" and "Year" and another drop down box with a list of numbers and the dates that these correspond to. In the example, "Month" and "-4" are selected, so the date range would be from 4 months before the present date until December 2012. Be sure to click save to confirm your selection.
*Click get '''''Get Group Data''''' to download the specified data.

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Settings | ►Settings]]
[[Account Groups | ►Account Groups]]

Account Groups

2014-06-27T03:06:13Z

WoodsM:

The Account Groups feature allows the user to download Account Groups Data from Ellserve, modify Account Groups Data or upload new Account Groups Data.

====[[Get Group Data|Get Group Data]]====

====[[Change Groups|Change Groups]]====

====[[Delete Groups|Delete Groups]]====

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Settings | ►>Settings]]

Climate Data

2014-06-27T03:05:54Z

WoodsM:

[[File:Map2.PNG|600px|right]]
The Climate Date feature allows the user to select which locations climate data will be collected from.

'''>> To select the map style you see''', click on the required map type tab in the top right corner. In the example to the right "Map" is selected.

'''>> To select the default region''' where the map will initially show, click the cog icon by the "Climate Data" and then select the appropriate region from the drop down list that appears.

'''>> To pan (move the map), do one of the following:'''
*Click and drag the map
*Click the up arrow at the top left of the map to move north
*Click the down arrow at the top left of the map to move south
*Click the right arrow at the top left of the map to move east
*Click the left arrow at the top left of the map to move west

'''>> Additionally you can zoom in or out''' by clicking the + / - buttons to the left of the map or alternatively by dragging the slider up / down.

The red markers on the map correspond to locations in the ''Unselected Values'' list and the green markers correspond to locations in ''Selected Values'' list.

'''>> Adding/removing a new location to/from the ''Selected Values'' list''' can be done in two ways:
*Highlighting the required location to be added in the ''Unselected Values'' list by clicking on it, and then clicking the right hand arrow located between the two boxes to shift it to the ''Selected Values'' list. Alternatively to remove a location from the ''Selected Values'' list highlight it and then click on the left hand arrow to shift it to the ''Unselected Values'' list.
*Clicking on a red marker on the map and then selecting "Add" in the pop up box adds that particular location to the selected values list, and turns the marker green. Alternatively clicking on a green marker and then selecting "Remove" in the pop up box removes that particular location from the ''Selected Values'' list.

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Settings | ►Settings]]

User Settings

2014-06-27T03:05:34Z

WoodsM:

{|class="wikitable" style="text-align: left; color: black;"
!Width="100" Align="Center"|'''Contact Person'''
|
:The person to be contacted about Ellserve matters
|-
!'''Email Address'''
|
:The Email address to be used for correspondence
|-
!'''Password'''
|
:Facility for changing your password
|}

'''>> To edit any of the above fields''' simply type in the required field and then click on "Apply" to confirm.

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Settings | ►Settings]]

Site Settings

2014-06-27T03:05:17Z

WoodsM:

{|class="wikitable" style="text-align: left; color: black;"
!Width="100" Align="Center"|'''Financial Period'''
|
:This allows you to set which month your financial year begins in from the drop down box.
|-
!'''Configuration Mode'''
|
:Choosing Configurable from the drop down box allows you to configure the site to your preferences as in [[Ellserve:Configuring_Ellserve|Configuring Ellserve]], choosing Not Configurable turns this option off.
|}

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Settings | ►Settings]]

Settings

2014-06-27T03:05:04Z

WoodsM: /* Account Groups */

__NOTOC__
The Settings section is accessed by clicking on the "Settings" tab in the '''[[Header Banner |Header Banner]]'''.
[[File:Settings Banner.PNG|right]]

The following Settings pages can be accessed by clicking on the corresponding tab in the Settings Banner (shown to the right).

====[[Site Settings]]====

====[[User Settings]]====

====[[Climate Data]]====

====[[Account Groups]]====

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]

Document Browser

2014-06-27T03:04:35Z

WoodsM: /* Usage */

[[File:Document Browser.png|right|750px|Frame]]
[[File:NewFolder.png|right|400px|Frame]]
[[File:DelFolder.png|right|750px|Frame]]
[[File:OpenFolder.png|right|750px|Frame]]
[[File:Upload.png|right|400px|Frame]]
[[File:File.png|right|750px|Frame]]
The Document Browser is used to manage documents and other electronic data stored in Ellserve.
==Configuration==
The document browser has no configurable features.

==Usage==

'''>> To navigate folders:'''
*Click on the up arrow in the top right corner to go back to previous folder
*To return to the "Home" screen click on the house icon in the top right corner.
*Clicking on a folder name in the folder hierarchy will open that folder.

'''>> To create a folder:'''
*Click on the folder name in the folders panel (this will highlight the folder) and click '''New Folder''' in the action panel.
*Enter the new folder name in the pop-up box
*Click the '''Create Directory''' button and close the pop-up box

'''>> To delete a folder:'''
*Click on the folder name in the folders panel (this will highlight the folder)
*Click '''Delete Folder''' in the action panel.

'''>> To open a folder:''' in the Document Browser simply double click on it.

'''>> To Upload a new document:'''
*Navigate to the storage folder and click '''Upload New File''' in the action panel. this wil open the file up load pop-up box.
*Use the '''Choose File''' button pop-up box and use the standard Windows file navigator to locate the document.
*Click the '''Upload File''' button and close the pop-up box

'''>> To open a document:'''
*Double click on the document icon in the documents panel; or
*Click on '''Download File''' in the action panel; or
*Copy the document URL from the External URL panel and paste in to a browser.

'''>> To delete a document:'''
*Click on the document name in the document panel (this will highlight the document)
*Click '''Delete File''' in the action panel.

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]
[[Data Page| ►Data Page]]
[[Display Controls| ►Display Controls]]

Notes

2014-06-27T03:04:03Z

WoodsM: /* Usage */

==Purpose==
A note is a free text field for recording useful information at a variety of levels within Ellserve.

There are four types of note:

{| class="wikitable" style="text-align: left; color: black; Width=600pt;"
! Width="150pt"|'''Type'''
! Width="250pt"|'''Description'''
!'''Examples Of Use'''
|-
|
:'''General'''
|
:To record information of a general nature applicable to single account or a group of accounts
|
:* To record a change of tariff structure for a specific account
:* To record a change in general ledger coding for a group of accounts
:* To attach contract details for all included accounts
|-
|
:'''Supply Point (ICP)'''
|
:To record information relating to a specific site/supply point.
|
:* To make note of a change in site usage that altered consumption patterns
:* To record a history of the site
|-
|
:'''Invoice'''
|
:To record information relating to a specific invoice.
|
:* To make note of billing issue and stages resolution
:* To record bill related events such as:
:** Consumption changes due to exceptional circumstances like a temporary close down or a period of unusually high production
:** Additional charges on a bill perhaps relating to the resolution of an outstanding issue or change of charging basis
|-
|
:'''Meter'''
|
:To record information relating to a specific meter.
|
:* To record information of how to find difficult to locate meters
:* To details meter issues (e.g. suspected faulty operation)
:* To record meter change events (e.g. switch to smart metering)
|}

'''Note: The four different types assist in classifying the content of notes, however all notes are associated at the account level.
When a note is created it is linked to all accounts current selected by the [[Filtering Functions|filter]].'''

==Configuration==
The notes control has no configurable features.

==Features==
The notes browser has three tabbed function panels:
#The browsing panel
#The editing panel
#The viewing panel

===The browsing panel===
The browsing provides access to previously created notes. It lists all notes for all accounts selected by the current [[Filtering Functions|filter]].

[[File:Notes.PNG|right|600px|Frame|Notes browsing panel]]

{| class="wikitable" style="text-align: left; color: black; Width=600pt;"
! Width="150pt"|'''Feature'''
!'''Description'''
|-
|
:'''Number of entries selector'''
|
: Selects how many entries will appear in the displayed list.
|-
|
:'''Off-screen entry selector'''
|
: Allows browsing of off-screen notes by numbered sub-page.
|-
|
:'''Account search'''
|
: Filters a sub-set of notes using a search string. Searching takes place across all fields and is applied as each character is typed.
|-
|
:'''Count of entries'''
|
: Shows a count of the individual notes currently accessible (this count is updated as searches are applied).
|-
|
:'''Sortable Columns'''
|
: All columns with a pale grey double headed arrow on the right margin of the column header cell are sortable. A single click anywhere in the column cell sorts the whole account list in ascending order by the contents of the column. A second click re-sorts in descending order. The list can only be sorted by one column at a time. Currently applied sorts are indicated by replacing the grey double headed arrows with a single dark grey arrow head (down for descending order, up for ascending order).
|-
|
:'''Number of accounts'''
|
: An information only column showing how many individual accounts are associated with the note.|-
|-
|
:'''Account selection'''
|
: Clicking on a row in the notes list causes all instance of the selected note to be listed in the viewing panel.
|}

----

===The editing panel===

The editing panel allows notes created, edited and be associated with documents stored on Ellserve.

===The viewing panel===

The viewing panel:
* displays the text of a note
* provides links to associated documents
* provides a searchable list of all account associated with an individual note (unlike the note browsing panel which shows all notes for the selected accounts)

<gallery caption="The Editing and Viewing Panels" widths="450px" heights="300px" perrow="2">
File:Edit.PNG
File:View1.PNG
</gallery>

==[[Notes Usage|Usage]]==

[[Notes Usage|Click here]] for more on using notes.

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]
[[Data Page| ►Data Page]]
[[Display Controls| ►Display Controls]]

Budget Tracking

2014-06-27T03:03:27Z

WoodsM: /* Usage */

The budget tracker allows actual cost and consumption to be tracked against budgets by individual account or by any grouping of accounts. The tracker highlights variances over a user-defined threshold by by month or quarter.

==Configuration==
[[File:Budget Tracker Config.PNG|700px|right]]
[[File:Budget Tracker.PNG|700px|right]]
{| class="wikitable" style="text-align: left; color: black;"
!Width="100" Align="Center"|'''Purpose '''
|
:To allow comparison between budgeted and actual cost and consumption.
|}

{|class="wikitable" style="text-align: left; color: black;"
! Width="150" Align="Center"|'''Settings'''
! Width="300"|'''Description'''
! Width="200"|'''Values'''
|-
|
:'''Title'''
|
:[[Control Title Configuration|Control display title]]
|
:Custom
|-
|
:'''Category'''
|
:Determines how quantitative data is aggregated
|
:Retailer, Business Unit, Asset Type, etc.
|-
|
:'''Commodity'''
|
:Determines the commodity for which data will be displayed
|
:*Energy
:*Electricity
:*Gas
:*Trade Waste
:*Water
:*Wastewater
|-
|
:'''Metric'''
|
:The units which consumption is displayed in
|
:*Electricity Cost Ex. GST($)
:*Electricity Consumption (kWh)
|-
|
:'''Height'''
|
:Determines the height of the table (in pixels)
|
:User-Defined
|-
|
:'''Threshold (%)'''
|
:The threshold percentage above which a green or red highlight will be used in the "diff" column
|
:User-Defined
|-
|
:'''Date From'''
|
:Controls the relative end date of the data. Data will be taken from the start of the previous year until the specified date. For example, selecting "Nov 2012" would give Data from the start of 2011 until November 2012.
|
:Date
|-
|
:'''Track By'''
|
:Controls the length of the reporting period used
|
:*Monthly
:*Quarterly
|}

==Usage==
The budget tracking control has no interactive usage features.

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]
[[Data Page| ►Data Page]]
[[Display Controls| ►Display Controls]]

Account Information

2014-06-27T03:03:00Z

WoodsM: /* Usage */

__NOTOC__
{| class="wikitable" style="text-align: left; color: black;"
!Width="100" Align="Center"|'''Purpose '''
|
:To provide access to individual Account details and quickly identify accounts of interest (e.g. largest consumption, highest unit cost or lowest emissions.
|}
===Configuration===
[[File:Account Config.PNG|700px|right]]
[[File:Accounts.PNG|700px|right]]

{|class="wikitable" style="text-align: left; color: black;"
! Width="150" Align="Center"|'''Settings'''
! Width="300"|'''Description'''
! Width="200"|'''Values'''
|-
|
:'''Title'''
|
:[[Control Title Configuration|Control display title]]
|
:Custom
|-
|
:'''Tabular Value types'''
|
:Controls which account details are shown in the table
|
:*Description
:*Last Invoice
:*Closed Date
:*Opened Date
:*Retailer
:*TAX
:*Consolidated Site
:*Department
|-
|
:'''Date range'''
|
: Reporting time period
|
:[[Date Picker Configuration|Date range from date picker]]
|-
|
:'''Value Types'''
|
:[[Monthly Value Picker|Values to be reported in table]]
|
:[[Time Series Data|All time series data values]]
|}

===Usage===

The account information control has a number of interactive features to identify and display [[Commodity Accounts#Account browser|account details]].

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]
[[Data Page| ►Data Page]]
[[Display Controls| ►Display Controls]]

Supply Point Information

2014-06-27T03:02:36Z

WoodsM: /* Usage */

[[File:ICP Config.PNG|700px|right]]

{| class="wikitable" style="text-align: left; color: black;"
!Width="100" Align="Center"|'''Purpose '''
|
:To provide access to individual Supply Point details via a customisable browser.
|}

''Note: 'ICP' is used interchangeably with 'Supply Point'
for gas and electricity or other commodities.''
==Configuration==
===The ICP Information Configuration Panel===
[[File:ICP Details.PNG|700px|right]]
{|class="wikitable" style="text-align: left; color: black;"
! Width="150" Align="Center"|'''Settings'''
! Width="300"|'''Description'''
! Width="200"|'''Values'''
|-
|
:'''Title'''
|
:[[Control Title Configuration|Control display title]]
|
:Custom
|-
|
:'''Tabular Value types'''
|
:Controls which details will be shown in the table
|
:*GXP
:*Commodity
:*Address
|-
|
:'''Date range'''
|
: Reporting time period
|
:[[Date Picker Configuration|Date range from date picker]]
|}

==Usage==

The connection information control has a number of interactive features to identify and display [[Connection Details#Connection Browser|connection details]].

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]
[[Data Page| ►Data Page]]
[[Display Controls| ►Display Controls]]

Invoice Browser

2014-06-27T03:02:10Z

WoodsM: /* Usage */

[[File:InvBrow1..png|right|700px|Frame|Data Table Configuration Panel]]
{| class="wikitable" style="text-align: left; color: black;"
!Width="100" Align="Center"|'''Purpose '''
|
:To provide on-screen access to individual invoice details and a bulk download of multiple invoices.
|}
==Configuration==
===The invoice browser configuration panel===
[[File:InvBrow2..png|right|700px|Frame|Data Table Display]]
{|class="wikitable" style="text-align: left; color: black;"
! Width="150" Align="Center"|'''Settings'''
! Width="260"|'''Description'''
! Width="290"|'''Values'''
|-
|
:'''Title'''
|
:[[Control Title Configuration|Control display title]]
|
:Custom
|-
|
:'''Value types'''
|
:The [[Descriptive Data|descriptive details]] used to identify accounts with invoices of interest.
|
:* Invoice No (where provided by retailer otherwise "N/A")
:* Account Name (usually retailer account number)
:* Invoice date (date ion which invoice was raised by retailer)
|-
|
:'''Date range'''
|
: Reporting time period
|
:[[Date Picker Configuration|Date range from date picker]]
|}

==Usage==

The invoice browser has a number of interactive features to identify and display invoices. The [[Bills Page#Invoice List|invoice list]] allows access to a single invoice which is displayed in the [[Bills Page#Invoice Details Panel|invoice details panel]].

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]
[[Data Page| ►Data Page]]
[[Display Controls| ►Display Controls]]

Graph

2014-06-27T03:01:44Z

WoodsM: /* Usage */

==Configuration==
===Single Y-Axis Graphs===
[[File:SingleY1.png|right|750px|Frame|Single Y-Axis Graph Configuration Panel]]
{| class="wikitable" style="text-align: left; color: black;"
!Width="100" Align="Center"|'''Purpose '''
|
:To chart a single [[Time Series Data|time series data value]].
|-
!'''Example '''
|
:To chart normalised energy consumption for a group of accounts cumulatively, by year for the last four years.
|}
[[File:SingleY2.png|right|750px|Frame|Single-Y Axis (line, year-wrap, cumulative]]
{|class="wikitable" style="text-align: left; color: black;"
! Width="150" Align="Center"|'''Settings'''
! Width="300"|'''Description'''
! Width="200"|'''Values'''
|-
|
:'''Title'''
|
:[[Control Title Configuration|Graph display title]]
|
:Custom
|-
|
:'''Graph type'''
|
: Determines the type of chart displayed
|
:Single Y-Axis
|-
|
:'''Graph value type'''
|
: Determines if point values are charted singly or cumulatively
|
:* Monthly
:* Cumulative
|-
|
:'''Wrap type'''
|
: Determines if values are charted continuously or wrapped buy financial year
|
:* Continuous
:* Year wrap
|-
|
:'''Height'''
|
: Determines the vertical height (in pixels) of the chart on the rendered web page
|
: Custom
|-
|
:'''Y-Axis value type'''
|
:[[Monthly Value Picker|Value to be charted]]
|
:[[Time Series Data|All time series data values]]
|-
|
:'''Y-Axis plot type'''
|
:Determines the on-screen appearance of the data plot
|
:* Line
:* Bar
|-
|
:'''Date range'''
|
: Reporting time period
|
:[[Date Picker Configuration|Date range from date picker]]
|}

''Note: To make a parameter available for in-session setting, check the box to the left of the setting parameter.

===Double Y-Axis Graphs===
[[File:DoubleY1.png|right|750px|Frame|Double Y-Axis Graph Configuration Panel]]
{| class="wikitable" style="text-align: left; color: black;"
!Width="100" Align="Center"|'''Purpose '''
|
:To chart two [[Time Series Data|time series data values]] of the same or different units against each other.
|-
!'''Example '''
|
:To chart normalised energy consumption for a single account cumulatively against cost for the last three financial years.
|}
[[File:DoubleY2.png|right|750px|Frame|Double-Y Axis (cost vs consumption)]]
{|class="wikitable" style="text-align: left; color: black;"
! Width="150" Align="Center"|'''Settings'''
! Width="300"|'''Description'''
! Width="200"|'''Values'''
|-
|
:'''Title'''
|
:[[Control Title Configuration|Graph display title]]
|
:Custom
|-
|
:'''Graph type'''
|
: Determines the type of chart displayed
|
:Double Y-Axis
|-
|
:'''Y1-Axis plot type'''
|
:Determines the on-screen appearance of the plot against the 1st Y-Axis
|
:* Line
:* Bar
|-
|
:'''Y2-Axis plot type'''
|
:Determines the on-screen appearance of the plot against the 2nd Y-Axis
|
:* Line
:* Bar
|-
|
:'''Height'''
|
: Determines the vertical height (in pixels) of the chart on the rendered web page
|
: Custom
|-
|
:'''Y1-Axis value type'''
|
:[[Monthly Value Picker|Value to be charted]] on the 1st Y-Axis
|
:[[Time Series Data|All time series data values]]
|-
|
:'''Y2-Axis value type'''
|
:[[Monthly Value Picker|Value to be charted]] on the 2nd Y-Axis
|
:[[Time Series Data|All time series data values]]
|-
|
:'''Date range'''
|
: Reporting time period
|
:[[Date Picker Configuration|Date range from date picker]]
|}


'''Tip: If using a double Y-Axis graph to chart values of the same unit take care when comparing the two plots as they could have different scales depending on how each axis has been rendered.'''


===Unit Graphs===
[[File:Unit1.png|right|750px|Frame|Unit Graph Configuration Panel]]
{| class="wikitable" style="text-align: left; color: black;"
!Width="100" Align="Center"|'''Purpose '''
|
:To chart mutiple [[Time Series Data|time series data values]] of the same units against each other.
|-
!'''Example '''
|
:To chart the unit cost of all energy, electricity and gas for the last two calendar years.
|}
[[File:Unit2.png|right|750px|Frame|Unit Cost Unit Graph]]
{|class="wikitable" style="text-align: left; color: black;"
! Width="150" Align="Center"|'''Settings'''
! Width="300"|'''Description'''
! Width="200"|'''Values'''
|-
|
:'''Title'''
|
:[[Control Title Configuration|Graph display title]]
|
:Custom
|-
|
:'''Graph type'''
|
: Determines the type of chart displayed
|
:Unit
|-
|
:'''Units'''
|
:Determines the unit type that can be displayed on the graph.
|
:* Cost ($)
:* Commodity Group Usage
:** Energy(kWh)
:** Water (kL)
:* Emissions tCO2</Sub}e
:* unit Cost ($/Unit)
|-
|
:'''Monthly values'''
|
:[[Monthly Value Picker|Values to be charted]]
|
:[[Time Series Data|All time series data values]] sharing the selected graphing unit
|-
|
:'''Height'''
|
: Determines the vertical height (in pixels) of the chart on the rendered web page
|
: Custom
|-
|
:'''Plot type'''
|
:Determines the on-screen appearance of the charted values.
|
:* Line
:* Bar
|-
|
:'''Graph value type'''
|
: Determines if point values are charted singly or cumulatively
|
:* Monthly
:* Cumulative
|-
|
:'''Date range'''
|
: Reporting time period
|
:[[Date Picker Configuration|Date range from date picker]]
|}


'''Tip: When configuring a unit chart take care to choose values that make sense, for example accumulated unit cost has no meaning.'''


===Pie Graphs===
[[File:Pie1.png|right|750px|Frame|Unit Graph Configuration Panel]]
{| class="wikitable" style="text-align: left; color: black;"
!Width="100" Align="Center"|'''Purpose '''
|
:To chart accumulated [[Time Series Data|time series data values]] for a single data item by a reporting category.
|-
!'''Example '''
|
:To chart the contribution of each business unit to total energy consumption for the last 12 months.
|}
[[File:Pie2.png|right|750px|Frame|Unit Cost Unit Graph]]
{|class="wikitable" style="text-align: left; color: black;"
! Width="150" Align="Center"|'''Settings'''
! Width="300"|'''Description'''
! Width="200"|'''Values'''
|-
|
:'''Title'''
|
:[[Control Title Configuration|Graph display title]]
|
:Custom
|-
|
:'''Graph type'''
|
: Determines the type of chart displayed
|
:Pie
|-
|
:'''Threshold Percentage'''
|
:Determines the threshold over which and single contributing group receives a dedicated slice.
|
:Custom
|-
|
:'''Monthly values'''
|
:[[Monthly Value Picker|Values to be charted]]
|
:[[Time Series Data|All time series data values]] sharing the selected graphing unit
|-
|
:'''Height'''
|
: Determines the vertical height (in pixels) of the chart on the rendered web page
|
: Custom
|-
|
:'''Category Type'''
|
:Determines the reporting category will be used to slice up the pie.
|
:Custom
|-

|
:'''Date range'''
|
: Reporting time period
|
:[[Date Picker Configuration|Date range from date picker]]
|}

''Note: When filtering down to a small number of accounts the pie chart may contain only one slice.

==Usage==
Graphs have no interactive usage features.

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]
[[Data Page| ►Data Page]]
[[Display Controls| ►Display Controls]]

Data Table

2014-06-27T03:01:20Z

WoodsM: /* Usage */

==Configuration==
[[File:Table1.png|right|750px|Frame|Data Table Configuration Panel]]
{| class="wikitable" style="text-align: left; color: black;"
!Width="100" Align="Center"|'''Purpose '''
|
:To report [[Time Series Data|time series data values]] in side-by-side columns, by month, quarter or year
|-
!'''Example '''
|
:To compare actual versus projected cost, consumption and emissions data by month for an individual or any predefined grouping of accounts or ICPs.
|}
[[File:Table2.png|right|750px|Frame|Data Table Display]]
{|class="wikitable" style="text-align: left; color: black;"
! Width="150" Align="Center"|'''Settings'''
! Width="300"|'''Description'''
! Width="200"|'''Values'''
|-
|
:'''Title'''
|
:[[Control Title Configuration|Control display title]]
|
:Custom
|-
|
:'''Frequency of data '''
|
: Defines time-step for data aggregation
|
:* Monthly
:* Quarterly
:* Half-yearly
:* Annually
|-
|
:'''Value types'''
|
:[[Monthly Value Picker|Values to be reported in table]]
|
:[[Time Series Data|All time series data values]]
|-
|
:'''Date range'''
|
: Reporting time period
|
:[[Date Picker Configuration|Date range from date picker]]
|}

==Usage==
The data table has no interactive usage features.

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]
[[Data Page| ►Data Page]]
[[Display Controls| ►Display Controls]]

Display Controls

2014-06-27T02:57:02Z

WoodsM: /* Document browser */

__NOTOC__
===Configurability===
Most display controls are configurable at two levels:
* '''Default:''' Controls are restored to the default settings at each new login. Default settings are maintained using the [[Control Default Settings Panel|control default settings panel]].
* '''Session:''' Session settings can be altered within a single login session. Session settings are altered in real-time using a control's '''in-session parameters panel'''.

''Note: In-session settings are made are available at run-time through the default configuration panel.''

===Control Types===
The display controls currently available in Ellserve are:

====[[Data Table|Data table]]====
The Data Table is a general purpose tabular display of monthly data

====[[Graph|Graph]]====
A number of graph types can be shown on the graph control. These are used to display monthly data

====[[Summary Info|Summary information]]====
This table can be configured to show monthly values summed over quarters, years or other configurable periods

====[[Invoice Browser|Invoice browser]]====
The invoice browser allows inspection of invoice details

====[[Supply Point Information|Supply Point (ICP) information]]====
Provides information relating to supply points

====[[Account Information|Account information]]====
Provides access to account information

====[[Budget Tracking|Budget tracker]]====
A specially designed control that helps keep track of overall budgetary information

====[[Notes|Notes]]====
Allows text notes relating to accounts or groups of accounts to be saved and retrieved

====[[Document Browser|Document browser]]====
Allows documents relating to be stored and accessed in Ellserve

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]
[[Data Page| ►Data Page]]

Monthly Value Picker

2014-06-27T02:56:26Z

WoodsM:

[[File:VPick1.png|right|border|400px|Monthly Value Picker]]

Most display controls provide tools for setting the monthly values to be charted or tabled.

[[File:VPick2.png|right|400px|Add New Value]]
[[File:VPick3.png|right|400px|Individual Value Selection]]
[[File:VPick4.png|right|400px|Criteria Selection]]
[[File:VPick5.png|right|400px|Save Criteria Selection]]
[[File:VPick6.png|right|400px|Saved Monthly Value Selection]]


'''>> To add a new monthly value to a control:'''

* Click on the pencil icon to the left of the box containing "Please Select A Value" (tabled data only)
** Three value criteria drop-down selectors will appear

* Choose appropriate criteria for the value in each of the drop down boxes (see table below)

* Click on the tick mark icon to save settings
** The three criteria boxes will be replaced by a single box containing the name of the selected value and the tick mark icon will be replaced with the pencil icon.


''Note: The order in which values are selected is reflected in the control.
''For example the columns in the data table control will appear in the same
''order as the values are listed in the value picker. New values are placed
''at the bottom of the list (i.e. would appear in the right most column in
''the data table) when they are first added.''


'''Tip: Always remember to click the tick mark to save your criteria, otherwise they will be ignored when data is displayed.'''


''Note: Each saved value selection causes the display of the underlying control to be refreshed

====Defaults====
Defaults for new charts:

* Normalised monthly consumption (Single Y-axis)
* Normalised monthly cost (Double Y-Axis)

No defaults are provided in new table-based controls.


'''>> To modify an existing monthly value:'''


* Click on the pencil icon next to the box containing the value to be amended and change the criteria to those required.
* Remember to click on the tick mark icon to save settings


''Note: Modified values are placed at the bottom of the values list (which may be off-screen in a long values list).''

[[File:VPick7.png|right|400px|Delete Monthly Value]]


'''>> To delete an existing monthly value:'''

* Click on the cross icon next to the right of box containing the value to be deleted.



''Note: No warning messages conforming the deletion will be displayed.



'''Tip: A quick way to rearrange the display order of values is to select an item to move and click on its pencil icon and then immediately click on its tick mark icon. This operation will not change the value's criteria, but will place the value at the bottom of the list.'''


----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]
[[Data Page| ►Data Page]]
[[Common Display Control Features| ►Common Display Control Features]]

Date Picker Configuration

2014-06-27T02:55:51Z

WoodsM:

[[File:Date1.png|right|400px|border|Date Picker - Collapsed]]
[[File:Date2.png|right|400px|border|Date Picker - Expanded]]
[[File:Date3.png|right|400px|border|Date Picker - Fixed/Relative Toggle]]
[[File:Date4.png|right|400px|border|Date Picker - Fixed Date Selector]]
[[File:Date5.png|right|400px|border|Date Picker - Relative Date Selector]]
Most controls show data over a specified date range (e.g. graphing energy costs from the beginning of the financial year, or browsing invoices received in the last three months). A date range is expressed as two (inclusive) values:
* From month
* To month

The default date range is used when a control is launched.

A date range may be:
* '''Fixed:''' both start and end months are specified calendar dates (e.g. May 2012 to August 2012 inclusive)
* '''Relative:''' both start and end months are set relative to the current month (e.g. from 6 months ago until now)
* '''Combined:''' Either the to or the from date is fixed while the other is relative (e.g. from June 2012 until last month inclusive).

On first opening, the [[Ellserve:Control Default Settings Panel|default settings panel]] shows the date selector in a collapsed state with the current default range displayed as calendar dates (relative dates settings are converted as appropriate).


'''>> To specify a date range using the picker:'''
* Use the expander icon to show the full date picker
* Click on the cog icon to toggle between fixed and relative date settings
* For fixed dates use the calendar icon to select the required month
* For relative dates:
** Select the required time interval (Month, Quarter, Year)
** Select number of intervals to be included in the range (can be typed or selected from the drop down list)


''Note: Negative interval numbers indicate historical offsets, ''
''while for future intervals the offset is indicated with a''
''positive number. The current interval is always indicated as zero.''


'''>> Check the 'Date Range' check box to enable date ranges to be changed in session.'''


----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]
[[Data Page| ►Data Page]]
[[Common Display Control Features| ►Common Display Control Features]]

In-session Settings Panel

2014-06-27T02:55:24Z

WoodsM:

[[File:InSessPanel.png|right|650px|Frame|Default Setting Panel - Chart Control]]

In-session settings allow the format and content of a display control to be temporarily modified. For example the date range for a chart can be altered from the default range using in-session settings.

The diagram to the left shows an in-session settings panel for a [[Ellserve:Graph#Single Y-Axis Graph|single Y-axis chart]] allowing a user to temporary specify the chart's date range.

'''>> To use a control's in-session settings:'''
Open or close the control's default settings panel by clicking on the expand/collapse icon. [[File:ExColl.png|left|Frame|In-session Settings Icon]]


''Notes:
''The expand/collapse icon usually appears in the top right corner of a control box.''
''The panel remains open until the control's collapse is clicked; the website remains usable whether this panel is expanded or collapsed.
''However, some controls require the panel to be closed for the control's display is refreshed with the new settings.''

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]
[[Data Page| ►Data Page]]
[[Common Display Control Features| ►Common Display Control Features]]

Control Default Settings Panel

2014-06-27T02:54:53Z

WoodsM:

[[File:DefaultPanel.png|right|750px|Frame|Default Setting Panel - Chart Control]]

'''>> To access a control's configuration features:'''
* Open the control's default settings panel by clicking on the cog icon.


[[File:Cog.png|Frame|Configuration (Cog) Icon]]

''Note: The cog icon is only visible in configurable mode.''

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]
[[Data Page| ►Data Page]]
[[Common Display Control Features| ►Common Display Control Features]]

Control Title Bar

2014-06-27T02:54:27Z

WoodsM:

The control title bar contains important information on the context of displayed data. It will show:
* an optional fixed description
* a system generated context description

Ellserve automatically generates titles for many display controls based on the control's content.
The control title settings allow a fixed, custom title to be specified. The custom title is entered in the description field and the check box toggles the title's visibility in the title bar. Fixed descriptions allow the user to set title bar headings that are meaningful to them.

[[File:TitleBar.png|600px|Frame|Control Title Element - Context Description]]

In the this example, fixed description is disabled, and the context description shows the control is displaying data for sites with time of use metering, aggregated by business unit over the period September 2011 to September 2012.

[[File:TitleBarAll.png|
600px|Frame|Control Title Element - Full Description]]

In this example the fixed description (Consumption Pie) has been enabled which decreases the font size of context description.

''Note: The fixed description can be disabled, but the context description is always displayed.''
''It is worth giving all controls a fixed name, even if it will not be displayed.''
''Control titles are used (in preference to generic control type) by the [[Page Configuration]] control to show ''
''the order in which display controls appear on a page. ''

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]
[[Data Page| ►Data Page]]
[[Common Display Control Features| ►Common Display Control Features]]

Common Display Control Features

2014-06-27T02:54:03Z

WoodsM: /* Monthly value picker */

__NOTOC__
The following configuration features are common to many of display controls:

====[[Control Title Bar]]====
Using the Display Control title bar

====[[Control Default Settings Panel|Accessing a control's configuration settings]]====
How to configure the behavior of a control

====[[In-session Settings Panel]]====
How to change what is shown on the control during a session

====[[Date Picker Configuration|Date picker]]====
How to select dates in the controls

====[[Monthly Value Picker|Monthly value picker]]====
How to select value sets in the controls

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]
[[Data Page| ►Data Page]]

Data Page

2014-06-27T02:53:41Z

WoodsM: /* Display Controls */

The Data Browser contains configurable pages containing graphs and tables summarising and giving access to all your Ellserve data. The data page contains a number of [[Glossary#Display Control|Display Controls]]

====[[Common Display Control Features]]====
Here is a description of the commonly seen features of the display controls in the data browser

====[[Display Controls]]====
Here is a description of the display controls available in the data browser

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]

Carousel

2014-06-27T02:53:16Z

WoodsM:

'''Purpose:'''
The carousel is a row of tabs each allowing access to one or more data display pages. More tabs can be accessed through the carousel than may be displayed on screen; left and right arrow icons allow the carousel to be moved one tab to the left or the right.

[[File:Carousel1.png|eft|750px|Frame|The Carousel]]


'''>> To open a display page click on a tab in the carousel'''


'''>> To show tabs not currently displayed by the carousel, click the 'more pages' tab.'''


''Note: The number of Data Section Pages in the standard configuration will vary by implementation, depending on the range of commodities being managed.

'''Carousel Sub-tabbing'''
Each tab on the carousel can provide access to a number of related pages through a set of sub-tabs. Tab/sub-tab relationships are defined under in the page [[Site Configuration|site configuration control]].


'''>> To open display sub-tabs move the mouse over a tab in the carousel'''

[[File:Carousel2.png|eft|500px|Frame|The Carousel]]

[[File:Carousel3.png|eft|500px|Frame|The Carousel]]

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]

Filtering by a Single Account or ICP

2014-06-27T02:52:38Z

WoodsM:

[[File:Filter5.png|right|750px|Frame|Filter Feature Expanded]]

A [[Filtering Functions|filter]] for a single account or ICP can be applied through a search function in the [[Accessing the Filter Manager|filter manager]].


'''>> To apply a filter for a single account:'''
* Expand the [[Accessing the Filter Manager|filter manager]]
* Click the '''Select by: Account''' button
* Begin entering a search string in to the '''Search:''' field (this can be an account number, part of an address or other relevant descriptive data)
* A list of search hits matching the string will appear in the search results (the list will shorten as the search string lengthens)
* Click on the relevant account number to apply a filter for that account alone 

''NOTE: When filtering by a single account or ICP all previously selected
''group options are hidden and replaced by the selected account/ICP
''in the current filter description. Removing the account/ICP
''from the filter restores all previous selected filter options.''

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]
[[Data Filter| ►Data Filter]]

Accessing the Filter Manager

2014-06-27T02:52:08Z

WoodsM:

By default Ellserve launches with no filters applied and the filter manager collapsed. The filter manager is found directly below the [[Header Banner|header banner]] in both the [[The Data Section|data]] and [[Reporting|reporting]] sections.

'''>> To Expand the Filter Manager::''' Click the ''''+'''' icon to the left of the filter description bar.

[[File:Filter 1.png|250px|Frame|Accessing The Filter Functions]]

In the example graphic below the filter manager is expanded, showing a total of 192 accounts for 101 ICPs available for filtering. No filter has yet been applied and the filter description bar still shows "All Accounts".

''Note: An ICP may be associated with more than one account over time.

[[File:Filter2.png|750px|Frame|Filter Feature Expanded]]

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]
[[Data Filter| ►Data Filter]]

Data Filter

2014-06-27T02:51:48Z

WoodsM: /* When to use the Filter */

__NOTOC__
'''Purpose:'''

A filter restricts information being displayed or reported to a useful sub-set (e.g. show me only information for time of use sites for the corporate service business group).

''Note: Filters only affect what is shown in the [[Data Section]]. The Reporting Section has its own filters.''
----

====[[Accessing the Filter Manager|Accessing the Filter Manager]]====

====[[Applying a Filter|Applying a Filter]]====

====[[Filtering by a Single Account or ICP|Filtering by a Single Account or ICP]]====

----

==='''When to use the Filter'''===
You are encouraged to make extensive use of the filter, and make a habit of applying filters as a first step in any analysis or reporting process.

''Note: Filtering reduces data server loads, resulting in faster website response times.''

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]

Data Browser

2014-06-27T02:51:32Z

WoodsM: /* Data Page */

The Data Browser contains configurable pages containing graphs and tables summarising and giving access to all your Ellserve data. The Data Browser contains three parts:

====[[Data Filter]]====
The data filter is used to choose the data set to be displayed in the data browser

====[[Carousel]]====
The Carousel gives access to a number of data pages

====[[Data Page]]====
The Data Page is a 'dashboard' or set of displays (graphs, tables, reports etc.) relating to the currently selected data set

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]

Header Banner

2014-06-27T02:51:15Z

WoodsM:

The Header Banner appears at the top of the screen in every Ellserve session.

[[File:Header_Banner.png|Right|800px|Frame|Ellserve Header Banner]]

'''Purpose:'''
* Displays the login ID of the current user
* Allows secure log out
* Provides access to functional sections:
** ''[[Data Browser]]'' providing on-screen access to data displays;
** ''[[Reporting]]'' allows report definition for downloading data in csv format; and
** ''[[Settings]]'' site configuration and maintenance functions.

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]

Summarised

2014-06-27T02:50:54Z

WoodsM: /* Summarised Data */

==Summarised Data==

Ellserve will create summarised data on-the-fly for on-screen display and file downloads.

Examples of derived data include:
* Total consumption for an account over a number of months
* Total quarterly cost for a group of accounts
* Total annual emissions for the whole organisation
* Number of days since last invoice for an account
* Year-to-Date variance between budget and actual cost for a cost centre
* Rolling 12 month average unit cost for a group of accounts (e.g. c/kWh)

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Ellserve Data | ►Ellserve Data]]

User Defined

2014-06-27T02:50:33Z

WoodsM:

User-defined data is a sub-set of descriptive data, which the client can define and allocate as properties to individual accounts. The properties occur in groups, and an account may be associated with one property in each group.

{|class="wikitable" style="text-align: left; color: black;"
! Width="100"|'''Group'''
! Width="250"|'''Purpose'''
! Width="350"|'''Example Properties'''
|-
|+'''Examples of User Defined Properties'''
| align="center" | '''Usage Type'''
|
:To identify and report on accounts by usage type
|
:* Office buildings
:* Irrigation pumps
:* External lighting
:* Swimming pools
:* Warehouses
|-
| align="center" | '''Business Unit'''
|
:To identify and report on accounts by organisational structure
|
:* Head office
:* Retail outlets
:* Parks and recreation
:* Museums and galleries
:* Cement production
|-
| align="center" | '''GL Code'''
|
:To identify and report on accounts by accounting structure
|
:The general ledger coding system used in your organisation
|-
| align="center" | '''Projects'''
|
:To identify and report on accounts involved in energy efficiency projects
|
:* Boiler refit
:* LED lighting
:* Behavioural changes
:* HVAC overhaul
:* Industrial process optimisation
|}

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Ellserve Data | ►Ellserve Data]]

Descriptive Data

2014-06-27T02:50:11Z

WoodsM: /* Descriptive Data */

===Descriptive Data===
Descriptive data are the properties used to identify and describe the main Ellserve entities:

{|class="wikitable" style="text-align: left; color: black;"
! Width="100"|'''Entity'''
! Width="175"|'''Property'''
! Width="750"|'''Definition'''
|-
|+'''Descriptive Data Items'''
| Rowspan="4" align="center" | '''ICP'''
| align="center" | ICP Number
|
:The unique connection point identifier to which all metered consumption is referenced.
|-
| align="center" | ICP Address
|
:The physical location of a metered installation.
|-
| align="center" | GXP
|
:For electricity supplies, this is the transmission system grid exit point used to by the market for reconciling consumption with generation nationally. For reticulated gas the GXP refer to the gate on a transmission system.
|-
| align="center" | Commodity
|
:The type of [[Ellserve:Glossary#Commodity|commodity]] metered (or supplied in the case in unmetered sites) ICP.
|-
| Rowspan="7" align="center" | '''Account'''
| align="center" | Account name
|
:The retailer's unique account identifier to which all billed costs are referenced.
|-
| align="center" | Account description
|
:A text field describing the account (defaults to the physical address associated with the account.
|-
| align="center" | Current ICP
|
:The connection points identifier/s currently associated with the account.
|-
| align="center" | Metering
|
:The metering type used for the account - examples include:
:* Time of use (TOU)
:* Non half hourly (NHH)
:* Unmetered (UNM)
:* Water
|-
| align="center" | Open date
|
:The date on which the account was first opened in Ellserve (defaults to the from date of the first invoice for the account held in Ellerve).
|-
| align="center" | Close date
|
:The date on which the account was closed opened in Ellserve. Typically an account is closed when:
:* a final read notice is picked up on an invoice
:* a invoice is received from a new retailer
:* a client confirms payment responsibility for a connection point has been terminated
|-
| align="center" | Retailer
|
:The supplier responsible for metering consumption and generating bills under the account.
|}

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Ellserve Data | ►Ellserve Data]]

Time Series Data

2014-06-27T02:49:42Z

WoodsM: /* Time Series (Monthly) Data */

===Time Series (Monthly) Data===
The calendar month is the basic time step for reporting data in Ellserve. All interval [[Ellserve:Source|source data]] is aggregated to [[Ellserve:Glossary#Monthly Data|monthly values]] for reporting purposes.

Monthly data is either
* Account-independent:
** Climate data
* Account-specific:
** Invoice count
* Account-specific & consumption-based:
** Consumption
** Cost (excluding GST)
** Cost (including GST)
** Emissions

{|class="wikitable" style="text-align: left; color: black;"
! Width="100"|'''Value Type'''
! Width="175"|'''Applies to'''
! Width="750"|'''Definition'''
|-
|+'''Monthly Value Types'''
| align="center" | '''[[Glossary#Normalisation|Normalised]]'''
| align="center" | Account-specific &
consumption-based data
|
:Values allocated to the month in which related consumption actually took place.
:E.g. That portion of June consumption in a July invoice would be aggregated to June's normalised consumption values.
|-
| align="center" | '''Invoiced'''
| align="center" | Account-specific & consumption-based data
|
:Values allocated to the month in which related consumption was invoiced (by invoice date).
:E.g. That portion of June consumption in a July invoice would be aggregated to July's invoiced consumption values.
|-
| align="center" | '''Forecast'''
| align="center" | Account-specific & consumption-based data
|
:Values allocated to the month in which actual consumption is expected to take place.
'' Note: Forecast values are updated as new invoice data is received.
|-
| align="center" | '''Projected'''
| align="center" | Account-specific & consumption-based data
|
: A specialised data form that integrates normalised and forecast data to allow for single 'expected' values for any month where,
: for whatever reason, the invoice record is incomplete.
|-
| align="center" | '''Budgeted'''
| align="center" | Account-specific &
consumption-based data
|
:A set of user-agreed 'expected' values for future months.
'' Note: Unlike forecast and projected data, budgeted values, are permanently fixed
'' i.e. they are not updated as new invoice data is received.
|-
| align="center" | '''Invoice Count'''
| align="center" | Account-specific
|
:A count of the invoices received for an account in single calendar month
'' Note: This value is useful when investigating unexpected invoiced cost spikes without accompanying normalised cost spikes.
|-
| align="center" | '''Climate Data'''
| align="center" | Account-independent
|
: [[Source#Meteorology|Meteorological]] data for selected weather stations.
|}

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Ellserve Data | ►Ellserve Data]]

Source Data

2014-06-27T02:48:42Z

WoodsM: /* Emissions factors */

Ellserve uses data obtained from these external sources

===Invoices===
Invoices, obtained directly from suppliers, provide nearly all the underlying data for Ellserve's reporting and charting functions. Line by line information on every invoice processed by Ellserve (including retired invoices) is available on-screen and in downloadable form through the [[Ellserve:Invoice Browser|Invoice browser]].

Ellserve extracts the following information (if present in source data) from supplier invoices:
* Supplier
* Account number
* Invoice number
* Invoice date
* Invoice period (start date and end date)
* Total commodity supply charges
* Total charge (commodity supply charges plus any balances bought forward or additional non-supply charges)
* Billed address
* GST
* Prompt payment discount
* Supply point details (e.g. ICP)
** Physical address
** Supply point ID
** Meter details
*** Meter number
*** Meter read type (e.g. actual/estimate/customer)
*** Meter read date
*** Metered usage (preferably using previous and latest reads)
*** Meter reading multiplier
* Tariff lines:
** Tariff name (supply, carriage, levy, penalty, tax and rebate tariffs)
** Tariff quantity (e.g. kWh)
** Tariff rate
** Tariff charge

===Meteorology===
Climate data, sourced from the [http://cliflo.niwa.co.nz/ NIWA climate database], collected as monthly values by selected metering station can be used for reporting and charting. Where consistent historical records are available the following data climate data types are collected by station:

* Degree days heating
* Degree days cooling
* Rainfall
* Sunshine hours
* Air temperature

===Emissions factors===
Emissions factors are used by Ellserve to calculate the tCO2e emissions associated with various energy sources. For direct burn energy sources such as natural gas or diesel the fixed conversion factors as provided by the [http://www.caenz.com/index.php?option=com_content&view=article&id=68%3Anew-zealand-energy-information-handbook&catid=8&Itemid=64 New Zealand Energy Information Handbook]. The emissions associated with a unit of electricity consumption is proportional to the amount of thermal energy sources (as opposed to renewable sources) used in generation. Energy Link uses its database of half hourly generation by fuel type across all of New Zealand, to calculate single monthly NZ emissions factors for electricity. The methodology for creating these factors is similar to that used by the [http://www.mfe.govt.nz/publications/climate/guidance-greenhouse-gas-reporting-2010/greenhouse-gas-reporting-2010.pdf Ministry for the Environment]. However, MfE's factors are calculated annually while Ellserve's are calculated monthly giving a more accurate view of actual emissions.

''Note: Energy Link emissions factors are not used to calculate monthly emissions values, they are not independently available through the website.

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Ellserve Data | ►Ellserve Data]]

Ellserve Data

2014-06-27T02:48:19Z

WoodsM:

__NOTOC__
Data available through Ellserve falls into five main groups:

====[[Source Data]]====
Data that has been brought into Ellserve from external sources
====[[Time Series Data|Time Series (monthly)]]====
Monthly values calculated by Ellserve
====[[Descriptive Data]]====
Commonly used data abour Account and ICPs
====[[User Defined|User Defined]]====
Data that is configured by the Ellserve user
====[[Summarised]]====
Reference values used to summarise over periods longer than a month

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]

Guide to Ellserve

2014-06-27T02:47:55Z

WoodsM: /* Glossary */

__NOTOC__
====[[Ellserve Data]]====
How to interpret the data available in Ellserve

====[[Header Banner|Header Banner]]====
The Header banner gives access to the main sections of the website

====[[Data Browser]]====
Provides on-screen access to data displays such as tables and graphs

====[[Reporting | Reporting]]====
Using the Ellserve report generator.

====[[Settings]]====
Choosing settings for the Ellserve website

====[[Customising Ellserve]]====
How to configure and use Ellserve.

====[[Glossary]]====
Definitions of terms used in Ellserve.

----
[[Main Page | ►Main Page]]

Summary Info

2014-06-27T02:46:25Z

WoodsM:

==Configuration==
[[File:Summary1.png|right|750px|Frame|Data Table Configuration Panel]]
{| class="wikitable" style="text-align: left; color: black;"
!Width="100" Align="Center"|'''Purpose '''
|
:To summarise [[Time Series Data|time series data values]] in side-by-side columns, by specific time intervals.
|-
!'''Example '''
|
:To show the most recent and various accumulated electricity consumption data for predefined time periods.
|}
[[File:Summary2.png|right|750px|Frame|Data Table Display]]
{|class="wikitable" style="text-align: left; color: black;"
! Width="150" Align="Center"|'''Settings'''
! Width="150"|'''Description'''
! Width="350"|'''Values'''
|-
|
:'''Title'''
|
:[[Control Title Configuration|Control display title]]
|
:Custom
|-
|
:'''Value types'''
|
:[[Monthly Value Picker|Values to be reported in table]]
|
:[[Time Series Data|All time series data values]]
|-
|
:'''Periods '''
|
: Defines time-step for data aggregation
|
:* Current financial half year (half year to date)
:* Current financial quarter (quarter to date)
:* Current financial year (year to date)
:* Current Month
:* Current (calendar) quarter
:* Current (calendar) Year
:* Last full year (the 12 months previous to the current month)
:* Last month
|-
|}

==Usage==
The summary info control has no interactive usage features.

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | ►Guide to Ellserve]]
[[Data Browser| ►Data Browser]]
[[Data Page| ►Data Page]]
[[Display Controls| ►Display Controls]]

Summary Info

2014-06-27T02:45:44Z

WoodsM:

==Configuration==
[[File:Summary1.png|right|750px|Frame|Data Table Configuration Panel]]
{| class="wikitable" style="text-align: left; color: black;"
!Width="100" Align="Center"|'''Purpose '''
|
:To summarise [[Time Series Data|time series data values]] in side-by-side columns, by specific time intervals.
|-
!'''Example '''
|
:To show the most recent and various accumulated electricity consumption data for predefined time periods.
|}
[[File:Summary2.png|right|750px|Frame|Data Table Display]]
{|class="wikitable" style="text-align: left; color: black;"
! Width="150" Align="Center"|'''Settings'''
! Width="150"|'''Description'''
! Width="350"|'''Values'''
|-
|
:'''Title'''
|
:[[Control Title Configuration|Control display title]]
|
:Custom
|-
|
:'''Value types'''
|
:[[Monthly Value Picker|Values to be reported in table]]
|
:[[Time Series Data|All time series data values]]
|-
|
:'''Periods '''
|
: Defines time-step for data aggregation
|
:* Current financial half year (half year to date)
:* Current financial quarter (quarter to date)
:* Current financial year (year to date)
:* Current Month
:* Current (calendar) quarter
:* Current (calendar) Year
:* Last full year (the 12 months previous to the current month)
:* Last month
|-
|}

==Usage==
The summary info control has no interactive usage features.

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | &#96584Guide to Ellserve]]
[[Data Browser| &#96584Data Browser]]
[[Data Page| &#96584Data Page]]
[[Display Controls| &#96584Display Controls]]

Summary Info

2014-06-27T02:45:07Z

WoodsM:

==Configuration==
[[File:Summary1.png|right|750px|Frame|Data Table Configuration Panel]]
{| class="wikitable" style="text-align: left; color: black;"
!Width="100" Align="Center"|'''Purpose '''
|
:To summarise [[Time Series Data|time series data values]] in side-by-side columns, by specific time intervals.
|-
!'''Example '''
|
:To show the most recent and various accumulated electricity consumption data for predefined time periods.
|}
[[File:Summary2.png|right|750px|Frame|Data Table Display]]
{|class="wikitable" style="text-align: left; color: black;"
! Width="150" Align="Center"|'''Settings'''
! Width="150"|'''Description'''
! Width="350"|'''Values'''
|-
|
:'''Title'''
|
:[[Control Title Configuration|Control display title]]
|
:Custom
|-
|
:'''Value types'''
|
:[[Monthly Value Picker|Values to be reported in table]]
|
:[[Time Series Data|All time series data values]]
|-
|
:'''Periods '''
|
: Defines time-step for data aggregation
|
:* Current financial half year (half year to date)
:* Current financial quarter (quarter to date)
:* Current financial year (year to date)
:* Current Month
:* Current (calendar) quarter
:* Current (calendar) Year
:* Last full year (the 12 months previous to the current month)
:* Last month
|-
|}

==Usage==
The summary info control has no interactive usage features.

----
[[Main Page | ►Main Page]]
[[Guide to Ellserve | 4Guide to Ellserve]]
[[Data Browser| 4Data Browser]]
[[Data Page| 4Data Page]]
[[Display Controls| 4Display Controls]]

Glossary

2014-06-18T22:00:12Z

WoodsM: /* Usage */

==Account==
The consumption element against which a bill is raised. The simplest accounts will have a single tariff for a single commodity at a single site (e.g. a single electricity meter (ICP) on an anytime tariff). More complex accounts may have more than one tariff (e.g. a single electricity ICP with separate day and night tariffs), it is also possible for one account to have more than one commodity (e.g. dual fuel, gas and electricity metering at the same address provided by the same retailer), and more than one ICP for the same commodity.

==Account Name==
A supplier provided identifier for an [[Glossary#Account|account]], typically a unique numeric identifier

==Budget==
A user-agreed and fixed set of related monthly data recording expected monthly cost and consumption values over a determined period of time (typically financial year).

==Commodity==
A consumable associated with quantity based invoicing, such as natural gas or electricity.

==Commodity Group==
A set of commodities that can be usefully reported as a group (e.g. the energy commodity group contains all commodities for which consumption can be converted to kWh units)

==Control==
A self-contained, data display element that can be placed on any location on any configurable web page. The standard template widgets are:
* Data Table
* Graph
* Summary Table
* Invoice Browser
* ICP Information Browser
* Account Information Browser
* Document Browser
* Notes Browser
* Budget Tracker

==Data==
The data in Ellserve is either:
* A data stream: time-series data captured (after validation) from
** invoices (e.g. account costs or ICP consumption), or
** external databases (e.g. climate data)
* User-specific reference(e.g. reporting groups)
* Quantised by month: reporting data aggregated from input and system generated data streams to a monthly value.

== Definition ==
A certain set of defined constraints, i.e. the required constraints for a particular report.
== Display Control ==
A section of the web page used to display, and possibly to edit, Ellserve data. A Display Control shows data in table, report or graphical form

==Forecast==
A continually updated set of system-generated monthly data of the expected monthly cost and consumption values for a period of 18 months into the future.

==Invoice==
A document detailing the charges made by a supplier for supply of a commodity.

==Invoice Amount Due==
The total to be paid to the supplier with regard to an individual invoice - this includes any balance bought forward from previous invoices or any non-typical charges made on the invoice.

==Invoice Charge==
The total of charges related to the supply of a commodity on a bill (excluding balances bought forward and non-standard charges. Typically charge and amount due are the same, but may differ if balances are bought forward as may happen for instance if a late payment resulted in the loss of a prompt payment discount.

==Invoice Due Date==
The date in which the payment detailed in an invoice is due to be paid to the supplier.

==Invoice Number==
An identifier used by a supplier to uniquely identify an [[Glossary#Invoice|invoice]]. Invoice identification can be complex: the supplier may use a single identifier when referring to a statement of several hundred individual invoices or may not use any identifier at all, but rely on invoice date.

''Note: "N/A" will appear in any invoice number field where no such number has been provided.

==Invoice Status==
The status of an invoice within Ellerve. An invoice may be:
* Live: The single, legitimate description of cost and consumption over the invoice period
* Retired: A superseded copy of an invoice, retained to allow for a complete record of invoices processed by Ellserve.

''Note: An invoice may be retired for many reasons, however, unless an account was mistakenly invoiced after being closed
'' all retired invoices will be associated by at least one live invoice.

==Monthly Data==
Ellserve reporting uses data aggregated to calendar month intervals.

Monthly data is either
* Account-independent:
** Climate data
* Account-specific:
** Invoice count
* Account-specific & consumption-based:
** Consumption
** Cost (excluding GST)
** Cost (including GST)
** Emissions

'''Monthly Value Types'''
{|class="wikitable" style="text-align: left; color: black;"
! Width="100"|'''Value Type'''
! Width="175"|'''Applies to'''
! Width="750"|'''Definition'''
|-
| align="center" | '''[[#Normalisation|Normalised]]'''
| align="center" | Account-specific &
consumption-based data
| Values allocated to the month in which related consumption actually took place.
E.g. That portion of June consumption in a July invoice would be aggregated to June's normalised consumption values.
|-
| align="center" | '''Invoiced'''
| align="center" | Account-specific &
consumption-based data
| Values allocated to the month in which related consumption was invoiced (by invoice date).
E.g. That portion of June consumption in a July invoice would be aggregated to July's invoiced consumption values.
|-
| align="center" | '''Forecast'''
| align="center" | Account-specific &
consumption-based data
| Values allocated to the month in which actual consumption is expected to take place.
''Note: Forecast values are updated as new invoice data is received.
|-
| align="center" | '''Projected'''
| align="center" | Account-specific &
consumption-based data
| A specialised data form that integrates normalised and forecast data to allow for single 'expected' values for any month where,
for whatever reason, the invoice record is incomplete.
|-
| align="center" | '''Budgeted'''
| align="center" | Account-specific &
consumption-based data
| A set of user-agreed 'expected' values for future months.
''Note: Unlike forecast and projected data, budgeted values, are permanently fixed
''i.e. they are not updated as new invoice data is received.
|}

==Normalisation==
The process of data standardisation to allow meaningful interpretation and comparison with other data. Data maybe normalised in several different ways; however in Ellserve the term “normalised” when applied to cost or consumption implies that invoiced data has been “spread” over the period during which actual consumption took place (thereby avoiding a consumption spike for a month in which more than one invoice is issued).

==Projection==
A continually updated set of system-generated monthly data of the expected monthly cost and consumption values where actual data stream values for a month are incomplete. Incomplete actual data may occur:
* For individual accounts where invoicing periods do not match calendar months
* For account groups where, in a given month, invoicing an account may complete, partial or absent.
Projected data values for an account are calculated by subtracting actual values from forecast values. Where an account’s actual values are based on incomplete invoicing, a falsely positive variance between Actual and Forecast data will occur. Projected data uses Forecast data to fill in the gap created by missing Actual data, eliminating falsely positive variances and allowing earlier detection of valid variances than would be otherwise possible. Where an account is full y invoiced for a month the Projected value is equal to Actual value.

==Report==
A set of Data returned by Ellserve

==Usage==
A term indicating a quantity of a commodity used (sometime associated with a specific activity or application - e.g. 100kWh space heating usage)

----
[[Main Page | 4Main Page]]
[[Guide to Ellserve | 4Guide to Ellserve]]

Configuring a Page

2014-06-18T21:59:29Z

WoodsM:

[[File:Page1.png|right|600px|Frame|Newly Created Page]]
Newly created pages appear as tabs on the Carousel named "New (n)".

New pages contain no display controls.

'''>> To configure a page:'''
[[File:Page2.png|right|600px|Frame|Page Configuration Panel]]
* Open the page configuration panel by clicking on the cog icon in the page's [[Ellserve:Carousel|carousel]] tab.
* Enter a name for the page in the name field
* Select controls to add to the page from the drop down list
* Use the arrow icons to define the order in which controls appear on the page (top of the list = first on the page)
* Use the cross icon to delete unwanted page controls


[[File:Page3.png|right|500px|Frame|Page Configuration Panel]]

The control types that can be added to a page are:

* [[Ellserve:Data Table|Data Table]]
* [[Ellserve:Graph|Graph]]
* [[Ellserve:Summary Info|Summary Info]]
* [[Ellserve:Invoice Browser|Invoice Browser]]
* [[Ellserve:Account Information|Account Information]]
* [[Ellserve:Document Browser|Document Browser]]
* [[Ellserve:Budget Tracking|Budget Tracking]]
* [[Ellserve:Documents|Documents]]
* [[Ellserve:Notes|Notes]]

''Note: When a new control is added to a page it is given a generic name.
'' Controls can be individually named using the control's configuration panel.

----
[[Main Page | 4Main Page]]
[[Guide to Ellserve | 4Guide to Ellserve]]
[[Customising Ellserve | 4Customising Ellserve]]

Customising Ellserve

2014-06-18T21:58:48Z

WoodsM: /* Adding and removing page controls */

__NOTOC__
====[[Introduction to Site Configuration]]====

====[[Adding or Removing Pages on the Carousel]]====

====[[Configuring a Page]]====

====Configuring Display Controls====
To see how to configure display controls go to [[Common Display Control Features]]

----
[[Main Page | 4Main Page]]
[[Guide to Ellserve | 4Guide to Ellserve]]

Configuring a Page

2014-06-18T21:58:31Z

WoodsM: moved Page Configuration to Configuring a Page

[[File:Page1.png|right|600px|Frame|Newly Created Page]]
Newly created pages appear as tabs on the Carousel named "New (n)".

New pages contain no display controls.

'''>> To configure a page:'''
[[File:Page2.png|right|600px|Frame|Page Configuration Panel]]
* Open the page configuration panel by clicking on the cog icon in the page's [[Ellserve:Carousel|carousel]] tab.
* Enter a name for the page in the name field
* Select controls to add to the page from the drop down list
* Use the arrow icons to define the order in which controls appear on the page (top of the list = first on the page)
* Use the cross icon to delete unwanted page controls


[[File:Page3.png|right|500px|Frame|Page Configuration Panel]]

The control types that can be added to a page are:

* [[Ellserve:Data Table|Data Table]]
* [[Ellserve:Graph|Graph]]
* [[Ellserve:Summary Info|Summary Info]]
* [[Ellserve:Invoice Browser|Invoice Browser]]
* [[Ellserve:Account Information|Account Information]]
* [[Ellserve:Document Browser|Document Browser]]
* [[Ellserve:Budget Tracking|Budget Tracking]]
* [[Ellserve:Documents|Documents]]
* [[Ellserve:Notes|Notes]]

''Note: When a new control is added to a page it is given a generic name.
'' Controls can be individually named using the control's configuration panel.

----
[[Main Page | 4Main Page]]
[[Customising Ellserve | 4Customising Ellserve]]