Skip to main content
JakeCham
JakeCham
Level 6
November 30, 2023
Solved

what are the usage of main POM.xml and other module related pom files

Hi Team,

I want to know what are the usage and purposes of main POM.xml and other module related pom files such as core,it.tests, ui.apps, ui.content.

 

Thanks.

 

This post is no longer active and is closed to new replies. Need help? Start a new post to ask your question.
aanchal-sikka
aanchal-sikkaAccepted solution
Community Advisor
December 5, 2023

In Adobe Experience Manager (AEM) projects, the main pom.xml file and module-related POM files play crucial roles in managing dependencies, configurations, and build processes. Here's a brief overview of their typical uses:

  1. Main POM.xml:

    • Aggregating Project Configuration: The main pom.xml serves as the primary configuration file for the entire AEM project. It aggregates configurations, dependencies, and build settings for all modules within the project.
    • Common Dependencies: It defines common dependencies, plugins, and configurations shared across different modules within the project.
    • Build Lifecycle Configuration: Specifies the build lifecycle phases, goals, and profiles applicable to the entire project.

  2. Module-Related POM Files:

    • Individual Module Configurations: Each AEM module (like a bundle, content package, or other components) typically has its own pom.xml file. These files are used to define configurations specific to the respective module.
    • Module-Specific Dependencies: Specifies dependencies and configurations specific to a particular module. For example, a content package module might have dependencies related to content structure.
    • Module Build Settings: Contains build settings such as plugin configurations, goals, and profiles applicable to the specific module.
    • Packaging Information: Defines the packaging type for the module, such as "jar," "bundle," or "content-package."

  3. Parent POM:

    • Inheritance: In multi-module AEM projects, the main pom.xml may serve as a parent POM. The module-related POM files inherit configurations from the parent POM, reducing redundancy.
    • Centralized Version Management: Centralizes version management for dependencies across modules, ensuring consistency and easier updates.

Overall, these POM files work together to organize, configure, and build AEM projects efficiently. They help manage dependencies, provide consistency across modules, and ensure that the project adheres to best practices in AEM development.

Aanchal Sikka
View in thread

3 replies

arunpatidar
Community Advisor
arunpatidarCommunity Advisor
Community Advisor
November 30, 2023

Hi @jakecham 
Please check details here 

https://experienceleague.adobe.com/docs/experience-manager-core-components/using/developing/archetype/using.html?lang=en#what-you-get 

Translate
Arun Patidar
    aanchal-sikka
    Community Advisor
    aanchal-sikkaCommunity AdvisorAccepted solution
    Community Advisor
    December 5, 2023

    In Adobe Experience Manager (AEM) projects, the main pom.xml file and module-related POM files play crucial roles in managing dependencies, configurations, and build processes. Here's a brief overview of their typical uses:

    1. Main POM.xml:

      • Aggregating Project Configuration: The main pom.xml serves as the primary configuration file for the entire AEM project. It aggregates configurations, dependencies, and build settings for all modules within the project.
      • Common Dependencies: It defines common dependencies, plugins, and configurations shared across different modules within the project.
      • Build Lifecycle Configuration: Specifies the build lifecycle phases, goals, and profiles applicable to the entire project.

    2. Module-Related POM Files:

      • Individual Module Configurations: Each AEM module (like a bundle, content package, or other components) typically has its own pom.xml file. These files are used to define configurations specific to the respective module.
      • Module-Specific Dependencies: Specifies dependencies and configurations specific to a particular module. For example, a content package module might have dependencies related to content structure.
      • Module Build Settings: Contains build settings such as plugin configurations, goals, and profiles applicable to the specific module.
      • Packaging Information: Defines the packaging type for the module, such as "jar," "bundle," or "content-package."

    3. Parent POM:

      • Inheritance: In multi-module AEM projects, the main pom.xml may serve as a parent POM. The module-related POM files inherit configurations from the parent POM, reducing redundancy.
      • Centralized Version Management: Centralizes version management for dependencies across modules, ensuring consistency and easier updates.

    Overall, these POM files work together to organize, configure, and build AEM projects efficiently. They help manage dependencies, provide consistency across modules, and ensure that the project adheres to best practices in AEM development.

    Translate
    Aanchal Sikka
      partyush
      Community Advisor
      partyushCommunity Advisor
      Community Advisor
      December 5, 2023

      Hi @jakecham 

      In a Maven-based project structure, especially in the context of Adobe Experience Manager (AEM) development, different pom.xml files serve distinct purposes. Let's break down the typical roles of the main pom.xml file and those related to various modules like core, it.tests, ui.apps, and ui.content:

      1. Main POM.xml:

      • Purpose:

        • The main pom.xml file, usually located at the project's root, is the primary Maven Project Object Model file.
        • It defines global configurations and dependencies for the entire project.

      • Usage:

        • Specifies general project information such as the project's name, version, and description.
        • Manages global dependencies that are common across different modules.
        • Sets up configurations for plugins that are applied globally.

      2. Core Module's POM.xml:

      • Purpose:

        • The core module typically represents the backend or server-side logic of an AEM application.
        • It encapsulates business logic, services, and other backend functionalities.

      • Usage:

        • Manages dependencies specific to the backend logic of the AEM application.
        • Defines configurations for building and packaging backend code.
        • Specifies plugins and configurations for tasks like code compilation and packaging.

      3. IT.Tests Module's POM.xml:

      • Purpose:

        • The it.tests module is commonly used for integration tests.
        • It allows you to test the integration of different components within your AEM application.

      • Usage:

        • Manages dependencies required for integration testing.
        • Configures plugins for running integration tests.
        • Defines test-specific configurations and resources.

      4. UI.Apps Module's POM.xml:

      • Purpose:

        • The ui.apps module typically represents the frontend or client-side part of an AEM application.
        • It includes components, templates, and static assets required for rendering the UI.

      • Usage:

        • Manages frontend dependencies such as client libraries, CSS, and JavaScript files.
        • Configures plugins for building and packaging frontend code.
        • Specifies resources and configurations specific to the AEM UI.

      5. UI.Content Module's POM.xml:

      • Purpose:

        • The ui.content module usually contains content packages that define the structure and content of the AEM application.

      • Usage:

        • Manages dependencies related to content authoring or specific content components.
        • Configures plugins for building and packaging content packages.
        • Specifies resources and configurations relevant to the AEM content structure.

      As @arunpatidar mentioned, You can check this link : https://experienceleague.adobe.com/docs/experience-manager-core-components/using/developing/archetype/using.html?lang=en#what-you-get 
      for more detail which can give you more insights for the same . 

      Translate
        Terms & ConditionsAccessibility statement

        Loading footer...