Deep Linking
Deep Linking allows you to create buttons, links and actions for faster navigation across the application. For example, on a dashboard you can have a button, which opens a page with specific document, or vice versa - a quote item can have a link to a specific dashboard for analysis.
For example, in a DashboardController
, use addLink() to link to any page with the same frontend application:
def controller = api.newController()
controller.addLink('Customers', AppPages.MD_CUSTOMERS_PAGE, null)
controller.addLink('Customer Detail', AppPages.MD_CUSTOMERS_PAGE, 'CD-00001')
return controller
Use internal links tokens to link to any pages within the Pricefx frontend application — rather than hardcoded urls. This ensures that the link works even if the frontend application changes.
An internal link consists of three parameters:
label
The text that will be displayed to the end user.
targetPage
The page that the end user will be redirected to. For example, AppPages.MD_PRODUCTS_PAGE
leads to the products page that lists all the products. For supported values see routePage Values to Use in targetPage.
targetPageState
The state of the targetPage
, or a sub-page of the targetPage
. For example, targetPage=AppPages.MD_PRODUCTS_PAGE
and targetPageState=MB-00001
leads to the product detail page for the sku MB-00001
.
Found an issue in documentation? Write to us.