Short-Term Redirects
Short-term redirects should be created within AEM pages for only a short period of time, meaning only until the long-term, permanent redirects can be implemented within AEM Dispatchers and published in the next Prod launch.
In Language Masters
Redirect Due to a URL Change
No action is needed in Language Masters for a temporary redirect, but action will be needed once the permanent redirect goes live.
Redirect Due to Page Retirement
In Page Properties > Basic tab, edit the following:
- Edit the backend Title of the page to include "REDIRECT -" at the beginning. This naming convention lets other CMS Authors know that this page is now being redirected and is not currently active.
In Page Properties > Site Configuration tab, edit the following:
- Mark the page as "No Index" to remove the page from the sitemap.xml
- Check "Hide Page From Internal Search" to remove the page from Product Finder results, Global Search results, and Card Carousels using Dynamic Tag option
Roll the page out to Prod.
Please note: If you are redirecting a page in the EN site, assess whether the same type of redirect also needs to be implemented within the international sites.
In Prod
In Page Properties > Basic tab, edit the following:
- Break inheritance for the Title field
- Edit the backend Title of the page to include "REDIRECT -" at the beginning. This naming convention lets other CMS Authors know that this page is now being redirected and is not currently active.
- Break inheritance for the Tag field
- Remove any tags that should no longer be associated to the page
In Page Properties > Advanced tab, edit the following:
- Select redirect type (301, 302); assumption is that most will be 301 for permanent redirect
- Enter URL in field if redirect goes to a third party URL, or browse for an AEM page
In Page Properties > Site Configuration tab, edit the following, if this information has not been inherited from the language-master page:
- Mark the page as "No Index" to remove the page from the sitemap.xml
- Check "Hide Page From Internal Search" to remove the page from Product Finder results, Global Search results, and Card Carousels using Dynamic Tag option
Publish the page. Please note that temporary redirects will be functional only if they are created within the Prod version of the page.
Please note: If you are redirecting a page in the EN site, assess whether the same type of redirect also needs to be implemented within the international sites.
In Tags
Redirect Due to URL Change
No action is needed in Language Masters for a temporary redirect, but action will be needed once the permanent redirect goes live.
Redirect Due to Page Retirement
Find the tag that corresponds to the page to be redirected, if applicable, and edit its Tag Title to include "DEAD -" at the beginning, but do not publish it. This will be most applicable for product pages, solution/subpages, and industry/subsector pages. This DEAD naming convention lets other CMS Authors know that this tag should no longer be associated to pages because it will be deleted when the next Prod launch occurs.
Long-Term Redirects
Long-term, permanent redirects are created in AEM Dispatchers by TA Digital. These permanent redirects cannot be created/edited/deleted by CMS Authors because CMS Authors do not have access to AEM Dispatchers.
TA Digital would like for AVEVA to track all new redirects needed within one Jira ticket that gets created prior to each Prod launch.
When the next Prod launch is scheduled, TA Digital will implement all the needed redirects in AEM Dispatchers so AVEVA can do UAT on Stage. Once approved on Stage, the permanent redirects will be published in the next Prod launch.
After the Prod launch occurs, do the following:
In Language Masters
Redirect Due to a URL Change
Move the page to edit the URL.
Redirect Due to Page Retirement
Do one of the following:
- Delete the page if it is no longer needed (i.e., you do not anticipate needing the content again, and you do not need the English source for future translation needs in international sites)
- If you do delete the page in language-masters, you also need to delete it in Prod
- If you delete the page in the EN site, consider if the page should also be deleted in the interational sites; it many cases it should be
- If keeping the page, edit the Title in Page Properties > Basic tab to change "REDIRECT -" to "DEAD -" to help other CMS authors understand where the page is in its life cycle
In Prod
Redirect Due to a URL Change and Redirect Due to Page Retirement
- Remove the temporary redirect from the Page Properties > Advanced tab to avoid any conflicts with the redirects in AEM Dispatchers and to prevent performance issues on the website.
Not removing temporary redirects in Page Properties will result in a "too many redirects" error message for the pages that have the temporary redirects.
Redirect Due to Page Retirement
- Unpublish the page (do you have to publish page once to remove temporary redirect, and then Unpublish it?)
In Tags
Redirect Due to a URL Change
Edit the Tag Title and/or Tag Path per the Tag Management guidance.
Redirect Due to Page Retirement
Delete the DEAD tags,, and republish the pages per the Tag Management guidance.