You are here

SkyVault 2.0 » For Developers » Developing Applications and Extensions » SkyVault Extensions

Modules

a SkyVault Module is a collection of code, configuration, scripts and media resources, typically packaged as an AMP file, and which extends the functionality of SkyVault. They can implement custom templates, custom models, web scripts, UI customizations, or can be used to implement extensive additions to the SkyVault functionality. Records Management is an an example of a module that provides a significant enhancement to SkyVault's capabilities.

Modules can be thought of as installable extensions to SkyVault. Once packaged into an AMP file format they can be applied to SkyVault using the Module Management Tool (MMT). SkyVault has two directories that contain AMP files, the amps directory and the amps_share directory. Modules that extend the repository tier are located in the amps directory. Modules that extend the Share tier are located in the amps_share directory.

When a module is installed using the MMT it is applied to the relevant WAR file. The SkyVault application typically consists of at least two WAR files: SkyVault.war and share.war. The module AMP file is applied to the appropriate WAR using the MMT. Larger, more complex modules may be distributed as two AMP files, one to be applied to the SkyVault WAR file and another to be applied to the Share WAR file. Records Management, for example, is distributed in this manner.

  • SkyVault Module Package (AMP) Modules are usually packaged in the SkyVault Module Package (AMP) file format for deployment in production environments. An AMP is essentially a Zip file with a specific layout, containing all of the files required for a specific extension, including data you might to upload to the repository.
  • AMP file format The AMP file has a specific directory layout that contains the files that make up the extension. In addition it contains special files such as module-context.xml, module.properties and file-mapping.properties that control the behavior of the AMP.
  • Module properties file The module properties file is required by the module service to identify the module, and its details, when it is installed.
  • Module context file Each module requires a module context file. This loads the Spring configuration for the module.
  • AMP to WAR mapping When an AMP file is to be deployed it is applied to the target WAR file using the Module Management Tool. An AMP is deployed by applying it to a target WAR file. This is a convenient way of applying a number of files to a variety of directories within the target WAR's exploded directory structure. When the AMP is applied, the default mappings can be applied to map from the module directory structure to the exploded WAR directory structure. Custom mappings can also be applied.
  • Customizing the AMP to WAR mapping A custom mapping from the AMP directory structure to the WAR file is sometimes useful, for example if you wish to use a non-standard module directory structure, or if you wish to map files into non-default locations in the target WAR. This custom mapping is achieved through use of the file-mapping.properties file.
  • Project layout When developing a module it is recommended that code is structured in a consistent format to comply with AMP file requirements.
  • Log4j.properties file Each module can have its own Log4j properties file.
  • Importing Module Data As part of your content model and module, you can import some data that the module uses. These can be, for example, Categories, FTL scripts in the data dictionary, project template hierarchies, ACP files.
  • Adding a Custom Model Custom content models can be bootstrapped into the repository via Spring configuration added to the module context file.
  • Importing Users/Groups A module can create users or groups as part of its initialization. This can be achieved by via creation of an import file containing the users/groups you want to import and then including these via the module context file.
  • Adding a Custom Permission Model A custom permission model can be bootstrapped via a module.
  • Adding Custom Client Configuration Custom web client configuration can be included via a module context.
  • Adding Custom Faces Configuration It is possible to add custom faces configuration to a module.
  • Using the Module Management Tool (MMT) The Module Management Tool (MMT) helps install and manage modules packaged as AMP (SkyVault Module Package) files. These AMP files are applied to a target WAR file, for example SkyVault.war or share.war.
  • Module Tutorials The following tutorials demonstrate how to create simple modules from scratch. They use Ant-based build scripts to illustrate the concepts of constructing, building and deploying modules. They do not represent a recommended way to develop extensions - they are designed to help you learn more about the construction and layout of modules from first principles.
Parent topic: SkyVault Extensions

© 2017 TBS-LLC. All Rights Reserved.