Reference Data Entities

Overview

AlternateImportCode

Name	Description
Entity Description	AlternateImportCode reference data entity
Source Schema	dbo
Source Table	PNAlternateImportCode
Destination Collection(Endpoint)	Reference
Entity Type	AlternateImportCode
Entity Variant	Common

AlternateImportCode Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
AlternateImportCodeID		Legacy internal reference	int	4
EntityUID		Legacy indication for Alternate Import code mapping	uniqueidentifier	16
EntityTypeID		Entity Level indicator	varchar	50
SystemTypeUID		Legacy indication for SystemTypes to AlternateImportCodes	uniqueidentifier	16
ImportCode		Business ID representing the AlternateImporCode	nvarchar	100

---

Area

Name	Description
Entity Description	Area reference data entity
Source Schema	dbo
Source Table	PNArea
Destination Collection(Endpoint)	Reference
Entity Type	Area
Entity Variant	Common

Area Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
ExtendedPropertiesname		Embedded Data - Site property Name	nvarchar	100
ExtendedPropertiesvalue		Embedded Data - Site property Name	nvarchar	1000
ExtendedPropertiesimportcode		Embedded Data - Site property Name	importcode	100
ExportSubject		Subject text for email/fax exports to the area	nvarchar	100
FormatTemplateEmailUID		ID of the email template used by the area for price exports	uniqueidentifier	16
FormatTemplateFaxUID		ID of the fax template used by the area for price exports	uniqueidentifier	16
FormatTemplateSMSUID		ID of the SMS template used by the area for price exports	uniqueidentifier	16
ManagerEmail		Email address of area manager	nvarchar	300
ManagerFax		Fax number of area manager	nvarchar	100
ManagerName		Area manager name	nvarchar	100
ManagerPhone		Telephone number of area manager	nvarchar	100
ManagerSMS		SMS number of area manager	nvarchar	300
ManagerUserUID	User	Unique identifier for the Area Manager	uniqueidentifier	16
Name		Area name	nvarchar	200
UseEmail		Flag to determine whether to export the area's prices by email (0 - no, 1 - yes)	bit	1
UseFax		Flag to determine whether to export the area's prices by fax (0 - no, 1 - yes)	bit	1
UseSMS		Flag to determine whether to export the area's prices by SMS (0 - no, 1 - yes)	bit	1

---

Brand

Name	Description
Entity Description	Brand reference data entity
Source Schema	dbo
Source Table	PNBrand
Destination Collection(Endpoint)	Reference
Entity Type	Brand
Entity Variant	Common

Brand Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
BrandID		Legacy internal reference	int	4
CurrentIncreaseCount		The current count of the number of times a competitor has increased their price	smallint	2
Discount		Any discounts associated to the brand	money	8
DisplayOrder		Order the brand is displayed on the Pricing page in legacy PriceNet	tinyint	1
IconURL		URL for the logo	varchar	4166
IncreaseTriggerValue		The number of times a competitor must increase their price before the triggering of sending the site to SFR	smallint	2
Name		Brand Name	nvarchar	100

---

Channel of Trade

Name	Description
Entity Description	Channel of Trade reference data entity
Source Schema	dbo
Source Table	PNChannelOfTrade
Destination Collection(Endpoint)	Reference
Entity Type	ChannelofTrade
Entity Variant	Common

Channel of Trade Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
ChannelOfTradeUID		Internal unique identifier	uniqueidentifier	16
Name		The name of the Channel of Trade	nvarchar	200

---

Competitor Group

Name	Description
Entity Description	Competitor Group reference data entity
Source Schema	dbo
Source Table	PNCompetitorGroup
Destination Collection(Endpoint)	Reference
Entity Type	CompetitorGroup
Entity Variant	Common

Competitor Group Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
CompetitorGroupUID		Internal unique identifer	uniqueidentifier	16
IsSystem		If it is a default group in the application	bit	1
Name		Group Name	nvarchar	200

---

Competitor Priority

Name	Description
Entity Description	Competitor Priority reference data entity
Source Schema	dbo
Source Table	PNCompetitorPriority
Destination Collection(Endpoint)	Reference
Entity Type	CompetitorPriority
Entity Variant	Common

Competitor Priority Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
CompetitorPriorityID		Internal unique identifier	int	4
Description		Description	varchar	100
TxID		Translation ID for the priority code text displayed in the application	int	4

---

Config

Name	Description
Entity Description	Config reference data entity
Source Schema	dbo
Source Table	PNConfig
Destination Collection(Endpoint)	Reference
Entity Type	Config
Entity Variant	Common

Config Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
ConfigID		Unique PriceNet ID representing the config parameter	varchar	50
IntValue		Integer value for the config parameter	int	4
TxID		Translation ID for user friendly text displayed in the application	int	4
DescriptionTxID		Translation ID for the description	int	4
Description		Internal description of the config parameter	varchar	512
Type		Defines which tab the parameter will appear under in the PriceNet Administrator. 0 is the first tab on the left	tinyint	1
DisplayOrder		A number to define where the config setting should appear on the relevant tab in the Administrator	int	4
Visible		Whether the setting is visible in the Administrator or not	bit	1
Required		Where this flag is set to true, the parameter must always have a value (i.e., It can never be null)	bit	1
UpdateInclude		If this flag is set to true, any changes to this parameter will be recorded in PNConfigHistory	bit	1
IncludeInPG		This flag will mark each record as to whether it will be pulled into price generation or not. 0 = ignore, 1 = include	bit	1
Timestamp		System column to identify if record has been changed	timestamp	8
DateValue		Datetime value for the config parameter	datetime	8

---

Contract Type

Name	Description
Entity Description	Contract Type reference data entity
Source Schema	dbo
Source Table	PNContractType
Destination Collection(Endpoint)	Reference
Entity Type	ContractType
Entity Variant	Common

Contract Type Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
ContractTypeID		Internal unique identifier	int	4
Component		The name of a .NET component that implements the functionality surrounding the contract type	varchar	100
Dealer		Contract ID	bit	1
ImportCode		Business ID representing the contract type	nvarchar	100
Name		Contract Name	nvarchar	200
TxID		Translation ID for user friendly text displayed in the application	int	4

---

Contract Value

Name	Description
Entity Description	Contract Value reference data entity
Source Schema	dbo
Source Table	PNContractValue
Destination Collection(Endpoint)	Reference
Entity Type	ContractValue
Entity Variant	Common

Contract Value Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
ContractValueTypeID	ContractValueType	Contract Value Type ID of contract value	int	4
ProposedPrice	Price	Proposed Price ID of contract value	uniqueidentifier	16
Value		Contract value	money	8

---

Contract Value Type

Name	Description
Entity Description	Contract Value Type reference data entity
Source Schema	dbo
Source Table	PNContractValueType
Destination Collection(Endpoint)	Reference
Entity Type	ContractValueType
Entity Variant	Common

Contract Value Type Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
ContractValueTypeID		Legacy internal reference	int	4
ContractTypeID		Numeric ID for Contract types. Valid options are 1,2,3,4,5,6,7	int	4
ContractType	ContractType	Legacy indication for type of pricing including Standard Margin Contract, Cost Plus & Cost Plus Extra	uniqueidentifier	16
TxID		Translation ID for user friendly text displayed in the application	int	4
Name		Name of the contract value type	nvarchar	100
StoredProcedure		Name of the stored procedure executed to produce a contract value of this type for a proposed price	varchar	100
Subclass		Name of the .NET class that implements the functionality to product a contract value of this type for a proposed price	varchar	100
EntityType	EntityType	Determines the ID of the Entity Type level at which this parameter resides. Will be either OWNSITE or OWNPRODUCT	varchar	25
Visible		Whether the Contract Value Type is visible as an available Pricing page section	bit	1
DefaultDisplayOrder		The default display order for the contract value type	int	4
DataType		Stores the name of the data type that is used to store the contract value. This will be one of the standard data type names that are used throughout the system (I.e. boolean, datetime, float, int, price, string or time)	varchar	50
Nullable		Indicates whether a contract value is nullable (for instance, a non-nullable contract value with a data type of 'price' returns 'decimal' values, whereas if the same contract value were nullable it would return values of type 'Nullable' or 'decimal?')	bit	1

---

Cost Breakdown

Name	Description
Entity Description	Cost Breakdown reference data entity
Source Schema	dbo
Source Table	PNCostBreakdown
Destination Collection(Endpoint)	Reference
Entity Type	CostBreakdown
Entity Variant	Common

Cost Breakdown Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
CostBreakdownID		Unique ID representing the Cost Breakdown	int	4
CostTypeID		Unique ID representing the Cost Type	int	4
Price		Cost Breakdown Price	money	8
EffectiveTime		Cost Breakdown price effective time	datetime	8
Source		The source of the cost breakdown	nvarchar	20
AggregationChecked		True of False flag associated to checking cost aggreation status	bit	1
Product		Unique identifier for Own Product associated to the Cost Breakdown Import	uniqueidentifier	16

---

Cost Type

Name	Description
Entity Description	Cost Type reference data entity
Source Schema	dbo
Source Table	PNCostType
Destination Collection(Endpoint)	Reference
Entity Type	CostType
Entity Variant	Common

Cost Type Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
CostType		Unique ID representing the Cost Type	int	4
ImportCode		Business ID representing the code	nvarchar	50
name		Cost Type name	nvarchar	100
system		Indicates that a particular cost type is system generated and cannot be amended or deleted by the user	bit	1
showOnPricingPage		Flag to enable/disable displaying Cost Type on pricing page	bit	1
validationCostPrice		Flag to enable/disable validating Cost Prices	bit	1
aggregatedCost		Flag to enable/disable cost aggregation	bit	1
makeTotalCost		Flag to enable/disable using costs as a total cost	bit	1

---

Cross Effect

Name	Description
Entity Description	Cross Effect reference data entity
Source Schema	dbo
Source Table	PNCrossEffect
Destination Collection(Endpoint)	Reference
Entity Type	CrossEffect
Entity Variant	Common

Cross Effect Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
CrossEffectID		Legacy internal identifier	int	4
PricingPeriodType	PricingPeriodType	The warehouse key of the pricing period type that the cross effect belongs to	int	4
CrossOwnProduct	Product	Own product ID for the price	uniqueidentifer	16
CrossCompetitorProduct	Product	Competitor product ID for the cross effect	uniqueidentifier	16
Elasticity		Elasticity value	float	8

---

Data Channel

Name	Description
Entity Description	Data Channel reference data entity
Source Schema	dbo
Source Table	PNDataChannel
Destination Collection(Endpoint)	Reference
Entity Type	DataChannel
Entity Variant	Common

Data Channel Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
DataChannelID		Internal legacy identifier	int	4
TxID		Translation ID for user friendly text displayed in the application	int	4
Description		Name of the data channel	varchar	100
FolderPath		Folder directory of the data channel	nvarchar	2048
Visible		Indication of whether data channel is available to select in the Kalibrate Pricing interface	bit	1
ImportChannel		Indication of whether the channel is utilized for importing data	bit	1
ChannelType		Indication of whether data channel utilizes xml or csv	varchar	8
DataType		DataType	int	4
HasHeaderRow		Indication of whether file has a header row to be ignored	bit	1
HasFooterRow		Indication of whether file has a footer row to be ignored	bit	1
Enabled		Indication of whether the channel is active for exporting to folder	bit	1
LastRunTime		TBC	datetime	8

---

Data Type

Name	Description
Entity Description	Data Type reference data entity
Source Schema	dbo
Source Table	PNDataType
Destination Collection(Endpoint)	Reference
Entity Type	DataType
Entity Variant	Common

Data Type Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
DataTypeID		Legacy internal reference	int	4
TxID		Translation ID for user friendly text displayed in the application	int	4
Description		Name of the data type	varchar	100
HoldingTableName		Name of holding table	varchar	50
MaximumHistoryDays		Maximum Story Days Setting	int	4
MaximumFutureDays		Maximum Furute Days Setting	int	4

---

Dealer Trust Category

Name	Description
Entity Description	Dealer Trust Category reference data entity
Source Schema	dbo
Source Table	PNDealerTrustCategory
Destination Collection(Endpoint)	Reference
Entity Type	DealerTrustCategory
Entity Variant	Common

Dealer Trust Category Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
Description		Description for the category	nvarchar	50
TrustLevel		Letter indicating the level of trust	tinyint	1

---

Entity Pricing Profile

Name	Description
Entity Description	Entity Pricing Profile reference data entity
Source Schema	dbo
Source Table	PNEntityPricingProfile
Destination Collection(Endpoint)	Reference
Entity Type	EntityPricingProfile
Entity Variant	Common

Entity Pricing Profile Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
PricingProfile		Unique ID representing a Pricing Profile	uniqueidentifier	16
EntityUID		Unique ID representing and entity associated to the Entity Pricing Profile	uniqueidentifier	16
EntityTypeID		Idnetifies the ID of the Entity Type level at which this parameter resides. Will be either OWNSITE, OWNPRODUCTGROUP or OwnProduct	varchar	50
PricingProfileTypeID		ID of Pricing Profile Type. Valid Options are STD,MAN or EVT	varchar	3
Stage		Location level of the pricing rule within the pricing profile	int	4
SecondaryEntityTypeUID		Unique ID representing a Secondary Entity associated to the pricing profile	uniqueidentifier	16
SecondaryEntityTypeID		Idnetifies the Secondary Entity Type level at which this parameter resides. Will be either EVENT or Event Template	varchar	50
System		True or False value for Systme generated data	bit	1

---

Event Template

Name	Description
Entity Description	Event Template reference data entity
Source Schema	dbo
Source Table	PNEventTemplate
Destination Collection(Endpoint)	Reference
Entity Type	EventTemplate
Entity Variant	Common

Event Template Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
AutoImplement		True/False flag for allowing Evnet to Auto Implement Prices	bit	1
EventTypeID		Legacy internal reference	int	4
generateNote		Flag to enable/disable note generation	bit	1
Name		Name of the event template	nvarchar	200
Precedence		The priority of the event. Events with lower precedence values are processed in preference of events with a higher precedence	tinyint	1
PriceRequestTypeID	Price Request Type	ID of a price request type	varchar	5
SalesImpactID		Legacy internal reference	int	4
System		Defines a system type event that are predefined by KSS	bit	1
Visible		Flag to enable/disable visibility	bit	1
VisibleInPNWeb		Allow display of Event in Kalibrate Survey Desktop	bit	1

---

Event Type

Name	Description
Entity Description	Event Type reference data entity
Source Schema	dbo
Source Table	PNEventType
Destination Collection(Endpoint)	Reference
Entity Type	EventType
Entity Variant	Common

Event Type Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
EventTypeID		Unique ID representing a type of event. Currently there are three types of event: 1 Informational event type, 2 Pricing event type, 3 Non-Pricing event type	tinyint	1
TxID		Translation ID for user friendly text displayed in the application	int	4
Description		Internal description of the event type	varchar	100

---

Extended Property

Name	Description
Entity Description	Extended Property reference data entity
Source Schema	dbo
Source Table	PNExtendedProperty
Destination Collection(Endpoint)	Reference
Entity Type	ExtendedProperty
Entity Variant	Common

Extended Property Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
ExtendedPropertyType		Unique ID representing the Extneded Property Type	uniqueidentifier	16
ExtendedPropertyGroup		Unique ID representing the Extneded Property Group	uniqueidentifier	16
Importcode		Extended Property Importcode	nvarchar	100
EntityTypeID		Own Site, Competitor Site, Own Site Competitor level ID	varchar	50
DisplayOrder		Display order value	int	4
GroupBy		Group By Option Setting	int	4
ReadOnly		Flag to enable/disable Read Only parameter	bit	1
Required		Flag to enable/disable required parameter	bit	1
Visible		Flag to enable/disable visibility	bit	1
VisibleInPNWeb		Allow display of Event in Kalibrate Survey Desktop	bit	1

---

Extended Property Group

Name	Description
Entity Description	Extended Property Group reference data entity
Source Schema	dbo
Source Table	PNExtendedPropertyGroup
Destination Collection(Endpoint)	Reference
Entity Type	ExtendedPropertyGroup
Entity Variant	Common

Extended Property Group Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
EntityTypeID		Own Site, Competitor Site, Own Site Competitor level ID	varchar	50
Name		Extended Property Group Name	nvarchar	100
DisplayOrder		Display order value	int	4

---

Extended Property Options

Name	Description
Entity Description	Extended Property Option reference data entity
Source Schema	dbo
Source Table	PNExtendedPropertyOptions
Destination Collection(Endpoint)	Reference
Entity Type	ExtendedPropertyOptions
Entity Variant	Common

Extended Property Options Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
ExtendedProperty		Unique ID representing the Extneded Property	uniqueidentifier	16
Name		Extended Property Group Name	nvarchar	100
DisplayOrder		Display order value	int	4

---

Extended Property Type

Name	Description
Entity Description	Extended Property Type reference data entity
Source Schema	dbo
Source Table	PNExtendedPropertyType
Destination Collection(Endpoint)	Reference
Entity Type	ExtendedPropertyType
Entity Variant	Common

Extended Property Type Attributes

FField	Reference Entity	Field Description	Format	Max Bytes
Name		Extended Property Type Name	nvarchar	100
TxID		Translation ID for user friendly text displayed in the application	int	4
Type		Extended Property data format	varchar	25
MinValue		Minimum value for numbers and decimals	int	7
MaxValue		Maximum value for numbers and decimals	int	7
MaxLength		Maximum length for text values	int	4

---

Import Error

Name	Description
Entity Description	Import Error reference data entity
Source Schema	dbo
Source Table	PNImporterror
Destination Collection(Endpoint)	Reference
Entity Type	Import Error
Entity Variant	Common

Import Error Attributes

FField	Reference Entity	Field Description	Format	Max Bytes
importErrorId		System generated legacy ID	int	4
ownSite	Site	Unique Identifier for Own Site linked to import error	uniqueidentifier	16
competitorSite	Site	Unique Identifier for Competitor Site linked to import error	uniqueidentifier	16
product		Unique Identifier for Global Product linked to import error	uniqueidentifier	16
priceRequest		Price rquest ID generated for errors linked to price generation	int	8
improtErrorCodeId		System generated reference ID for the import error code linked to import error	int	4
errorDetails		XML details of import error	xml	not null
importCode1		Importcode of the first entity associated to import error	nvarchar	50
importCode2		Importcode of the second entity associated to import error	nvarchar	50
importCode3		Importcode of the third entity associated to import error	nvarchar	50
brand		Brand Name linked to import error	nvarchar	100
effectiveTimeChar		Effectivetime of the imported data	datetime	8
price		Price value for import error	decimal	18,9
Source		Data source of the import error	nvarchar	50
triggerPriceGen		True/False flag for triggering price generation when resubmitting values	bit	1

---

Import Error Code

Name	Description
Entity Description	Import Error Code reference data entity
Source Schema	dbo
Source Table	PNImporterrorcode
Destination Collection(Endpoint)	Reference
Entity Type	Import Error Code
Entity Variant	Common

Import Error Code Attributes

FField	Reference Entity	Field Description	Format	Max Bytes
importErrorCodeId		System generated legacy ID	int	4
txId		Translation ID for user friendly text displayed in the application	int	4
filterTxId		Translation ID for user friendly text displayed in the application excluding placeholders	int	4
description		Description for the type of import error	varchar	500
errorData		Field holding placeholders for the error messages	varchar	25
irrecoverable		True/False flag used to note records that cannot be revocered by resubmission	bit	1

---

Log Alpha

Name	Description
Entity Description	Log Alpha reference data entity
Source Schema	dbo
Source Table	PNLogAlpha
Destination Collection(Endpoint)	Reference
Entity Type	LogAlpha
Entity Variant	Common

Log Alpha Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
OwnProduct	OwnProduct	Own Product ID	uniqueidentifier	16
PricingPeriodTemplate	PricingPeriodTemplate	Pricing Period Template ID	uniqueidentifier	16
LogAlpha		Log alpha value.	float	8

---

Margin Allocation Method

Name	Description
Entity Description	Margin Allocation Method reference data entity
Source Schema	dbo
Source Table	PNMarginAllocationMethod
Destination Collection(Endpoint)	Reference
Entity Type	MarginAllocationMethod
Entity Variant	Common

Margin Allocation Method Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
MarginAllocationMethodID		Legacy internal identifier	int	4
Name		Name of the Margin allocation Method	nvarchar	200
TxID		Translation ID for user friendly text displayed in the application	int	4

---

Market Share Data

Name	Description
Entity Description	Market Share Data reference data entity
Source Schema	dbo
Source Table	PNMarketShareData
Destination Collection(Endpoint)	Reference
Entity Type	MarketShareData
Entity Variant	Common

Market Share Data Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
MarketShareDataID		Legacy internal reference	int	4
SiteID	Site	Import code for an Own or Competitor Site	nvarchar	50
SiteType		Valid site types are OWNSITE or COMPETITORSITE	varchar	14
DataLevel		Data level identifier. Valid options are 0:Product Level, 1: Product group level, 2: Site level	tinyint	1
GlobalEntityID	Entity	Idnetifier for either the product or product group	nvarchar	50
StartDate		Period start date	datetime	8
EndDate		Period end date	datetime	8
Estimate		Volume estimate in gallons	decimal	9
Source		Source of imported data	navchar	100
PriceMarginDatalevel		Data level for an optional price margin	tinyint	1
PriceMarginGlobalEntity	Entity	The identifier for either the product or product group.	nvarchar	50
AveragePriceOverPeriod		The average price over the period.	money	8
AverageMarginOverPeriod		The average margin over the period.	money	8

---

Network

Name	Description
Entity Description	Network reference data entity
Source Schema	dbo
Source Table	PNNetwork
Destination Collection(Endpoint)	Reference
Entity Type	Network
Entity Variant	Common

Network Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
ExtendedPropertiesname		Embedded Data - Site property Name	nvarchar	100
ExtendedPropertiesvalue		Embedded Data - Site property value	nvarchar	1000
ExtendedPropertiesimportcode		Embedded Data - Site property importcode	importcode	100
ImportCode		Network Import Code	nvarchar	100
ManagerName		Network Manager's name	nvarchar	100
ManagerEmail		Network Manager's email	nvarchar	300
ManagerSMS		Network Manager's Mobile number	nvarchar	300
ManagerUser		Network Manager User	uniqueidentifier	16
Name		Network Name	nvarchar	100
NetworkID		internal legacy reference	int	4

---

Price Point Set

Name	Description
Entity Description	Price Point Set reference data entity
Source Schema	dbo
Source Table	PNPricePiontSet
Destination Collection(Endpoint)	Reference
Entity Type	PricePointSet
Entity Variant	Common

Price Point Set Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
Name		Name given to the selection	nvarchar	200
Allow0		It will allow 0	bit	1
Allow1		It will allow 1	bit	1
Allow2		It will allow 2	bit	1
Allow3		It will allow 3	bit	1
Allow4		It will allow 4	bit	1
Allow5		It will allow 5	bit	1
Allow6		It will allow 6	bit	1
Allow7		It will allow 7	bit	1
Allow8		It will allow 8	bit	1
Allow9		It will allow 9	bit	1

---

Pricing Period Template

Name	Description
Entity Description	Pricing Period Template reference data entity
Source Schema	dbo
Source Table	PNPricingPeriodTemplate
Destination Collection(Endpoint)	Reference
Entity Type	PricingPeriodTemplate
Entity Variant	Common

Pricing Period Template Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
PricingPeriodType	PricingPeriodType		uniqueidentifier	16
Name		Name of the pricing period template	nvarchar	200
DayOfWeek		Defines the day of the week the template relates to. Valid values are: 1 = Sunday, 2 = Monday, 3 = Tuesday, 4 = Wednesday, 5 = Thursday, 6 = Friday, 7 = Saturday	tinyint	1
StartTime		Time defining the start of the period (date part ignored)	datetime	8
EndTime		Time defining the end of the period (date part ignored)	datetime	8

---

Pricing Period Type

Name	Description
Entity Description	Pricing Period Type reference data entity
Source Schema	dbo
Source Table	PNPricingPeriod
Destination Collection(Endpoint)	Reference
Entity Type	PricingPeriodType
Entity Variant	Common

Pricing Period Type Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
PricingPeriodTypeID		Legacy internal reference	int	4
Name		Display name for the pricing period type	nvarchar	200
DisplayOrder		Defines the order in which the pricing period types are displayed on the cross effects pages	tinyint	1

---

Pricing Profile

Name	Description
Entity Description	Pricing Profile reference data entity
Source Schema	dbo
Source Table	PNPricingProfile
Destination Collection(Endpoint)	Reference
Entity Type	PricingProfile
Entity Variant	Common

Pricing Profile Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
Name		Pricing profile name	nvarchar	200
EntityTypeID		Type of entity allowed in the profile - valid values are: OWNPRODUCT, OWNPRODUCTGROUP and OWNSITE	varchar	50
Description		Description of the pricing profile	nvarchar	8000
System		Internal flag to denote whether or not the profile is a user-generated one or a standard one supplied with PriceNet (0 - user created, 1 - supplied with PriceNet)	bit	1

---

Pricing Profile Rule

Name	Description
Entity Description	Pricing Profile Rule reference data entity
Source Schema	dbo
Source Table	PNPricingProfileRule
Destination Collection(Endpoint)	Reference
Entity Type	PricingProfileRule
Entity Variant	Common

Pricing Profile Rule Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
DisplayOrder		The order in which the Rule is displayed within it's Pricing Profile in the Pricing Profiles page. It is also the order in which the Rule is processed within it's Pricing Profile during the Price Generation process	tinyint	1
PricingProfile	PricingProfile	TBC	uniqueidentifier	16
Rule	Rule	Rule	uniqueidentifier	16
Severity		Internal setting that dictates the severity of a validation rule (0 - user defined, 1 - non-fatal, 2 - fatal)	tinyint	1

---

Price Status

Name	Description
Entity Description	Price Status reference data entity
Source Schema	dbo
Source Table	PNCompetitorPriceStatus
Destination Collection(Endpoint)	Reference
Entity Type	PriceStatus
Entity Variant	Common

Price Status Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
CompetitorPriceStatusID		Legacy internal reference	int	4
TxID		Translation ID for user friendly text displayed in the application	int	4
Description		Description of the price status	varchar	50

---

Priority

Name	Description
Entity Description	Priority reference data entity
Source Schema	dbo
Source Table	PNPriority
Destination Collection(Endpoint)	Reference
Entity Type	Priority
Entity Variant	Common

Priority Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
Name		Name of the priority	varchar	50
TxID		Translation ID to display a user friendly description of the priority	int	4
Value		Unique ID representing the priority - valid values are: 1 - Low Priority, 2 - Medium Priority, 3 High Priority	int	4

---

Report Group

Name	Description
Entity Description	Report Group data entity
Source Schema	dbo
Source Table	PNReportGroup
Destination Collection(Endpoint)	Reference
Entity Type	Report Group
Entity Variant	Common

Report Group Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
Name		Name of the Report Group	nvarchar	100
Display order		Display order of Report Group (not used for reporting)	tinyint	1
Colour		Colour of the Report Group display	char	6

---

Rule

Name	Description
Entity Description	Rule reference data entity
Source Schema	dbo
Source Table	PNRule
Destination Collection(Endpoint)	Reference
Entity Type	Rule
Entity Variant	Common

Rule Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
RuleID		Internal legacy reference	int	4
EntityTypeID		Idnetifies the ID of the Entity Type level at which this parameter resides. Will be either OWNSITE, OWNPRODUCTGROUP or OwnProduct	varchar	50
Component		The name of the class that contains the scripts for the Rule	varchar	100
RuleType	RuleType	UNique identifier for rule type assocaited to Rules	int	4
TxID		Translation ID for the rule name that is displayed in the application	int	4
DescriptionTxID		Translation ID for the rule description that is displayed in the application	int	4
System		Indicates whether the rule is user accessible or not	bit	1
DefaultSeverity		Internal setting that dictates how a rule will initially be added in the UI (1 - send to SFR, 2 - invoke backup profiles)	tinyint	1
Description		Internal description of the rule	varchar	200
Dealer		Whether the rule is specific to Dealer Pricing	bit	1

---

Rule Parameter

Name	Description
Entity Description	Rule Parameter reference data entity
Source Schema	dbo
Source Table	PNRuleParameter
Destination Collection(Endpoint)	Reference
Entity Type	ruleParameter
Entity Variant	Common

Rule Parameter Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
ruleParameterID		Internal legacy reference	int	4
rule		Unique Identifier for the rule linked to rule parameter	uniqueidentifier	16
parameterId		Name of rule set that parameter values apply	varchar	100
dataType		Data type indicator. Accepatble values are Boolean, Float, Integer, Price, String, Time	varchar	20
TxID		Translation ID for the rule parameter that is displayed in the application	int	4
minValue		Minimum value used for the rule parameter	int	8
maxValue		Maximum value used for the rule parameter	int	8
maxLength		Maximum field length for the data type used in rule paramater	int	4
defaultValue		System default value for rule parameter	sql_variant	4
visible		True/False flag for ruleparameter visibility	bit	1
descriptionTxId		Translation ID for the rule description that is displayed in the application	int	4
displayOrder		System generated value for the rule parameter display order	tinyint	1

---

Rule Parameter Value

Name	Description
Entity Description	Rule Parameter Value reference data entity
Source Schema	dbo
Source Table	PNRuleParametervalue
Destination Collection(Endpoint)	Reference
Entity Type	RuleParameterValue
Entity Variant	Common

Rule Parameter Value Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
RuleParameter	RuleParameter	Unique Identifier for the rule linked to rule parameter	uniqueidentifier	16
EntityPricingProfile	EntityPricingProfile	Unique Identifier for the rule linked to rule parameter	uniqueidentifier	16
PricingProfileRule	PricingProfileRule	Unique Identifier for the rule linked to rule parameter	uniqueidentifier	16
Value		Value for Rule Parameter	sql_variant	8016
System		System generated True or False value. 0 or 1	bit	1

---

Rule Type

Name	Description
Entity Description	Rule Type reference data entity
Source Schema	dbo
Source Table	PNRuleType
Destination Collection(Endpoint)	Reference
Entity Type	RuleType
Entity Variant	Common

Rule Type Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
RuleTypeID		Legacy internal reference	int	4
TxID		Translation ID for the Rule Type name that is displayed in the application	int	4
Description		Internal description for the Rule Type code	varchar	100

---

Rule Property Value

Name	Description
Entity Description	Rule Property Value reference data entity
Source Schema	dbo
Source Table	PNRulePropertyValue
Destination Collection(Endpoint)	Reference
Entity Type	RulePropertyValue
Entity Variant	Common

Rule Property Value Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
RulePropertyValueID		Legacy internal reference	int	4
RulePropertyID		Name of Rule Property	varchar	25
Site	Own Site	The UID of the Own Site the property value is being set against	uniqueidentifier	16
Entity	Rule	Unique Identifier of the Rule Property associated with Rule Property Value	unique identifier	16
Float Value		Float Value of the RulePropertyValue	Float	4

---

Sales Impact

Name	Description
Entity Description	Sales Impact reference data entity
Source Schema	dbo
Source Table	PNSalesImpact
Destination Collection(Endpoint)	Reference
Entity Type	SalesImpact
Entity Variant	Common

Sales Impact Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
SalesImpactID		Internal unique identifier	int	4
IncludeInPMI		If the sales under this impact code will be included in the policy automatic update management	bit	1
Name		Sales Impact Name	nvarchar	200
SalesEffect		Value indicating if this sales impact type has a negative, positive or neutral effect on sales volumes, values allowed are -, + 0	char	1
System		If the sales impact is a system default	bit	1
VisibleInPNWeb		If it will be visible in Survey Desktop application (former PNWeb). Any sales impact records with a SalesImpactID >= 500 should always have this value set to 0	bit	1

---

Sales Type

Name	Description
Entity Description	Sales Type reference data entity
Source Schema	dbo
Source Table	PNSalesType
Destination Collection(Endpoint)	Reference
Entity Type	SalesType
Entity Variant	Common

Sales Type Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
SalesTypeID		Internal unique identfier	int	4
Name		Sales type Name	nvarchar	200
ExcludeFromRefinement		Whether this sales type should be included in the optimisation refinement	bit	1
ImportCode		Sales type ID	nvarchar	100
IncludeInAggregation		Whether this sales type should be aggregate to form the Total Sales	bit	1
PaymentTypeID		Any payment type related to this sales type	int	4
PromotionID		Internal unique identfier	int	4
System		If it was created by default	bit	1

---

Site Stock Type

Name	Description
Entity Description	Site Stock reference data entity
Source Schema	dbo
Source Table	PNSiteStockType
Destination Collection(Endpoint)	Reference
Entity Type	SiteStockType
Entity Variant	Common

Site Stock Type Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
Name		Name of the stock type	nvarchar	40

---

Store Sales

Name	Description
Entity Description	Store Sales reference data entity
Source Schema	dbo
Source Table	PNStoreSales
Destination Collection(Endpoint)	Reference
Entity Type	StoreSales
Entity Variant	Common

Store Sales Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
StoreSalesID		Internal unique identfier	int	4
StoreSalesTypeID		Internal unique identfier	int	4
SiteId		Unique identifier representing an Own Site	uniqueidetifier	16
ProductId		Unique identifier representing an Own Product	uniqueidetifier	16
ProductGroupId		Unique identifier representing an Own Product Group	uniqueidetifier	16
DecimalValue		Value of sales being reported	decimal	18,9
IntValue		Value of sales being reported	int	4
StartDate		Effective Start Time of record	datetime	8
EndDate		Effective end time of record	datetime	8

---

Store Sales Type

Name	Description
Entity Description	Store Sales Type reference data entity
Source Schema	dbo
Source Table	PNStoreSalesType
Destination Collection(Endpoint)	Reference
Entity Type	StoreSalesType
Entity Variant	Common

Store Sales Type Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
StoreSalesTypeID		Internal unique identfier	int	4
Name		StoreSales Type Name	nvarchar	100
Importcode		Impoort Code ID of Store Sales Type	nvarchar	50
EntityTypeID		Type of entity allowed in the profile - valid values are: OWNPRODUCT, OWNPRODUCTGROUP and OWNSITE	varchar	50
DataType		Data Type Setting valid opions are decimal and integer	varchar	10
AggregatetoOwnSite		Flag to enable disable own site data aggregation	bit	1
AggregatetoOwnProductGroup		Flag to enable disable display Own Product Group data aggregation	bit	1

---

System Type

Name	Description
Entity Description	System Type reference data entity
Source Schema	dbo
Source Table	PNSystemType
Destination Collection(Endpoint)	Reference
Entity Type	SystemType
Entity Variant	Common

System Type Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
SystemTypeID		Internal unique identfier	int	4
Importcode		Impoort Code ID of Store Sales Type	nvarchar	50
Name		StoreSales Type Name	nvarchar	100

---

Terminal

Name	Description
Entity Description	Terminal reference data entity
Source Schema	dbo
Source Table	PNTerminal
Destination Collection(Endpoint)	Reference
Entity Type	Terminal
Entity Variant	Common

Terminal Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
ImportCode		Terminal ID	nvarchar	100
Name		Terminal Name	nvarchar	200

---

Time Zone

Name	Description
Entity Description	Time Zone reference data entity
Source Schema	dbo
Source Table	PNTimeZone
Destination Collection(Endpoint)	Reference
Entity Type	TimeZone
Entity Variant	Common

Time Zone Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
BaseUtcOffset		Hours time zone is offset from Coordinated Universal Time (UTC)	smallint	2
DisplayName		The description of the timezone that appears in the application	nvarchar	200
Name		The official name of the time zone	nvarchar	200
SupportsDaylightSavingTime		Flag if Time Zone area includes daylight savings time	bit	1
TimeZoneID			int	4

---

User

Name	Description
Entity Description	User reference data entity
Source Schema	dbo
Source Table	PNUser
Destination Collection(Endpoint)	Reference
Entity Type	User
Entity Variant	Common

User Attributes (includes User Restriction Attributes)

Field	Reference Entity	Field Description	Format	Max Bytes
Name		User name for login purposes	nvarchar	200
UserProfile		Unique identifier for the user profile assigned to a user	uniqueidentifier	16
UserrestrictionUID		Unque identifier for the user restriction assigned to a user	uniqueidentifier	16
entityUID	Site	Unique identifier for the entity restriction	uniqueidentifier	16
entitytypeid		Entity type assigned to the user restriction. Acceptable values are OwnSite,Channeloftrade,Network, Area	varchar	50
exclude		True or False flag for user restirction	bit	1

---

User Profile

Name	Description
Entity Description	User Profile reference data entity
Source Schema	dbo
Source Table	PNUserProfile
Destination Collection(Endpoint)	Reference
Entity Type	User Profile
Entity Variant	Common

User Profile Attributes

Field	Reference Entity	Field Description	Format	Max Bytes
Name		User Profile name	nvarchar	100
defaultLanguageId		Default language assigned to profile	vcarchar	10
audit		True/False flag for audit trail	bit	1
profileId		System generated ID not used for reporting	int	8
canManageAccountLocks		True/False flag for ability to lock or unlock user accounts	bit	1
passwordExpires		True/False flag for password expiration	bit	1
noPasswordReuse		True/False flag for password resue	bit	1
accountLocks		True/False flag for assigning account lock policy to user profile	bit	1
oneTimePassword		True/False flag for requiring one-time password on first login attempt	bit	1
optOutofPasswordComplexity		True/False flag for requiring passowrd complexity policy	bit	1