EToolbox Link Inspector is a tool for Adobe Experience Manger (AEM) that collects broken links (external/internal) under the specified content path. The tool generates a comprehensive report with the detailed information about broken links and provides content managers with a possibility to fix batches of broken links via UI dialog.
EToolbox Link Inspector gathers the following data in relation to broken links:
- link href
- link type
- http status code
- status message
- reference to the page containing the link, including the page's title and location
- reference to the component containing the link, including the component's title, resource type and location
- reference to the property containing the link, including the property's name and location
The primary focus is detection of broken links on an Author instance and correcting them by content managers before going to live.
The tool provides a possibility to fix broken links (single as well as batches) via TouchUI based dialogs:
Besides, there is a broad set of configurable options for report generation allowing to set up content and links filtering in order to have a more precise inspection.
See project's Wiki for more details.
| AEM 6.5 | AEM 6.4 | Java SE | Maven |
|---|---|---|---|
| 6.5.5.0+ | 6.4.8.1+ | 8, 11 | 3.3.9+ |
The tool can be installed using the package or via building the project.
- Get the latest package version from https://github.com/exadel-inc/etoolbox-link-inspector/releases
- Install the package etoolbox-link-inspector.all-XX.zip using the Package Manager
- Ensure that the bundle EToolbox Link Inspector - Core (etoolbox-link-inspector.core) is in Active state.
To build all the modules and deploy the all package to a local instance of AEM, run in the project root directory the following command:
mvn clean install -PautoInstallSinglePackage
After the Installation steps are completed it is necessary to:
- Set up the cron expression and enable the scheduler task at /system/console/configMgr/com.exadel.etoolbox.linkinspector.core.schedulers.DataFeedGenerationTask, see the Scheduled Data Feed Generation section in Wiki for more details;
- Set up the root path for searching broken links at /system/console/configMgr/com.exadel.etoolbox.linkinspector.core.services.data.impl.GridResourcesGeneratorImpl, see the Data Filtering section in Wiki for more details.
The report generation will start in accordance with the configured cron. As soon as the data feed is generated, the results will be available at Tools > EToolbox > Link Inspector (<YOUR_AEM_INSTANCE>/tools/etoolbox/link-inspector.html)
Check out the Data Filtering section in Wiki for more filtering options.
You can find the documentation in the project's Wiki.
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
This project is available under the Apache License, Version 2.0.