EbsRouter.callRoute

One of the location hashes available in Single Page Application mode.

"#/userjourney" | "#/entityform" | "#/customform"

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 wish to edit some specific attributes of a record. For this purpose, we will open the relevant step in the entity's default editing form for that record.

• The location hash for the page is #/userjourney.
• We store the page's identification information in the myState variable.
• The name of the form's source entity is myEntity.
• The record ID is efed27b8-99ab-4b08-9691-e8e0ea139985.
• The name of the form is default.
• The form is in edit mode.
• The step number is 2 (the third step of the form).

var myState = {routeData: {​​
    entityName: "myEntity",​​
    formId: "efed27b8-99ab-4b08-9691-e8e0ea139985",​​
    formName: "default",​​
    pageNo: "2",
    type: "edit"}
};

EbsRouter.callRoute('#/userjourney', myState)