A Appendix A: Dashboard and Contextual Parameters

Mirror of Oracle documentation

Converted for search and offline reading. Authoritative source: Oracle. Diagrams and some complex tables are simplified — check the PDF when in doubt.

A

Appendix A: Dashboard and Contextual Parameters

Dashboard Parameters

In order to embed custom reports in base dashboards and have those reports leverage the data filters, you will want to use them as input parameters in your reports. For any parameters that support multiple values through use of the advanced search option, the parameters will contain all values added in the search separated by commas. For example, in the Buyer dashboard if more than one department is put in the filter, then both of those would be passed in the parameter departmentIds. The tables below outline the parameters used for each of the dashboards in the Merchandising solutions for that purpose.

Merchandising

Dashboard	Parameter Displayed Name	Parameter
Buyer	Department	departmentIds
	Class	classIds
	Subclass	subclassIds
	Supplier Site	supplierSiteIds
	Store	storeIds
	Brand	brands
	Country of Sourcing	originCountries
	Order Context	orderContextIds
Data Steward	Department	departmentIds
	Class	classIds
	Subclass	subclassIds
	Supplier Site	supplierSiteIds
	Country of Sourcing	originCountries
	Created Date	createDates
	Location	locationIds
	Brand	brands
	Item Type	itemTypeId
	Item Level	itemLevelId
	Transaction Level	tranLevelId
	UDA	udaId
	UDA Value	udaValues
	Season	seasonId
Finance Analyst	Set of Books	setOfBooksIds

A-1

Appendix A Dashboard Parameters

Dashboard	Parameter Displayed Name	Parameter
	Org Unit	orgUnitIds
	Location	locationIds
	Department	departmentIds
	Class	classIds
	Subclass	subClassIds
Inventory Analyst	Department	departmentIds
	Class	classIds
	Subclass	subclassIds
	Supplier Site	supplierSiteIds
	Area1	areaIds
	Store Grade	storeGradeGroupIds
	Store	storeIds
	Brand	itemBrands
	Order Context	orderTypeIds
Inventory Control	Chain	chainIds
Analyst	Area	areaIds
	Location	locationIds
	Supplier Site	supplierSiteIds
	Department	departmentIds
	Class	classIds
	Subclass	subClassIds

• 1 Either Area or Store Grade are displayed in the filter, depending on the system option setting.

Sales Audit

There are no filters on the Sales Audit dashboard.

Pricing

Dashboard	Parameter Displayed Name	Parameter
Pricing Analyst	Department	Department
	Class	ClassId
	Subclass	Subclass
	Zone	Zone
	Channel	Channel
	Store	Location
	Supplier Site	SupplierSite
Promotion Planner	Department	Department
	Class	ClassId
	Subclass	Subclass

A-2

Appendix A Contextual Parameters

Dashboard	Parameter Displayed Name	Parameter
	Zone	Zone
	Channel	Channel
	Store	Location
	Supplier Site	SupplierSite

Invoice Matching

Dashboard	Parameter Displayed Name	Parameter
Accounts Payable	AP Reviewer	ApReviewer
Reviewer	Set of Books	SetOfBooks
	Location	Location
	Supplier	Supplier
	Supplier Site	SupplierSite
	Department	Dept
	Class	Class1
	Subclass	Subclass
	Org Unit	OrgUnit
	Document Date	DocDate
	Item	Item

Allocation

Dashboard	Parameter Displayed Name	Parameter
Allocator	Department	DepartmentId
	Class	ClassId
	Subclass	SubclassId

Contextual Parameters

In order to create reports that are contextual to the page in which they are displayed, you will need to use the available parameters for that page and also know which events trigger an update to the parameters. This section outlines what is supported for each of the Merchandising solutions.

Merchandising

For all of the Merchandising contextual panes, there is a report that can be used to help with visibility to the parameters available. This helper report can be configured on during development phases of your program and then configured off in production. It is controlled by the report system option

RMS_OI_SYSTEM_OPTIONS.DISPLAY_CONTEXTUAL_PAYLOAD.Here is an example of what the report looks like in the Item workflow:

A-3

Appendix A Contextual Parameters

Cost Change Workflows

Workflow	Contextual Model Name	Action Type	Event Description	Parameters
Cost Change By Item	Cost Change By Item Contextual Model	CostChangeItemSelectedE vent	Item table row is selected	CostChangeId Item Supplier OriginCountry EffectiveDate DisplayCurrency RandomNo
Cost Change By Item Location	Cost Change By Item Location Contextual Model	CostChangeItemLocSelect edEvent	Item Location table row is selected	CostChangeId Item Location Supplier OriginCountry EffectiveDate DisplayCurrency RandomNo

Deals Workflows

Workflow	Contextual Model Name	Action Type	Event Description	Parameters
Deal	Deal Head Contextual Model	DealHeadEvent	Components table row is selected	DealId Supplier/Partner DealCompId DealCurrency DisplayCurrency
			Deal page is loaded	DealId Supplier/Partner DealCurrency DisplayCurrency
Fixed Deal	Fixed Deal Head Contextual Model	FixedDealHeadEve nt	Fixed Deal page is loaded	DealId Supplier/Partner DisplayCurrency
			Fixed Deal page is loaded	Supplier/ PartnerDisplayCurr ency

A-5

Appendix A Contextual Parameters

Franchise Workflows

Workflow	Contextual Model Name	Action Type	Event Description	Parameters
Franchise Order	Franchise Order Head Contextual Model	FranchiseOrderEvent	Franchise Order page is loaded Items table row is selected	WfOrderNoCu stomer WfOrderNo Item SourceLocatio n
				CustomerLoc
Franchise Return	Franchise Return Head Contextual Model	FranchiseReturnHeadLoad Event FranchiseReturnItemSelecti onEvent	Franchise Return page is Loaded Items table row is selected	RMANum WfOrderNoIte m

Import Workflows

Workflow	Contextual Model Name	Action Type	Event Description	Parameters
ALC Finalization	ALC Order Finalize Contextual Model	AlcOrderFinalizeSelectionEvent	ALC Finalization results row selected.	ShipmentOrd er
Customs Entry	Customs Entry Contextual Model	CustomsEntryLoadEvent	Customs Entry page is loaded	CustEntryId
Letter Of Credit	Letter Of Credit Head Contextual Model	FinalizeTransportationValueCh angeEvent	Letter Of Credit Head page is loaded	VesselId VoyageFlightI D
				EstDeparture Date
Letter Of Credit Order Selection	Letter Of Credit Order Contextual Model	LetterOfCreditHeadLoadEvent	Letter Of Credit Order table row is selected	LCReference Num
Obligation	Obligation Contextual Model	LetterOfCreditOrderSelectionE vent	Obligation page is Loaded	Order Applicant Bank
Finalize Transportatio n	Finalize Transportation Contextual Model	ObligationLoadEvent	On value change of vessel, voyage flight, or estimated departure date	ObligationId
Transportatio n	Transportation Contextual Model	TransportationLoadEvent	Transportation page is loaded.	Transportatio nId

A-6

Appendix A Contextual Parameters

Item Workflows

Workflow	Contextual Model Name	Action Type	**Event Description **	Parameters
Item	Item Contextual Model	ItemSelectedEvent	Item page is loaded	Item
Item Children	Item Children Contextual Model	ItemChildSelectedEvent	Item Children table row selected.	Item
Item Children By Diff	Item Children By Diff Contextual Model	ItemChildDiffSelectedEven t	Item Children By Diff table row is selected.	Item
Item Location	Item Location Contextual Model	ItemLocSelectedEvent	Location table row is selected	Item Location
Item Location Inventory	Item Location Inventory Contextual Model	ItemLocInventorySelection Event	Item Location Inventory table row is selected	Item Location
Item Search	Item Search Contextual Model	ItemSearchItemSelectedE vent	Item Search results table row is selected	Item
Item Supplier	Item Supplier Contextual Model	ItemSupplierSelectedEvent	Supplier row selected.	Item Supplier
Item Supplier Country	Item Supplier Country Contextual Model	ItemSuppCountrySelected Event	Country of Sourcing row selected.	Item Supplier OriginCountr y
Pack Details	Pack Details Contextual Model	PackDetailsSelectionEvent	Packs By Component table row selected.	Item
Related Item	Related Item Contextual Model	RelatedItemSelectedEvent	Related Items table row is selected	Item
Sales Issues By Location	Sales Issues By Location Contextual Model	SalesIssuesByLocSelectio nEvent	Sales Issues By Location table row is selected	Item Location
Simple Pack Item	Simple Pack Item Contextual Model	SimplePackItemSelectedE vent	Simple Pack Setup table row is selected	Item

Purchase Order Workflows

ADF Bundle: oracle.retail.apps.rms.procurement.view.RmsProcurementViewControllerBundle

A-7

Appendix A Contextual Parameters

Workflow	Contextual Model Name	Action Type	Event Description	Parameters
Order Detail	Order Detail Contextual Model	OrderDetailEvent	Allocations table row is selected	Order Item Location PhysicalWH Allocation DisplayCurrenc y DisplayUOM
			Items table row is selected	Order Item
				ItemParent Diff1
				Diff2 Diff3 Diff4
				OrderCurrency DisplayCurrenc y DisplayUOM
			Locations table row is selected	Order Item Location
				DisplayCurrenc y DisplayUOM
Order Distribution	Order Distribution Item Contextual Model	OrderDistItemSelectio nEvent	Order Distribution table row is selected	Order Item Supplier Location
Order	Order Header Contextual Model	OrderHeadLoadEvent	Order page is Loaded	Order Supplier ImportInd Department Location Status OrderCurrency OrderType
Order Search	Order Search Contextual Model	OrderSearchOrderSele ctedEvent	OrderSearchOrderSele ctedEvent: Order Search results table row is selected	Order Supplier Status Currency

A-8

Appendix A Contextual Parameters

Replenishment Workflows

Workflow	Contextual Model Name	Action Type	Event Description	Parameters
Buyer Worksheet	Buyer Worksheet Contextual Model	BuyerWorksheetSelectionE vent	Table row is selected	Item Supplier SourceType Location DisplayCurrenc y
Replenishment Attributes	Replenishment Attribute Contextual Model	ReplAttributeLoadEvent	Replenishment Attribute page is loaded	Item Location
Replenishment Attribute Search	Replenishment Attribute Search Contextual Model	ReplAttributeSearchSelecti onEvent	Replenishment Search results table row is selected	Item Location
Substitute Items	Substitute Items Contextual Model	SubstituteItemSelectedEve nt	Substitute Items table row is selected.	Item SubstituteItem

RTV Workflows

Workflow	Contextual Model Name	Action Type	Event Description	Parameters
Return To Vendor	Return To Vendor Head Contextual Model	ReturnToVendorEv ent	Item table row is selected.	Rtv Item Location
				Supplier
				DisplayCurrency InventoryStatus DisplayUOM
			Return to Vendor page is loaded.	Rtv Location
				Supplier
				Status
				DisplayCurrency DisplayUOM

A-9

Appendix A Contextual Parameters

Shipment and Receipt Workflows

Workflow	Contextual Model Name	Action Type	Event Description	Parameters
Receipt Adjustment by Cost	Receiver Cost Adjustment Item Contextual Model	ReceivingCostAdjItemSele ctionEvent	Receipt Adjustment By Cost page table row is selected	Order Supplier Department Item Location DisplayCurren cy
Shipment	Shipment Head Contextual Model	ShipmentPageEvent	Details table row is selected	Shipment Item Carton
			Shipment page is loaded.	Shipment ASN BOL EstArrivalDate InvMatchDate ReceiveDate ShipDate NotBeforeDate NotAfterDate ToLoc Status
Shipment Search	Shipment Search Contextual Model	ShipmentSearchSelectionE vent	Shipment Search results table row is selected	Shipment Order BOL ToLoc
Stock Order Reconciliation	Stock Order Exception Detail Contextual Model	StockOrderExceptionEvent	Carton Level Dispositions table row is selected	Carton Shipment BOL FromLoc ToLoc
			Stock Order Exceptions table row is selected	BOL FromLoc ToLoc Shipment

Stock Count Workflows

Workflow	Contextual Model Name	Action Type	Event Description	Parameters
Stock Count	Stock Count	StockCountResultsSelectio	Items and Count	StockCountId
Results	Results Contextual Model	nEvent	Locations tables row is selected	Item Location

A-10

Appendix A Contextual Parameters

Workflow	Contextual Model Name	Action Type	Event Description	Parameters
Unit Variance and Adjustment	Unit Var Adjustment Location Contextual Model	UnitVarianceAndAdjustmen tEvent	Details table row is selected	StockCountId Location Department Class SubClass
			Location table row is selected	StockCountId Location Item
Value Variance and Adjustment	Value Var Adjustment Location Contextual Model	ValueVarAdjLocSelectionE vent	Value Variance and Adjustment tables row is selected	StockCountIdL ocation
Virtual	Virtual Warehouse	VirtualWhDistSelectionEve	Physical	StockCountId
Warehouse Distribution	Distribution Contextual Model	nt	Warehouse/Items table row is selected	Item PhysicalWh

Transfer Workflows

Workflow	Contextual Model Name	Action Type	Event Description	Parameters
Mass Return Transfer	Mass Return Transfer Head Contextual Model	MassReturnTransfer Event	Mass Return Transfer page is loaded	MRT Warehouse Status
				Supplier
				DisplayCurrency
			Item table row is selected	MRT Item
				DisplayCurrency
			Locations table row is selected.	MRT Item
				Location
				DisplayCurrency

A-11

Appendix A Contextual Parameters

Workflow	Contextual Model Name	Action Type	Event Description	Parameters
Transfer Details	Transfer Detail Contextual Model	TransferDetailSelecti onEvent	Transfer Details table row is selected	Transfer Item ItemParent Diff1 Diff2
				Diff3
				Diff4
				InventoryStatus FromLoc ToLoc Finisher
				DisplayCurrency DisplayUOM DisplayLeg
Transfer	Transfer Head Contextual Model	TransferHeadLoadEv ent	Transfer page is loaded	Transfer FromLoc ToLoc Finisher Status DeliveryDate
Transfer Search	Transfer Search Contextual Model	TransferSearchSelec tionEvent	Transfer search results table row is selected	Transfer FromLoc ToLoc Finisher Status

Sales Audit

Workflow	Contextual Model Name	Action Type	Event Description	Parameters
Store Day Search	Store Day Search Contextual Model Name	OnloadEvent	Store Day Search page is loaded	val1 (Store)
Store Day Search	Store Day Search Contextual Model Name	OverShortHistorySelec tedEvent	When a user selects a row in the results table	val1 (Store)
Store Day Summary	Maintain Store Day Contextual Model Name	OnloadEvent	Store Day Summary page is loaded	val1 (Store) val3 (Store Sequence Number) currency

A-12

Appendix A Contextual Parameters

Workflow	Contextual Model Name	Action Type	Event Description	Parameters
Transaction	Maintain Transaction Contextual Model Name	TableSelectedEvent	The user selects an item in the Item table	val1 (Store) val2 (Tranaction Sequence Number) itemSeqNo item
Tender Summary	Tender Summary Contextual Model Name	TableSelectedEvent	Results are returned in the Tender Summary page	val1 (Store)currency

Pricing

Workflow	Contextual Model Name	Action Type	Event	Parameters
Price Change Group	Price Event Contextual Area	PriceChangeItemSelecte dEvent	When the user selects a row in the price change group maintenance screen.	Item ItemDesc DiffDesc Location LocationDesc LocationType
				ZoneDisplayId ZoneDesc
				Currency BatchGenExcl
				RandomNo
				ZoneID
				PeType (PC, CLR)
				MaintItemWsId
				MaintLocWsId

A-13

Appendix A Contextual Parameters

Workflow	Contextual Model Name	Action Type	Event	Parameters
Clearance Group	Price Event Contextual Area	PriceChangeItemSelecte dEvent	When the user selects a row in the Clearance group maintenance screen.	Item ItemDesc DiffDesc Location LocationDesc LocationType ZoneDisplayId ZoneDesc Currency BatchGenExcl RandomNo ZoneID PeType (PC, CLR) MaintItemWsId1 MaintLocWsId2
Price Inquiry	Price Event Contextual Area	PriceInquiryItemSelected Event	When the user selects a row in the Price Inquiry Search screen.	Item ItemDesc Location LocationDesc LocationType Currency SearchStartDat e SearchEndDate ActionDate LocationPricing WorkspaceId Application
Conflicts	Price Event Contextual Area	PriceChangeItemSelecte dEvent	When the user selects a row in the Conflict Check Error Maintenance screen.	ConflictId RandomNo

1 Row ID in the item table.

2 Row ID in the location table.

A-14

Appendix A Contextual Parameters

Invoice Matching

Workflow	Contextual Model Name	Action Type	Event Description	Parameters
Summary Match - Detail Match Item View	Detail Match Contextual Area	DetailToleranceRan ge	When the user enters the Detail Match screen.	SessionId WorkspaceId lang locale accessibility ItemViewId InvcItemViewId RowType (STYLE, SKU, INVC, RCPT) StagedPayloadId
Summary Match - Detail Match Item View	Detail Match Contextual Area	qtyComparison	When a user clicks on an item in the item table in Detail Match.	SessionId WorkspaceId lang locale accessibility ItemViewId InvcItemViewId RowType (STYLE, SKU, INVC, RCPT) StagedPayloadId
Summary Match - Detail Match Item View	Detail Match Contextual Area	costComparison	When a user clicks on an item in the item table in Detail Match.	SessionId WorkspaceId lang locale accessibility ItemViewId InvcItemViewId RowType (STYLE, SKU, INVC, RCPT) StagedPayloadId
Discrepancy Review List	Discrepancy List Contextual Area	suppSiteEventBindi ng	When a user clicks in a row in the search results table.	siteId (supplier site) sessionId lang locale accessibility
Discrepancy Review List	Discrepancy List Contextual Area	qtyEventBinding	When a user clicks in a row in the search results table.	workspaceId discViewId sessionId item lang locale accessibility

A-15

Appendix A Contextual Parameters

Workflow	Contextual Model Name	Action Type	Event Description	Parameters
Discrepancy Review List	Discrepancy List Contextual Area	costEventBinding	When a user clicks in a row in the search results table.	workspaceId discViewId sessionId item lang locale accessibility
Summary Match - Invoice Summary Match	Summary Match Contextual Area	SummaryTolerance Range	When a user clicks on an item in the table in Summary Match.	siteId (supplier site) sessionId workspaceId stagedPayloadId lang locale accessibility
Summary Match - Invoice Summary Match	Summary Match Contextual Area	supplierSiteEvent	The user enters the Summary Match screen.	siteId (supplier site) sessionId stagedPayloadId lang locale accessibility

Allocation

Workflow	Contextual Model Name	Action Type	Event Description	Parameters
Allocation Maintenance (What-if Allocation only)	Allocation Maintenance Contextual Area	itemSourceSelectio nEvent	The user selects a row in the Review table	sessionId allocId item diff1 diff2diff3diff4
Allocation Maintenance	Allocation Maintenance Contextual Area	itemLocSelectionEv ent	The user selects a row in the Location table	sessionId location item diff1 diff2 diff3 diff4

A-16

Appendix A Contextual Parameters

Workflow	Contextual Model Name	Action Type	Event Description	Parameters
Allocation Maintenance	Allocation Maintenance Contextual Area	itemForcastSelectio nEvent	The user selects a row in the Location table	sessionId item diff1
				diff2 diff3
				diff4
				location
				locType

A-17

---

In this guide

• Guide: Merchandising Cloud Services Customization and Extension Guide
• Previous: 8 Using BI Publisher for Custom Reports