+

Search Tips   |   Advanced Search

Simple modules

Simple modules for the resource aggregator framework are provided in the WebDAV folder.

If we need all features of the framework, define modules through a plugin.xml or JSON file in the contributions folder.

Each subdirectory within the modules folder defines one module. 

    WebDAV Root + modules 
    +-- module A
    +-- module B
    +-- ...
    +-- module Z

To start quickly, use the pre-defined module...

    getting_started_module

Add the JavaScript, CSS, or markup file to one of the subfolders, and the resources are integrated into HCL WebSphere Portal.

Invalidate the resource aggregator cache to integrate changes...

    Administration | Portal Analysis | Theme Analyzer | Utilities | Control Center | Invalidate cache


Module directory

After creating our own module by creating a new directory in the modules directory, verify the module is integrated with HCL WebSphere Portal. Add it to the profile currently set on the page. To verify the profile for any page, use the Theme Analyzer Page Explorer...

Simple contributions can be of three contribution types: head, config, menu.

For more information, on simple modules read the readme.txt file in the getting_started_module folder.


Simple module directory structure

Simple modules can be customized with the following files and directories.

    /module-id

    Each directory in /modules defines a new module, but does not support versions.

      /module-id/prereqs.properties

      Optional. Define the prereqs of this module. In the file, there is one module-id per new line. Module versions are not supported.

        module-id
        module-id

      /module-id/capabilities.properties

      Capabilities of the module. In the file, there is a property such as style with the name and value that is separated by an equal sign. Add one per line.

        name=value
        name=value

      /module-id/localization.properties

      Optional file defining title and description of the module. In the file, there is a property such as style. For example,

        title.locale=title
        description.locale=description

      Replace locale and with the local representing code for the location. For example, for the United States, use en_us. Replace title with the title of the module.

      /module-id/head

      See Head contribution.

      /module-id/config

      See Config contribution.

      /module-id/menu

      Files stored in this directory are made available to the menu framework.

        /module-id/menu/*.json

        JSON resources containing the menu definition are served in alphabetical order.


See


Parent Writing modules