Lobby Navigation Guideline

Contents

• Navigation setup of lobbies in Aurena
• Supported navigation parameters
• Placeholder types in lobby navigation
• Lobby navigation for different UI elements
• Passing page parameters when navigating into a lobby page from a lobby element
• Handling 'NULL' or empty values for filtering in the URL
• Setting up complex logic
• Enumerations
• Appendix

Navigation Setup of Lobbies in Aurena

Navigation from an element is setup in the element designer.

Open theLobby Element Designer and select an element. The Navigation settings can be set in the Navigation section

Figure 1:Navigation Properties

Navigation in IFS EE is set through URL Address

Navigation in Aurena is set through Web Acess URL Address.This setting is available only for elements of type Aurena or Aurena B2B. Change the element type by selecting a Client type in Layout settings.

Figure 2: Select client type in layout properties

Aurena Navigation URL

The URL path will depend on the type of the navigation.

Figure 3: Aurena URL Path

Hint: To help construct the navigation link go to the destination page and view the path from the URL in the browser. For further assistance for construing the navigation link with fitter parameters, use the Page Search to filter the data intended to be viewed on the page and use the ‘Copy link’ option.

Figure 4: Copy link from filtered page

Supported Navigation Parameters

Note: If you are using more than one parameter for the same navigation, the parameters should be separated using ‘&’.

Example:  page/PlanningUnitsAnalysis/List?contexts=Company:$Company$&$filter=BusinessPlanId eq $BUSINESS_PLAN_ID$

Place Holders for Lobby Navigation

It is possible to use parameters in the filter conditions to populate data in the destination page after navigation. Following are the types of placeholders supported by framework used in Lobby and general navigation between pages in Aurena

Page Parameters ($PLACEHOLDER$)

Include page parameters values of the Lobby page.

Example:  page/CustomerInstallmentsAnalysis/List?$filter=CustomerId eq $CustomerId$

Data Values ($[PLACEHOLDER])

Include data values of the element

Example: page/PlanningUnitsAnalysis/List?$filter=OrderNo eq $[ORDER_NO]

       CSV (Context Substitution Variable) (#PLACEHOLDER#)

Include CSV values.

Example: page/PlanningUnitsAnalysis/List?$filter=MainRepresentativeId eq #USER_ID#

NOTE: CSV value formats for dates can be found in Appendix B.

 Lobby Navigation For Specific UI Elements

Following are some element specific examples on how the Web Access URL Address can be constructed for Aurena pages.

Passing Page Parameters When Navigating from a Lobby Element to a Lobby Page

By default all common parameters with filled values upon navigation will be transferred to the destination lobby. If it is needed to customized use the pageParams URL parameter to map the page parameters of the source lobby to the page parameters of the destination lobby. Using the pageParams overrides the default behavior hence all mapping needs to be specified under pageParams mapping. 

Example:

Figure 4: Datasource Designer

URL Navigation: Mapping different page parameters between lobby pages

Figure5: Web access URL Navigation

In this example ‘COMPANY’ page parameter should be there on both pages

Handling 'NULL' or Empty Values for Filtering in the URL

If the user wants to send null values in the URL the page parameter should be filled using <> symbol. Framework replaces this symbol with ‘null’ in the navigation parameter.

Figure 7: Passing NULL for page parametersI

Example: page/TreeControllers/CustomerPage?$filter=Country eq ‘SWEDEN’ and CustomerNo eq null 

This filter returns a set of customers whose country is Sweden and has no value for set in the field customer number. 

If the value is left empty it is interpreted as the user does not wishes to filter using the parameter.

When navigating the filter segment containing the page parameter placeholders will be dropped.  

Example: page/TreeControllers/CustomerPage?$filter=Country eq ‘SWEDEN’

Setting Up Complex Logic

Including complex logic in to the navigation could result in unexpected results.

Other supported URL examples can be found in Appendix C.

Enumerations

 When using enumeration values in filter conditions, full qualified name must be used, like the advanced search.

Eg: - $filter = Objstate eq  IfsApp.ActivityListHandling.ActivityState'Planned'

Due to the fact that SQL Lobby sources are using Views and Aurena Pages are using Projections, it's not always possible to create a one to one mapping between those two. This becomes apparent when trying to use enumerations values from the datasource in filter conditions to Aurena pages. In the view there are two values for enumerations: a client value and a database value (having suffix _DB). The Aurena page expects a projection value, which is a third value not present in the view. Sometimes it corresponds to the client value, sometimes to the database value, but sometimes to none of them. This can be checked by going to the Aurena page and performing queries and examining filter conditions. In cases where the expected value doesn't match neither client or database value, the filtering can be solved by adding a column with a mapping to the lobby datasource. This column would look like this example:

decode(MRP_TYPE_DB, 'BY_SITE', 'MrpBySite', 'BY_SELECTION', 'MrpBySelection' ...

It needs to be created manually and it will contain a mapping between DB values and projection values and can be used for filter conditions for Aurena pages.

APPENDIX

Appendix A: Supported $filter query options for Lobby navigation in Aurena

Figure A1: Query Options

* Link to OData documentation lobby element.for $filter query options; OData Documentation>>

* The client renders the URL syntaxes defined in the

Appendix B: CSV (Context Substitution Values) for Dates

Following are the date related CSV (Context Substitution Variable) values for searching dates available in Aurena so far;

#TODAY#, #TOMORROW#, #YESTERDAY#

 Example: #START_OF_THIS_YEAR#, #END_OF_NEXT_WEEK#

It is possible to add, deduct dates from date defined by the CSV value. When using the dropdown, labels are shown as ‘Today’, ‘Start of this month’, etc. but the relevant CSV value will be used in search after picking it from the dropdown.

Scenario: In range (Due Date): #START_OF_THIS_MONTH# to #END_OF_THIS_MONTH#+7

Advanced: DueDate >= ‘#START_OF_THIS_MONTH#’ AND DueDate <= ‘#END_OF_THIS_MONTH#+7’

Example: page/TaxCodes/List?$filter=ValidFrom eq '#TODAY#+2] 

page/TaxCodes/List?$filter=(ValidFrom ge '#START_OF_THIS_YEAR#' and ValidFrom le '#END_OF_THIS_YEAR#-21')

Appendix C: Supported URL Examples for $FILTER

Notes:

·         In some cases, same filtering achieved using some SQL expressions can be achieved using odata filter as well even though there is no direct mapping between the syntaxes.