Help is available by sending an email to csf-support@mit.edu
Have any suggestion on how improve this wiki?  Please give us your feedback at csf-support@mit.edu

About this TAB

The topics presented in this TAB are primarily designed for a project team leader who need to setup and configure an new ES software project.

Quick Links to:

• About this TAB
• Education System developer VMs
• Creating a new ES software project
• Using CSF modules
• Working with X509 Application Certificates
• Working with Hibernate Mappings
• Quick Tips
  • General Quick Tips
  • Hibernate Quick Tips
  • Maven Quick Tips
  • MyEclipse Quick Tips
  • OC4J Quick Tips
  • Tomcat Quick Tips
• DWR deprecated
• Eclipse JVM memory configuration
• Creating a new Bamboo CI project
• Project properties
• Available for downloading

Education Systems developer VMs

1. Education Systems developer VMs
2. Request a ES developer VM
3. Connecting to a ES developer VM
4. Configure a ES developer VM

Creating a new ES software project

An Education Systems (ES) project will typically consist of 2 Maven artifacts. These Maven artifacts are:

• Only one Maven WAR artifact which contains all the WEB facing (i.e. jsp's, controllers, css, js, ...) components of the ES project.
• At least one Maven JAR artifact which contains all the support (i.e. services, daos, hibernate mapping, ...) components of the ES project.

To assist the software development teams, 2 Maven project templates (for a Maven war artifact and a Maven jar artifact) have been developed.

The following are the instructions on how to use the templates to create and customize an ES Maven WAR or Maven JAR artifact.

1. Selecting names for your project
2. Using the JAR template
   • OVERVIEW
   • Creating the project jar component using the jar-template
   • Customizing the project JAR
   • Customizing the project JAR pom.xml
   • Adding a new JAR to your project
3. Using the WAR template
   • OVERVIEW
   • Section 1: Creating the project war component using the war-template
   • Section 2: Customizing the project WAR
   • Section 3: Customizing the project WAR pom.xml
4. Customizing project files
   • Customizing the project .properties file
   • Customizing the Maven settings.xml
5. Writing unit tests
   • Using the unit test base class
6. The ES masterpom
   • The ES masterpom (what it is and what it does for you) (under construction)
7. SVN patch files
   • Creating an SVN patch file using Eclipse

Using CSF modules

1. Using csf-email

Working with X509 Application Certificates

1. How to configure your web application to authenticate users with X509 Application Certificates

Working with Hibernate Mappings

1. How to configure your application to use Hibernate Mappings

Quick Tips

1. General Quick Tips
   
2. Hibernate Quick Tips
   
3. Maven Quick Tips
   
4. MyEclipse Quick Tips
   
5. OC4J Quick Tips
   
6. Tomcat Quick Tips

DWR deprecated

1. DWR has been deprecated in favor of MVC controllers.

Eclipse JVM memory configuration (do this if you are getting OutOfMemoryError: PermGen Space errors).

1. Eclipse Indigo - OC4J JVM memory configuration
2. Eclipse Indigo - Tomcat 7 JVM memory configuration
3. Eclipse myEclipse - OC4J JVM memory configuration
4. Eclipse myEclipse - Tomcat 7 JVM memory configuration

Creating a new Bamboo CI project

• The Bamboo CI project configuration (under construction)

Properties properties

• The project properties
  1. CSF Email properties
  2. CSF Local authentication/authorization properties
  3. CSF ROLES authorization properties
  4. ESAPIS and DASHBOARD properties

Available for downloading

1. MAC plugin for managing Environmental Variables
2. project.properties (right click on this link then select Save target as....  Navigate to your ${user.home} directory and click Save)
3. settings.xml (right click on this link then select Save target as....  Navigate to your ${user.home}/.m2 directory and click Save)
   This link contains instructions on how to configure the settings.xml file.
4. keystores and truststore downloads