Context Navigation

Changes between Version 96 and Version 97 of DeveloperInstructions

Timestamp:: 07/16/14 11:44:25 (10 years ago)
Author:: Vangel Ajanovski
Comment:: —

Legend:

: Unmodified
: Added
: Removed
: Modified

DeveloperInstructions

-              v96
+              v97
 If this is not the one you installed for our purpose, delete that one or add new one that points to the JDK that you installed (and not JRE) similar to the image below
+[[Image(2.jpg)]]
+Before running or building the project, several local parameters should be set.
+This is done via a standard way of maven profiles, so you should open/create a file named '''settings.xml''' in the '''.m2''' directory in your main OS user profile directory.
+[[Image(eclipse_ide_choose_jdk.png)]]
+== Building the project ==
+Before running or building the project, several local parameters should be set depeding how to run the project, the paths, which database to use, etc.
+This is done via a standard way of maven profiles, so you should open/create a file named '''settings.xml''' in the '''.m2''' directory in your user profile directory.
 If you don't know where this is - check Eclipse preferences - maven - user settings.
 …
 You can create several profiles in this file, with different id and activation parameters, so that you can use choose the one you want on running the application, or packaging for deployment.
+Contact the developer team for parameter values for the development test servers. Otherwise install PostgreSQL, setup a username, password and create a UTF-8 database, and set the '''hbm2ddlauto''' parameter to '''update''', and the database schema structure will be automatically created.
+With hbm2ddlauto=update used, enables updates to the database schema structure when the Java source code of the Entities changes, otherwise the default value of this parameter is '''validate'''.
+More precisely this parameter designates that the database will be scanned and if the source code has structural changes, such changes will be automatically implemented in the database schema. This should be only used by intenet and it should not be left as default as unwanted changes could be commited to the database by mistake without a warning. So set this to update only when you are about to make database structure changes and then change it back to validate, which only checks that the source and the schema correspond.
+If you use another database system then hibernate.dialect should be changed, '''but this is not tested'''.
+'''CAS (CENTRAL AUTHENTICATION SERVICE)'''
+Contact the developer team for parameter values for the development test servers and example content of this file.
+Otherwise, if you are not part of the official developer team - you can do it yourself, but harder. Install PostgreSQL, setup a username, password and create a new empty UTF-8 database, and set the '''hbm2ddlauto''' parameter to '''update''', and the database schema structure will be automatically created. WARNING: if you create the database yourself, you will need some seed data in some tables to be able to use the application. Check ModelConstants.java for some of the special codes of entities that you will need to have and cope with this :)
+When hbm2ddlauto=update is used, it enables updates to the database schema structure when the Java source code of the Entities changes, otherwise the default value of this parameter is '''validate'''.
+More precisely this parameter designates that the database will be scanned and if the source code has structural changes, such changes will be automatically implemented in the database schema. This should be only used by intent and it should not be left as default as unwanted changes could be commited to the database by mistake without a warning.
+'''So set this to UPDATE only when you are about to make database structure changes and then change it back to VALIDATE, which only checks that the source and the schema correspond.'''
+If you use another database system, then hibernate.dialect should be changed, '''but this is not tested'''.
+=== CAS (CENTRAL AUTHENTICATION SERVICE) ===
+The application uses CAS for login authentication, so you need to set up a test service.
 If you already have a CAS server, change the paths in the settings.xml file.
 …
 - Download any of the 3.5.x CAS versions  from [http://downloads.jasig.org/cas/] and unpack it.
 - Find the file named CAS-server-webapp-versionnumber.war and copy it to the main folder of the Eclipse project and rename it to cas.war
+- Find the included file named CAS-server-webapp-someversionnumber.war and copy it to the main folder of the isis project and rename it to cas.war
 This will enable a test login to the system, whereas the username is anything you need, and the password is the same as the username.
+'''Start the application from Eclipse'''[[BR]]
+Run -> Run Configurations  , then in the maven section right click then New, use any Name you like (for example '''start dossier'''), Base Directory -> ${workspace_loc:/projectname} , Goals -> '''clean jetty:run'''
+In the parameter add one with the name of '''env''', and value of '''develop'''.
+Repeat this again all the same but with a Name '''stop app''' and Goals '''jetty:stop'''
+=== Running the application from Eclipse ===
+Run -> Run Configurations  , then in the maven section right click then New, use any Name you like (for example '''start isis'''), Base Directory -> ${workspace_loc:/isis} , Goals -> '''clean jetty:run'''
+In the profiles put the name of the profile (the id of the profile) that you have put in .m2/settings.xml.
+Usually you will have separate profiles for testing database, profile for official database, etc. This is where you choose how will the application run and where it will connect to.
+Repeat this again for another configuration for stopping the app - all the same but with a Name '''stop isis''' and Goals '''jetty:stop'''
 It should look like this:[[BR]]
 …
 Click on Run and the application will begin to build.
+Note that on the first run, Maven will try to download all required libraries for development from the Internet and setup the library paths for all dependencies. This can take a very long time if your connection is not fast.
+On subsequent runs, this will not happed, but Maven tries to check for changes. If you want to speed up the process, after everything has been run without problems at least once, you should check the parameter '''Offline''' in the Maven parameters for that run configuration.
+The system listens on port 8081 (Jetty on 8081)
+http://localhost:8081/
+Note that on the first run, Maven will try to download all required libraries for runtime from the Internet and setup the library paths for all dependencies. This can take a very long time if your connection is not fast. On subsequent runs, this will not happen, as Maven only checks for updates. If you want to speed up the process, after everything has been run without problems at least once, you should check the parameter '''Offline''' in the Maven parameters for that run configuration.
+If everything is OK you will see in the console log that the system listens on port 8081 (Jetty on 8081)
+So open
+http://localhost:8081/upisi
+in your browser
 '''Note:'''