Topics Map > Documents Tab

KB User's Guide - Documents Tab - Redirect a document via the "See also" field

This document describes how the "See also" field can be used to create a redirect from an inactive document to point users to another active document.

This feature is useful in cases where you want to make sure that users who try to access an inactive document (through saved bookmarks, links from other websites, etc) are able to find more current information. For example, perhaps you want to explain why the old documentation is no longer available, or you have a new document that has effectively replaced it.

Setting a Redirect

  1. In the KB Admin Tools, edit the document that you are planning to deactivate.

  2. In the See also field, enter the ID number of the document you would like to redirect to, and delete any other ID numbers that may already be present.

    Screenshot showing See also field (found between the Other Notes and Topics section) with a single document ID number entered.
  3. In the Expiration field, click on the Never link to set the expiration date of the obsolete document to 3000-01-01 00:00:00.

    Screenshot showing the Expiration field set to 3000-01-01 00:00:00, with the "Never" link to the right of the field highlighted
  4. Set the document Status to Inactive.

  5. Click on the Submit button to save your changes.

Check the Redirect on the Live Site

On the Live Site, (attempt to) open the document that has been deactivated by entering the Document ID into the search field. The system will check to see if this inactive document has a document ID number in the "See also" field. Next, the KB System verifies that the redirected document is Active, to prevent potential infinite loops. Your link may appear to "jump" to a different but related document. The word "redirect" will appear in the URL.

In the image below, the obsolete document redirected to a document with the ID of XXXXXX. Of course, your updated Document ID number will appear in the place of the XXXXXX.

URL bar showing a KB document link with the document number and redirect circled in red

Keywordsobsolete trash trashed Inactive deactivated redirect route rout routed routing info outdated url address forward prevent broken link guide refer location retiredDoc ID52086
OwnerLeah S.GroupKB User's Guide
Created2015-06-08 16:14:21Updated2023-03-30 11:56:02
SitesKB User's Guide
Feedback  0   0