User Tools

Site Tools


data_template

This is an old revision of the document!


Manage Data Template

Overview

  • This section enables Administrator users to customise the CSV template used by everyone in the organisation to upload bulk data.
  • Administrator users can add/remove fields from the CSV template
  • Administrator users can reorder the position of the fields in the CSV template
  • A unique CSV template is saved for each organisation.
  • Any changes to this template will affect all users for the organisation.
  • Any data file uploaded by a user in the Manage Upload Data section which is not in line with the organisation's CSV template will receive an error “Bad File”.

How to download the current CSV Template

Steps:

1. Navigate to Admin menu > Global Settings > Manage Data Template

2. Click on “Generate CSV Template” blue text in the top right hand corner.

3. A CSV file will download in your browser. This CSV file will simply contain 1 row of data headers.

4. Save this CSV file (in CSV format) on your desktop for future use.

How to use the data template

1. The data template you have downloaded represents the CSV upload file format for use by all CarbonView users in your organisation. The template is not customised on a user by user basis.

2. You will note that there will be at least 6 columns with header labels in Row 1. There are 6 compulsory fields that must always be included in the data template to upload data successfully.

The 6 compulsory fields are:

CSV Header Column Field Name Equivalent Description
Division Entity i.e. the “EntityID” of the entity you wish to add to the data to. This field is Case Sensitive
Emission_Profile_Source Emission Source i.e. the “EmissionSourceID” of the emission source you wish to add the data to. This field is Case Sensitive
Start_Date Period Start Date i.e. the first day of the period the data relates to
End_Date Period End Date i.e. the last day of the period the data relates to
Contribution Usage i.e. the consumption amount
Contribution_Unit Unit i.e. the unit of measure the consumption amount is reported in

You may find that your data template has more fields than these compulsory 6. In most cases these columns can be left blank as they are not mandatory, but always best to check with your organisation's CarbonView account manager as to how they want you to upload data.

3. To complete the data template to ensure a successful upload, please refer to each section below:

MANDATORY FIELDS

CSV Header Column Example Rules
Division Arndell Park
1. Must match exactly the spelling of the Entity's EntityID,
2. The EntityID is found in the Manage Entity page (Admin > Setup > Manage Entity > Select the entity. 
Tips: If the EntityID is not being recognised, sometimes there is a 'space' at the end that needs to be removed or the Entity has been de-activated in which case it needs to be re-activated in the Manage Entity section'' |
Emission_Profile_Source EUNSW2015
1. Must match exactly the spelling of the Emission Profile Source's EmissionID,
2. The Emission Source must be assigned to the Entity in the "Assign Entity" tab of the Manage Emission Profile page,
3. The Emission Profile source must be "Active" and "Visible" (to change to to Manage Emission Profile Details and tick them on)
Start_Date 15/01/2014
1. Must be in the date format specific to the user's profile. 
2. Commonly, most users are set up with a date format of DD/MM/YYYY. To check/change the user's date format, go to Admin > Users > Manage Users. Click "Edit" the user's account and check/change the "Date Format" dropdown then "Save". 
3. Start Date must be an earlier date than End Date. 
End_Date 14/02/2014
1. Must be in the date format specific to the user's profile. 
2. Commonly, most users are set up with a date format of DD/MM/YYYY. To check/change the user's date format, go to Admin > Users > Manage Users. Click "Edit" the user's account and check/change the "Date Format" dropdown then "Save". 
3. End Date must be a later date than Start Date. 
Contribution 1000
1. This is the amount of electricity/fuel/water/etc consumed for the date period specified, 
2. Must be a numerical value,
3. Must align with the consumption unit selected
Contribution_Unit KILO_WATT_HOURS
1. This is the unit of measure the contribution amount is to be reported in (e.g. Kilo Watt Hours). 
2. Only Contribution Units available for an Emission Source can be used (e.g. you cannot report data in a unit of measure that has not been set up for that emission source). 
3. For a list of all unit of measures, refer to 4.1. List of Contribution Units.
4. For all custom emission sources, the unit of measure must match exactly the "Contribution Unit" nominated when set up. To check, go to Admin > Emission Profile > Manage Emission Profile > Select the emission source in question and check the "Contribution_Unit" field, 

OTHER COMMON NON-MANDATORY FIELDS

G. Asset

H. Cost

I. Currency

J. Provider

H. Contributor_ID

I. Comment

J. Country

H. Flex Fields

How to modify your data template

Steps

1. Navigate to Admin menu > Global Settings > Manage Data Template

2. The table that immediately appears includes all potential fields that can be added in the data template.

3. You will see that on the first page in the table, the 6 mandatory fields are automatically ticket.

4. Scroll through the list and tick on the fields you wish to include. These will automatically be included in the template (i.e. no 'save' button)

5. Click on the “Customise Template” button in the right hand corner. This opens the “Move Data Elements” page. You can re-order the data template columns to suit your needs. e.g. “1.Division” means Division will appear in the first column, etc. Again, this will save automatically.

6. From now on, this data elements order represents your new Data Template.

7. To download the uploaded data template, click “Generate CSV Template”.

Note: If there are other users that use the data template to upload data, ensure you share this updated version with them as they will encounter “Bad File” error messages when using the outdated templates.

data_template.1423449135.txt.gz · Last modified: 2020/09/25 09:53 (external edit)