Developing and Page Diff
CAUTIONFeature Overview
Content creation is an iterative process. Authoring with efficiency requires being able to see what has changed from one iteration to another. Viewing one page version and then the other is inefficient and prone to error. An author wants to be able to compare the current page to a previous version side-by-side with the differences highlighted.
The page diff allows a user to compare the current page to launches, previous versions, etc. For details of this user feature, see Page Diff.
Operation Details
When comparing versions of a page, the previous version that the user wishes to compare is recreated by AEM in the background in order to facilitate the diff. This is needed to be able to render the content for side-by-side comparison.
This recreation operation is done by AEM internally and is transparent to the user and requires no intervention. However an administrator viewing the repository for example in CRX DE Lite would see these recreated versions within the content structure.
Depending on the AEM patch level, the behavior is different and may require certain permissions in order to work properly.
Prior to AEM 6.4.3
When content is compared, the whole tree up to the page to compare is recreated in the following location:
/content/versionhistory/<userId>/<site structure>
Because when using the page diff mechanism, AEM recreates the previous version of the page, in order to use the feature the user must have certain JCR permissions.
CAUTION/content/versionhistory.As of AEM 6.4.3
When content is compared, the whole tree up to the page to compare is recreated in the following location:
/tmp/versionhistory/
This content is created by a service user with permissions limiting visibility to the current user. For this reason, no special permissions are required.
A cleanup task runs automatically to clean up this temporary content.
Developer Limitations
Previously, in Classic UI, special development consideration had to be made to facilitate AEM diffing (such as using cq:text tag lib, or custom integrating the DiffService OSGi service into components). This is no longer needed for the new diff feature, since the diff occurs client-side via DOM comparison.
However there are a number of limitations that need to be considered by the developer.
-
This feature uses CSS classes that are not name spaced to the AEM Product. If other custom CSS classes or 3rd party CSS classes with the same names are included on the page, the display of the diff may be affected.
html-addedhtml-removedcq-component-addedcq-component-removedcq-component-movedcq-component-changed
-
Because the diff is client-side and executes on page load, any adjustments to the DOM after the client-side diff service has run will not be accounted for. This may affect
- Components that use AJAX to inlcude content
- Single Page Applications
- Javascript based components that manipulate the DOM upon user interaction.
The Perfect Blend: A New Era of Collaboration with AEM and Workfront
Adobe Customer Success Webinars
Wednesday, Apr 2, 5:00 PM UTC
Explore how Adobe Experience Manager and Workfront integrate to help teams move from ideation to delivery without the usual bottlenecks, ensuring content is organized, on-brand, and ready to go live faster.
Register
Elevate and Empower Teams with Agentic AI for Exceptional Experiences
Elevate and empower your CX teams with AI that transforms creativity, personalization, and productivity. Discover how Adobe is...
Tue, Mar 18, 1:00 PM PDT (8:00 PM UTC)
B2B Reimagined: Transforming Go-to-Market Strategies for Profitable Growth
B2B brands are facing a digital revolution. Buyers expect hyper-relevant content and self-service, while internally AI is transforming...
Wed, Mar 19, 1:00 PM PDT (8:00 PM UTC)
Connect with Experience League at Summit!
Get front-row access to top sessions, hands-on activities, and networking—wherever you are!
Learn more