Main Content

Magnolia Community Forums: Get help with Magnolia: Module requirements


  • arjen
    arjen
    Full name: Arjen Schipmolder
    Posts: 15
    Last post: Nov 30, 2017 11:43:44 AM
    Registered on: Jul 12, 2017
    Module requirements
    #1 by arjen on Jul 19, 2017 4:03:05 PM

    Hi,

    Could someone please explain what the requirements are for a module to be included in a project?
    I've got a working project to which I'd like to add a custom module, in this case a rest services module but I guess it could have been anything.

    In my main project root I have created the module itself using maven ('basic Magnolia module' archetype) and I have added it as module to the modules tag in the POM in the root of the project.

    The problem is that, when I build my project, it seems to completely ignore the new module. It's also not listed in the build whereas others are listed as "Initializing module XX" etc.

    So, does anyone know what the minimum requirements are for the main project to include the any module?

    Thanks
    Arjen

  • cmeier
    cmeier
    Full name: Christoph Meier
    Posts: 212
    Last post: Oct 19, 2017 6:08:59 PM
    Re: Module requirements
    #2 by cmeier on Jul 19, 2017 4:47:01 PM

    So ...

    If your module should be part of your Magnolia webapp or Magnolia bundle, make sure your new module is added to the webapp / bundle. Typically that's done with Maven dependency management.
    Run
    mvn dependency:tree
    on the pom of your webapp to see whether your webapp really contains the custom module.

    What module you want? Just a Maven module or a "Magnolia Maven module"?
    Do you want to see it in on the configuration workspace of your magnolia instance? If yes ... and in some other contexts, too, i recommend createing a "Magnolia Maven module".
    In this case, your module should contain an "XML-based module descriptor". This should already be sufficient to see it in the configuration worksapce / that the Magnolia module is initialized on start up of the instance.

    Some docs to read about these topics:

    - https://documentation.magnolia-cms.com/display/DOCS/Modules
    - https://documentation.magnolia-cms.com/display/DOCS/XML-based+module+descriptor
    - https://documentation.magnolia-cms.com/display/DOCS/How+to+create+a+custom+Java+based+REST+endpoint#HowtocreateacustomJavabasedRESTendpoint-CreatingaMagnoliaMavenmodulewithMavenarchetype
    - https://documentation.magnolia-cms.com/display/DOCS/Creating+a+custom+bundle
    - https://documentation.magnolia-cms.com/display/DOCS/Creating+a+custom+bundle#Creatingacustombundle-Addmodules

    I hope this helps
    cheers,
    Christoph

You don't have the permission to post on this thread

Sign in

To login on this forum, you can use your Magnolia Forge, Support or Partner account, or, below, your Google, Yahoo! or OpenID account. If you have trouble logging in, or any other sort of issue, please let us know in the Meta forum, on the user-list, or simply by email at forum-admin at magnolia-cms dot com.

* Required

... or sign in with:

  • icon http://{your-openid-url}
  • icon
  • icon https://me.yahoo.com/