Timeseries Definitions - externalId Naming Conventions
What
In order to structure your timeseries definitions, and to easily find your way in definitions, it is important to have a proper naming convention.
A proper naming convention simplifies recognizing at what level a timeseries handles data, when you are configuring your calculation models this comes in handy.
Based on our experience we use following format:
{prefix}_{group}_{name}_{type short}_{owner short}
Examples:
NL_ELECTRICITY_GRID_COST_BP_AP
HZ_ELECTRICITY_OFFTAKE_SP_AR
Prefix
To identify on which level the Timeseries Definition is configured:
- Core
- Country
- Tenant
In the above example - it is a country related Timeseries - NL is the prefix, the second example is a Tenant specific timeseries for which the tenant choose to use HZ as an identifier.
Group
Group provides a higher level form of configuration - in this case the commodity is used for both examples.
Name
Name is the logical name - which is also mentioned in the "name" attribute of the Timeseries Definition.
In the examples:
GRID_COST - is the Grid Cost
OFFTAKE - is the Offtake of the electricity
Type
BP = Billing Price
SP = Sales Price
MQ = Metering Quantity
MV = Metering Volume
MR = Metering Reading
BQ = Billing Quantity
SQ = Sales Quantity
Owner
AP = Access Point
APAR = Access Point Arrangement
PAAR = Party Arrangement
AR = Arrangement
GB = Global