Price Request Entities
Overview
The Price collection consists of all of the different entities associated with price requests.
Price Request Data Model
The following data model shows the Price Request entity and it's relational links. For the full model, see Data Model.
Event
| Name | Description |
|---|---|
| Entity Description | Attributes of the core Event entity |
| Source Schema | dbo |
| Source Table | PNEvent |
| Destination Collection(Endpoint) | PriceRequest |
| Entity Type | Event |
| Entity Variant | Common |
Event Attribute Details
| Field | Reference Entity | Field Description | Format | Max Bytes |
|---|---|---|---|---|
| EventTemplate | EventTemplate | ID of the template used for the event | int | 4 |
| StartTime | Start time of the event. | datetime | 8 | |
| EndTime | End time of the event. | datetime | 8 | |
| ProcessTime | Process time of the event. | datetime | 8 | |
| InitialEvent | Event | The ID of the first event in a series of recurring events. | uniqueidentifier | 16 |
| Recurring | Whether the event is recurring (0 - no, 1 - yes). | bit | 1 | |
| RecurringPeriod | Recurring period if the event is recurring - valid values are: 0 (Daily), 1 (Weekly), 2 (Monthly), 3 (Annually). | tinyint | 1 | |
| RecurringDays | Used to represent the days of the week which the event will recur on if RecurringPeriod is Daily. This will be a bitmask interpreted by the code. | tinyint | 1 | |
| RecurringCount | Number of times the event will recur. | int | 4 | |
| RecurringMonthDay | For monthly events, stores the day of the month on which the event recurs. For non-monthly events, NULL is stored. | tinyint | 1 | |
| RecurringMonthWeek | For monthly events, stores the week of the month on which the event recurs (i.e., 1st, 2nd, 3rd, 4th). If this is set, RecurringMonthDay will store an integer 1-7 representing the day of the week the event will recur on. For non-monthly events, NULL is stored. | tinyint | 1 | |
| RecurringYearMonth | For annual events, stores the number of the month on which the event recurs. RecurringMonthDay will store the day of that month on which it recurs if this is set. For non-annual events, NULL is stored. | tinyint | 1 | |
| HasRecurred | Flag to show that an event has recurred. | bit | 1 | |
| RecurredCount | The number of time an event has so far recurred. | int | 4 | |
| Cancelled | Flag to show that an event has been cancelled or not. | bit | 1 | |
| CancelledTime | The date and time an event was cancelled. | datetime | 8 | |
| SalesRecoded | Flag indicating if sales records affected by this event have been recoded. | bit | 1 | |
| PriceChange | Value of Price Change initiated by the eventC | money | 8 | |
| RevertAtEnd | Flag to set Revert at End of event functinality | bit | 1 | |
| SalesImpact | SalesImpact | Legacy ID of Sales Impact | int | 4 |
General Price Change
| Name | Description |
|---|---|
| Entity Description | Attributes of the core General Price Change entity |
| Source Schema | dbo |
| Source Table | PNGeneralPriceChange |
| Destination Collection(Endpoint) | PriceRequest |
| Entity Type | GeneralPriceChange |
| Entity Variant | Common |
General Price Change Attribute Details
| Field | Reference Entity | Field Description | Format | Max Bytes |
|---|---|---|---|---|
| Event | Event | Event ID for the event the GPC relates to. | uniqueidentifier | 16 |
| Name | User defined name for the general price change. | nvarchar | 200 | |
| Type | Type ID for the type of the GPC. | varchar | 20 | |
| Status | Status ID for the status of the GPC. | tinyint | 1 | |
| ProcessImmediately | If set the GPC will process straight away, if not set the GPC will not process until the process start time is reached. | bit | 1 | |
| ProcessMinutes | Number of minutes before GPC start time that the GPC should be processed. | int | 4 | |
| Review | If set the GPC prices will be held for review before being exported. | bit | 1 | |
| ReviewEmailRecipients | List of email recipients who will be notified of GPC prices in review. | nvarchar | 1000 | |
| EmailSent | Flag to show when emails have been sent. | bit | 1 | |
| AutoImplementMode | Specifies the auto-implement mode for the GPC. | bit | 1 | |
| ExportTime | Optional specified export time. | datetime | 8 | |
| ProcessStartTime | The date and time the GPC processing started. | datetime | 8 | |
| ProcessEndTime | The date and time the GPC processing completed. | datetime | 8 | |
| ExportStartTime | The date and time the GPC price export started. | datetime | 8 | |
| ExportEndTime | The date and time the GPC price export completed. | datetime | 8 | |
| GPCByMonth | Used to group GPC's by their start month in the entity navigator. | char | 7 | |
| User | User | PriceNet ID of user that created the GPC. | uniqueidentifier | 16 |
| HoldPrices | A flag to indicate if GPC prices are held from processing, from export or from start time (see Market Pricing, Set Actual Price GPC, Hold Prices). | tinyint | 1 | |
| ValidatePrices | Flag to indicate whether the maximum GPC price increase / decrease should be validated. | bit | 1 | |
| BypassLimitSurveyAge | Flag to indicate whether the system should ignore the Maximum Price Surve Age After General Price Change setting. | bit | 1 |
Master Price Request
| Name | Description |
|---|---|
| Entity Description | Attributes of the core General Price Change entity |
| Source Schema | dbo |
| Source Table | PNMasterPriceRequest |
| Destination Collection(Endpoint) | PriceRequest |
| Entity Type | MasterPriceRequest |
| Entity Variant | Common |
Master Price Request Attribute Details
| Field | Reference Entity | Field Description | Format | Max Bytes |
|---|---|---|---|---|
| OwnSite | OwnSite | PriceNet ID of the own site that the request was import for. | uniqueidentifier | 16 |
| PriceRequestType | PriceRequestType | This is the type of price request imported and must be one of the values in PNPriceRequestType where CanImport = true. | varchar | 5 |
| Source | This is the Source of the price request provided by the client. | source | 40 | |
| ValidateSeconds | This is the number of validation seconds that are imported as part of the price request. | int | 4 | |
| ProcessSeconds | This is the number of process seconds that are imported as part of the price request. | int | 4 | |
| ExportTime | This is the export time data that is imported as part of the price request. | datetime | 8 | |
| HasErrors | This flag shows if any of the records have errors in the error browser. The flag is reset by post import processing if the value is resubmitted or deleted. | bit | 1 | |
| SplitDate | This is the date/time that the price request was split into product group price requests. | datetime | 8 | |
| Processed | The column will identify if the price request has been processed by splitting, because the SplitDate will still be null if the price request doesn't split. | bit | 1 |
Price Request
| Name | Description |
|---|---|
| Entity Description | Attributes of the core Price Request entity |
| Source Schema | dbo |
| Source Table | PNPriceRequest |
| Destination Collection(Endpoint) | PriceRequest |
| Entity Type | PriceRequest |
| Entity Variant | Common |
Price Request Attribute Details
| Field | Reference Entity | Field Description | Format | Max Bytes |
|---|---|---|---|---|
| PriceRequestSeqID | Unique ID representing the price request (automatically generated integer number) - this number can be exported to identify a set of proposed prices and it could be returned in an import file to validate whether or not the price(s) have been approved. | int | 4 | |
| ScheduleTime | Date and time the price request is due to process. This is normally set to the creation time of the price request, but can hold the processing of the price request until a later time. | datetime | 8 | |
| OwnProductGroup | ProductGroup | ID of the Own Product Group that the price request was created for. | uniqueidentifier | 16 |
| Event | Event | ID of the event that spawned the price request. | uniqueidentifier | 16 |
| Processed | Indicates when the price request has been processed through price generation. | bit | 1 | |
| OnHold | Indicates an error state during price generation. If this is set it means that price generation could not process the price request at all. | bit | 1 | |
| PriceRequestType | PriceRequestType | ID of the price request type. | varchar | 5 |
| User | ID of the user who dealt with the price request in SFR. | uniqueidentifier | 16 | |
| AutoImplement | Flag that allows single requests to be auto implemented (1 - auto implement, 0 - do not auto implement). | bit | 1 | |
| PreProcessed | Indicates that the price request has completed the pre-processing stage and is now eligible for price generation. | bit | 1 | |
| Cancelled | Indicates that the price request has been cancelled and has no further effect on pricing. | bit | 1 | |
| CancelledTime | Time of cancellation. | datetime | 8 | |
| PRCancelledStatusID | Three letter code (DTM, EVT, GEN, GPC, LOW, NOM) or NULL. | varchar | 3 | |
| GPCReview | Used when a price request must go to GPC review as a result of user action (save of GPC details when in GPC review), rather than being exported. | bit | 1 | |
| PriceRequestValidationStatusID | Price request validation status. | tinyint | 1 | |
| InvalidCategory | This is a strategy value set by price request validation. | bit | 1 | |
| CheckedForLF | Flag to determine whether the price request has been checked for lead follow relations. | bit | 1 | |
| SFRTxID | Translation ID of a fixed message that will be used to send PR to SFR, required for LF processing which determines that PRs need to go to SFR before they are priced. | int | 4 | |
| StrategyNoteUID | StrategyNote | PriceNet ID representing the note that the price request will ultimately produce. Used for PD Type price requests. | uniqueidentifier | 16 |
| Initialised | This is the date and time that the price request has been processed through the strategy initialisation function. | datetime | 8 |
Price Request Review
| Name | Description |
|---|---|
| Entity Description | Attributes of the core Price Request Review entity |
| Source Schema | dbo |
| Source Table | PNPriceRequestReview |
| Destination Collection(Endpoint) | PriceRequest |
| Entity Type | PriceRequestReview |
| Entity Variant | Common |
Price Request Review Attribute Details
| Field | Reference Entity | Field Description | Format | Max Bytes |
|---|---|---|---|---|
| PriceRequestUID | PriceRequest | Unique ID representing the price request review record. | uniqueidentifier | 16 |
| StartTime | Date and time the price request was put into review. | datetime | 8 | |
| EndTime | Date and time the price request exited from review. | datetime | 8 |
Price Request Type
| Name | Description |
|---|---|
| Entity Description | Attributes of the core Price Request Review entity |
| Source Schema | dbo |
| Source Table | PNPriceRequestType |
| Destination Collection(Endpoint) | PriceRequest |
| Entity Type | PriceRequestType |
| Entity Variant | Common |
Price Request Type Attribute Details
| Field | Reference Entity | Field Description | Format | Max Bytes |
|---|---|---|---|---|
| PriceRequestTypeID | Unique ID representing the price request type. | varchar | 5 | |
| TxID | Translation ID to display a user friendly description of the price request type. | int | 4 | |
| Description | Internal description of the price request type. | varchar | 100 | |
| System | Indicates that this type of price request cannot be chosen by the user as the basis of custom pricing (i.e. Event Profiles). | bit | 1 | |
| Precedence | Defines the priority of processing for price request types. The lower the precedence, the higher the priority. This allows the system to chose which price request to process where more than one exists for the same product group. | tinyint | 1 | |
| PricingProfileTypeID | PriceNet ID of a pricing profile type that the price request type will generate prices by. | varchar | 3 | |
| CanImport | This flag determines if the Price Request is a valid Type that can be imported via the price request import channel. | bit | 1 | |
| CanSplit | This flag determines if the Price Request is a valid Type that can be split after the price request has imported. | bit | 1 | |
| CanValidate | This is a flag to identify if the price request type is checked by price request validation. | bit | 1 | |
| CanWriteToFile | Flag to identify whether the price request type can be exported to file. By default, the answer is "1", meaning it can be exported. | bit | 1 | |
| Rating | This defines how important a price request type is in relation to other price request types as far as "battling" is concerned, the higher the number the higher the priority. | int | 4 |
Price Request State
| Name | Description |
|---|---|
| Entity Description | Attributes of the core Price Request State entity |
| Source Schema | dbo |
| Source Table | PNPriceRequestState |
| Destination Collection(Endpoint) | PriceRequest |
| Entity Type | PriceRequestState |
| Entity Variant | Common |
Price Request State Attribute Details
| Field | Reference Entity | Field Description | Format | Max Bytes |
|---|---|---|---|---|
| PriceRequest | PriceRequest | The ID of the Price Requests that have exported. | int | 4 |
| PriceRequestID | legacy identifier | uniqueidentifier | 16 | |
| PRSStatusID | PriceNet ID representing the status of the PriceRequest. | tinyint | 1 | |
| State | The state identifying if the prices have been acknowledged (OK is acknowledged). | nvarchar | 50 | |
| Notes | Notes that can be set against the price request review item. | nvarchar | 2000 | |
| ExportTime | This is the date that the prices were re-exported. | datetime | 8 | |
| ReadyToExport | If the user closes the prices on the pricing page, this flag determines that the prices are ready to export again. | bit | 1 | |
| Exported | This flag determines if the prices have been exported following a receipt failure. | bit | 1 | |
| Rejected | If the user rejects the prices on the pricing page, this flag determines that the prices are closed. | bit | 1 | |
| ApplyUser | ID of the user that closed/rejected the prices on the pricing page. | niqueidnetifier | 16 | |
| ApplyTime | This is the date/time that the user that closed/rejected the prices on the pricing page. | datetime | 8 | |
| Processed | This flag determines if the imported record has been processed. | bit | 1 |
Proposed Price Audit
| Name | Description |
|---|---|
| Entity Description | Attributes of the core General Price Change entity |
| Source Schema | dbo |
| Source Table | PNProposedPriceAudot |
| Destination Collection(Endpoint) | PriceRequest |
| Entity Type | ProposedPriceAudit |
| Entity Variant | Common |
Proposed Price Audit Attribute Details
| Field | Reference Entity | Field Description | Format | Max Bytes |
|---|---|---|---|---|
| ProposedPrice | Price | Unique identifier for the Proposed Price associated to this record | uniqueidentifier | 16 |
| AuditData | XML Data with PriceRequest Audit Details | XML | N/A | |
| BinaryData | Binary Code associateds to Proposed Price Audit record | varbinary | (max)null | |
| ManualPrice | True or False Flag for Manual price | bit | 1 |
Proposed Price State
| Name | Description |
|---|---|
| Entity Description | Attributes of the core Proposed Price State entity |
| Source Schema | dbo |
| Source Table | PNProposedPriceState |
| Destination Collection(Endpoint) | PriceRequest |
| Entity Type | ProposedPriceState |
| Entity Variant | Common |
Proposed Price State Attribute Details
| Field | Reference Entity | Field Description | Format | Max Bytes |
|---|---|---|---|---|
| ProposedPrice | ProposedPrice | PriceNet ID of the proposed price the state relates to. | uniqueidentifier | 16 |
| ActionID | Action Code, valid values are: EXPACC (Export accept), EXPREJ (Export Reject), SFRAPP (Sites for review approved) and SFRJEJ (Sites for review reject). | char | 6 | |
| Price | The price supplied for approval. | money | 8 | |
| PreviousPrice | The value of the proposed price prior to the approval action. | money | 8 | |
| Source | The source of the price approval. | nvarchar | 50 | |
| Notes | Time the record was created/last updated. | nvarchar | 2000 | |
| Processed | Flag to determine if the record has been processed by the post import processing step. | bit | 1 |
Restoration
| Name | Description |
|---|---|
| Entity Description | Restoration reference data entity |
| Source Schema | dbo |
| Source Table | PNRestoration |
| Destination Collection(Endpoint) | PriceRequest |
| Entity Type | Restoration |
| Entity Variant | Common |
Restoration Attributes
| Field | Reference Entity | Field Description | Format | Max Bytes |
|---|---|---|---|---|
| actualEndTime | Actual end time of restoration | datetime | 8 | |
| inRestoration | True/False flag to idneifty if an Own Site is in Restoration | bit | 1 | |
| OwnProductGroup | Unique identifier for the product group associated to this restoration record | uniqueidentifer | 16 | |
| postRestorationHandled | True or False flag indicationg if Post Restoration handling was performed | bit | 1 | |
| scheduledEndTime | scheduled/expected End Time of restoration | datetime | 8 | |
| wasGPC | True/False flag if Restoration instance was created as a result of a GPC | bit | 1 |
Restoration Competitor
| Name | Description |
|---|---|
| Entity Description | Restoration competitor reference data entity |
| Source Schema | dbo |
| Source Table | PNRestorationcompetitor |
| Destination Collection(Endpoint) | PriceRequest |
| Entity Type | Restorationcompetitor |
| Entity Variant | Common |
Restoration Competitor Attributes
| Field | Reference Entity | Field Description | Format | Max Bytes |
|---|---|---|---|---|
| ownProductgroup | Unique identifier for the ownProductgroup associated to the record | uniqueidentifier | 16 | |
| ownSitecompetitor | Unique identifier for the ownSitecompetitor associated to the record | uniqueidentifier | 16 | |
| triggerIncrease | Trigger value for triggering restoration | money | 8 | |
| delta | Delta value for restoration | money | 8 | |
| dropTosfr | True/False flag for action to take when price drops | bit | 1 | |
| isTrigger | True/False flag to denote if a competitor is a restoration trigger | bit | 1 |
Strategy Note
| Name | Description |
|---|---|
| Entity Description | Attributes of the core Strategy Note entity |
| Source Schema | dbo |
| Source Table | PNStrategyNote |
| Destination Collection(Endpoint) | PriceRequest |
| Entity Type | StrategyNote |
| Entity Variant | Common |
Strategy Note Attribute Details
| Field | Reference Entity | Field Description | Format | Max Byte |
|---|---|---|---|---|
| Content | The actual note related to a strategy | nvarchar | (max)1-4000 |