Managing shared DITA topic updates and impacted map republishing in Adobe Experience Manager Guides
This article explains the available approaches for identifying and managing DITA maps impacted when a shared topic is updated in Adobe Experience Manager (AEM) Guides, including manual and custom automation options.
Description description
Environment
- Adobe Experience Manager (AEM) Guides
Issue/Symptoms
- When a shared DITA topic is reused across multiple DITA maps in AEM Guides, updating the topic does not automatically identify all impacted maps.
- Updating the topic does not automatically trigger regeneration and republishing of the impacted maps.
- The References panel (References
>Used In) can be used to view reference relationships between topics and maps. But, there is no built-in API or workflow to automatically identify, regenerate, and republish all impacted maps after a topic update. - Custom development is required to achieve full automation for this scenario.
Resolution resolution
To identify and republish impacted DITA maps after a shared topic update, follow these steps:
-
Use the References panel in AEM Guides to manually identify all DITA maps that reference a modified topic.
-
To determine the publication status of impacted maps, review the publication logs for each map or use available APIs to verify the publication status.
-
For automation, implement a custom workflow or event handler in AEM:
a. Configure a backend listener (such as an OSGi
ResourceChangeListener, JCR observation, or workflow launcher) to detect save events on DITA topics.b. When a topic is updated, query the repository to find all referencing maps using the reference data.
c. For each impacted map, trigger output generation and publishing using available publishing APIs or workflows.
d. Implement logic to prevent duplicate or overlapping publish jobs, for example by checking job queues or using unique job identifiers.
-
After automation is implemented, verify that updating a shared topic triggers regeneration and republishing of all impacted maps as expected.