ebs.goToRoute

Contains the identification information of a page. The routeData property can take different forms, depending on the type of page (a list, a flow step, a custom form, etc.).

{
    routeData: IRouteListState | IRouteFormDrivenState | IRouteCustomActionState | IRouteBusinessTransactionsState | any;
}

Identification information specific to a list page.

{
    type?: string;
    mainHtmlId?: string;
    entityName: string;
    viewName?: string;
    menuItemContext?: string;
}

Identification information specific to a form or form driven flow page.

{
    formId?: string;
    type?: string;
    mainHtmlId?: string;
    entityName: string;
    defaults?: string;
    returnHash?: string | any;
    formName?: string;
    isUserJourney?: boolean;
    pageNo?: number|string;
    menuItemContext?: string;
}

Identification information specific to a custom form (also known as a custom flow). You can use either the form's unique identifier or name.

{
    customActionId?: string;
    customActionName?: string;
}

Identification information specific to a record's business workflow transitions list.

{
    type: "BW";
    formId: string;
    entityName: string;
    mainHtmlId?: string;
}

Optional configurations for backward compatibility, pop-up windows, and fallback routes.

{
    legacyUrl?: string;
    popup?: boolean;
    fallbackRoute?: EbsRouteName;
    defaultRoute?: EbsRouteName;
}

In this example, we navigate o a specific entity view in single page application mode, while maintaining the current route and saving the navigation step in the browser's history:

• The name of the entity is myEntity.
• The name of the view is default.
• We store the identification information of the view in the routeData constant.
• We store the identification information of the page (state) in the routeState constant.

 const routeData:IRouteListState = { entityName: myEntity, type: list, viewName: default };
 const routeState:IRouterState = { routeData };
 ebs.goToRoute(routeState)

In this example, we navigate o a specific entity view in legacy mode while maintaining the current route and not saving the navigation step in the browser's history:

• The name of the entity is myEntity.
• The name of the view is default.
• We use the ebs.getListNavigationUrl function to retrieve the navigation URL of the entity view and store it in the legacyUrl constant.

const legacyUrl = ebs.getListNavigationUrl(myEntity, default);
ebs.goToRoute(routeState, {legacyUrl}, true);