UNDER CONSTRUCTION

{color:green}Help is available by sending an email to [mailto:csf-support@mit.edu]{color}

Quick Links to:

Picking a projectName and a projectArtifactId

The first thing that must be done is to pick a *projectName* and a *projectArtifactId*.  These will be used throughout the life time of your project.
\\
\\
The *projectName* is a short acronym that is used to uniquely identify your project.
The *projectArtifactId* is the application context under which your project war file will be deployed to the OC4J server.
\\
\\
Once the *projectName* and *projectArtifactId* have been selected, they should not be changed.
\\
\\
Here are a few examples of what other project have used in the past:

||projectName||projectArtifactId||project description|
|ssb|sfs-ssb|student sponsored billing|
|ogs|ogs|online grade submission|
|onlinereg|onlinereg|online registration|
|iap|iap|individual activities period|


Installation of the project war component using the war-template

  1. Run Eclipse.  Go to File > New > Other....
    Scroll down to Maven and expand then select Checkout Maven Projects from SCM as shown in the following panel. 
    !setupWarTemplate002.jpg!
    When satisfied that everything is correct, click Next.
  2. Do the following: 
    * From the *SCM URL:* dropdown, select *snv*.
* Uncheck *Checkout All Projects*.
* Copy and pasted the following URL into the *SCM URL:* input field.

    {code}
svn+ssh://svn.mit.edu/es-projects/es-project-template/war-template/trunk
{code}
    When done the panel should be identical to the following: 
    !setupWarTemplate004.jpg!
    When satisfied that everything is correct, click Next.
  3. If you want the change the Workspace location, uncheck the Use default Workspace location and enter the path to the desired workspace. 
    !setupWarTemplate006.jpg!
    When satisfied that everything is correct, click Finish.
  4. Verify the Maven Project that is being imported. The Import Maven Projects panel should be identical to the following panel. 
    !setupWarTemplate008.jpg!
    When satisfied that everything is correct, click Finish.
  5. When the project is opened, your Eclipse - Project Explorer View should look as follows: 
    !setupWarTemplate010.jpg!
    Right click on the project and select Team > Disconnect
  6. When following Confirm Disconnect from SVN is displayed, select Also delete the SVN meta-information from the file system.. 
    !setupWarTemplate012.jpg!
    When satisfied that everything is correct, click Yes.
  7. Open the Eclipse - Navigator View 
    * expand the *projectArtifactId* project,
* delete the *.settings* file.
  8. Open the Eclipse Project Explorer View. The view should look as follows: 
    !setupWarTemplate014.jpg!
    Right click on the project and select Refactor > Rename....
    Replace projectArtifactId with the projectArtifactId that you have previously selected. 
    *Note*:  You might want to append a *-war* to the projectArtifactId to denote that this is the war component of your project.

    For example: If my projectArtifactId was att, then my panel would look like the following: 
    !setupWarTemplate016.jpg!
    When satisfied that everything is correct, click OK.
  9. The Eclipse - Project Explorer View should look similar to the following: 
    !setupWarTemplate018.jpg!
    Right click on the project and select Team > Share Project...
  10. Select SVN as shown below: 
    !setupWarTemplate020.jpg!
    When satisfied that everything is correct, click Next.
  11. Select Create a new repository location as shown below: 
    !setupWarTemplate022.jpg!
    When satisfied that everything is correct, click Next.
  12. Enter a desired SVN URL for your project.
    For example: 
    Keep in mind that there are at least 2 component for every project, a WAR and a JAR.
You Should keep all project components grouped together in the same SVN directory.  A logical grouping
would be by the projectName that you selected.  If my projectName were *att*, then the SVN
URL would be *svn+ssh://svn.mit.edu/es-projects/att*.  This would mean that my war project
would be created under the *es-projects/att* directory in the SVN repository.  This is shown
in the following panel:

    !setupWarTemplate024.jpg!
    Don't forget to enter your User name and Password,
    When satisfied that everything is correct, click Finish.
  13. When the following panel is display notifying you that a new SVN entry will be created: 
    !setupWarTemplate026.jpg!
    When satisfied that everything is correct, click OK.
  14. Do the following: 
    * In the *Advanced Mode* section, select *Use project name*.
* In the *Project Repository Layout* section, select *Use single project layout*.
* Check *Use Subversion recommended layout ('trunk', 'branches' and 'tags')* check box.
    The panel should be as illustrated in the following panel: 
    !setupWarTemplate028.jpg!
    When satisfied that everything is correct, click Finish.
  15. Nothing to do here.  This is an information panel similar to the following panel: 
    !setupWarTemplate030.jpg!
    When satisfied that everything is correct, click Finish.
  16. When a panel similar to the one below is display, enter a comment.
    This is the initial SVN check-in (svn commit) for the WAR project: 
    !setupWarTemplate032.jpg!
    When satisfied that everything is correct, click OK.
  17. When the SVN commit has completed, the Eclipse - Project Explorer View should look similar to the following. 
    !setupWarTemplate034.jpg!

Installation of the project war component using the war-template is now complete.

Customizing the project WAR

  1. Run Eclipse and open a Project Explorer View and open the Maven WAR project that you want to customize.
    Your Project Explorer View should look similar to the following: 
    !customizeWar002.jpg!

  2. Expand your project, then expand src/main/resources.
    Your Project Explorer View should look similar to the following: 
    !customizeWar004.jpg!

  3. Open the applicationContext-projectName-config.xml for editing and change the following lines substituting your project name for projectName.
    The are 5 occurances of projectName that have to be changed.