Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

Your maven overlay needs to conform to the Maven standard directory layout, so that Maven can find where everything needs to go by its own conventions.

One way you can create the file structure for your overlay project is to simply create the directories manually.  You need three high level directories: src/main/java - where Java files go, src/main/resources - where non Java files go (xml configuration, for instance), and src/main/webapp where the web application related resources (web.xml, jsps, tags) should live.  Under these directories, the traditional KFS project structure (for foundation code, org/kuali/kfs...etc, etc) directories are created; the directory tree may be pretty much duplicated between src/main/java and src/main/resources.

Alternatively, you can use maven's archetype plugin to start the overlay project:

...

Note

This is a great time to split out your customizations if they are embedded in KFS, as the dramatically altered file structure of KFS will make merging those changes painful.

DiffMerge is a nice tool to compare your project with the same base version of kfs.  Simply export the resulting file diff from DiffMerge into csv, and use that information to help script moving the files to the appropriate Maven layout.

  

Workflow

Workflow upgrades are found in kfs-core/src/main/config/workflow-upgrades/.  Each month where workflow documents were changed or added has its own directory; files within that are identified by the JIRA which necessitated the change or addition.

The product team decided that it would never create a process to upgrade workflow changes automatically.  This is because implementing institutions should be aware of workflow changes and customize them to the needs of their own institution.  Therefore, looking through these changes should be an important part of an upgrade process.