Isomorphic Software Maven Plugin – Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal	Description
isc:deploy	Deploys a collection of `Module` s to the Maven repository location indicated by the given `repositoryUrl` property. Functionally, pretty much just like the Deploy Plugin's deploy-file goal, except this one works on a collection. Refer to
isc:download	Downloads and unpacks a given distribution, but does not actually do anything with the resulting Maven artifacts.
isc:help	Display help information on isc-maven-plugin. Call `mvn isc:help -Ddetail=true -Dgoal=<goal-name>` to display parameter details.
isc:install	Installs a collection of `Module` s to the user's local repository. Functionally, pretty much just like the Install Plugin's install-file goal, except this one works on a collection. Refer to
isc:install-reify-onsite	Downloads and unpacks a Reify OnSite distribution and deploys it to `targetDir` . Note that the current version of this goal only supports installing the SmartClient version of Reify OnSite. Isomorphic does also provide a version of Reify OnSite packaged as a SmartGWT application, but that is outside the scope of this plugin. Note that Reify OnSite is NOT a Maven project, This goal installs the actual product in the target directory you specify; it does not install files to any Maven cache or repository.
isc:reify-import	Provides for single-step download and extraction of assets hosted on the Reify platform. While there is nothing to prevent a user from modifying the imported resources, changes should almost always be made using Reify and then re-imported. If necessary, use the API (e.g., RPCManager.createScreen, Canvas.getByLocalId) to modify imported screen definitions at runtime. Imported MockDataSources can simply be replaced using e.g., SQLDataSources having the same ID in another directory - there is no reason to modify the contents of the 'mock' subdirectory. To encourage recommended usage, the reify-import goal takes steps to detect local changes and fail when any are found. Refer to the `skipOverwriteProtection` parameter for details. Further, a validation step (optional, see `skipValidationOnImport` ) attempts to detect commonly found discrepancies between your MockDataSources and working DataSources. The Reify for Developers documentation topic contains further discussion around best practices during the design / development cycle. If you've built your project using one of the Maven archetypes for either SmartGWT or SmartClient, you should have a skeleton configuration in you POM already. if not, add something like the following: <pluginManagement> <plugins> <plugin> <groupId>com.isomorphic</groupId> <artifactId>isc-maven-plugin</artifactId> <version>1.4.5</version> <!-- the m2pluginextras dependency will be required when skipValidationOnImport = false --> <dependencies> <dependency> <groupId>com.isomorphic.extras</groupId> <artifactId>isomorphic-m2pluginextras</artifactId> <version>${smartgwt.version}</version> </dependency> </dependencies> </plugin> </plugins> </pluginManagement> <build> <plugins> <plugin> <groupId>com.isomorphic</groupId> <artifactId>isc-maven-plugin</artifactId> <configuration> <smartclientRuntimeDir>${project.parent.build.directory}/gwt/launcherDir/myapplication/sc</smartclientRuntimeDir> <dataSourcesDir>WEB-INF/ds/classic-models</dataSourcesDir> </configuration> </plugin> </plugins> </build> and check that the SmartClient runtime has been extracted to the configured location (via e.g., mvn war:exploded, mvn jetty:run).
isc:reify-validate	A utility class to run the 's validation step independently of the import process. Invocation will require values for smartclientRuntimeDir, dataSourcesDir, and optionally mockDataSourcesDir parameters. See also:
isc:upgrade-reify-onsite	Downloads and unpacks a Reify OnSite distribution and uses it to upgrade the existing Reify OnSite deployment at `targetDir` without affecting your settings or data. Note that the current version of this goal only supports the SmartClient version of Reify OnSite. Isomorphic does also provide a version of Reify OnSite packaged as a SmartGWT application, but that is outside the scope of this plugin. Note that Reify OnSite is NOT a Maven project, This goal upgrades the actual product in the target directory you specify; it does not install files to any Maven cache or repository.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven	3.9.2
JDK	1.8

System Requirements History

The following specifies the minimum requirements to run this Maven plugin for historical versions:

Plugin Version	Maven	JDK
from 1.4.7 to 1.5.0	3.9.2	8
1.4.6	3.9.2	Default target for maven-compiler-plugin version 3.13.0
from 1.4.0 to 1.4.5	3.1	8
from 1.0.0 to 1.3.2	3.1	6

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>com.isomorphic</groupId>
          <artifactId>isc-maven-plugin</artifactId>
          <version>1.5.0</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>com.isomorphic</groupId>
        <artifactId>isc-maven-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"