Distribution Definition – byNeuron

What

The purpose of a Distribution Definition is to distribute one value of a larger bucket size into smaller buckets based on a profile defined in another timeseries.

Where

A distribution definition can be applied and configured on a Timeseries Definition.

Example

"distributionDefinition": {
    "strategy": {
        "type": "profile", // 'linear' or 'profile'
    }
    "profileConfig": { // required if strategy is 'profile'
        // A direct reference to a profile time series to use for redistribution.
        "timeseriesExternalId": "E1B" 
        // By looking up the relation entries a set of profile time series will be used for redistribution that cover the whole period.
        "relation": { 
            "entityType": "ItemAccessPointRelation",
            "hasTarget": "AccessPoint",
            "targetRole": "accessPointRole#METERING_POINT",
            "hasSource": "Item",
            "sourceRole": "itemRole#PROFILE"
        },
        // If lastOnly (default) then the last profile is used for for the whole period.
        // if lastAndRedistribute then in a first step the last profile is used for for the whole period.
        // then in a second step for the sub periods where another profile was present sum is taken for that sub period and redistributed according to the old profile.
        "usage": "lastAndRedistribute", 
        // What to do with inactive profiles.
        // If true then the distribution values are set to 0. This has a serious implication that there will be a mismatch between the value to distribute and the sum of redistributed values!!
        // If false (default) then the distribution according to the last profile is left intact.
        "nullifyInactiveProfiles": false 
    },
    "interval": "day", //15min, hour, day, week, month, year
    "fractionalDigits": 2, //0 - 15, default 6, how many digits the distributed values should have, any rest value will be added on the last distributed value
    "keepOriginal": true, //default true, whether or not to keep the original value after distribution
    "indexSetCodes": [
        {
            "codeType": "someCodeType",
            "code": "SOME_CODE"
        }
    ],
    "keyValueSets:": [
        {
            "key": "someKey",
            "value": "someValue"
        }
    ]
}