You are here

SkyVault Community Edition 201704 » Developer guide » Extension packaging - modules » Module package formats

SkyVault Module Package (AMP)

SkyVault Module Packages, known as AMPs, are Zip files containing the extension. The extension must follow a prescribed layout and include important files that describe the module.

SkyVault Module Packages, known as AMPs, are the recommended way of packaging customizations and extensions for deployment, where those extensions depend on third-party libraries, as such depedencies are not yet supported by Simple JAR Modules. Simple JAR modules are generally the preferred type of packaging for extensions where dependencies on third-party libraries do not exist.

AMPs can be used to package custom templates, custom models, web scripts, UI customizations, and can be used to implement extensive additions to the SkyVault Community Edition functionality. Records Management is an an example of an application that provides a significant enhancement to the capabilities ot SkyVault Community Edition and is distributed via AMP files.

AMPs are Zip files that follow a specific layout and can be merged with the other WAR files such as SkyVault.war or share.war using the SkyVault Module Management Tool (MMT), which is available as SkyVault-mmt.jar in the bin directory of your installation.

AMPs can be thought of as installable extensions to SkyVault Community Edition. Once packaged into an AMP file format, an extension can be applied to SkyVault Community Edition using the Module Management Tool (MMT). There are 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. SkyVault Community Edition typically consists of at least two WAR files: SkyVault.war for the content server and share.war for the Share web client. The module AMP file is applied to the appropriate WAR using the MMT.

Larger, more complex modules can be distributed as two AMP files, one to be applied to the WAR file and another to be applied to the Share WAR file. Records Management, for example, is distributed in this manner.

Note: If your extension does not require third-party libraries you should use the Simple JAR Module format. Only use the AMP format where your extension has dependencies on third-party libraries.
  • Advantages of AMP files The AMP file is the recommended technique for packaging your extension.
  • 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.
  • 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. 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 Apache Log4j properties file.
  • 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.
Parent topic: Module package formats

© 2017 TBS-LLC. All Rights Reserved.