Breadcrumb is breaking on page refresh - Known Error

Breadcrumb is breaking on page refresh Description Breadcrumb navigation may not retain the navigation history after a page refresh within certain workspace experiences. While navigating within a workspace, the breadcrumb correctly reflects the navigation path. However, upon refreshing the page, the previously maintained navigation history may be lost and the breadcrumb may reset.

This occurs when a workspace experience uses navigation parameters that are not originally defined in the route configuration. During navigation, these parameters are carried forward and the breadcrumb trail is maintained. However, on page refresh, the parameters are parsed from the URL where they are not present since they were never part of the configured route. This inconsistency between navigation and page load causes the breadcrumb trail to break.

This behavior has been observed in workspaces such as Strategic Planning Workspace and Risk Workspace on instances running version XP9 and later.

Steps to Reproduce

This issue can occur in any workspace where navigation relies on parameters that are not defined as part of the route configuration. When such unconfigured parameters are used during navigation, the breadcrumb trail will be lost upon page refresh.

Example: Strategic Planning Workspace

1. Create an instance on XP9 or later. Install Strategic Planning 4.7.1 Snapshot from Plugins.

2. Navigate to Strategic Planning Workspace.

3. Create a Portfolio Plan.

4. Open the Goals Module.

5. Create a Goal from the Context Menu.

6. Click on Add Target and create a target.

7. Click on the Target and verify a side panel opens on the right side.

8. Click on Full Details.

9. Click on the Planning Items tab.

10. Click on the Add button.

11. Verify the breadcrumb trail is displayed correctly.

12. Refresh the page.

13. Observe that the breadcrumb trail is lost.

Note: This issue is also reproducible in the Risk Workspace following a similar navigation pattern.

Workaround Add the missing navigation parameters to the route configuration in UI Builder. This ensures the parameters are included in the URL during navigation, making them available on page refresh.

Note: The specific parameters that need to be added may vary depending on the workspace and route. Contact ServiceNow Support to identify the missing parameters for your workspace.

Example: Risk Workspace

1. Navigate to All > UI Builder.

2. Open Risk Workspace.

3. Search for the /record route.

4. Open the route's page settings.

5. In the URL parameters section, add the following as optional parameters:

query , and sysparmView 6. Save and verify that the breadcrumb trail persists after page refresh.

Example: Strategic Planning Workspace

1. Navigate to All > UI Builder.

2. Open Strategic Planning Workspace.

3. Search for the /record route.

4. Open the route's page settings.

5. In the URL parameters section, add the following as optional parameters:

For instances running versions prior to Zurich: add parentTable and parentRecordSysId . For instances running Zurich or later: add parentTable , parentRecordSysId , and sysparmView . 6. Save and verify that the breadcrumb trail persists after page refresh.