Automatic Redirects
Automatic redirects ensure that URLs within a Heretto Portal environment are stable when content is updated and reorganized. Automatic redirects are supported only in manual deployments v4.
Automatic redirects are enabled by default for each manual deployment. As a result, when content is restructured, for example, files are moved or renamed, URLs in Heretto Portal remain stable. Automatic redirects are maintained for a page for 18 months since its publication to portal.
It is possible to disable this feature and delete any redirects previously saved for a deployment. This option is especially useful to teams who are implementing Heretto Portal or need to perform major content restructuring and don't want redirects to be recorded. For more information, see Disable Automatic Redirects for a Deployment.
Important Considerations
Automatic redirects are supported only in the next generation manual deployments (v4); they are not supported in active sync deployments.
Automatic redirects use UUIDs assigned to topics and the IDs of elements like
sitesection,topichead, andversionto redirect users. UUIDs are assigned to topic automatically. IDs need to be set manually in theidattribute to elements in maps.Automatic redirects require the
idattribute to be set in thesitesection,topichead, andversionelements. If theidattribute is missing, automatic redirects will not work.Automatic redirects do not support a situation when the UUID of a topic changes.
Automatic redirects do not support URLs to pages with API specifications. For example, if you replace a JSON file with API specifications with a new one, portal will not automatically redirect to new pages, even if the file has the same name. For more information about publishing API specifications, see Heretto API Docs.
Automatic redirects do not support URLs to pages with API specifications if an API method moves from one JSON file to another. For example, when a JSON file is edited in Heretto CCMS to remove a method, then that method is added to a different JSON file in the CCMS.
Automatic redirects do not support redirects between different portal environments. For example, when moving from a current documentation portal to Heretto Portal.
Peer links are not part of this feature. For more information, see URL (Peer Links).
If set up, manual redirects override automatic redirects.
Disable Automatic Redirects for a Deployment
Users assigned the Administrator role in Heretto CCMS can disable automatic redirects for deployments. Disabling automatic redirects also removes any previously recorded URL history for a deployment.
We recommend disabling automatic redirects in all deployments when you are in the implementation phase and make frequent, significant changes in content. We recommend re-enabling automatic redirects in all deployments before going live with a portal implementation.
- In the top-left corner, click the Main Menu
and go to Deployments.
Any URL history that has been recorded for the deployment has been deleted and automatic redirects are now disabled. If a page URL changes and any users had the old URL saved, they won't be redirected to the new URL and will see a 404 error instead.