Redirect a reference to a page ID

  • Release version: Xanadu
  • Updated August 1, 2024
  • 1 minute to read
  • Redirect all references from Service Portal widgets to a certain page to point to a new page with a single record to avoid manually replacing the hard-coded page ID in widgets.

    Before you begin

    Role required: sp_admin

    About this task

    Multiple widgets in Service Portal may link to a single page using a hard-coded page ID. This process allows you to replace page references in widgets without locating and replacing all references to the page ID by cloning and updating each widget.

    To redirect all references to a page, create a record in the Page Route Maps table [sp_page_route_map]. This table enables you to redirect a reference to a page without cloning base system widgets.

    Creating a record in the Page Route Maps table only redirects references to a page. It does not redirect navigation to a page ID within a URL.

    Note:
    You don't need to create a page route map to redirect users to a 404 page. To specify the 404 page for your portal, update the 404 page field in the Portal [sp_portal] record.

    Procedure

    1. Navigate to All > Service Portal > Page Route Maps.
    2. Click New.
    3. On the form, fill in the fields.
      Field Description
      Short Description Optional short description to describe the redirect.
      Service Portal(s) Portals that apply the redirect. If you don't select a portal, the redirect applies to all portals in the instance.
      Route from Original page you are redirecting from.
      Route to Page you are redirecting to.
      Active Whether the Page Route Map record is active. The redirect only applies when the record is active.
      Order Priority of the Page Route Map record. If more than one active record has the same value in the Route from field, the record with the lowest order applies. The system evaluates records from lowest to highest. If multiple records have a matching order, the system honors the oldest record.
    4. Click Update.

    Result

    All references to the page listed in the Route from field redirect to the page in the Route to field.