Skip to end of metadata
Go to start of metadata

The KME Tool Archetype is used to create a skeleton project for a new KME tool.

Download

The current version is available from the GA 1.1 page: Downloads GA 1.1

Setup

  1. Unpack .zip.
  2. Navigate to unpacked directory.
  3. Run: mvn install
  4. Navigate to where you want to generate your tool. You should not attempt to generate the tool within the archetype directory.

Generate a new tool

Above is an example command to generate a tool with the following options:

Key

Value

groupId

org.kuali.mobility

artifactId

kmetoolexample

groupPath

org/kuali/mobility

kmeVersion

1.0.0-M2-RELEASE

  1. groupId should be set for your institution or organization.
  2. artifactId should be unique for your specific project and descriptive. Examples of existing tool artifactIds are: alerts, conference, and maps.
  3. groupPath should be the same as your groupId, except as a directory path. In the example above, the groupId is org.kuali.mobility and the matching groupPath is org/kuali/mobility.
  4. kmeVersion should match the version of KME for which you are developing your tool. Verify that your value matches the version in your KME root POM.

When you run the archetype:generate command, you will be asked to set values for your tool configuration. You must provide a version for your tool, a fileNamePrefix, and a toolNameShort.

The version defaults to 1.0-SNAPSHOT. If you wish to accept the default, just press enter.

fileNamePrefix is used to prefix Java class names and should be capitalized, one word, and without special characters.

toolNameShort is used for directories in paths, non-Java filenames, and other miscellaneous uses. It should be in lowercase, one word, without special characters.

After defining the property values, you will be prompted with a Y:. Press enter to accept.

POM Configuration

After the tool is generated, you can import it into Eclipse. To make use of it in the KME, you will need to modify the root pom and the mdot-webapp pom.

  1. In the root pom, add a version property for your tool within the existing properties tag.
  2. In the root pom, add dependencies for your new tool within the existing dependencies tag.
  3. Note: In the root pom, there is a module added to the Modules tag in the Profiles area. This is normally automatically added to the root pom by the archetype tool. If you ever have to import a tool made with the archetype, you will need to add this as well. 
  4. In the mdot-webapp pom, add dependencies for your new tool within the existing dependencies tag. Use your tool's groupId and artifactId in their respective tags.
    At this point, you can run mvn install on your new project and the KME project to run your new tool.
  • No labels