| Oracle® Retail Merchandising Cloud Suite Customization and Extension Guide Release 22.1.201.0 F55407-01 |
|
 Previous |
 Next |
| Oracle® Retail Merchandising Cloud Suite Customization and Extension Guide Release 22.1.201.0 F55407-01 |
|
Previous |
Next |
Merchandising solutions expose select task flows that you can directly access from external solutions using a specific URL, custom reports, and so on. This feature is referred to as in-context launch because, as part of the URL, parameters for the workflow are passed in to open a page displaying information related to those parameters. For example, the Item task flow in Merchandising could be called for a specific item ID. The requested task flow will be displayed in a new browser window or tab, depending on the specified target of the URL.
When this page is launched, Merchandising will display the information for the item included in the URL in either view or edit mode.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmItem=<item>&pmMode=<mode>&navModelItemId=MaintainItemFlowExt
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmItem | Yes | Item ID |
| pmMode | No | The mode in which the screen should be opened. Valid values are EDIT or VIEW. |
When this page is launched, Merchandising will display the Item Supplier Country information based on the values sent in the URL in either view or edit mode.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmSupplierStr=<Supplier>&pmItem=<item>&pmMode=<mode>&pmSubClass=<subclass>&pmVPN=<VPN>&navModelItemId=MaintainItemSuppCntryFlowExternal
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmSupplier | Yes | Supplier site |
| pmItem | Yes | Item ID |
| pmMode | No | The mode in which the screen should be opened. Valid values are EDIT or VIEW. |
| pmVPN | No | Vendor product number for the item/supplier. |
When this page is launched, Merchandising will display the Item Locations based on the item sent in the URL.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmItem=<item&navModelItemId=MaintainItemLocsFlowExternal
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmItem | Yes | Item ID |
When this page is launched, Merchandising will display the search results based on the VPN, supplier and/or hierarchy values sent in the URL. If none of the parameters are included, then the screen will be displayed with no search results.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmSupplierSite=<SupplierSite>&pmDept=<dept>&pmClass=<class>&pmSubClass=<subclass>&pmVPN=<VPN>&navModelItemId=searchItemFlowExternal
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmSupplierSite | No | Supplier Site ID |
| pmDept | No | Department ID |
| pmClass | No | Class ID |
| pmSubClass | No | Subclass ID |
| pmVPN | No | Vendor product number |
When this page is launched, Merchandising will open the replenishment attributes based on the information in the URL.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmItemStr=<Item>&pmLocationStr=<Location>&pmMode=<mode>&navModelItemId=MaintainReplAttrFlowExternal
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmItemStr | Yes | Item |
| pmLocationStr | Yes | Store or virtual warehouse ID |
| pmMode | No | The mode in which the screen should be opened. Valid values are EDIT or VIEW. |
When this page is launched, Merchandising will display the search results based on the hierarchy values sent in the URL. One or more departments can be sent, or a single department/class or single department/class/subclass combination. If none of the parameters are sent, the screen will be displayed with no search results.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmDepts=<dept>&pmClass=<class>&pmSubClass=<subclass>&pmSuppStr=<supplier>&pmLocStr=<location>&pmOtbEowDateStr=<OTBEOWDate>&pmnotAfterDateStr=<NotAfterDate>&pmnotBeforeDateStr=<NotBeforeDate>&navModelItemId=searchOrderflowExternal
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmDept | No | One or more department IDs to search for orders based on the items on the order; if multiple sent, they should be separated by commas. For example, pmDepts=100,200,300. |
| pmClass | No | Class ID for items on the order |
| pmSubClass | No | Subclass ID for items on the order |
| pmSuppStr | No | Supplier site for the order |
| pmLocStr | No | Location on the order |
| pmOtbEowDateStr | No | OTB End of Week Date for the order in the format DD-MON-RR. |
| pmnotAfterDateStr | No | Not Before Date for the order in the format DD-MON-RR. |
| pmnotBeforeDateStr | No | Not After Date for the order in the format DD-MON-RR. |
When this page is launched, Merchandising will display information for the order included in the URL in either view or edit mode.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmMode=<mode>&pmOrderNo=<order>&navModelItemId=MaintainPurchaseOrderFlow
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmOrderNo | Yes | Purchase order number |
| pmMode | No | The mode in which the screen should be opened. Valid values are EDIT or VIEW. |
When this page is launched, Merchandising will display information for the order included in the URL in either view or edit mode.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmMode=<mode>&pmOrderNoStr=<order>&navModelItemId= MaintainOrderDetailFlow
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmOrderNoStr | Yes | Purchase order number |
| pmMode | No | The mode in which the screen should be opened. Valid values are EDIT or VIEW. |
When this page is launched, Merchandising will open the Purchase order creation screen populated with the values passed in the URL.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmMode=<mode>¬AfterDateStr=<notAfterDate>¬BeforeDateStr=<notBeforeDateStr>&pmLocation=<Location>&pmDept=<Dept>&pmSupplierStr=<SupplierSite>&navModelItemId=CreatePurchaseOrderFlowExternal
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmSupplierStr | No | Supplier Site for the order |
| notAfterDateStr | No | Not After Date |
| notBeforeDateStr | No | Not Before Date |
| pmDept | No | Department; optional if department is not required for purchase orders. |
| pmMode | No | If included this should be passed as NEW. |
| pmLocation | No | If included, the PO created will be for a single location. |
When this page is launched, Merchandising will display the search results based on the parameters included in the URL. If none of the parameters are sent, the screen will be displayed with no search results.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmItem=<item>&pmFromLoc=<FromLocation>&pmToLoc=<toLocation>&pmFinisher=<Finisher>&navModelItemId=searchTransferFlowExternal
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmItem | No | Item on the transfer to be used as search criteria |
| pmFromLoc | No | From location on the transfer to be used as search criteria |
| pmToLoc | No | To location on the transfer to be used as search criteria |
| pmFinisher | No | Finisher on the transfer to be used as search criteria. |
When this page is launched, Merchandising will display the screen for transfer creation populated with information included in the URL.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmDeptStr=<Dept>&pmFromLocStr=<FromLoc>&pmToLocStr=<toLoc>&pmFinisherStr=<Finisher>&pmDeliveryDateStr=<DeliveryDate>&pmFromLocType=<FromLocType>pmToLocType=<toLocType>&pmFinisherType=<FinisherType>&pmTsfType=<TransferType>&navModelItemId= CreateMaintainTransferFlowExternal
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmDeptStr | No | Department to use for the new transfer; required if the system option is set to require department on a transfer. |
| pmFromLocStr | No | From Location to use for the new transfer. |
| pmToLocStr | No | To Location to use for the new transfer. |
| pmFinisherStr | No | Finisher to use for the new transfer. |
| pmDeliveryDateStr | No | Delivery date to use for the transfer in the format DD-MON-RR. |
| Finisher Type | No | Indicates the type of finisher - Internal or External. Valid values - I or E. |
| TransferType | No | Type of transfer to create. Valid values are found in code type TR4E. |
When this page is launched, Merchandising will display information for the transfer included in the URL in either view or edit mode.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmMode=<mode>&pmTsfNo=<transfer>&navModelItemId=MaintainTransferHeaderFlow
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmTsfNo | Yes | Transfer number |
| pmMode | Yes | The mode in which the screen should be opened. Valid values are EDIT or VIEW. |
When this page is launched, Merchandising will display the search results based on the parameters included in the URL. If none of the parameters are sent, the screen will be displayed with no search results.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmSupplierStr=<Supplier>&pmLocationStr=<Location>&pmItem=<item>&navModelItemId= SearchReturnToVendorFlowExternal
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmSupplierstr | No | Supplier site for the RTV |
| pmLocationStr | No | Location from where items will be shipped on the RTV. Can be a store or virtual warehouse. |
When this page is launched, Merchandising will display the information for the RTV included in the URL in either view or edit mode.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmRtvOrderNo=<rtv>&pmMode=<mode>&navModelItemId=MaintainRtvDetailFlow
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmRtvOrderNo | Yes | RTV number |
| pmMode | No | The mode in which the screen should be opened. Valid values are EDIT or VIEW. |
When this page is launched, Merchandising will display the transaction data based on the search criteria included in the URL. In order to successfully execute the search, at least one of the following must be included department, item, store, or warehouse, along with the transaction date range.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmItem=<item>&pmWarehouse=<warehouse>&pmStr=<store>&pmTransStrtDate=<tran_start_date>&pmTransEndDate=<tran_end_date>&pmPostStrtDate=<post_start_date>&pmPostEdDate=<post_end_date>&pmCreateDate=<create_date>&pmDpt=<dept>&pmCls=<class>&pmSubcls=<subclass>&navModelItemId=ViewTransactionDataFlow
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmItem | No | Item ID |
| pmWarehouse | No | Virtual warehouse ID |
| pmStr | No | Store ID |
| pmTransStrtDate | Yes | Start range for searching on transaction date |
| pmTransEndDate | No | End range for searching on transaction date; if not included in the URL, the start date will be used as the end date in the search. |
| pmPostStrtDate | No | Start range for searching on post date |
| pmPostEdDate | No | End range for searching on post date |
| pmCreateDate | No | Create Date |
| pmDept | No | Department ID |
| pmCls | No | Class ID |
| pmSubcls | No | Subclass ID |
When this page is launched, Merchandising will open the Inventory adjustment screen.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmItem=<item>&navModelItemId=MaintainInventoryAdjustmentByItemFlowExternal
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmItem | Yes | Item ID for which to create the inventory adjustment |
When this page is launched, Merchandising will open the Shipment results based on the information in the URL.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmDistroNoStr=<DistroNo>&pmOrderNo=<OrderNo>&pmSupplier=<Supplier>&pmFromLoc=<FromLoc>&pmToLoc=<ToLoc>&navModelItemId=SearchShipmentFlowExternal
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmDistroNoStr | No | Transfer or allocation ID for which to search for a shipment. Only one of either a distro number or order number should be included. |
| pmOrderNo | No | PO number for which to search for a shipment. Only one of either a distro number or order number should be included. |
| pmSupplier | No | Supplier site is used for PO shipment searches only |
| pmFromLoc | No | From location is used for transfer and allocation shipments |
| pmToLoc | No | To location can be used for searches for PO and transfers/allocation shipments. |
When this page is launched, Merchandising will display information for the shipment included in the URL in either view or edit mode.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmShipment=<shipment>&pmMode=<mode>&navModelItemId=MaintainShipmentDetailFlow
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmShipment | Yes | Shipment number |
| pmMode | No | The mode in which the screen should be opened. Valid values are EDIT or VIEW. |
When this page is launched, Merchandising will open the Transfer Reconciliation screen with results based on the information on the URL.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmDistroNoStr=<Distro>&pmBOL=<BOL>&pmCarton=<Carton>&pmFromLoc=<fromLoc>&pmToLoc=<toLoc>&navModelItemId=MaintainStockOrderReconciliationFlowExternal
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmDistroNoStr | No | Transfer or allocation number to search for shipments requiring reconciliation. |
| pmBOL | No | Bill of Lading requiring reconciliation |
| pmCarton | No | Carton requiring reconciliation |
| pmFromLoc | No | From location which has a transfer or allocation requiring reconciliation. Can be a store, warehouse, or finisher. |
| pmToLoc | No | To location which has a transfer or allocation requiring reconciliation. Can be a store, warehouse, or finisher. |
When this page is launched, Merchandising will open the Receive Cost Adjustment page for a shipment.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmShipmentNo=<ShipmentNo>&navModelItemId=MaintainReceiptUnitAdjustmentFlowExternal
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmShipmentNo | Yes | Shipment Number for which to perform a receipt adjustment. |
When this page is launched, Merchandising will open the Receive Unit Adjustment.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmOrderNoStr=<OrderNo>&pmItem=<item>&navModelItemId=MaintainreceivingcostadjflowExternal
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmOrderNoStr | Yes | Order number for which a cost adjustment will be created. |
| pmItem | Yes | Item ID that will have its cost adjusted on a PO. |
When this page is launched, Merchandising will display the average cost adjustment screen with the item and location data defaulted based on the information in the URL.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/Rms/faces/RmsHome?pmMode=<mode>&pmItem=<item>&pmLocType=<loc_type>&pmLocation=<location&navModelItemId=MaintainAvgCostAdjFlowExt
Parameters:
| Parameter | Required | Description |
|---|---|---|
| pmItem | Yes | Item ID |
| pmLocType | Yes | Location type - either S (store) or W (warehouse) |
| pmLocation | Yes | Store or virtual warehouse ID |
| pmMode | No | The mode in which the screen should be opened. Valid values are EDIT or VIEW. |
When this page is launched, Allocation will open the Allocation Maintenance page to initiate an allocation with the passed in source type, source ID and item IDs.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/alloc/faces/Home?navModelItemId=quickCreateTF&source=<source>&sourceIdList=<source_list>&itemIdList=<item_list>
Parameters:
| Parameter | Required | Description |
|---|---|---|
| Source | Yes | Should be a valid source type for an allocation - PO, WAREHOUSE, ASN, or BOL |
| Source ID List | Yes | Should indicate the entity ID that relates to the source. For example, if the source is PO, then this would be one or more purchase order number. If more than one is included, they should be separated by semicolons. |
| Item List | Yes | Should indicate the items that will be allocated. If more than one is included, they should be separated by semicolons. |
When this page is launched, Allocation will open the allocation included in the URL in edit mode.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/alloc/faces/Home?navModelItemId=loadAllocationTF&allocationId=<alloc_id>
Parameters:
| Parameter | Required | Description |
|---|---|---|
| Allocation | Yes | Valid allocation ID. |
When this page is launched, Invoice Matching fetches all the invoices and receipts associated with the default match key from the supplier and for the given invoice.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/ReimViewController/faces/Home?navModelItemId=SummaryMatchService&supplier=<supplier ID>&invoice=<invoice ID>
Parameters:
| Parameter | Required | Description |
|---|---|---|
| Supplier | Yes | Supplier ID |
| Invoice | Yes | Invoice or document ID |
When this screen is launched, Invoice Matching fetches all the discrepant invoices for the given supplier and invoice.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/ReimViewController/faces/Home?navModelItemId=DiscrepancyListService&supplier=<supplier ID>&invoice=<invoice ID>
Parameters:
| Parameter | Required | Description |
|---|---|---|
| Supplier | Yes | Supplier ID |
| Invoice | Yes | Invoice or document ID |
When this page is launched, Sales Audit will pre-populate the Store Day search based on the parameters included and optionally auto execute the search. Only one store/day combination can be included.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/ResaPortal/faces/Home?navModelItemId=SearchStoreDayTF?Store=<storeId>&BusinessDay=<BusinessDay>
Parameters:
| Parameter | Required | Description |
|---|---|---|
| Store | Yes | The ID for a store to include in a search |
| BusinessDay | Yes | Business day to use in the search in the format DD-MON-RR. |
| AutoExecute | No | Indicates if the query should be automatically executed when the screen is launched or not. Valid values are Y or N. |
| AssignedStores | No | Filters the returned list to the user's assigned stores (Y) or to the stores not assigned to the user (N). |
| DataStatus | No | Filters the returned list of store days by data status for one of the following: Fully Loaded (F), Purged (G), Loading (L), Partially Loaded (P), and Ready for Import (R). |
| OverAllStatus | No | Filters the returned list of store days by overall status for one of the following: Complete (A) or In Progress (I). |
When this page is launched, Sales Audit will display information for the store day based on the parameters included in the URL in edit mode or view mode, depending on the user's privileges.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/ResaPortal/faces/Home?navModelItemId=MaintainStoreDayTF?StoreSeqNo=<StoreDaySequenceNo>&Store=<Store ID>&BusinessDate=<BusinessDate>
Parameters:
| Parameter | Required | Description |
|---|---|---|
| StoreSeqNo | Yes | The sequence number for the store day. |
| Store | Yes | ID for a store |
| BusinessDate | Yes | Business day to use in the search in the format DD-MON-RR. |
| TabToDisclose | No | This parameter, if included can indicate that the Over/Short tab should be the focus when the page opens. If this parameter is included, it must have a value of OS, which means that the Over/Short tab will be in focus. Otherwise, the focus will be on the error list. |
When this page is launched, Sales Audit will display information for the transaction sequence number included in the URL in edit mode or view mode, depending on the user's privileges.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/ResaPortal/faces/Home?navModelItemId=MaintainTransactionTF?TransactionSeqNo=<TransactionSeqNo>
Parameters:
| Parameter | Required | Description |
|---|---|---|
| TransactionSeqNo | Yes | The sequence number for the transaction. |
When this page is launched, Sales Audit will pre-populate the Transaction search based on the parameters included and optionally auto execute the search. Only a single transaction sequence can be sent.
URL:
https://rex.retail.<Region Name>.ocs.oraclecloud.com/<Customer Subnamespace>/ResaPortal/faces/Home?navModelItemId=ManageTransactionTF?TransactionSeq=<TransactionSeq>&Store=<StoreID>&TranBusinessDate=<TranBusinessDate>
Parameters:
| Parameter | Required | Description |
|---|---|---|
| TransactionSeq | Yes | The sequence number for the transaction. |
| StoreId | Yes | The ID of a store to include in the search. |
| TranBusinessDate | Yes | The business date to use in the search in the format in the format DD-MON-RR. |
| ErrorExists | No | If included, filters the returned list to transactions with errors (Y) or without (N). |
| AutoExecute | No | Indicates if the query should be automatically executed when the screen is launched or not. Valid values are Y or N. |
