Transitions to a Tecton or Platform feature.
The navigateTo capability transitions the page to the Tecton or Platform-level feature passed as an argument. If navigating to a Tecton feature, a specific module within that feature can be passed as the second argument.
If a module name is not provided for a Tecton feature, the capability will find and navigate to the module with the primary key set to true. Additionally, if the module's configuration has the navigable property set to false, the capability will do nothing. As a result, it may be helpful to check if a module is navigable via the isNavigable capability so you can provide an alternative workflow if necessary.
Using navigateTo with the ssoDirect route requires a navigation node to be in place for the SSO. The UUX platform uses the setup from the navigation option to determine how to open the SSO and whether disclaimer or PDF acceptance is required before opening. The required navigation node can be hidden from display. Please submit a SDK Support ticket for assistance with adding these required navigation elements.
// type for passing multiple arguments
function navigateTo(featureName: string, moduleName?: string, urlParams?: any[], queryParams?: Dict<any>): void;
// type for passing arguments as an object
function navigateTo(options: {featureName: string, moduleName?: string, urlParams?: any[], queryParams?: Dict<any>}): void;To generate arguments for use in navigateTo(), log in and go to the desired page. Once there, execute the following line of code in the browser console to get the current route's attributes:
The following code is only available at the UUX platform level as of UUX 4.6.1.10.
Do not include it in any module code. This is a private lookup for informational purposes only.
window.getUUXRouteInfo()
The output in the console will look something like this:
// example: 'landingPage'
{featureName: 'landingPage', queryParams: {}, urlParams: []}
// example: 'account' page - details tab
{featureName: 'account', queryParams: {currentTab: 'details'}, urlParams: ['5009']}
You can either transfer the returned data by hand, or copy the output to your clipboard by executing copy(window.getUUXRouteInfo()). Paste the copied data as the argument for navigateTo(), and you will have a properly configured argument for navigating to your desired page!
Pre-UUX 4.6.1.10 Tips:
If you are on an older version of UUX, you can deduce the parameters from your URL address bar.
The first URL parameter after /uux.aspx# is key to understanding if you are in a Tecton or Platform feature.
/extension means you are in a Tecton feature/extension means you are in a Platform featureIf you are in a Tecton feature, the next two path parameters typically match the pattern of /<featureName>/<moduleName>. These values can be used in their corresponding arguments for the navigateTo() capability.
/<featureName>/<moduleName> parameters are considered queryParams for the navigateTo() capabilityqueryParams in the URL of a Tecton feature might be URL Encoded. You will have to decode those values to match the Javascript object structure expected for the queryParams argument in navigateTo()urlParams when navigating to a Tecton featureIf you are in a Platform feature, the next parameter following the uux.aspx# typically corresponds to the value used in featureName.
uux.aspx#/settings indicates the featureName is 'settings'Depending on the Platform feature, the next URL parameters after the feature will either be period-separated additions to the value of featureName, or they are to be passed as values in the urlParams array
/settings/profile would be translated to featureName: 'settings.profile'/account/5006 would be translated to featureName: 'account', urlParams: ['5006']Query Parameters follow a common pattern regardless of the feature and typically:
&)symbol'true' under the hood in the online banking applicationOne exception to these common patterns is with NLP navigation pages in UUX. The query parameter in the URL address likely begins with ?tectonRoute=, and the value begins with a URL encoded, period-separated string. The last value of that period-separated string is the first key of your queryParams object. For example, tectonRoute=%7B"tecton.MyExtension.Main.PageConfigs"%3A%20%7B"pageShortName"%3A%20%22"myPage"%22%7D%7D would be used as queryParams: { PageConfigs: { pageShortName: "myPage"} in the navigateTo() capability. See below for more examples.
Here are some examples of the different ways to use navigateTo():
tecton.actions.navigateTo('FundsTransferEdit', ['15432']);
tecton.actions.navigateTo('GoalBasedSavings', 'create', {category: 'rainyday'});// navigates to a Tecton extension
tecton.actions.navigateTo({
featureName: 'FundsTransfer',
moduleName: 'Main',
urlParams: ['123'],
queryParams: {isRecurring: true}
});
// navigates to a NLP page
tecton.actions.navigateTo({
featureName: 'AlternativeNavigationTCT_applynow',
moduleName: 'Main',
queryParams: {
PageConfigs: {
pageShortName: 'applynow',
sections: [
'nlpSectOffers',
'nlpSectApplyforLoan',
'nlpSectOnlineAccountOpening',
'nlpSectJointheTeam'
],
filterExists: "true"
}
}
});
In this example, the navigateTo method’s featureName parameter is provided a value of “landingPage”. You can observe the change to the URL as well as the page content when the user clicks on the button associated with the navigation event.
Captured on UUX version 4.6.0.10A.
Unique name of a feature that can be a Tecton feature or Platform feature
Supported only for Tecton features
Specifies which module within a feature to navigate to.
Not supported in Tecton features.
Used for Platform features whose routes rely on url (path) parameters. This is an array of parameters.
Initial Release