Differences

This shows you the differences between two versions of the page.

--- data_template [2015/02/04 23:16]
120.150.160.101 [How to download the current CSV Template]
+++ data_template [2020/09/25 09:53] (current)
@@ Line 26: / Line 26: @@
+===== How to use the data template =====
+. 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.
+. 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.
+. 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 | <code json>
+. Must match exactly the spelling of the Entity's EntityID,
+. 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'' |
+</code> | |
+^ Emission_Profile_Source | EUNSW2015 | <code json>
+. Must match exactly the spelling of the Emission Profile Source's EmissionID,
+. The Emission Source must be assigned to the Entity in the "Assign Entity" tab of the Manage Emission Profile page,
+. The Emission Profile source must be "Active" and "Visible" (to change to to Manage Emission Profile Details and tick them on)
+</code> | |
+^ Start_Date | 15/01/2014 | <code>
+. Must be in the date format specific to the user's profile.
+. 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".
+. Start Date must be an earlier date than End Date.
+</code> |
+^ End_Date | 14/02/2014 | <code>
+. Must be in the date format specific to the user's profile.
+. 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".
+. End Date must be a later date than Start Date.
+</code> |
+^ Contribution | 1000 | <code>
+. This is the amount of electricity/fuel/water/etc consumed for the date period specified,
+. Must be a numerical value,
+. Must align with the consumption unit selected
+</code> |
+^ Contribution_Unit | KILO_WATT_HOURS | <code>
+. This is the unit of measure the contribution amount is to be reported in (e.g. Kilo Watt Hours).
+. 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).
+. For a list of all unit of measures, refer to 4.1. List of Contribution Units.
+. 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,
+</code> | |
+OTHER COMMON NON-MANDATORY FIELDS
+^ CSV Header Column ^ Example ^ Rules |
+^ Asset | NMI0023412911 | <code json>
+. Must match exactly the spelling of the Asset's AssetID,
+. The AssetID is found in the Manage Asset page (Admin > Setup > Manage Assets > Select the asset.
+. The Asset must be assigned to both the Entity and the Emission Source you are loading data for.
+. To assign an Asset to an Entity, go to the "Assign Asset" tab within the Manage Entity page.
+. To assign an Asset to an Emission Source, go to the "Asset Asset" tab within the Manage Emission Profile page.
+Tips: If the AssetID is not being recognised, sometimes there is a 'space' at the end that needs to be removed or the Asset has been de-activated in which case it needs to be re-activated in the Manage Asset section'' |
+</code> | |
+^ Cost | 3545.22 | <code json>
+. Must be a numerical value
+</code> | |
+^ Currency | AUSTRALIAN_DOLLAR | <code json>
+. This is the currency you are reporting cost in.
+. If you are reporting cost, you must also identify the currency.
+. The currency must match the currency nominated for the Entity. To check/change the currency set for the Entity, go to Admin > Set up > Manage Entity and select the relevant Entity. Here you can check/change the Currency field in the Manage Entity form and hit save.
+. The format for entering Currency in the CSV template must be in the correct naming convention. For a list of all currencies, refer to 4.2. List of Currencies.
+</code> | |
+^ Provider | Energy Australia | <code json>
+. This is the field to input your supplier / provider name.
+. This is free text.
+</code> | |
+^ Contributor_ID (i.e. Bill/Invoice Number) | INV09832 | <code json>
+. This is the field to input your Bill/Invoice Number
+. This is free text.
+</code> | |
+^ Comment | Per 09-Sep-14 Statement | <code json>
+. This is the field to input any comments to describe the amount.
+. This is free text.
+</code> | |
+^ Country | AUSTRALIA | <code json>
+. Some Emission Profile sources require the Country to be specified to calculate carbon emissions.
+. This field is to be completed if you've received an error message requiring Country to be specified.
+. All Countries need to be entered in the template in the naming convention specified in 4.3 List of Countries.
+</code> | |
+^ Flex Fields | "Kilometers Travelled" | <code json>
+. Some Customers would like to upload specific information for each row of data. In CarbonView, customers can use Flex Fields to add additional fields to the data entry template.
+. To set up Flex Fields, please refer to the Setting up Flexible Fields section.
+. Fields that use Flex Fields 1-5 allow for numerical data only.
+. Fields that use Flex Fields 7-15 (i.e. all the rest) allow for any text.
+</code> | |
+===== How to modify your data template =====
+Steps
+. Navigate to Admin menu > Global Settings > Manage Data Template
 . The table that immediately appears includes all potential fields that can be added in the data template.
-There are 6 compulsory fields that must always be included in the data template (these will be automatically ticked).
-The 6 compulsory fields are:
+. You will see that on the first page in the table, the 6 mandatory fields are automatically ticket.
-a) Contribution (i.e. the consumption amount)
-b) Contribution_Unit (i.e. the unit of measure the consumption amount is reported in)
+. 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)
-c) Division (i.e. the "EntityID" of the entity you wish to add to the data to)
-d) Emission_Profile_Source (i.e. the "EmissionSourceID"of the emission source you wish to add the data to)
+. 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.
-e) End_Date (i.e. the last day of the period the data relates to)
-f) Start_Date (i.e. the first day of the period the data relates to)
+. From now on, this data elements order represents your new Data Template.
+. 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.
-. After you

CarbonView

User Tools

Site Tools

Differences

Page Tools