Global Product Group Entities
Overview
The Product Group collection consists of the Global Product Groups, OwnProductGroups and their association with a specific sites.
Product Data Model
The following data model shows the Product entity and it's relational links. For the full model, see Data Model.
Global Product Group
| Name | Description |
|---|---|
| Entity Description | Details related to a customer's Global Product Groups |
| Source Schema | dbo |
| Source Table | PNGlobalProductGroup |
| Destination Collection(Endpoint) | ProductGroup |
| Entity Type | ProductGroup |
| Entity Variant | Global |
Global Product Group Attribute Details
This table identifies all of the attributes that are available on the Global Product Group record
| Field | Reference Entity | Field Description | Format | Max Bytes |
|---|---|---|---|---|
| GlobalProductGroupID | ID of the global product group. | int | 4 | |
| GlobalProductGroupUID | Unique ID representing the global product. | uniqueidentifier | 16 | |
| ImportCode | Identifier that is used to reference data relating to a specific product group. | importcode | 100 | |
| Name | Name of the product group. | nvarchar | 200 | |
| Alias | This is a simply a name a product group is known by. This way all the fuels product groups can be linked as can all the diesel product groups. | nvarchar | 200 | |
| Active | Indicates whether the global product is active or not. | bit | 1 | |
| PrimaryProductUID | Product | PriceNet ID for the global product that has been designated as the primary product of the product group. | uniqueidentifier | 16 |
| IncludeInOptimise | Indicates whether the product group (and it's products) would be included in site level optimisation or not. | bit | 1 | |
| GeneratePrices | Indicates whether price generation should occur for the product group. | tinyint | 1 | |
| AutoImplement | Indicates whether proposed prices will be exported automatically (if they pass validation) or will be sent to review. | bit | 1 | |
| Policy | Policy value defining how much the product group will try to achieve profit or volume in optimisation. | int | 4 | |
| PMITemplateUID | PriceNet ID for the policy management (PMI) template that has been designated to the product group. | uniqueidentifier | 16 | |
| PMILastRunDate | Last date and time the PMI Process was run for this product group. | datetime | 8 | |
| PMISuggestedPolicy | The policy suggested by the PMI Process. | int | 4 | |
| PMIRunningRate | The running rate calculated by the PMI Process. | int | 4 | |
| PMIAutoImplement | Defines whether the PMISuggested policy will be automatically implemented (copied to the product group's policy property) or not. | bit | 1 | |
| PMIFrequency | How often (in days) the PMIProcess should run for the product group. | tinyint | 1 | |
| PMIRunningLength | The number of days over which the PMI process will calculate the running rate during the PMI process. | int | 4 | |
| PMIMarginRunningLength | The default number of days that the average margin for the PMI calculation will be calculated over, held at this level to allow it to be changed for future own product groups created from the global product group template. | int | 4 | |
| DisplayOrder | Indicates the position of the product group will be displayed in the application. | tinyint | 1 | |
| RestPreRestPricing | Dictates the type of pricing that will be done, 0 indicates standard price generation, 1 = Use last price based on export type. | tinyint | 1 | |
| RestSuspendAutoImplement | Defines whether auto-implement of prices will be suspended for restoration based price requests. | bit | 1 | |
| RestTurnOffAutoImplementAtEnd | Defines whether auto-implement will be turned off for the product group at the end of a restoration. | bit | 1 | |
| RestMatchHighestCompetitor | Defines whether to base the initial restoration price on the highest competitor price, if 0 the lowest competitor price will be used. | bit | 1 | |
| RestAllowDecrease | Defines whether prices can be decreased during restoration. | bit | 1 | |
| RestUseHigherRulesPrice | Defines whether price generation should use the higher of the rules based price or restoration price. | bit | 1 | |
| RestAllowFirstLower | Defines whether after restoration has finished the system is allowed to propose the first lower price in the market. | bit | 1 | |
| RestSFROnDrop | Defines whether to send the product group to review when competitors drop price during a restoration. | bit | 1 | |
| RestGPCToRest | Defines whether a product group that has a GPC is moved into restoration after the first GPC price. | bit | 1 | |
| RestMaxHours | The maximum number of hours a product group can be in restoration. | float | 8 | |
| RestGeneratePricesAtEnd | Defines whether a product group is forced to generate prices when a restoration ends. | bit | 1 | |
| RestFirstGenToSFR | Defines whether the first price generation (as a result of the RestGeneratePricesAtEnd being set) is sent to review. | bit | 1 | |
| PMISalesImpactLimitPercentage | An integer value defining the percentage of event-coded data that is acceptable in the PMI Process. | tinyint | 1 | |
| RestTriggerWaitPeriod | Maximum to wait after one or more competitors have triggered to go into restoration. | float | 8 | |
| RestLaggardModeID | Decides how to deal with competitors that trigger late on in restoration; 0 = Exclude Laggards From Calculation, 1 = Include Laggards In Calculation; 2 = Send the site to SFR with a note. | tinyint | 1 | |
| RestUseGPCTriggerCount | Whether GPC initiated restorations should use a different trigger count to normal restorations. | bit | 1 | |
| RestGPCTriggerCount | Specific trigger count for GPC initiated restorations. | int | 4 | |
| RestConsiderAllProducts | A restoration setting. | bit | 1 | |
| GenerateOnGPCEnd | Determines whether when a GPC reaches its end time, a price generation should be performed. | bit | 1 | |
| LFAutoImplement | Flag to determine whether LF price requests automatically implement - it needs to support 3 options (Auto implement, Use same as main setting, Review prices) | tinyint | 1 | |
| Created | Time the record was created. | datetime | 8 | |
| LastUpdated | Time the record was last updated. | datetime | 8 |
Own Product Group
| Name | Description |
|---|---|
| Entity Description | Details related to a customer's Own Product Groups |
| Source Schema | dbo |
| Source Table | PNOwnProductGroup |
| Destination Collection(Endpoint) | ProductGroup |
| Entity Type | ProductGroup |
| Entity Variant | Own |
Own Product Group Attribute Details
| Field | Reference Entity | Field Description | Format | Max Bytes |
|---|---|---|---|---|
| Active | Flag to indicate whether the product group is active or not (0 = Inactive, 1 = Active) | bit | 1 | |
| AlternativeMainMarkerUID | Site/ownSitecompetitor | Unique ID representing the alternative main marker site. | uniqueidentifier | 16 |
| AutoChangeAcknowledgement | PMI setting where False sends to Sites For Review for review and True applies and sends to Sites For Review for notification. | bit | 1 | |
| AutoImplement | Indicates whether proposed prices will be exported automatically (if they pass validation) or will be sent to review. | bit | 1 | |
| GenerateOnGPCEnd | Determines whether when a GPC reaches its end time, a price generation should be performed. | bit | 1 | |
| GeneratePrices | Indicates whether price generation should occur for the product group. | tinyint | 1 | |
| GlobalProductGroupUID | ParentProductGroup | UID of the global product group. | uniqueidentifier | 16 |
| IncludeInOptimise | Indicates whether the product group (and it's products) would be included in site level optimisation or not. | bit | 1 | |
| LFAutoImplement | Flag to determine whether LF price requests automatically implement - it needs to support 3 options (Auto implement, Use same as main setting, Review prices) | tinyint | 1 | |
| MaxVolumeTarget | The maximum forecasted volume target for the product group. | float | 8 | |
| MinVolumeTarget | The minimum forecasted volume target for the product group. | float | 8 | |
| OwnProductGroupID | ID representing the own product group. | int | 4 | |
| OwnProductGroupUID | Unique ID representing the own product group. | uniqueidentifier | 16 | |
| OwnSiteCompetitorUID | Site/ownSitecompetitor | PriceNet ID of an own site competitor which has been designated as the "Main Marker" for the product group. | uniqueidentifier | 16 |
| OwnSiteUID | Site | ID of the own site. | uniqueidentifier | 16 |
| PMIAutoImplement | Defines whether the PMISuggested policy will be automatically implemented (copied to the product group's policy property) or not. | bit | 1 | |
| PMIFrequency | How often (in days) the PMIProcess should run for the product group. | tinyint | 1 | |
| PMIGroupingID | ID of a PMI Group. | tinyint | 1 | |
| PMILastRunDate | Last date and time the PMI Process was run for this product group. | datetime | 8 | |
| PMIMargin | Value of Margin value used by PMI Template | money | 8 | |
| PMIMarginRunningLength | The default number of days that the average margin for the PMI calculation will be calculated over for this product group. | int | 4 | |
| PMIMarginRunningRate | Value of the Margin running rate used by PMI Table | int | 4 | |
| PMIRunningLength | The number of days over which the PMI process will calculate the running rate during the PMI process. | int | 4 | |
| PMIRunningRate | The running rate calculated by the PMI Process. | int | 4 | |
| PMISalesImpactLimitExceeded | Indicator to show when the Sales Impact Limit Percentage has been exceeded during the PMI Process. | bit | 1 | |
| PMISalesImpactLimitPercentage | An integer value defining the percentage of event-coded data that is acceptable in the PMI Process. | tinyint | 1 | |
| PMISuggestedPolicy | The policy suggested by the PMI Process. | int | 4 | |
| PMITemplateUID | ID for the policy management (PMI) template that has been designated to the product group. | uniqueidentifier | 16 | |
| Policy | A value (0 - 100) that characterises your pricing tactic. | int | 4 | |
| PreviousPolicy | The previous policy value for the product group. | int | 4 | |
| ProfitTarget | The profit target of the product group. | float | 8 | |
| RestActive | Indicator to show when the product group is in a restoration. | bit | 1 | |
| RestAllowDecrease | Defines whether prices can be decreased during restoration. | bit | 1 | |
| RestAllowFirstLower | Defines whether after restoration has finished the system is allowed to propose the first lower price in the market. | bit | 1 | |
| RestConsiderAllProducts | A restoration setting. | bit | 1 | |
| RestFirstGenToSFR | Defines whether the first price generation (as a result of the RestGeneratePricesAtEnd being set) is sent to review. | bit | 1 | |
| RestGeneratePricesAtEnd | Defines whether a product group is forced to generate prices when a restoration ends. | bit | 1 | |
| RestGPCToRest | Defines whether a product group that has a GPC is moved into restoration after the first GPC price. | bit | 1 | |
| RestGPCTriggerCount | Specific trigger count for GPC initiated restorations. | int | 4 | |
| RestGroup | Optional name of restoration group that this product group belongs to. | nvarchar | 100 | |
| RestLaggardModeID | Decides how to deal with competitors that trigger late on in restoration; 0 = Exclude Laggards From Calculation, 1 = Include Laggards In Calculation; 2 = Send the site to SFR with a note. | tinyint | 1 | |
| RestMatchHighestCompetitor | Defines whether to base the initial restoration price on the highest competitor price, if 0 the lowest competitor price will be used. | bit | 1 | |
| RestMaxHours | The maximum number of hours a product group can be in restoration. | float | 8 | |
| RestPreRestPricing | Dictates the type of pricing that will be done, 0 indicates standard price generation, 1 = Use last price based on export type. | tinyint | 1 | |
| RestSFROnDrop | Defines whether to send the product group to review when competitors drop price during a restoration. | bit | 1 | |
| RestSuspendAutoImplement | Defines whether auto-implement of prices will be suspended for restoration based price requests. | bit | 1 | |
| RestTriggerCount | The number of competitors who have triggered restoration. | tinyint | 1 | |
| RestTriggerWaitPeriod | Maximum number of hours to wait after one or more competitors have triggered to go into restoration. | float | 8 | |
| RestTurnOffAutoImplementAtEnd | Defines whether auto-implement will be turned off for the product group at the end of a restoration. | bit | 1 | |
| RestUseGPCTriggerCount | Whether GPC initiated restorations should use a different trigger count to normal restorations. | bit | 1 | |
| RestUseHigherRulesPrice | Defines whether price generation should use the higher of the rules based price or restoration price. | bit | 1 | |
| VolumeTarget | The volume target based on the minimum volume target, the maximum volume target and the policy. | float | 8 |