Show TOC

App Extensibility: Order ProductsLocate this document in the navigation structure

Use

You can extend the Order Products app according to your business needs for different aspects. For this purpose, the following extensibility options are available:

  • Add Customer Fields

    You can extend the app by adding new customer fields.

  • Extend the content in all views

    You can extend the app by adding further fields in views: order product, product detail and select store.

  • Replace the content in all views

    You can extend the app by replacing the whole content in views: order product, product detail and select store.

Add Customer Fields

To add a customer field to the app, the extensibility entities listed below are available on the different software layers. You have to extend each of these entities according to your specific business needs:

UI

Back End/ABAP

View

Extension Point

Design Time: Gateway Entity

Design Time: Extension Include (in DDIC Structure)

Runtime: BAdI to be implemented

StoreList.view.xml

storeAttributeExtension

Store

RTST_OP_S_STORE_INCL

BADI_RTST_OP_STORE

ProductList.view.xml

pageHeaderExtension

productTableColumnExtension/

productTableCellExtension

StoreProduct

RTST_OP_S_STORE_PRODUCT_INCL

BADI_RTST_OP_STOREPRODUCT

productAttributesExtension

productQuantitiesExtension

productOrderQuantityExtension

ProductDetails.view.xml

pageHeaderExtension

productAttributesExtension

orderQuantityVBoxExtension

quantitiesFormExtension

calendarPanelExtension

priceDetailsFormExtension

calendarColumnExtension/

calendarCellExtension

StoreProductWeek

RTST_OP_S_STORE_PROD_WEEK_INCL

BADI_RTST_OP_STOREPRODWEEK

Controller Hook: extHookSetAdditionalPromotionContent

StoreProductRetailPromotion

RTST_OP_S_STR_PROD_PROMO_INCL

BADI_RTST_OP_RETAILPROMOTION

Further Extensibility Entities

Business Add-Ins (BAdIs)

The following BAdIs are available for extensibility purposes:

  • Enhancements for Application Log (BADI_RTST_OP_APPL_LOG)

    You can use this BAdI to change the messages to be persisted in the application log.

  • Enhancement for Entity Filter of Retail Store Order (BADI_RTST_OP_FILTER)

    You can use this BAdI to enhance the filter.

  • Enhancement for Entity FilterValue of Retail Store Order (BADI_RTST_OP_FILTERVALUE)

    You can use this BAdI to implement an own handler for the FilterValue entity or to enhance the filter values with individual filters.

  • Enhancement for Entity StoreProductRetailPromotion (BADI_RTST_OP_RETAILPROMOTION)

    You can use this BAdI to implement an own handler for Promotion entity.

  • Enhancement for Entity Store of Retail Store Order Product (BADI_RTST_OP_STORE)

    You can use this BAdI to enhance the Store entity.

  • Enhancement for Entity StoreProduct of Retail Store Order Product (BADI_RTST_OP_STOREPRODUCT)

    You can use this BAdI to enhance the product for a store.

  • Enhancement for Entity StoreProductWeek of Retail Store Order Product (BADI_RTST_OP_STOREPRODWEEK)

    You can use this BAdI to enhance the entity StoreProductWeek.

  • Enhancement for Entity StoreWeekDisplay of Retail Store Order Product (BADI_RTST_OP_STOREWEEKDISPL)

    You can use this BAdI to implement an own handler for the StoreWeekDisplay entity for example to enhance the display of the weeks for the calendar tool.

  • Enhancement for Entity User of Retail Store Order Product (BADI_RTST_OP_USER)

    You can use this BAdI to implement an own handler for the User entity.

For more information about the BAdIs, see Customizing for Order Products under Start of the navigation path Logistics – General Next navigation step SAP Retail Store Next navigation step In-Store Merchandise and Inventory Management – UI5 Apps Next navigation step Order Products End of the navigation path

Extension Includes

The following extension includes are available for the Gateway Entities:

DDIC

Extension Include

Use

RTST_OP_S_FILTER

RTST_OP_S_FILTER_INCL

Allows you to add new fields to the entity Filter

RTST_OP_S_FILTER_VALUE

RTST_OP_S_FILTER_VALUE_INCL

Allows you to add new fields to the entity Filter Value

RTST_OP_S_RETAIL_PROMOTION

RTST_OP_S_RETAIL_PROMO_INCL

Allows you to add new fields to the entity Promotion

RTST_OP_S_STORE

RTST_OP_S_STORE_INCL

Allows you to add new fields to the entity Store

RTST_OP_S_STORE_PRODUCT

RTST_OP_S_STORE_PRODUCT_INCL

Allows you to add new fields to the entity Store Product

RTST_OP_S_STORE_PRODUCT_GR

RTST_OP_S_STR_PROD_GR_INCL

Allows you to add new fields to the Goods Receipt Related Properties

RTST_OP_S_STORE_PRODUCT_MASTER

RTST_OP_S_STR_PROD_PRODCT_INCL

Allows you to add new fields to Product Property

RTST_OP_S_STORE_PRODUCT_ORDER

RTST_OP_S_STR_PROD_ORDER_INCL

Allows you to add new fields to Order (Proposal) related properties

RTST_OP_S_STORE_PRODUCT_PRICE

RTST_OP_S_STR_PROD_PRICE_INCL

Allows you to add new fields to Price related properties

RTST_OP_S_STORE_PRODUCT_PROMO

RTST_OP_S_STR_PROD_PROMO_INCL

Allows you to add new fields to Promotion related properties

RTST_OP_S_STORE_PRODUCT_STOCK

RTST_OP_S_STR_PROD_STOCK_INCL

Allows you to add new fields to Stock related properties

RTST_OP_S_STORE_PRODUCT_WEEK

RTST_OP_S_STORE_PROD_WEEK_INCL

Allows you to add new fields to entity Week

RTST_OP_S_STORE_PROD_WEEKDAY

RTST_OP_S_STOREPROD_WKDAY_INCL

Allows you to add new fields to the complex type Store Product Weekday

RTST_OP_S_STORE_WEEK_DISPLAY

RTST_OP_S_STORE_WEEK_DISP_INCL

Allows you to add new fields to the entity Store Week Display

RTST_OP_S_USER

RTST_OP_S_USER_INCL

Allows you to add new fields to the entity User

If there are additional fields available in the OData service, you can display these fields on the UI. For more information, see the extensibility documentation for the respective SAP NetWeaver release on your front-end server at http://help.sap.com/fiori_implementation Start of the navigation path Extensibility Information for SAP Fiori Next navigation step Extending the UI Layer Next navigation step UI Extensibility Workflow Next navigation step  Next navigation step Checking the SAP-Enabled Extension Options Next navigation step Extension Points End of the navigation path.

Extension Points

The following view extension points are available in the UI:

View

Extension Point

Use

ProductList.view.xml

pageHeaderExtension

Allows you to extend the page header.

ProductList.view.xml

productTableColumnExtension

Allows you to extend existing columns with a new column.

ProductList.view.xml

productTableCellExtension

Allows you to extend the table cell content of the newly added column.

ProductList.view.xml

productAttributesCellReplacement

Allows you to replace the content.

ProductList.view.xml

productAttributesGTINReplacement

Allows you to replace the GTIN

ProductList.view.xml

productAttributesExtension

Allows you to extend further attributes in the first column

ProductList.view.xml

productOrderQuantityCellReplacement Tablet

Allows you to replace the cell content.

ProductList.view.xml

productOrderQuantityCellReplacement

Allows you to replace the cell content.

ProductList.view.xml

productOnPromotionCellReplacement

Allows you to replace the cell content.

ProductList.view.xml

productCurrentQuantityCellReplacement

Allows you to replace the cell content.

ProductList.view.xml

productExpectedQuantityCellReplacement

Allows you to replace the cell content.

ProductList.view.xml

productPushQuantityCellReplacement

Allows you to replace the cell content.

ProductList.view.xml

productQuantitiesCellReplacement

Allows you to replace the cell content.

ProductList.view.xml

productQuantitiesExtension

Allows you to extend the cell content of column ProductQuantitieswith further product attributes.

ProductList.view.xml

productOrderQuantityExtension

Allows you to extend the cell content of column ProductOrderQuantities with further product attributes.

View

Extension Point

Use

ProductDetails.view.xml

pageHeaderExtension

Allows you to extend the header cell with further attributes.

ProductDetails.view.xml

productOrderHeaderProductAttributesReplacement

Allows you to replace the cell content of the whole product attributes screen area.

ProductDetails.view.xml

productOrderHeaderGTINReplacement

Allows you to replace the GTIN in the product attributes by other attributes.

ProductDetails.view.xml

productAttributesExtension

Allows you to extend the cell content of product attributes in the header with further fields.

ProductDetails.view.xml

productOrderHeaderOrderQuantityReplacement

Allows you to replace the cell content of the whole order quantity screen area.

ProductDetails.view.xml

orderQuantityVBoxExtension

Allows you to extend the cell content of the order quantity screen area with further attributes.

ProductDetails.view.xml

productOrderQuantitiesGridReplacement

Allows you to replace the second screen area content with your own design.

ProductDetails.view.xml

quantitiesFormExtension

Allows you to extend the second screen area content with further attributes/fields.

ProductDetails.view.xml

calendarPanelExtension

Allows you to extend the Sales History/Expected Deliveries area with further fields

ProductDetails.view.xml

calendarColumnExtension

Allows you to extend a new column at the end of the calendar area.

ProductDetails.view.xml

calendarCellExtension

Allows you to extend the calendar cell content of the newly added column.

ProductDetails.view.xml

calendarCellCWReplacement

Allows you to replace the cell content of the first column of the calendar (CalendarWeek) with your own design.

ProductDetails.view.xml

priceDetailsFormExtension

Allows you to extend the last screen area with the price details.

View

Extension Point

Use

StoreList.view.xml

storeAttributeListItemReplacement

Allows you to replace an attribute list item.

StoreList.view.xml

storeAttributeExtension

Allows you to extend attributes behind the store address.

View

Extension Point

Use

FooterContent.fragment.xml

footerBarReplacement

FooterContent.fragment.xml

footerBarButtonReplacement

Allows you to replace the whole footer bar.

FooterContent.fragment.xml

AfooterBarExtension

Allows you to extend the footer bar with further buttons.

If there are additional fields available in the OData service, you can display these fields on the UI. For more information, see the extensibility documentation for the respective SAP NetWeaver release on your front-end server at http://help.sap.com/fiori_implementation Start of the navigation path Extensibility Information for SAP Fiori Next navigation step Extending the UI Layer Next navigation step UI Extensibility Workflow Next navigation step  Next navigation step Checking the SAP-Enabled Extension Options Next navigation step Extension Points End of the navigation path.

UI Controller Hooks

To plug in and execute custom code, the following hooks are available in the controller code:

Controller

Hook

Use

ProductList.controller.js

extHookGetDisableInitialFiltering

Allows you to disable initial filtering.

ProductList.controller.js

extHookGetEnableProductExpand

Allows you to enable direct product details read.

ProductList.controller.js

extHookGetGrowingThreshold()

Allows you to provide growing threshold for product table.

ProductList.controller.js

extHookOnScanButtonPress

Allows you to react on scan button.

ProductList.controller.js

extHookAddActionSheetButtons

Allows you to add buttons to the action sheet.

ProductList.controller.js

extHookOnScanButtonPress({object} oEvent)

Allows you to react on scan button.

ProductList.controller.js

extHookAddActionSheetButtons

Allows you to add buttons to the action sheet.

ProductList.controller.js

extHookSetAdditionalPromotionContent

Allows you to provide additional promotion fields.

ProductList.controller.js

extHookProvideCalendarCellFragmentPath

Allows you to provide the path to a modified calendar cell fragment.

If there are additional UI controller hooks available in the controller code, you can add own code. For more information, see the extensibility documentation for the respective SAP NetWeaver release on your front-end server at http://help.sap.com/fiori_implementation Start of the navigation path Extensibility Information for SAP Fiori Next navigation step Extending the UI Layer Next navigation step UI Extensibility Workflow Next navigation step  Next navigation step Checking the SAP-Enabled Extension Options Next navigation step UI Controller Hooks End of the navigation path.

UI Utility Class Hooks

To plug in and execute custom code, the following hooks are available in the utility class code:

Class

Hook

Use

Calendar Utility

addAdditionalCustomDataForWeekday

Allows you to add custom data for the calendar cells in product detail

Data Change Utility

repdigitCheckEnabled

Allows you to enable the predefined repdigit check.

Data Change Utility

orderQuantityHardErrorCheck

Allows you to perform an order quantity check which leads to an error.

Data Change Utility

orderQuantitySoftCheck

Allows you to perform an order quantity check which leads to a warning.

Data Change Utility

getMaxOrderQuantity

Allows you to get the maximum allowed order quantity.

Scan Utility

isMerchandiseCategorySelectionEnabled

Allows you to enable the automatic merchandise category filter selection.

Scan Utility

selectAdditionalFilterItems

Allows you to select additional filters based on a scanned product.

Scan Utility

isAutomaticGTINProcessingEnabled

Allows you to enable the automatic GTIN processing in the scan popup.

Facet Filter Utility

getPersEnablementForFilterID

Allows you to specify the personalization of filter values.

If there are additional UI controller hooks available in the controller code, you can add own code. For more information, see the extensibility documentation for the respective SAP NetWeaver release on your front-end server at http://help.sap.com/fiori_implementation Start of the navigation path Extensibility Information for SAP Fiori Next navigation step Extending the UI Layer Next navigation step UI Extensibility Workflow Next navigation step  Next navigation step Checking the SAP-Enabled Extension Options Next navigation step UI Controller Hooks End of the navigation path.

Display of UI Controls

The following UI controls can be hidden on the app UI:

View

Control ID

Use

Main.view.xml

fioriContent

App

CalendarCell.fragment.xml

orderProductsButtonScan

VBox

FooterContent.fragment.xml

orderProductsButtonScan

Button

FooterContent.fragment.xml

orderProductsButtonAdd

Button

FooterContent.fragment.xml

orderProductsButtonLess

Button

FooterContent.fragment.xml

orderProductsButtonAction

Button

ProductDetails.view.xml

orderProductsDetailsPage

Page

ProductDetails.view.xml

orderProductsButtonUp

Button

ProductDetails.view.xml

orderProductsButtonDown

Button

ProductDetails.view.xml

orderProductsHBoxHeader

HBox

ProductDetails.view.xml

orderProductsVBoxProduct

VBox

ProductDetails.view.xml

orderProductsOHProduct

ObjectHeader

ProductDetails.view.xml

orderProductsObjAttrGlobalTradeItemNumber

ObjectAttribute

ProductDetails.view.xml

orderProductsObjAttrUnitConv

ObjectAttribute

ProductDetails.view.xml

orderProductsObjAttrPromotion

ObjectAttribute

ProductDetails.view.xml

orderProductsVBoxQuantity

VBox

ProductDetails.view.xml

orderProductsInputOrderQuantity

Input

ProductDetails.view.xml

orderProductsTextOriginalQuantity

Text

ProductDetails.view.xml

orderProductsHBoxPrice

HBox

ProductDetails.view.xml

orderProductsIconPromotion

Icon

ProductDetails.view.xml

orderProductsObjNumberPrice

ObjectNumber

ProductDetails.view.xml

orderProductsGridQuantities

Grid

ProductDetails.view.xml

orderProductsFormQuantities

SimpleForm

ProductDetails.view.xml

orderProductsLabelOrderQuantity

Label

ProductDetails.view.xml

orderProductsTextOrderQuantity

Text

ProductDetails.view.xml

orderProductsLabelStock

Label

ProductDetails.view.xml

orderProductsTextStock

Text

ProductDetails.view.xml

orderProductsLabelPushQuantity

Label

ProductDetails.view.xml

orderProductsTextPushQuantity

Text

ProductDetails.view.xml

orderProductsLabelExpiration

Label

ProductDetails.view.xml

orderProductsTextExpiration

Text

ProductDetails.view.xml

orderProductsPanelCalendar

Panel

ProductDetails.view.xml

orderProductsTextCalendarMonth

Text

ProductDetails.view.xml

orderProductsTableCalendar

Table

ProductDetails.view.xml

orderProductsColumnCW

Column

ProductDetails.view.xml

orderProductsColumnDayOne

Column

ProductDetails.view.xml

orderProductsColumnLabelDayOne

Label

ProductDetails.view.xml

orderProductsColumnDayTwo

Column

ProductDetails.view.xml

orderProductsColumnLabelDayTwo

Label

ProductDetails.view.xml

orderProductsColumnDayThree

Column

ProductDetails.view.xml

orderProductsColumnLabelDayThree

Label

ProductDetails.view.xml

orderProductsColumnDayFour

Column

ProductDetails.view.xml

orderProductsColumnLabelDayFour

Label

ProductDetails.view.xml

orderProductsColumnDayFive

Column

ProductDetails.view.xml

orderProductsColumnLabelDayFour

Label

ProductDetails.view.xml

orderProductsColumnDaySix

Column

ProductDetails.view.xml

orderProductsColumnLabelDaySix

Label

ProductDetails.view.xml

orderProductsColumnDaySeven

Column

ProductDetails.view.xml

orderProductsColumnLabelDaySeven

Label

ProductDetails.view.xml

orderProductsCalendarListItem

ColumnListItem

ProductDetails.view.xml

orderProductsVBoxCW

VBox

ProductDetails.view.xml

orderProductsTextCW

Text

ProductDetails.view.xml

orderProductsGridPricingDetails

Grid

ProductDetails.view.xml

orderProductsFormPricingDetails

SimpleForm

ProductDetails.view.xml

orderProductsLabelRegularPrice

Label

ProductDetails.view.xml

orderProductsTextRegularPrice

Text

ProductList.view.xml

orderProductsListPage

Page

ProductList.view.xml

orderProductsSearchFieldProducts

SearchField

ProductList.view.xml

orderProductsFacetFilter

FacetFilter

ProductList.view.xml

orderProductsTableProducts

Table

ProductList.view.xml

orderProductsColumnProduct

Column

ProductList.view.xml

orderProductsColumnOrderTablet

Column

ProductList.view.xml

orderProductsColumnOnPromotion

Column

ProductList.view.xml

orderProductsColumnCurrentQuantity

Column

ProductList.view.xml

orderProductsColumnExpectedQuantity

Column

ProductList.view.xml

orderProductsColumnAllocatedQuantity

Column

ProductList.view.xml

orderProductsColumnQuantity

Column

ProductList.view.xml

orderProductsVBoxProductAttributes

VBox

ProductList.view.xml

orderProductsTextProductName

Link

ProductList.view.xml

orderProductsTextGlobalTradeItemNumber

Text

ProductList.view.xml

orderProductsTextPromotionLabel

Text

ProductList.view.xml

orderProductsHBoxOrderQuantityTablet

HBox

ProductList.view.xml

orderProductsInputOrderQuantityTablet

Input

ProductList.view.xml

orderProductsTextQuantityUnitTablet

Text

ProductList.view.xml

orderProductsTextUOMConversionTablet

Text

ProductList.view.xml

orderProductsTextCurrentQuantity

Text

ProductList.view.xml

orderProductsTextExpectedQuantity

Text

ProductList.view.xml

orderProductsTextPushQuantity

Text

ProductList.view.xml

orderProductsVBoxProductQuantities

VBox

ProductList.view.xml

orderProductsColumnQuantityHBoxOrderQuantity

HBox

ProductList.view.xml

orderProductsColumnQuantityTextOrderQuantity

Text

ProductList.view.xml

orderProductsColumnQuantityHBoxStockQuantity

HBox

ProductList.view.xml

orderProductsColumnQuantityTextStockQuantity

Text

ProductList.view.xml

orderProductsColumnQuantityHBoxRegularOrders

HBox

ProductList.view.xml

orderProductsColumnQuantityTextRegularOrders

Text

ProductList.view.xml

orderProductsColumnQuantityHBoxAllocationOrders

HBox

ProductList.view.xml

orderProductsColumnQuantityTextAllocationOrders

Text

ProductList.view.xml

orderProductsVBoxOrderQuantity

VBox

ProductList.view.xml

orderProductsInputOrderQuantity

Input

ProductList.view.xml

orderProductsTextQuantityUnit

Text

ProductList.view.xml

orderProductsHBoxUOMConversion

HBox

ProductList.view.xml

orderProductsTextUOMConversion

Text

ScanInput.fragment.xml

orderProductsInputScanPopup

Input

ScanInput.fragment.xml

orderProductsButtonScanPopupDone

Button

StoreList.view.xml

orderProductsStoreListPage

Page

StoreList.view.xml

orderProductsSearchFieldStores

SearchField

StoreList.view.xml

orderProductsListStores

List

StoreList.view.xml

orderProductsObjAttrStoreName

ObjectAttribute

StoreList.view.xml

orderProductsObjAttrFormattedAddress

ObjectAttribute

For more information about hiding UI controls, see the extensibility documentation for the respective SAP NetWeaver release on your front-end server at http://help.sap.com/fiori_implementation Start of the navigation path Extensibility Information for SAP Fiori Next navigation step Extending the UI Layer Next navigation step UI Extensibility Workflow Next navigation step  Next navigation step Checking the SAP-Enabled Extension Options Next navigation step Hiding UI Controls End of the navigation path.

More Information

For a general description of the extensibility options and procedures of SAP Fiori apps, see http://help.sap.com/fiori_implementation Start of the navigation path Extensibility Information for SAP Fiori End of the navigation path.