Properties of the Maximo Maven plugin

The plugin properties are listed in this page. They are grouped together to reflect the logical links between them.

General Properties

This section holds the definition of all General purpose properties of this plugin.

Property name Description Optional?
maximo.version Indicates the version of the Maximo system you are working on. The different allowed values are:

  • 6.x
  • 7.x

Default value: maximo.version=6.2.1

maximo.home This property indicates where is your development Maximo installation. The complete path to the Maximo installation root must be given. This property enables the dev-deploy goal.

Default value: maximo.home=[] (empty)

maximo.codepatch.applications This property gives the list of Maximo applications that are processeed by the plugin.

WARNING: This property's value should never be changed.

Default value: maximo.codepatch.applications= activeportal,bocrystal,DOCLINKS,maximo,maximohelp,maximormiregistry

maximo.codepatch.maximo.applications The list of sub-applications of the Maximo application that gets processed by this plugin.

WARNING: The value of this property should never be changed!

Default value: maximo.codepatch.maximo.applications= businessobjects,maximouiweb,mboejb,mbojava,mboweb,meajmsejb,meaweb,properties


Code patch assembly control properties

Property name Maximo Version Description Optional?
maximo.codepatch.mx6.classes.[app].[subapp] 6.x, 7.x These properties are used to add or modify new files in your Maximo installation (part of the Code Patch). The name of the specifi properties are made of the name of the Maximo application they affect. If this application is a component of another application, we use both the application and sub-application names to identify the property. Exemple:

maximo/businessobjects would give: maximo.codepatch.mx6.classes.maximo.businessobjects

maximo/maximouiweb would give: maximo.codepatch.mx6.classes.maximo.maximouiweb

bocrystal application would give: maximo.codepatch.mx6.classes.bocrystal

See the property: maximo.codepatch.applications for the complete list of supported applications.

See the property: maximo.codepatch.maximo.applications for the complete list of sub-applications of the Maximo aplication.

These properties, like their names suggests, are used to identify all files that must be included in the Code Patch. The property values are treated as Ant FileSet includes clause. Individual classes can be added and wildcards can be used (ex: maximo.codepatch.mx6.classes.maximo.maximouiweb=com/eginc/bo/**/*.class) Many classes or filter entries can be added using a comma to seperate them.

Yes 6.x, 7.x This property holds the files to include in the package for the tools that must be deployed on your Maximo installation. Specific files or patterns (like **/*Test.cmd ) can be used.

Default value:[] (empty)

Yes 6.x, 7.x This property is used to specify the list of classes that must be added in the maximo/tools directory. Specific file names or patterns ( like **/*Test.class ) can be used.

Default value:[] (empty)
maximo.dist.mx6.sql.scripts 6.x, 7.x This property gives the list of SQL script that must be included in the distribution. Note that all scripts copied with this property will not be part of the code patch, meaning that nothing gets copied in the Maximo. The scripts are caried along batch files and other install utilities within the files of the distribution itself. Specifc files or file patterns (like **/*Test.sql ) can be used.

Default value: maximo.dist.mx6.sql.scripts=[] (empty)
maximo.patch.dep.deploy.dir 6.x, 7.x This property indicates in which base directory the marked dependencies are to be deployed. For more details, see the documentation of the goal: maximo:deploy-deps.

The default value of the property is the same than the distribution assembly (not the code patch):

Default value: maximo.patch.dep.deploy.dir=${maximo.patch.dist.assembly.dir}

Jars can be published with the distribution itself if they are required only by the installation program. If they are required by Maximo when running, the librairies must be added in the Code patch. To do so, this property must have the following value:


And also, it must be indicated at the dependency level in which sub-directory the jar must be copied:

jar.dependency.dist.dir = /applications/maximo/lib
jar.dependency.dist.dir 6.x, 7.x Specifies in which directory the dependency must be copied (other than the target root directory).

ATTENTION:If you use this functionnality, the Manifest generation option of the maven-jar-plugin plugin will generate a faulty Manifest for the Classpath entry (using the jar.manifest.classpath property in the dependency). Custom code must be supplied when the plugin generates the classpath entry for the manifest.

Default value: jar.dependency.dist.dir=

[pom.artifactid].deploy 6.x, 7.x This property must be added to each dependency that must be deployed. Use true or any other string for value. The mere presence the property is enough to mark it.

Default value: N/A

Yes 6.x, 7.x This property renames the jar when it gets deployed. This may be necessary when modifying a jar that is already part of a framework on which your module is built on. Most will not use the jar including the version name like Maven produces by default.

Default value: N/A
Yes 6.x This property is used to point to the source directory where tools files must be copied. These files are part of the code patch and so must reflect the exact directory structure of the target Maximo. It is a good practice to seperate your Maximo published tools from the ones comming with Maximo.


Default value: tools/eginc/${pom.artifactId}
Yes 7.x Same as

Default value: tools/eginc/${pom.artifactId}
Yes 6.x, 7.x Directory where the source files for the tools directory in Maximo are located. The content of this directory and all under it is copied.

Default value: ${basedir}/src/tools

Distribution assembly control properties

Property name Maximo version Description Optional?
maximo.patch.install.scripts.include 6.x, 7.x To indicate to the plugin if install script should be included in this distribution. Install script are copied from template files using current project values to dynamically have all your scripts adapted to your chosen distribution file name.

Default value: maximo.patch.install.scripts.include=true

No 6.x, 7.x The file name of the patch file produced by the plugin (the distribution file).

Default value: ${pom.artifactId}-hotfix-${pom.currentVersion}.zip

maximo.patch.code.patch.assembly.dir 6.x, 7.x This is the root directory where the plugin constructs the code patch content. This directory and everything under it will be part of the file produced. The content of this directory is unzipped on a Maximo when deploying your package.

Default value: maximo.patch.code.patch.assembly.dir=${}/code-patch-assembly

maximo.patch.dist.assembly.dir 6.x, 7.x This directory is used as the root for the content of the complete package. This directory and all its content are zipped and this makes the package distribution. The file name of this zip is given by the property

Default value: maximo.patch.dist.assembly.dir=${}/dist-assembly
maximo.patch.distribution.dir 6.x, 7.x This is where the complete compressed distribution file is created when the complete build operation succeeds.

Default value: maximo.patch.dist.assembly.dir=${}/distributions

maximo.patch.install.script.dir 6.x, 7.x This property gives out the name of the directory where the Ant script template for the install program can be found along with the the other scripts (batch files, sh scripts, etc).

Default value: maximo.patch.install.script.dir=${maven.src.dir}/install

maximo.patch.sql.script.dir 6.x, 7.x The root directory used to hold the SQL scripts that are part of you package.

Default value: maximo.patch.sql.script.dir=${basedir}/src/main/SQL
maximo.patch.install.intructions.navigation 6.x, 7.x This property allows the generation of installation instructions for your package in PDF format. As soon as you give a value to this property, the PDF generation process will be enabled and executed when building the distribution. The instruction file will be generated in the target/docs directory and after automatically copied in the root of the distribution ( directory pointed by the maximo.patch.dist.assembly.dir property.

Default value: maximo.patch.install.intructions.navigation=

maximo.codepatch.mx6.psdi.scripts 6.x This property allows the inclusion of PSDI scripts in your package (.mxs, .msg files). Including a PSDI script in your package also triggers the execution of this script by the generated Ant install script.

Only file names comma seperated are accepted as values. All scripts must be located in the directory: ${basedir}/src/psdi/scripts in order to get included.

Default value: maximo.codepatch.mx6.psdi.scripts=[] (empty)

maximo.codepatch.mx7.psdi.scripts 7.x Same as maximo.codepatch.mx6.psdi.scripts

Default value: maximo.codepatch.mx7.psdi.scripts=[] (empty)