Skip to main content

Module Basics

About Modules​

In intra-mart Accel Platform, the concept of a module has been incorporated into its development and its construction (operation).

A module refers to a unit of functionality, and iAP defines it as a collection of resources for realizing functionality that serves a particular purpose.

When introducing iAP, you can choose whether to install each feature (that is, each module) on a per-module basis, and at the same time, you can customize on a per-module basis.

Building an environment that uses modules is done with IM-Juggling.

Development Using Modules​

All functionality provided by iAP is provided in units of modules.

Accordingly, when adding functionality to iAP, you need to develop on a per-module basis.

Developing on a per-module basis not only narrows the scope of development, but also confines the range of impact you must consider during development to a single module rather than the entire application.

This documentation explains how to develop modules using Visual Studio Code and Accel CLI. Note that Apache Maven is used internally as the build foundation.

Module Structure​

A module is a unit of functionality and a collection of resources for realizing that functionality.

A module contains assets (resources) such as the following:

  • Resources used in the script development model
  • Resources for Java development
  • Resources placed in storage
  • Configuration files
  • Static resources

Furthermore, the above resources are divided into two kinds: resources required to compose the functionality, and sample resources.

For each kind of resource, you can choose whether or not to include it in iAP by using IM-Juggling, which is used when building the iAP environment.

A module also contains information for identifying itself. This is called module metadata.

Module metadata holds the module's ID, version, and dependencies.

The dependencies specify the IDs and versions of the other modules that the module depends on.

By defining this module metadata correctly, the consistency of module combinations is verified when building the iAP environment.