22 Retail Price
The Retail Price module is an application available in Supply Chain Hub. This chapter describes the implementation considerations and the operation details.
Implementation Overview
Retail Price provides the ability for retailer and supplier users to create, maintain and publish Price Events to RPCS.
Supported Price Event types are Price Changes and Simple Promotions.
Status Workflow
Figure 22-1 Retail Price Status Workflow
Retail Price follows a workflow path for Price Events, and the status can change depending on:
- The user permissions.
- The status of the Price Event.
- The type of the Price Event.
Price Event Status:
- New (N) – The initial status of a Price Event. While in this status, the Price Event can be moved to either Approved or Rejected status, by performing the appropriate actions. Submitting a New Price Event will automatically approve it if the user has approval permission (the Price Event must not have substantial changes if the user is a supplier).
- Approved (A) – Price Event has been approved and is awaiting publishing. While in this status the Price Event can move on to three other status: Rejected if the user rejects it, Changes Proposed if the Price Event is edited or Processing if the Price Event has been picked up by the publish process (triggered either by a batch or automatically if it’s an emergency Price Event).
- Rejected (R) – Price Event has been rejected and will no longer be published. While in this status the Price Event can be edited, and upon submission will move it back to New status.
- Changes Proposed (P) – Approved Price Event has been edited and is awaiting approval. While in this status the Price Event can move on to Approved status if the changes have been approved or rejected, the difference between these two actions is that approving will keep the changes proposed while reject will discard them. If the user editing the Approved Price Event has approval permission, the changes proposed will be automatically approved so this status may not be visible (the Price Event must not have substantial changes if the user is a supplier).
- Extracted (EX) – Price Event has been published and is available in RPCS. The final status for a Price Change. A Simple Promotion in this status can either be Cancelled by users with approval permission – which will move it to a Processing status (as the cancelation also needs to be published) – or become Active – which occurs automatically when the current date is between the Simple Promotion’s start and end dates.
- Active (AC) – Virtual status (not reflected within the database tables) for an Extracted Simple Promotion whose start and end dates includes the current date. Active Simple Promotions can still be cancelled by users with approval permission.
- Cancelled (X) – Simple Promotion that has been Cancelled and the cancellation has already been published to RPCS. No actions can be performed on a Cancelled Simple Promotion.
- Error (E) – Price Event was picked up by the publish process but was not able to be correctly integrated within RPCS due to errors. No actions can be performed on these Price Events, they must be analyzed and manually recovered by the support team.
- Processing (PR) – Price Event has been picked up by the publish process and is awaiting integration into RPCS. No actions can be taken while the Price Event is in this status. Also used as a virtual status for Price Events which are undergoing custom validations asynchronously and cannot not be edited by the user.
- Completed (CP) – Virtual status (not reflected within the database tables) for an Extracted Simple Promotion whose end date surpass the current date. No actions can be performed on a Completed Simple Promotion
Configuration
This section describes Retail Price configurations.
POM Configuration
Batch scheduler details with all batches, dependencies and frequencies can be downloaded following the steps in the Supply Chain Hub Frameworks section.
Figure 22-3 Retail Price Batch Schedule Overview
Promotion and Offer Aggregator
Retail Price can have the group of promotions to be generated with dynamic rules by using the Aggregator Framework documented in the Supply Chain Hub Frameworks section.
Promotion Aggregator
Configured with AGG_NAME “SPPM_PRM_OF” it generates a Dynamic ID to aggregate Price Events as RPCS Offers in the same Promotion ID based on below default configurations. In case ACTIVE_IND is set no ‘N’ it will be set as “'SPPM_SUPPLIER' + '_' + SUPPLIER + '_' + START_DATE + '_' + EXCLUSIVE_DISCOUNT_IND”
| Parameter | Value |
|---|---|
| APP_ALIAS | SPPM |
| AGG_NAME | SPPM_PRM |
| ENTITY_TABLE | ORCV_V_SPPM_PRM_AGG |
| ENTITY_KEY_1 | PRICE_EVENT_ID |
| ENTITY_KEY_2 | NA |
| ENTITY_KEY_3 | NA |
| ENTITY_KEY_4 | NA |
| ENTITY_KEY_5 | NA |
| AGG_DELIMITER | _ |
| AGG_FIELD_1 | 'SPPM_SUPPLIER' |
| AGG_FIELD_2 | SUPPLIER |
| AGG_FIELD_3 | START_DATE |
| AGG_FIELD_4 | EXCLUSIVE_DISCOUNT_IND |
| AGG_FIELD_5 | NA |
| ACTIVE_IND | N |
Offer Aggregator
Configured with AGG_NAME “SPPM_PRM_OF” it generates a Dynamic ID to aggregate Price Events as RPCS Offers in the same Offer ID based on below default configurations. In case ACTIVE_IND is set no ‘N’ it will be set as “PRICE_EVENT_ID + '_' + CHANGE_VALUE”
| Parameter | Value |
|---|---|
| APP_ALIAS | SPPM |
| AGG_NAME | SPPM_PRM_OF |
| ENTITY_TABLE | ORCV_SPPM_PCEVT_ITEM |
| ENTITY_KEY_1 | PRICE_EVENT_ID |
| ENTITY_KEY_2 | ITEM |
| ENTITY_KEY_3 | CHANGE_VALUE |
| ENTITY_KEY_4 | NA |
| ENTITY_KEY_5 | NA |
| AGG_DELIMITER | _ |
| AGG_FIELD_1 | PRICE_EVENT_ID |
| AGG_FIELD_2 | CHANGE_VALUE |
| AGG_FIELD_3 | NA |
| AGG_FIELD_4 | NA |
| AGG_FIELD_5 | NA |
| ACTIVE_IND | N |
Other Cloud Services Configuration
This section describes implementation details that must be reviewed from an Oracle Retail Merchandising System perspective.
Other Implementation Considerations
This section describes Retail Price implementation considerations.
Notifications and Alerts
The module uses the Events Framework to inform users about events occurred by generating notifications and alerts. Below is the list of Notifications and Alerts available. The notifications are implemented via the Rule Engine Framework documented in the Supply Chain Hub Frameworks section.
Notifications
ORCV_SPPM_EVENT_PEND_APPR_PRC
Price Event %s1 pending approval.
| Property | Value |
|---|---|
| Event Name | SPPM_EVENT_PEND_APPR_PRC |
| Event Type | ORCV_SPPM_EVENT_PEND_APPR_PRC |
| Description | New Price Change submitted/updated by Supplier |
| Trigger | UI/S9T |
| Target Users | Retailer users that are assigned as the retailer contact of the supplier and have access to the Price Change in question. |
ORCV_SPPM_EVENT_PEND_APPR_SPROMO
Price Event %s1 pending approval.
| Property | Value |
|---|---|
| Event Name | SPPM_EVENT_PEND_APPR_SPROMO |
| Event Type | ORCV_SPPM_EVENT_PEND_APPR_SPROMO |
| Description | New Simple Promotion submitted/updated by Supplier. |
| Trigger | UI/S9T |
| Target Users | Retailer users that are assigned as the retailer contact of the supplier and have access to the Simple Promotion in question. |
Alerts
ORCV_SPPM_EVENT_PCEVTS_PENDING
Price Events pending approval.
| Property | Value |
|---|---|
| Event Name | SPPM_EVENT_PCEVTS_PENDING_ACTION |
| Event Type | ORCV_SPPM_EVENT_PCEVTS_PENDING |
| Alert Type | |
| Description | Price Events with pending approval actions from retailer. |
| Trigger | Batch |
| Target Users | Retailer users that are assigned as the retailer contact of the supplier and have access to the Price Event in question. |
ORCV_SPPM_EVENT_EMERGENCY_PCEVTS_PENDING
Emergency Price Events with actions pending.
| Property | Value |
|---|---|
| Event Name | SPPM_EVENT_EMERGENCY_PCEVTS_PENDING |
| Event Type | ORCV_SPPM_EVENT_EMERGENCY_PCEVTS_PENDING |
| Alert Type | |
| Description | Emergency Price Events with pending approval actions for retailer |
| Trigger | UI/S9T |
| Target Users | Retailer users that are assigned as the retailer contact of the supplier and have access to the Price Event in question. |
Custom Validations
The module performs validations by implementing Custom Validation Groups of the Custom Validations Framework described in the Supply Chain Hub Frameworks section. The groups are listed below.
SPPM_PRC_SUBMIT
Triggered when the Price Change is Submitted.
All validation functions for this Custom Validation Group are available in ORCV_SPPM_CVAL_PCEVT package.
| FUNCTION | VALIDATION | SEQ NO |
|---|---|---|
| VALIDATE_SUPPLIER | Validate if supplier is valid and user has access to it. | 1 |
| VALIDATE_DESCRITPION | Validate if the description is valid. | 2 |
| VALIDATE_PCEVT_TYPE | Validate if the price event type is valid. | 3 |
| VALIDATE_REASON_CODE | Validate if the reason code is valid. | 4 |
| VALIDATE_LOCATION_LEVEL | Validate if the location level is valid. | 5 |
| VALIDATE_STATUS | Validate if the status is valid as per the action to execute. | 6 |
| VALIDATE_CHANGE_TYPE | Validate if the change type is valid as per the price event type. | 7 |
| VALIDATE_CHANGE_VALUE | Validate if the change value is valid. | 8 |
| VALIDATE_EXCLUSIVE_DISCOUNT | Validate if the exclusive discount indicator is valid as per the price event type. | 9 |
| VALIDATE_START_DATE | Validate if the start date is valid as per the supplier’s configurations. | 10 |
| VALIDATE_END_DATE | Validate if the end date is valid as per the price event type. | 11 |
| VALIDATE_ITEM | Validate if the items are valid for that price event and the user has access to them. | 12 |
| VALIDATE_LOCATION | Validate if the locations are valid for that price event according to the currency/location level and if the user has access to them. | 13 |
| VALIDATE_CHG_PROPOSAL_OVERLAP | Validates if the price event has any overlaps with other price events in changes proposed status. | 14 |
| VALIDATE_PCEVTS_OVERLAP | Validates if the price event has any overlaps with other approved price events or those in RPCS. | 15 |
| VALIDATE_CURRENCY | Validate if the currency is valid. | 16 |
SPPM_PRC_APPROVE
Triggered when the Price Change is Approved.
All validation functions for this Custom Validation Group are available in ORCV_SPPM_CVAL_PCEVT package.
| FUNCTION | VALIDATION | SEQ NO |
|---|---|---|
| VALIDATE_STATUS | Validate if the status is valid as per the action to execute. | 1 |
| VALIDATE_START_DATE | Validate if the start date is valid as per the supplier’s configurations. | 2 |
| VALIDATE_CHG_PROPOSAL_OVERLAP | Validates if the price event has any overlaps with other price events in changes proposed status. | 3 |
| VALIDATE_PCEVTS_OVERLAP | Validates if the price event has any overlaps with other approved price events or those in RPCS. | 4 |
SPPM_PRC_REJECT
Triggered when the Price Change is Rejected.
All validation functions for this Custom Validation Group are available in ORCV_SPPM_CVAL_PCEVT package.
| FUNCTION | VALIDATION | SEQ NO |
|---|---|---|
| VALIDATE_STATUS | Validate if the status is valid as per the action to execute. | 1 |
| VALIDATE_START_DATE | Validate if the start date is valid as per the supplier’s configurations. | 2 |
SPPM_PRC_CHANGE_PROPOSAL
Triggered when the approved Price Change is Updated.
All validation functions for this Custom Validation Group are available in ORCV_SPPM_CVAL_PCEVT package.
| FUNCTION | VALIDATION | SEQ NO |
|---|---|---|
| VALIDATE_STATUS | Validate if the status is valid as per the action to execute. | 1 |
| VALIDATE_START_DATE | Validate if the start date is valid as per the supplier’s configurations. | 2 |
SPPM_PRC_PUBLISH
Triggered when the Price Change is Published.
All validation functions for this Custom Validation Group are available in ORCV_SPPM_CVAL_PCEVT package.
| FUNCTION | VALIDATION | SEQ NO |
|---|---|---|
| VALIDATE_CHANGE_VALUE | Validate if the change value is valid. | 1 |
| VALIDATE_CHG_PROPOSAL_OVERLAP | Validates if the price event has any overlaps with other price events in changes proposed status. | 2 |
| VALIDATE_PCEVTS_OVERLAP | Validates if the price event has any overlaps with other approved price events or those in RPCS. | 3 |
SPPM_PRC_EDIT
Triggered when the Price Change is Edited.
All validation functions for this Custom Validation Group are available in ORCV_SPPM_CVAL_PCEVT package.
| FUNCTION | VALIDATION | SEQ NO |
|---|---|---|
| VALIDATE_STATUS | Validate if the status is valid as per the action to execute. | 1 |
| VALIDATE_START_DATE | Validate if the start date is valid as per the supplier’s configurations. | 2 |
SPPM_PRC_SUB_CHANGES
Triggered when the Price Change is Submitted.
All validation functions for this Custom Validation Group are available in ORCV_SPPM_CVAL_PCEVT package.
| FUNCTION | VALIDATION | SEQ NO |
|---|---|---|
| VALIDATE_SUB_CHANGES_IND | Validate if the price event has substantial changes at header level. | 1 |
SPPM_SPROMO_SUBMIT
Triggered when the Simple Promotion is Submitted.
All validation functions for this Custom Validation Group are available in ORCV_SPPM_CVAL_PCEVT package.
| FUNCTION | VALIDATION | SEQ NO |
|---|---|---|
| VALIDATE_SUPPLIER | Validate if supplier is valid and user has access to it. | 1 |
| VALIDATE_DESCRITPION | Validate if the description is valid. | 2 |
| VALIDATE_PCEVT_TYPE | Validate if the price event type is valid. | 3 |
| VALIDATE_REASON_CODE | Validate if the reason code is valid. | 4 |
| VALIDATE_LOCATION_LEVEL | Validate if the location level is valid. | 5 |
| VALIDATE_STATUS | Validate if the status is valid as per the action to execute. | 6 |
| VALIDATE_CHANGE_TYPE | Validate if the change type is valid as per the price event type. | 7 |
| VALIDATE_CHANGE_VALUE | Validate if the change value is valid. | 8 |
| VALIDATE_EXCLUSIVE_DISCOUNT | Validate if the exclusive discount indicator is valid as per the price event type. | 9 |
| VALIDATE_START_DATE | Validate if the start date is valid as per the supplier’s configurations. | 10 |
| VALIDATE_END_DATE | Validate if the end date is valid as per the price event type. | 11 |
| VALIDATE_ITEM | Validate if the items are valid for that price event and the user has access to them. | 12 |
| VALIDATE_LOCATION | Validate if the locations are valid for that price event according to the currency/location level and if the user has access to them. | 13 |
| VALIDATE_CHG_PROPOSAL_OVERLAP | Validates if the price event has any overlaps with other price events in changes proposed status. | 14 |
| VALIDATE_PCEVTS_OVERLAP | Validates if the price event has any overlaps with other approved price events or those in RPCS. | 15 |
| VALIDATE_CURRENCY | Validate if the currency is valid. | 16 |
SPPM_SPROMO_APPROVE
Triggered when the Simple Promotion is Approved.
All validation functions for this Custom Validation Group are available in ORCV_SPPM_CVAL_PCEVT package.
| FUNCTION | VALIDATION | SEQ NO |
|---|---|---|
| VALIDATE_STATUS | Validate if the status is valid as per the action to execute. | 1 |
| VALIDATE_START_DATE | Validate if the start date is valid as per the supplier’s configurations. | 2 |
| VALIDATE_CHG_PROPOSAL_OVERLAP | Validates if the price event has any overlaps with other price events in changes proposed status. | 3 |
| VALIDATE_PCEVTS_OVERLAP | Validates if the price event has any overlaps with other approved price events or those in RPCS. | 4 |
SPPM_SPROMO_REJECT
Triggered when the Simple Promotion is Rejected.
All validation functions for this Custom Validation Group are available in ORCV_SPPM_CVAL_PCEVT package.
| FUNCTION | VALIDATION | SEQ NO |
|---|---|---|
| VALIDATE_STATUS | Validate if the status is valid as per the action to execute. | 1 |
| VALIDATE_START_DATE | Validate if the start date is valid as per the supplier’s configurations. | 2 |
SPPM_SPROMO_CANCEL
Triggered when the Simple Promotion is Cancelled.
All validation functions for this Custom Validation Group are available in ORCV_SPPM_CVAL_PCEVT package.
| FUNCTION | VALIDATION | SEQ NO |
|---|---|---|
| VALIDATE_STATUS | Validate if the status is valid as per the action to execute. | 1 |
| VALIDATE_CANCEL_END_DATE | Validate if the end date is valid as per system’s batch date. | 2 |
| VALIDATE_CANCEL_EVENT_TYPE | Validate if the price event type is valid for cancellation. | 3 |
SPPM_SPROMO_CHANGE_PROPOSAL
Triggered when the approved Simple promotion is Updated.
All validation functions for this Custom Validation Group are available in ORCV_SPPM_CVAL_PCEVT package.
| FUNCTION | VALIDATION | SEQ NO |
|---|---|---|
| VALIDATE_STATUS | Validate if the status is valid as per the action to execute. | 1 |
| VALIDATE_START_DATE | Validate if the start date is valid as per the supplier’s configurations. | 2 |
SPPM_SPROMO_PUBLISH
Triggered when the Simple Promotion is Published.
All validation functions for this Custom Validation Group are available in ORCV_SPPM_CVAL_PCEVT package.
| FUNCTION | VALIDATION | SEQ NO |
|---|---|---|
| VALIDATE_CHANGE_VALUE | Validate if the change value is valid. | 1 |
| VALIDATE_CHG_PROPOSAL_OVERLAP | Validates if the price event has any overlaps with other price events in changes proposed status. | 2 |
| VALIDATE_PCEVTS_OVERLAP | Validates if the price event has any overlaps with other approved price events or those in RPCS. | 3 |
SPPM_SPROMO_EDIT
Triggered when the Simple Promotion is Edited.
All validation functions for this Custom Validation Group are available in ORCV_SPPM_CVAL_PCEVT package.
| FUNCTION | VALIDATION | SEQ NO |
|---|---|---|
| VALIDATE_STATUS | Validate if the status is valid as per the action to execute. | 1 |
| VALIDATE_START_DATE | Validate if the start date is valid as per the supplier’s configurations. | 2 |
SPPM_SPROMO_SUB_CHANGES
Triggered when the Simple Promotion is Submitted.
All validation functions for this Custom Validation Group are available in ORCV_SPPM_CVAL_PCEVT package.
| FUNCTION | VALIDATION | SEQ NO |
|---|---|---|
| VALIDATE_SUB_CHANGES_IND | Validate if the price event has substantial changes at header level. | 1 |
Specific Batch Configuration
This section describes Retail Price batch configurations.
Publish Price Event Batch
Publish Price Event Batch publishes Price Events in Processing status to Integration API when the start date is greater than the VDATE - PRICE_PRIOR_DEADLINE_DAYS.
- Job: ORCV_SPPM_PUB_PCEVT_JOB
- Frequency: Ad-hoc
- Dependency: None
- Inter Scheduler Dependency: None
Batch default configuration (ORCV_BATCH_CONFIG):
| COLUMN NAME | DEFAULT VALUES |
|---|---|
| PROGRAM_NAME | ORCV_SPPM_PUB_PCEVT_JOB |
| MAX_CHUNK_SIZE | 1000 |
| MAX_CONCURRENT_THREADS | 4 |
| RETRY_LOCK_ATTEMPTS | 3 |
| RETRY_WAIT_TIME | 3 |
| RETRY_MAX_ATTEMPTS_COUNT | 3 |
| RETRY_ORDERED | N |
| RETRY_IND | N |
Update Price Event Status Batch
Update Price Event Status Batch cross-references Price Events in Processing status with the integration tables and updates the Price Events’ status depending on if they were updated successfully or not.
If there were any errors during the integration the batch will also insert the error records into the error tables used by Retail Price.
- Job: ORCV_SPPM_PCEVT_UPD_ST_JOB
- Frequency: Ad-hoc
- Dependency: None
- Inter Scheduler Dependency: None
Batch default configuration (ORCV_BATCH_CONFIG):
| COLUMN NAME | DEFAULT VALUES |
|---|---|
| PROGRAM_NAME | ORCV_SPPM_PCEVT_UPD_ST_JOB |
| MAX_CHUNK_SIZE | 1000 |
| MAX_CONCURRENT_THREADS | 4 |
| RETRY_LOCK_ATTEMPTS | 3 |
| RETRY_WAIT_TIME | 3 |
| RETRY_MAX_ATTEMPTS_COUNT | 3 |
| RETRY_ORDERED | N |
| RETRY_IND | N |
Price Event Emergency Alert Batch
Price Event Emergency Alert Batch generates alert emails for price events which are in New status but should now be picked up by the publish batch as their start date is greater than the VDATE - PRICE_PRIOR_DEADLINE_DAYS.
The emails will then be sent to the retailer contacts of the price event’s suppliers.
- Job: ORCV_RLEG_SPPM_PCEVT_EVT_PND
- Frequency: Ad-hoc
- Dependency: None
- Inter Scheduler Dependency: None
This batch uses the Rule Engine Framework described in the Supply Chain Hub Frameworks section with the following configurations.
Rule default configuration (ORCV_RLEG_RULE):
| RULE KEY | RULE NAME | PROGRAM_NAME | APP ALIAS | RULE MODE |
|---|---|---|---|---|
| SPPM_PCEVT_EVT_PND | ORCV_RLEG_SPPM_EVENT_PCEVT_JOB | ORCV_RLEG_SPPM_EVENT_PCEVT_JOB | SPPM | BATCH |
Batch default configuration (ORCV_BATCH_CONFIG):
| COLUMN NAME | DEFAULT VALUES |
|---|---|
| PROGRAM_NAME | ORCV_RLEG_SPPM_PCEVT_EVT_PND |
| MAX_CHUNK_SIZE | 1000 |
| MAX_CONCURRENT_THREADS | 4 |
| RETRY_LOCK_ATTEMPTS | 3 |
| RETRY_WAIT_TIME | 3 |
| RETRY_MAX_ATTEMPTS_COUNT | 3 |
| RETRY_ORDERED | N |
| RETRY_IND | N |
Codes
Certain operations require codes to define the options available at system level. Below you can find the list of code types available.
The codes are defined in the ORCV_CODE_HEAD and ORCV_CODE_DETAIL tables.
| CODE TYPE | CODE TYPE DESCRIPTION |
|---|---|
| PCCT | Price Change - Change Type |
| PEPR | Price Event - Promotion Reason Codes |
| PERR | Price Event - Action Reason Codes |
| PMAI | Price Event - Add Items by |
| PMCT | Promotion - Change Type |
| PMEL | Price Event - Error Level |
| PMES | Price Event - Event Status |
| PMET | Price Event - Event Type |
| PMIT | Price Event - Search by |
| PMLL | Price Event - Location Level |
| PMLT | Price Event - Location Type |
| PMPC | Price Event - Price Control |
Templates
Retail Price uses a spreadsheet download and upload process, developed as part of the Retail Supply Chain Frameworks, for creation, maintenance, and extraction of data. To support these processes there are some templates which must be configured, and several configurations should be reviewed as part of the implementation.
Template Price Events
Template key: SPPM_PCEVT_DATA
The required permissions per action for this template are the following:
Table 22-1 Template Key: SPPM_PCEVT_DATA
| ACTION TYPE | ROLE NAME |
|---|---|
| Download Blank | ORCV_SPPM_APP_JOB |
| Download | ORCV_SPPM_PRC_APPR_JOB |
| Download | ORCV_SPPM_PRC_EDIT_JOB |
| Download | ORCV_SPPM_PRC_VIEW_JOB |
| Upload | ORCV_SPPM_PRC_APPR_JOB |
| Upload | ORCV_SPPM_PRC_EDIT_JOB |
| Download | ORCV_SPPM_SPROMO_APPR_JOB |
| Download | ORCV_SPPM_SPROMO_EDIT_JOB |
| Download | ORCV_SPPM_SPROMO_VIEW_JOB |
| Upload | ORCV_SPPM_SPROMO_APPR_JOB |
| Upload | ORCV_SPPM_SPROMO_EDIT_JOB |
Table 22-2 Worksheet Price Event Header
| ACTION | MANDATORY CELLS / FIELDS | NOTES |
|---|---|---|
| Create | Price Event ID, Price Event Description, Price Event Type, Supplier, Start Date, Currency, Reason Code, Location Level, Change Type |
Creates a new Price Event in New status, can also directly be Approved if the user has the necessary permissions and – if a supplier user – the Price Event has no substantial changes. Depending on the Price Event Type and configuration, certain other fields might also be mandatory, such as End Date and Exclusive Discount. |
| Update | Price Event ID |
Updates an existing Price Event. Only New, Approved, Rejected and Changes Proposed Price Events can be updated. If Approved the Price Event will move to Changes Proposed status (can be directly Approved if the user has the necessary permissions and – if a supplier user – no substantial changes were added). If Rejected the Price Event will move to New status (same auto-approval rules apply). If New or Changes Proposed status the Price Event will maintain the same status (again, can be auto-approved following the rules above). |
| Approve | Price Event ID | Approves the Price Event. Only New and Changes Proposed Price Events can be Approved. In both cases the Price Event will move on to Approved status. |
| Reject | Price Event ID |
Rejects the Price Event. Only New and Changes Proposed Price Events can be Rejected. If New the Price Event will move on to Rejected status. If Changes Proposed the Price Event will move back to Approved status with the prior approved data. |
| Cancel | Price Event ID | Cancels the Price Event. Only Extracted and Active Price Events can be Cancelled. In both cases the status moves on to Cancelled. |
Table 22-3 Worksheet Price Event Detail
| ACTION | MANDATORY CELLS / FIELDS | NOTES |
|---|---|---|
| Create | Price Event ID, Item ID | Adds an item to the Price Event ID. |
| Create | Price Event ID, VPN | Adds an item (using the VPN) to the Price Event ID. |
| Update | Price Event ID, Item ID | Updates the item’s Change Value for the Price Event ID. |
| Update | Price Event ID, VPN | Updates the item’s (using the VPN) Change Value for the Price Event ID. |
| Delete | Price Event ID, Item ID | Removes the item from the Price Event ID. |
| Delete | Price Event ID, VPN | Removes the item (using the VPN) from the Price Event ID. |
Table 22-4 Worksheet Price Event Detail Location
| ACTION | MANDATORY CELLS / FIELDS | NOTES |
|---|---|---|
| Create | Price Event ID, Location ID | Adds a store to the Price Event ID. |
| Create | Price Event ID, Zone ID | Adds a zone to the Price Event ID. |
| Update | Price Event ID, Location ID | Updates the store’s Exclude Indicator. |
| Delete | Price Event ID, Zone ID | Removes the store from the Price Event ID. |
| Delete | Price Event ID, Location ID | Removes the zone from the Price Event ID. |
Template Simplified Price Event Creation
Template key: SPPM_PCEVT_SIMPLE_DATA
The required permissions per action for this template are the following:
Table 22-5 Template Key: SPPM_PCEVT_SIMPLE_DATA
| ACTION TYPE | ROLE NAME |
|---|---|
| Download Blank | ORCV_SPPM_APP_JOB |
| Upload | ORCV_SPPM_PRC_APPR_JOB |
| Upload | ORCV_SPPM_PRC_EDIT_JOB |
| Upload | ORCV_SPPM_SPROMO_APPR_JOB |
| Upload | ORCV_SPPM_SPROMO_EDIT_JOB |
Table 22-6 Worksheet Price Event
| ACTION | MANDATORY CELLS / FIELDS | NOTES |
|---|---|---|
| Create | Price Event Description, Price Event Type, Supplier, Start Date, Currency, Reason Code, Change Type, Change Value, Location Type, Location ID, Item ID |
Creates a new Price Event in New status, can also directly be Approved if the user has the necessary permissions and – if a supplier user – the Price Event has no substantial changes. Depending on the Price Event Type and configuration, certain other fields might also be mandatory, such as End Date and Exclusive Discount. |
| Create | Price Event Description, Price Event Type, Supplier, Start Date, Currency, Reason Code, Change Type, Change Value, Location Type, Location ID, VPN |
Creates a new Price Event in New status, can also directly be Approved if the user has the necessary permissions and – if a supplier user – the Price Event has no substantial changes. Depending on the Price Event Type and configuration, certain other fields might also be mandatory, such as End Date and Exclusive Discount. |
Codes
Certain operations require codes to define the options available at system level. Below you can find the list of code types available.
The codes are defined in the ORCV_S9T_CODE_HEAD and ORCV_S9T_CODE_DETAIL tables.
| CODE TYPE | CODE TYPE DESCRIPTION |
|---|---|
| PEHA | Price Events Header - Price Event Data Action |
| PELT | Price Events Header - Price Event Data Location Type |
References
Retail Price also uses the Queries module to enable communication between retailer and supplier users, details about Queries are available in the Supply Chain Hub Frameworks section.
Operations
This section describes Retail Price operations.
Integration by Module
Figure 22-4 Retail Price Integration by Module
| STEP | DESCRIPTION |
|---|---|
| 0 | RSCH Data Access of MFCS data |
| 1 | Price Change Java Service picks up published Price Changes to be integrated into RPCS. |
| 2 | Price Change Java Service calls RPCS Price Change Induction Rest Service. |
| 3 | Promotion Java Service picks up published Promotions to be integrated into RPCS. |
| 4 | Promotion Java Service calls RPCS Promotion Induction Rest Service. |
| 5 | Retail Price calls Upload Download Java Service to transform files, depending on the request details, Upload Download Java Service might need to callback to Retail Price to get more details. |
| 6 | Event Alert Java Service checks if there are alerts to be triggered. |
Batch by Module
This section describes the Retail Price batches.
Publish Price Event Batch
The batch uses the Batch Framework.
Authentication Method: OAuth2
BaseURL: https://<BASE_URL>/ords/mfcs/orcv/common/batch/<URL_PATH>
| URL PATH | REQUEST METHOD | REQUEST BODY | AFFECTED TABLES |
|---|---|---|---|
| start | POST |
{ "cycleName": "", "flowName": "", "processName": "", "async": "", "executionId": "", "jobName": "ORCV_SPPM_PUB_PCEVT_JOB", "agentExecutionId": "", "parameters": "" } |
ORCV_BATCH_STATUS_CONTROL ORCV_THREAD_CONTROL ORCV_BATCH_AUDIT_STATUS ORCV_PRICE_INT_PC_SVC ORCV_PRICE_INT_PRM_HEAD_SVC ORCV_SPPM_PCEVT_HEAD ORCV_SPPM_PCEVT_HEAD_PREV ORCV_SPPM_PCEVT_ITEM ORCV_SPPM_PCEVT_ITEM_PREV ORCV_SPPM_PCEVT_LOC ORCV_SPPM_PCEVT_LOC_PREV |
| restart | POST |
{ "cycleName": "", "flowName": "", "processName": "", "async": "", "executionId": <EXEC_ID>, "jobName": "ORCV_SPPM_PUB_PCEVT_JOB", "agentExecutionId": "", "parameters": "" } |
ORCV_BATCH_STATUS_CONTROL ORCV_THREAD_CONTROL ORCV_BATCH_AUDIT_STATUS ORCV_PRICE_INT_PC_SVC ORCV_PRICE_INT_PRM_HEAD_SVC ORCV_SPPM_PCEVT_HEAD ORCV_SPPM_PCEVT_HEAD_PREV ORCV_SPPM_PCEVT_ITEM ORCV_SPPM_PCEVT_ITEM_PREV ORCV_SPPM_PCEVT_LOC ORCV_SPPM_PCEVT_LOC_PREV |
| log | GET |
URL query parameters: /log?jobName=ORCV_SPPM_PUB_PCEVT_JOB &executionId=<EXEC_ID>&logDate=YYYY-DD-MM |
N/A |
| kill | POST |
{ "cycleName": "", "flowName": "", "processName": "", "async": "", "executionId": <EXEC_ID>, "jobName": "ORCV_SPPM_PUB_PCEVT_JOB", "agentExecutionId": "", "parameters": "" } |
ORCV_BATCH_STATUS_CONTROL ORCV_THREAD_CONTROL ORCV_BATCH_AUDIT_STATUS |
| status | GET |
URL query parameters: /status?jobName=ORCV_SPPM_PUB_PCEVT_JOB &executionId=<EXEC_ID>&logDate=YYYY-DD-MM |
N/A |
Update Price Event Batch
The batch uses the Batch Framework.
Authentication Method: OAuth2
BaseURL: https://<BASE_URL>/ords/mfcs/orcv/common/batch/<URL_PATH>
| URL PATH | REQUEST METHOD | REQUEST BODY | AFFECTED TABLES |
|---|---|---|---|
| start | POST |
{ "cycleName": "", "flowName": "", "processName": "", "async": "", "executionId": "", "jobName": "ORCV_SPPM_PCEVT_UPD_ST_JOB", "agentExecutionId": "", "parameters": "" } |
ORCV_BATCH_STATUS_CONTROL ORCV_THREAD_CONTROL ORCV_BATCH_AUDIT_STATUS ORCV_PRICE_INT_PC ORCV_PRICE_INT_PC_GRP_XREF ORCV_PRICE_INT_PRM_XREF ORCV_SPPM_PCEVT_HEAD ORCV_SPPM_PCEVT_ITEM |
| restart | POST |
{ "cycleName": "", "flowName": "", "processName": "", "async": "", "executionId": <EXEC_ID>, "jobName": "ORCV_SPPM_PCEVT_UPD_ST_JOB", "agentExecutionId": "", "parameters": "" } |
ORCV_BATCH_STATUS_CONTROL ORCV_THREAD_CONTROL ORCV_BATCH_AUDIT_STATUS ORCV_PRICE_INT_PC ORCV_PRICE_INT_PC_GRP_XREF ORCV_PRICE_INT_PRM_XREF ORCV_SPPM_PCEVT_HEAD ORCV_SPPM_PCEVT_ITEM |
| log | GET |
URL query parameters: /log?jobName=ORCV_SPPM_PCEVT_UPD_ST_JOB &executionId=<EXEC_ID>&logDate=YYYY-DD-MM |
N/A |
| kill | POST |
{ "cycleName": "", "flowName": "", "processName": "", "async": "", "executionId": <EXEC_ID>, "jobName": "ORCV_SPPM_PCEVT_UPD_ST_JOB", "agentExecutionId": "", "parameters": "" } |
ORCV_BATCH_STATUS_CONTROL ORCV_THREAD_CONTROL ORCV_BATCH_AUDIT_STATUS |
| status | GET |
URL query parameters: /status?jobName=ORCV_SPPM_PCEVT_UPD_ST_JOB &executionId=<EXEC_ID>&logDate=YYYY-DD-MM |
N/A |