Volume Entities
Overview
The Volume collection consists of all of the different types of Volumes that are generated by or imported into the kalibrate pricing system.
Volume Data Model
The following data model shows the Volume entity and its relational links. For the full model, see Data Model.
Delivery Volume
| Name | Description |
|---|---|
| Entity Description | Details related to Delivery Volume |
| Source Schema | dbo |
| Source Table | PNDeliveryVolume |
| Destination Collection(Endpoint) | Volume |
| Entity Type | Volume |
| Entity Variant | Delivery |
Delivery Volume Attribute Details
| Field | Reference Entity | Field Description | Format | Max Bytes |
|---|---|---|---|---|
| CheckedForPG | Flag to indicate whether a particular delivery volume value has been considered for price generation | bit | 1 | |
| DeliveryVolumeID | ID representing the delivery volume | int | 4 | |
| EffectiveTime | Time the delivery was made | datetime | 8 | |
| Product | Product | The product that was delivered | uniqueidentifier | 16 |
| UnitCostPrice | Cost per unit | costprice | 9 | |
| Volume | Delivery volume | float | 8 |
Forecast Volume
| Name | Description |
|---|---|
| Entity Description | Details related to Forecast Volume |
| Source Schema | dbo |
| Source Table | PNForecastVolume |
| Destination Collection(Endpoint) | Volume |
| Entity Type | Volume |
| Entity Variant | Forecast |
Forecast Volume Attribute Details
| Field | Reference Entity | Field Description | Format | Max Bytes |
|---|---|---|---|---|
| EndTime | End time for the volume recorded for the product | datetime | 8 | |
| ForecastVolumeUID | Unique ID representing the forecast volume record | uniqueidentifier | 16 | |
| OwnProductUID | Product | Own product ID for the volume | uniqueidentifier | 16 |
| StartTime | Start time for the volume recorded for the product | datetime | 8 | |
| Volume | Forecast volume for the product and date period | float | 8 |
Plan Volume
| Name | Description |
|---|---|
| Entity Description | Details related to Plan Volume |
| Source Schema | dbo |
| Source Table | PNPlanVolume |
| Destination Collection(Endpoint) | Volume |
| Entity Type | Volume |
| Entity Variant | Plan |
Plan Volume Attribute Details
| Field | Reference Entity | Field Description | Format | Max Bytes | |
|---|---|---|---|---|---|
| AchievedMargin | Actual sales margin for the date period - this is populated by a nightly background task after the import of actual sales volumes during the day | float | 8 | ||
| AchievedVolume | Actual sales volume (sell-out) for the date period - this is populated by a nightly background task after the import of actual sales volumes during the day | float | 8 | ||
| AchievedVolumeYTD | Achieved volume year-to-date value up to the end date of the period. For the current period, the value will only be up to the current date. Future periods will contain no values. The actual volume is stored if PlanBasis = 0 at the time of calculation, delivery volume if PlanBasis = 1 at the time of calculation | float | 8 | ||
| BusinessMargin | Optional margin objective provided by the business; used when the standard/tactical plan followed by the pricing team is different | float | 8 | ||
| BusinessVolume | Optional volume objective provided by the business; used when the standard/tactical plan followed by the pricing team is different | float | 8 | ||
| DeliveredMargin | Delivery margin for the date period - this is populated by a nightly background task after the import of delivery volumes during the day | float | 8 | ||
| DeliveredVolume | Delivery volume (sell-in) for the date period - this is populated by a nightly background task after the import of delivery volumes during the day | float | 8 | ||
| EndTime | End time to which this plan volume applies | datetime | 8 | ||
| FixedMargin | Fixed Margin Value | float | 8 | ||
| FixedVolume | Fixed Volume Value | float | 8 | ||
| Forecasted | True or False flag to include in forecasted sales | bit | 1 | ||
| ForecastVolume | Forecasted volume for the product and day period | float | 8 | ||
| LastSalesDate | This is the date of the latest recorded sales volume for the product and planning period. If PlanBasisID = 0, this is the actual sales volume date (from PNSalesVolume). If PlanBasisID = 1, this is the delivery volume date (from PNDeliveryVolume) | datetime | 8 | ||
| LastSalesDateVolume | This is the actual achieved volume (as detailed above) for the planning period up to and including the last sales date | float | 8 | ||
| Margin | Planned margin for the date period | float | 8 | ||
| OwnProductUID | Product | The OwnproductUID for the own product lniked to the plan. | uniqueidentifier | 16 | |
| PlanBasisID | Indicates whether the planned volume should be measured against actual sales (sell-out) or delivery (sell-in) volumes as for some own products actual sales volumes are not available. 0 - sell-out, 1 - sell-in | tinyint | 1 | ||
| PlanType | Whether system utilizes the Standard Plan or optional Business Plan to set run rates and optimization targets | tinyint | 1 | ||
| PlanVolumeID | Legacy identifier (deprecated) | int | 4 | ||
| StartTime | Start time from which this Plan volume applies | datetime | 8 | ||
| Summarised | Flag that controls the population of the VolumeYTD and AchievedVolumeYTD columns (0 - not yet processed, 1 - processed) | bit | 1 | ||
| Volume | Planned volume for the date period | float | 8 | ||
| VolumeYTD | Planned volume year-to-date value up to the end date of the period. For the current period, the value will only be up to the current date. Future periods will contain no values | float | 8 |
Projected Volume
| Name | Description |
|---|---|
| Entity Description | Details related to Projected Volume |
| Source Schema | dbo |
| Source Table | PNProjectedVolume |
| Destination Collection(Endpoint) | Volume |
| Entity Type | Volume |
| Entity Variant | Projected |
Projected Volume Attribute Details
| Field | Reference Entity | Field Description | Format | Max Bytes |
|---|---|---|---|---|
| EndTime | End time for the period the projection applies to | datetime | 8 | |
| OwnProductGroupUID | ProductGroup | Own product ID for the volume | uniqueidentifier | 16 |
| ProjectedVolumeID | ID representing the projected volume record | int | 4 | |
| StartTime | Start time for the period the projection applies to | datetime | 8 | |
| Volume | Projected volume for the product and date period | float | 8 |
Sales Volume
| Name | Description |
|---|---|
| Entity Description | Details related to Sales Volume |
| Source Schema | dbo |
| Source Table | PNSalesVolume |
| Destination Collection(Endpoint) | Volume |
| Entity Type | Volume |
| Entity Variant | Sales |
Sales Volume Attribute Details
| Field | Reference Entity | Field Description | Format | Max Bytes |
|---|---|---|---|---|
| AverageCost | Average Cost Price for the related product | costprice | 9 | |
| AverageMargin | Average Margin for the related product | money | 8 | |
| AveragePrice | Average Sales Price for the related product | money | 8 | |
| EndTime | Date/Time at which the sales volume period ends | datetime | 8 | |
| Product | Product | Own Product to which this volume applies | uniqueidentifier | 16 |
| SalesImpact | SalesImpact | Sales impact code | int | 4 |
| SalesTypeID | ID representing the sales volume type | int | 8 | |
| SalesType | SalesType | Unique identifer of sales type associated to this record | uniqueidentifier | 16 |
| SalesVolumeID | Legacy internal identifier (deprecated) | int | 4 | |
| StartTime | Date/Time from which the sales volume period starts | datetime | 8 | |
| Summarised | Used to control which sales records require calculation of average price and margin | bit | 1 | |
| Volume | Actual sales volume for the product and sales type | float | 8 | |
| VolumePrice | Price associated to the sales record | money | 8 |
Daily Volume Variants
Certain prices within the Volume collection are presented as daily aggregates of their underlying raw Volumes. There are daily variants for Sales, Plan and Delivery volumes. These are simplified entities that generally contain just the average margin over the course of a single calendar day.
Sales Volume Daily Variant
| Name | Description |
|---|---|
| Entity Description | Daily Aggregate of Sales Volume records for a calendar day |
| Destination Collection(Endpoint) | Volume |
| Entity Type | Volume |
| Entity Variant | SalesVolumeDaily |
Sales Volume Daily Variant Attributes
| Field | Reference Entity | Field Description | Format | Max Bytes |
|---|---|---|---|---|
| CalendarDate | Calendar Date for which the sales volume aggregsate applies | datetime | 8 | |
| Product | Product | Product for which this sales volume relates | uniqueidentifier | 16 |
| SalesVolumeId | Legacy reference (deprecated) | int | 4 | |
| AverageMargin | Average of the underlying sales volume margin | money | 8 | |
| SalesTypeId | Legacy reference (deprecated) | int | 4 | |
| SalesImpactId | Legacy reference (deprecated) | int | 4 | |
| Volume | Total Volume from the underlying sales volume records | float | 8 |
Plan Volume Daily Variant
| Name | Description |
|---|---|
| Entity Description | Daily Aggregate of Plan Volume records for a calendar day |
| Destination Collection(Endpoint) | Volume |
| Entity Type | Volume |
| Entity Variant | PlanVolumeDaily |
Plan Volume Daily Variant Attributes
| Field | Reference Entity | Field Description | Format | Max Bytes |
|---|---|---|---|---|
| CalendarDate | Calendar Date for which the plan volume aggregate applies | datetime | 8 | |
| Product | Product | Product for which this plan volume relates | uniqueidentifier | 16 |
| PlanVolumeId | Legacy reference (deprecated) | int | 4 | |
| AverageMargin | Average of the underlying plan volume margin | float | 8 | |
| Volume | Total Volume from the underlying plan volume records | float | 8 |