Help25

Components Redirect Manager

From Joomla! Documentation

The Redirect Manager is a component that is accessed from the back-end of a Joomla! website. Its main function is to provide a mechanism to give an Administrator the ability to redirect the URL of a web page which no longer exists to a working web page. You must have the Use Apache mod_rewrite option enabled in your Joomla! installation Global Configuration options in order for the redirects you create to function.

How to access[edit]

  • Select Components → Redirect from the drop-down menu of the Joomla! Administrator Panel.

Description[edit]

This component is primarily used for redirecting URLs for web pages that no longer exist on your website to web pages that are working. The URL you want to redirect from must not be a working one on your website which actually loads a web page. It can be the URL to a web page which you have disabled in the Joomla! back-end administrator interface. The Source URL you specify when you create the redirect should be the full URL as you would type it in your web browser. The component will only display the last portion of the source URL in the redirect listing. The Destination URL you specify when you create a redirect must be the full URL as well. To work the component requires the redirect plugin to be active.

Screenshot[edit]

Help25-components-redirect manager-screen.png

Column Headers[edit]

Click on the column heading to sort the list by that column's value.

  • Checkbox. Check this box to select one or more items. To select all items, check the box in the column heading. After one or more boxes are checked, click a toolbar button to take an action on the selected item or items. Many toolbar actions, such as Publish and Unpublish, can work with multiple items. Others, such as Edit, only work on one item at a time. If multiple items are checked and you press Edit, the first item will be opened for editing.
  • Expired URL. The URL which is being redirected on your website. Only the web page portion of the URL is displayed in this listing.
  • New URL. The destination URL for the redirect.
  • Referring Page. The referring web page for the redirect.
  • Created Date. The date the Redirect was created on.
  • Enabled. Whether or not the item is enabled. A green circle with a white check mark in it means it is enabled. A red circle with a white dot in it means it is disabled.
  • 404 Hits. The number of times this page was requested and not being forwarded. Sorting on this column helps to find old links from external websites (or even internal old links).
  • ID. This is a unique identification number for this item assigned automatically by Joomla!. It is used to identify the item internally, and you cannot change this number. When creating a new item, this field displays 0 until you save the new entry, at which point a new ID is assigned to it.

List Filters[edit]

Filter by Partial Title[edit]

You can filter the list of items by typing part of the redirect's name or the ID number of the redirect. Help25-banners-manage-filter-name.png

Filter by State[edit]

In the upper right area, above the column headings, there is one drop-down list box as shown below:

Help25-components-redirect manager-filter-attributes.png

Only items matching the selection will be displayed in the list.

  • State: State of the item. Possible values are:
    • Published: The item is published. This is the only state that will allow regular website users to view this item.
    • Unpublished: The item is unpublished.
    • Archived: The item has been archived.
    • Trashed: The item has been sent to the Trash.

Number of Items to Display[edit]

Below the list you'll find:

  • Page Controls. When the number of items is more than one page, you will see a page control bar as shown below.
    Help25-chunk-colheader-pagination.png
    • Display #: Select the number of items to show on one page.
    • Start: Click to go to the first page.
    • Prev: Click to go to the previous page.
    • Page numbers: Click to go to the desired page.
    • Next: Click to go to the next page.
    • End: Click to go to the last page.

Batch Processing[edit]

Below the listing of redirects, is a section named 'Update selected links to the following new URL'. This function allows you to change the 'Destination URL' for the selected redirects.

Help25-components-redirect manager-batch update.png
  • Destination URL. The destination URL to set for the selected redirects.
  • Comment. The comment to set for the selected redirects.
  • Update Links. Updates all selected redirects with the specified Destination URL and Comment.

Toolbar[edit]

At the top right you will see the toolbar:

Help25-Toolbar-New-Edit-Enable-Disable-Archive-Trash-Options-Help.png

The functions are:

  • New. Opens the editing screen to create a new redirect.
  • Edit. Opens the editing screen for the selected redirect. If more than one redirect is selected (where applicable), only the first redirect will be opened. The editing screen can also be opened by clicking on the Title or Name of the redirect.
  • Enable. Makes the selected redirects available for use on your website.
  • Disable. Makes the selected redirects unavailable for use on your website.
  • Archive. Changes the status of the selected redirects to indicate that they are archived. Archived redirects can be moved back to the published or unpublished state by selecting "Archived" in the Select Status filter and changing the status of the redirects to Published or Unpublished as preferred.
  • Trash. Changes the status of the selected redirects to indicate that they are trashed. Trashed redirects can still be recovered by selecting "Trashed" in the Select Status filter and changing the status of the redirects to Published or Unpublished as preferred. To permanently delete trashed redirects, select "Trashed" in the Select Status filter, select the redirects to be permanently deleted, then click the Empty Trash toolbar icon.
  • Options. Opens the Options window where settings such as default parameters or permissions can be edited.
  • Help. Opens this help screen.

Options[edit]

Click the Options button to open the Redirect Manager Options window which lets you configure this component.

Buttons Common to All Tabs[edit]

  • Save. Saves the redirect manager options and stays in the current screen.
  • Save & Close. Saves the redirect manager options and closes the current screen.
  • Cancel/Close. Closes the current screen and returns to the previous screen without saving any modifications you may have made.

Permissions Tab[edit]

This screen allows you to set the component permissions in Joomla. This is important to consider if you have sites with many different user categories all of whom need to have different accessibilities to the component. The screenshot below describes what you should see and the text below that describes what each permission level gives the user access to:

Help25-components-redirect manager-options-permissions.png

You work on one Group at a time by opening the slider for that group. You change the permissions in the Select New Settings drop-down list boxes. The options for each value are Inherited, Allowed, or Denied. The Calculated Setting column shows you the setting in effect. It is either Not Allowed (the default), Allowed, or Denied. Note that the Calculated Setting column is not updated until you press the Save button in the toolbar. To check that the settings are what you want, press the Save button and check the Calculated Settings column.

The default values used here are the ones set in the Global Configuration Permissions Tab

Configure
Open the redirect manager component option screens (the modal window these options are in)
Access Administration Interface
Open the redirect manager component manger screens
Create
Create new redirects in the component
Delete
Delete existing redirects in the component
Edit
Edit existing redirects in the component
Edit State
Change an redirects state (Publish, Unpublish, Archive, and Trash) in the component.

There are two very important points to understand from this screen. The first is to see how the permissions can be inherited from the parent Group. The second is to see how you can control the default permissions by Group and by Action. This provides a lot of flexibility. For example, if you wanted Shop Suppliers to be able to have the ability to create an article about their product, you could just change their Create value to "Allowed". If you wanted to not allow members of Administrator group to delete objects or change their state, you would change their permissions in these columns to Inherited (or Denied). It is also important to understand that the ability to have child groups is completely optional. It allows you to save some time when setting up new groups. However, if you like, you can set up all groups to have Public as the parent and not inherit any permissions from a parent group.

Quick Tips[edit]

  • In order for your redirects to work, you must enable the option Use Apache mod_rewrite in the Global Configuration options of your Joomla! installation. Note also that just enabling the 'Use Apache mod_rewrite' option is not enough. You must take the additional step of renaming the htaccess.txt file in the web site directory where you installed Joomla! to .htaccess or to whatever file name your Apache web server requires for additional configuration directives. In the Apache configuration file this setting is named 'AccessFileName' and by default this is set to '.htaccess'

Related information[edit]