Customer Documentation Portal
  • Docs

›Data Model

Getting Started

  • Welcome
  • Environments
  • Onboarding

Documentation

  • Introduction
  • Data Organisation
  • Authentication
  • Query Language
  • Data Model

    • Data Model
    • Entities
    • Price
    • Price Request
    • Product
    • Product Group
    • Reference
    • Site
    • Survey History
    • Volume
  • Import Endpoints

Tutorials

  • Welcome
  • Excel
  • Authenticating

Site Entities

Overview

The Sites collection consists of the locations from which customers and their competitors sell products.


Site Data Model

The following data model shows the Site entity and it's relational links. For the full model, see Data Model.


Data Model


Own Site

NameDescription
Entity DescriptionDetails related to a customer's Own Site
Source Schemadbo
Source TablePNOwnSite
Destination Collection(Endpoint)Site
Entity TypeSite
Entity VariantOwn

Own Site Attribute Details

This table identifies all of the attributes that are available on the Site record for an Own Site.

FieldReference EntityField DescriptionFormatMax Bytes
AchievedVolumeThis value represents all sales or delivery volumes that lie between the start and end of the planning period.float8
AddressOwn or Competitor site address.nvarchar300
Address2Own or Competitor site address.nvarchar300
Address3Own or Competitor site address.nvarchar300
Address4Own or Competitor site address.nvarchar300
Address5Own or Competitor site address.nvarchar300
AllowRestPriceLimitsUsed to determine whether the restoration price limits rule is allowed to function or not for the site.bit1
AlternateImportcodesEmbedded values for Alternateimportcodesnvarchar50
AlwaysWaitFlag for Always Wait Statusbit1
AreaAreaEmbedded Reference to the related Area entity.Uniqueidentifier16
AutoImplementGroupThis property indicates if the Proposed Prices for the products within the selected product group will be automatically exported to the store should the price generation process passes all validation rules successfully.varchar24
AutoRejectCounterThis is the count of rejected price requests from price request validation.int4
BrandUIDBrandInternal Unique identifier for a related record.Uniqueidentifier16
BreakEvenPercentageBreak Even Percentage for the Global Product.int4
ChannelOfTradeUIDChannelOfTradeInternal Unique identifier for a related record.Uniqueidentifier16
CompetitorSitesSiteArray of Embedded Competitor Site reference identifiers with an indicator for display competitor survey targets.Uniqueidentifier16
ContractTypeUIDContractTypeThe contract type selected for an Own Site. The contract prices are used by certain pricing rules and may also be displayed on the Pricing page. are determined by price calculationswhich use parameter values that are specific to each contract type.uniqueidentifier16
CountryThe country in which the Own or Competitor site is located.nvarchar100
DealerControlThis property indicated if the site is set up as a dealer control site.bit1
DealerControlExportThis property indicates if the dealer control site can export generated prices to your model based on the contract price rule.bit1
DealerControlPricingOwnSiteUIDSiteInternal Unique identifier for a related record.Uniqueidentifier16
DealerCostToRetailPercentageThis property specifies the minimum value allowed for the dealer's margin percentage required for the ‘Dealer Cost to Retail % price’ validation rule.tinyint1
DealerTrustCategoryUIDDealerTrustCategoryThis property on the Internet Price Checking tab allows you to set the trusted level of Own Sites to determine if prices submitted by the site require verification.Uniqueidentifier16
DealerUseGrossDtwA flag to indicate if the Exported price type for Dealer Trade Area pricing is Gross DTW, otherwise it will export as Net DTW.bit1
DefinedOffsetCompetitorUIDSiteThis property identifies the competitor selected to be used by the 'Defined Offset' pricing rule. If the defined offset competitor is not selectedthe site will be sent to SFR.Uniqueidentifier16
DelayedPricingPeriodIf delayed pricing is enabled, this property defines the restrictive time period by entering the number of hours to apply in between price changes.int4
DTWPricingMethodThe primary pricing strategy used to set Dealer Trade Area pricing including Street-back (subtraction), Cost-based (addition), and Margin Share.tinyint1
EnableDelayedPricingThis property enables the delayed pricing functionalitywhich adds a specified time delay to restrict the number of price changes allowed for a product at the site.bit1
ExportMinutesPastTheHourThe minutes after the hour that a price is exported out of the system. (Typically used if a user's price transport system does not read the price effective timestamp).int4
ExportMinutesPastTheHourSwitchFlag to turn on Amend Export to be X minutes past the hour setting.bit1
ExtendedPropertiesnameEmbedded Data - Site property Namenvarchar100
ExtendedPropertiesvalueEmbedded Data - Site property Valuenvarchar1000
ExtendedPropertiesimportcodeEmbedded Data - Site property importcodeimportcode100
ExtendedPropertiestypeEmbedded Data - Data value inditcator. Valid types are Bool, Date,Float, Int, StringN/AN/A
ExportSubjectThe title of the email/fax/SMS notification containing the new price changes for the Own Site.nvarchar100
FormatTemplateEmailUIDInternal Unique identifier for a related record.Uniqueidentifier16
FormatTemplateFaxUIDInternal Unique identifier for a related record.Uniqueidentifier16
FormatTemplateSMSUIDInternal Unique identifier for a related record.Uniqueidentifier16
FutureEffectiveTimeThis property represents the future effective time of all prices generated by standard price generation that will be exported from the site. If no time is specifiedthe default time is automatically used as the Effective Time.datetime8
GenerateAllProductGroupsThis property identifies if the price generation process will be triggered for all products within the assigned and active product groups.bit1
GeneratePricesOnCostImportThis property identifies if the price generation process will be triggered upon the receipt of cost.bit1
GPCGroupUsed to group GPCs in the navigator and display on the details page.nvarchar200
ImportCodeModel items such as sites and products are identified by an ID or import code that is used to import data relating to a specific model item.importcode100
InStrategyBinary flag to indicate if the site is within a strategy, only used in conjunction with the Implemented Strategy import.bit1
IsApplyingPricesFlag for Apply Price Statusbit1
IsDealerA flag that identifies a site as a Dealer.bit1
LastNoteTimeDate and time of the last note created for the site.datetime8
LastReviewTimeDate and time of the last review note for the site.datetime8
LatitudeEnter the positioning coordinates for the Own or Competitor site.float8
LeadFollowGroupName of Lead-Follow group assigned to Own Site.varchar17
LicenseKeyA license key is assigned to each Own Site to allow you to price it through the Kalibrate system.nvarchar200
ListPriceCompetitorUIDSiteThe properties on the List Price tab allow you to define competitors who can be used to generate a local price for reference in pricing calculations.uniqueidentifier16
LongitudeEnter the positioning coordinates for the Own or Competitor site.float8
ManagerEmailThis property holds the email by which you can contact the Site Manager.nvarchar300
ManagerFaxThis property holds fax number by which you can contact the Site Manager.nvarchar100
ManagerNameThis property holds the name of the Store Manager in charge of the Own Site.nvarchar100
ManagerPhoneThis property holds the telephone numbers by which you can contact the Site Manager.nvarchar100
ManagerSMSThis property holds the SMS details by which you can contact the Site Manager.nvarchar300
ManagerUserUIDUserInternal Unique identifier for a related record.Uniqueidentifier16
MappingLabelThis property contains a description to identify the site label shown in the Map widget.nvarchar100
MotorwayThis property identifies a motorway-type Own Site for use with particular pricing rules.bit1
NameThis property contains the name that best describes the Own or Competitor sites.nvarchar200
NetworkNetworkEmbedded reference to a related Network object.Uniqueidentifier16
NextTillIdInternal Unique identifier for a related record.int4
NotionalStreetPriceCalculationMethodMethod of calculating the initial street price that will be used for setting Dealer Trade Area Pricing with options including Average of Included Sites, Highest of Included Sites, Lowest of Included Sites, and Median of Included Sites.tinyint1
NotionalStreetPriceCalculationDeltaAmount to be offset from the initially calculated Notional Street Price to determine the final Notional Street Price to be utilized for Dealer Trade Area strategies.money8
OwnPriceTriggersPGThis property controls if the strategy is triggeredand new Proposed Prices are generated upon the import of any Own Price.bit1
OwnSiteIDLegacy Reference (deprecated)int4
PGLockFlag to Lock Price Generationbit1
PHHSiteCodeThis property represents the code by which the Own Site is known in 3rd party import files so that information such as PHH prices can be imported correctly.int4
PNWebSubmitPriceRequestFlag to indicate if the site can submit proposed price state acknowledgements.bit1
PNWLastAccessDate and time that the site was last accessed through PNWeb.datetime8
PNWLastUserID of PNWeb user who had last access to the site.Uniqueidentifier16
PostCodeThe zip or postcode of Own or Competitor site.nvarchar40
PriceCheckingPossibleFlag for allowing Internet Price Checkingbit1
PriceDecreaseSetupDelayNumber of minutes that is removed from the effective time of the proposed price and is used to determine the export time (in conjunction with SysCommsDelay) - used when there has been a decrease in price.int4
PriceDisparityThresholdThe value against which the two lowest competitor prices are compared by the 'Price Disparity Check' and 'Match Lowest with Delta and Price Disparity' pricing rules.money8
PriceIncreaseSetupDelayNumber of minutes that is removed from the effective time of the proposed price and is used to determine the export time (in conjunction with SysCommsDelay) - used when there has been an increase in price.int4
PricingStrategyThe Pricing Strategy represents your price generation and validation process. It should produce Proposed Priceswhich embody your brand image and ensure that you can achieve margin and sales volume targets.nvarchar200
PriorityPriorityEmbedded reference to a Priority objectUniqueidentifier16
ProposedIsImplementedThis property allows us to automatically acknowledge the Proposed Prices that have been implemented at an Own Site.bit1
RecodeSalesFlag indicating if sales at the site should be re-coded if they are affected by events.bit1
RegionalManagerNameThe name of the Regional Manager responsible for the Own Site.nvarchar100
RequiredMarginThresholdThe value against which the product margin is compared by the 'Match Lowest with Delta and Price Disparity' pricing rule.money8
RollingRunningRateCalculated percentage of total achieved volume against total volume over-weighted planning periods. Running Rate YTD = (actual volume YTD / planned volume YTD) * 100.int4
RunningRateDaysThe number of days over which the Running Rate is calculated for the Own Site.int4
SFROnPGFailThis property indicates if the site will be sent into Sites for Review if the price generation process fails the validation rules.bit1
SignTypeText field to store a description of the Sign Typenvarchar200
SiteSiteEmbedded reference of the Own SiteUniqueidentifier16
SiteGroupingsEmbedded Values for Site Group Names and Valuesnvarchar100
SiteOperationalSpecify whether the site is currently able to apply any prices generated. This property is referenced by the 'Site Operational' validation pricing rule to determine whether prices should be sent to SFR and rejected.bit1
SiteStockTypeSiteStockTypeEmbedded reference to a Site Stock Type object.Uniqueidentifier16
SOEEndTimeState of Emergency end time.datetime8
SOEStartTimeState of Emergency start time.datetime8
SiteSystemActiveSpecifies whether the site is Active or inactivebit1
SysCommsDelayNumber of minutes that is removed from the effective time of the proposed price and is used to determine the export time (in conjunction with values held in PriceIncreaseSetupDelay and PriceDecreaseSetupDelay).int4
TargetMarginShows the latest imported 'Target Margin' type cost breakdown value.money8
TerminalTerminalEmbedded reference to a Terminal object.Uniqueidentifier16
TimeWeightedCostDaysNumber of days over which the time weighted cost should be calculated.int4
TimeZoneIDTimeZoneInternal Unique identifier for a related recordint4
TriggerCompetingOwnSitePGFlag to allow Competiting Own Site Price Generationbit1
UseEmailThe email address to be used by the Export mechanism to communicate new price changes for the Own Site.bit1
UseFaxThe fax number to be used by the Export mechanism to communicate new price changes for the Own Site.bit1
UserUIDUserInternal Unique identifier for a related recordUniqueidentifier16
UseSMSThe SMS details to be used by the Export mechanism to communicate new price changes for the Own Site.bit1
VolatilityThe volatility property defines what 'normal' volatility is. Volatility allows you to: See a 'volatility' indicator (which displays whether the product(s) have 'normal' 'high' or 'low' volatility) adjacent to the 'Proposed Price(s)' on the Pricing pagefor own products which have the Volatility feature configured.nvarchar40

Competitor Site

NameDescription
Entity DescriptionDetails related to a customer's Competitor Sites
Source Schemadbo
Source TablePNCompetitorSite
Destination Collection(Endpoint)nSite
Entity TypeSite
Entity VariantCompetitor

Competitor Site Attribute Details

This table identifies all of the attributes that are available on the Site record for a Competitor Site.

FieldReference EntityField DescriptionFormatMax Bytes
ActiveIndicates whether the site is active or inactive.bit1
AddressOwn or Competitor site address.nvarchar300
Address2Own or Competitor site address.nvarchar300
Address3Own or Competitor site address.nvarchar300
Address4Own or Competitor site address.nvarchar300
Address5Own or Competitor site address.nvarchar300
AlternateImportcodesEmbedded values for Alternateimportcodesnvarchar50
AreaUIDAreaInternal Unique identifier for a related record.uniqueidentifier16
AssignElasticitiesFlag to determine whether default elasticities are automatically assigned when the competitor site is made a competitor of an own site. 0 = Not added, 1 = Added.bit1
BrandUIDBrandInternal Unique identifier for a related record.uniqueidentifier16
CompetitorGroupUIDCompetitorGroupInternal Unique identifier for a related record.uniqueidentifier16
CompetitorPriceAgeThe maximum age of a competitor price in minutes that the various pricing rules can consider as valid during the price generation process.smallint2
CompetitorPriorityIDCompetitorPriorityThis property ensures the competitors are listed in an appropriate order on the Pricing Site Survey and Price and Volume Chart pages. High priority competitors take precedence over Medium competitors which take precedence over Low competitors.tinyint1
CompetitorSiteUIDSiteInternal Unique identifier for a related record.uniqueidentifier16
CountryThe country in which the Own or Competitor site is located.nvarchar100
DistanceToNearestOwnSiteThis property represents the distance of the competitor from the nearest Own Site.float8
ExtendedPropertiesnameEmbedded Data - Site property Namenvarchar100
ExtendedPropertiesvalueEmbedded Data - Site property Valuenvarchar1000
ExtendedPropertiesimportcodeEmbedded Data - Site property Import codeimportcode100
ExtendedPropertiestypeEmbedded Data - Data value inditcator. Valid types are Bool, Date,Float, Int, StringN/AN/A
ImportCodeModel items such as sites and products are identified by an ID or import code that is used to import data relating to a specific model item.importcode100
IncludeInForecastModelA flag to determine if a Competitor will be utilized in Optimization modeling.bit1
LastUpdatedCalendar date/time indicating the last time the record was updated.datetime8
LatitudeEnter the positioning coordinates for the Own or Competitor site.float8
LongitudeEnter the positioning coordinates for the Own or Competitor site.float8
MappingLabelThis property contains a description to identify the site label shown in the Map widget.nvarchar100
NameThis property contains the name that best describes the Own or Competitor sites.nvarchar200
PercentileA percentage value that relates to the pricing position of the competitor. A percentile value of '0' indicates the lowest price, and a value of '100' indicates the highest price.int4
PercentileExcludeCompetitorSelect the checkbox to exclude the selected competitor from the percentile calculation.bit1
PercentileMinutesEnter the number of hours over which the percentile value is calculated from competitor surveys. For example enter '24' to calculate the percentiles from competitor surveys received in the last 24 hours.int4
PercentileRoundDownSelect the checkbox to round down to the previous value below the percentile value.bit1
PercentileRoundUpSelect the checkbox to round up to the next value above the percentile value.bit1
PostCodeThe zip or postcode of Own or Competitor site.nvarchar40
PriceCheckCityThe city where the price check competitor is located.nvarchar200
PriceCheckCountryThe country where the price check competitor is located.nvarchar200
PriceCheckingPossibleThis property identifies the Competitor as one where prices can be verified from a 3rd party source over the internet.bit1
PriceCheckPostcodeThe postcode where the price check competitor is located.nvarchar200
PriceCheckSourceThe name of the source being used to validate the submitted competitor prices. This value is passed to the 3rd party application and used if no source was specified in the original price request.nvarchar200
PriceCheckStreetEnter the street name to identify the price check competitor.nvarchar200
PriceCheckWebsiteEnter the website address from where the competitor prices can be retrieved.nvarchar400
SiteIDInternal Unique identifier for a related record.int4
SiteGroupingsEmbedded Values for Site Group Names and Valuesnvarchar100
SpiderCompetitorPriceAgeNumber of minutes that a price request validation will look to find a valid "spider" price in competitor price history.smallint2
TimeZoneIDTimeZoneInternal Unique identifier for a related record.int4
ValidationSecondsThe maximum period in seconds for validation of dealer submitted competitor prices.smallint2

Dealer Site Relation

NameDescription
Entity DescriptionDetails related to a Dealer Site Relationships to Competitors and Own Sites
Source Schemadbo
Source TablePNDealerSiteRelation
Destination Collection(Endpoint)site
Entity TypedealerSiterelation
Entity VariantCommon

DealerSiteRelation Attribute Details

This table identifies all of the attributes that are available from the dealerSiterelation endpoint.

FieldReference EntityField DescriptionFormatMax Bytes
DealerSiterelationIDsystem generated ID for dealaerSiterelation. Not used for reportinguniqueidentifier16
CompetitorownsiteUIDSiteUnique identifier that defines the competitor site linked to a dealer siteuniqueidentifier16
DealercontrolOwnSiteUIDSiteUnique identifier that defines the Own Site that "controls" the dealer siteuniqueidentifier16
OwnsiteUIDSiteUnique identifier that defines the Own Site linked to a DTAuniqueidentifier16
BrandUIDReferenceUnique identifier for the DTA Branduniqueidentifier16
DisplayOrdersystem value for disaply ordertinyint1
IncludeinDTACalculationsTrue/False flagbit1

OwnSiteCompetitor

NameDescription
Entity DescriptionDetails related to a customer's OwnSiteCompetitors
Source Schemadbo
Source TablePNOwnsitecompetitor
Destination Collection(Endpoint)/ownSitecompetitor
Entity TypeownSitecompetitor
Entity VariantCommon

OwnsiteCompetitor Attribute Details

This table identifies all of the attributes that are available on the Site record for an Own Site used as a Competitor to an Own Site.

FieldReference EntityField DescriptionFormatMax Bytes
CompetitorgroupUIDUnique identifier that defines the Competitorgroup (sql string of numbers)uniqueidentifier16
CompetitorownsiteUIDOwnsiteCompetitorUnique identifier that defines the Ownsitecompetitor site (sql string of numbers)uniqueidentifier16
CompetitorsiteUIDSiteUnique identifier that defines the competitor site (sql string of numbers)uniqueidentifier16
CompetitorvisibilityIDInteger value of visibility typeint4
DeltaPrice Delta Valuemoney8
displayCompetitorsurveytargetsFlag to enable/disable required competitor surveysbit8
DistanceDistance to nearest Own Sitefloat8
DistanceUnitImperial or Metric value for distance measurementint4
edlDataMonetary value of the edl DeltaMoney8
ExtendedPropertiesimportcodeEmbedded Data -Site property import codeimportcode100
ExtendedPropertiesnameEmbedded Data - Site property Namenvarchar100
ExtendedPropertiesvalueEmbedded Data - Site property Valuenvarchar1000
IncludeinAgeValidationFlag to enable/disable checking price against the Age Validation rulebit1
includeinPercentileCalculationFlag to enable/disable counting competitor in market competitor calculationsbit1
IncludeinPriceAgeRuleFlag to enable/disable inclusion of competitor in Price Age Rule Validationbit1
MarginDeltaPrice Margin Delta Valuemoney8
nmDataMonetary value of the nm DeltaMoney8
NonExportingFlag to allow importing and exporting of competitor masterdat and pricesbit1
OwnsiteCompetitorIDLegacy Referencenvarchar4
OwnsiteUIDSiteUnique identifier that defines the own site (sql string of numbers)uniqueidentifier16
priceDispartiyCheckFlag toenable/disable checking price against priceDiaprty settingsbit1
priceGenerationTriggerConditionInteger value for setting for selected PG Trigger conditionstinyint8
priceGenerationTriggerDelaySetting (in minutes) if using PG delayint4
showinPricingFlag to enable/disable showing competitor in pricing widgetint4
TriggerPriceGenFlag to enabel/disable price generation on competitor price importbit1
UseDeltaFlag to to allow use of price deltabit1
VisibleinPnmobileFlag to enble/disable competitor visibility in Kalibrate Mobilenvarchar100
VisibleinPNWebFlag to enble/disable competitor visibility in Kalibrate Survey Desktopnvarchar100
← ReferenceSurvey History →
  • Overview
    • Site Data Model
    • Own Site
    • Competitor Site
    • Competitor Site Attribute Details
    • Dealer Site Relation
    • DealerSiteRelation Attribute Details
    • OwnSiteCompetitor
    • OwnsiteCompetitor Attribute Details
Copyright © 2025 Kalibrate Technologies Limited