Page Comparison

...

...

The following software prerequisites must be installed with the appropriate environment variables to build and run SSP:ssp-platform.PNG

• JDK 1.6 update 21 or later (JDK 1.7 is not supported as of 2014/08; the .7 is required starting with v2.6.0.  JDk 1.6 will no longer work.  The SSP development team has also observed somewhat better GC performance with the Sun/Oracle JDK vs OpenJDK)
  
  • Download Location: http://java.sun.com

  • Environment Variable: JAVA_HOME

    Tip
    title Java Environment Variable
    JAVA_HOME=/path/to/your/java (ie: /usr/local/java or C:\java\jdk) (optional) PATH= append the bin subdirectory to the path statement

• Tomcat 6.X (Tomcat 7 is not supported as of 2014/04)

  • Instructions for installing and configuring Tomcat for the SSP-Platform (uPortal 4.0)

    Warning
    title Tomcat Configuration
    It is important to complete sections: Environment Variables, Shared Libraries, Shared Sessions, Java Heap.  Minimally, the catalina.properties file must contain: shared.loader=${catalina.base}/shared/lib/*.jar   And your active connector/s in <tomcat>/conf/server.xml must have the emptySessionPath flag set:   <Connector port="8080" protocol="HTTP/1.1"     connectionTimeout="20000" redirectPort="8443" emptySessionPath="true"/> And increase the heap in <tomcat>/bin/setenv.sh (*nix) or <tomcat>/bin/setenv.bat (Windows). Smaller sizing is probably feasible, but the examples below match what our SSP CI envs run with. For production systems, start with a max heap of roughly half available physical memory and increase from there if necessary. The uPortal instructions above recommend using JAVA_OPTS for heap sizing. This can lead to problems on memory constrained systems because JAVA_OPTS will be used when trying to stop Tomcat with its own scripts. You don't typically need a large heap at all for that operation. So CATALINA_OPTS is a better choice for sizing the heap in setenv scripts, because that var will only be used for Tomcat's http-serving runtime. setenv.sh: CATALINA_OPTS=-Xms2G -Xmx2G -XX:PermSize=256m -XX:MaxPermSize=256m setenv.bat (uPortal instructions linked to above are missing the 'set'): set CATALINA_OPTS=-Xms2G -Xmx2G -XX:PermSize=256m -XX:MaxPermSize=256m

  • Additionally, a performance improvement has been experienced by enabling compression in Tomcat

    Tip
    Add compression="force" to the server.xml in the connector like the following:   <Connector port="8080" protocol="HTTP/1.1 connectionTimeout="20000" redirectPort="8443" emptySessionPath="true" compression="force" />

• Maven 3.0.3 or later
  
  • Download Loation: http://maven.apache.org

  • Environment Variable: MAVEN_HOME

    Tip
    title Maven Environment Variables
    MAVEN_HOME= /path/to/your/maven (ie: /usr/local/maven or C:\tools\maven) M2_HOME= /path/to/your/maven (ie: /usr/local/maven or C:\tools\maven) (optional) PATH= append the bin subdirectory to the path statement

• Ant 1.8.2 (use this exact version)
  

  • Download Location: http://ant.apache.org

  • Environment Variable: ANT_HOME

    Tip
    title Ant Environment Variable
    ANT_HOME= /path/to/your/ant (ie: /usr/local/ant or C:\tools\ant) (optional) PATH= append the bin subdirectory to the path statement

• Sencha SDK
  

  • Download Location: http://www.sencha.com/products/sdk-tools/download

    Tip
    PATH= append the root to the path statement

    
    

  • See  SSP Sencha Build Tool Usage for additional installation steps on 64-bit OSs
    
    

• RDBMS (support for PostgreSQL and Microsoft SQL Server)
  
  • PostgreSQL 9.1 or later
    
    • Download Location: http://www.postgresql.org
      
      • On Unix:
        
        • PostgreSQL is available in the package manager of most linux distributions.
          
          • Install it according to the distribution's instructions
        • Ubuntu - https://help.ubuntu.com/11.10/serverguide/C/postgresql.html
      • On Mac:
        
        • PostgreSQL is available via the homebrew package manager or as a download on the postgresql.org site.
      • On Windows:
        
        • PostgreSQL is available as a download on the postgresql.org site.
    • Configure PostgreSQL
      
      • Server Connection
        
        • Launch the PG Admin application
        • In the Object Browser, navigate to and right click on Server Groups -> Servers -> PostgreSQL 9.1 (localhost:5432)
        • Click Connect and the enter the administrator password
      • Login Roles
        
        • In the Object Browser, right click on Login Roles and click New Login Role
          

          • In the Properties tab, enter a Role name of "sspadmin" without the quotes

          • In the Definition tab, enter a Password of "sspadmin" without the quotes

        • In the Object Browser, right click on Login Roles and click New Login Role

          
          

          • In the Properties tab, enter a Role name of "ssp" without the quotes

          • In the Definition tab, enter a Password of "ssp" without the quotes

        • Confirm the new Login Roles exist in the Object Browser
      • Database
        
        • In the Object Browser, right click on Databases and click New Database
          
          • Enter "ssp" without the quotes as the database name
          • Enter "sspadmin" without the quotes as the database owner
        • Confirm the new database exists in the Object Browser
  • Microsoft SQL Server 2008 R2 and 2012
    
    • Server Connection
      
      • Launch the SQL Server Management Studio application
      • Enter your database connection info including administrator account credentials, and click Connect
    • Login Roles
      
      • Navigate to Security->Logins, and right click on New Login
        
        • Login name of "sspadmin" without the quotes
        • Select SQL Server authentication and enter a Password of "sspadmin" without the quote
        • Uncheck Enforce password policy
      • Right click on Logins again, and New Login Role
        
        • Login name of "ssp" without the quotes
        • Select SQL Server authentication and enter a Password of "ssp" without the quote
        • Uncheck Enforce password policy
      • Confirm the new users exist
    • Database
      
      • Navigate to and right click on Databases and click New Database
        
        • Enter "ssp" without the quotes as the database name
      • Confirm the new database exists
      • Run the following SQL to assign user permissions and configure the required database settings

...

...

• • ssp-platform-config.properties
    
    • The ssp-platform-config.properties file must be modifed for database connectivity and email settings
      • Original File Location: ./uportal-war/src/main/resources/properties/ssp-platform-config.default.properties
      • Edit the file and save in the SSP_CONFIGDIR
    • Run-Time File Location: <SSP_CONFIGDIR>/ssp-platform-config.properties

    • Configuration Values:

    Value	Description
    environment.build.hibernate.connection.driver_class	jdbc driver file For best results with SQL Server, the JTDS driver included with the Platform installation is recommended.
    environment.build.hibernate.connection.url	jdbc connection syntax For best results with SQL Server, the JTDS driver included with the Platform installation is recommended.
    environment.build.hibernate.connection.username	jdbc connection database username
    environment.build.hibernate.connection.password	jdbc connection database password
    environment.build.hibernate.dialect	jdbc connection dialect For best results with SQL Server, the JTDS driver included with the Platform installation is recommended.
    environment.build.uportal.server	Hostname and port for your SSP deployment. (Default: localhost:8080)
    environment.build.uportal.protocol	HTTP/S protocol at which end users access your SSP deployment. (Default: http)
    environment.build.uportal.email.fromAddress	Address from which Platform email will originate. Rarely used. (Default: ssp@university.edu)
    environment.build.sso.*	Several properties which configure inbound LTI and legacy SSO. See documentation specific to those features: SSP LTI Provider and SSP Signed URL SSO. Note that to enable these features environment.build.sso.local.sharedSecret must be set to the same non-empty value as ssp_platform_sso_ticket_service_shared_secret in $SSP_CONFIGDIR/ssp-config.properties

...

• • (database specific attributes)	(default values)
    environment.build.raweventsdb.connection.driver_class	${environment.build.hibernate.connection.driver_class}
    environment.build.raweventsdb.connection.url	${environment.build.hibernate.connection.url}
    environment.build.raweventsdb.connection.username	${environment.build.hibernate.connection.username}
    environment.build.raweventsdb.connection.password	${environment.build.hibernate.connection.password}
    environment.build.aggreventsdb.connection.driver_class	${environment.build.hibernate.connection.driver_class}
    environment.build.aggreventsdb.connection.url	${environment.build.hibernate.connection.url}
    environment.build.aggreventsdb.connection.username	${environment.build.hibernate.connection.username}
    environment.build.aggreventsdb.connection.password	${environment.build.hibernate.connection.password}
    environment.build.portaldb.initial.size	1
    environment.build.portaldb.min.idle	1
    environment.build.portaldb.max.active	50
    environment.build.portaldb.max.idle	50
    environment.build.portaldb.max.wait	2000
    environment.build.portaldb.abandon.when.percentage.full	70
    environment.build.portaldb.remove.abandoned	TRUE
    environment.build.portaldb.remove.abandoned.timeout	300
    environment.build.portaldb.jdbc.interceptors	ConnectionState(useEquals=true);ResetAbandonedTimer
    environment.build.portaldb.test.while.idle	TRUE
    environment.build.portaldb.test.on.borrow	TRUE
    environment.build.raweventsdb.initial.size	1
    environment.build.raweventsdb.min.idle	1
    environment.build.raweventsdb.max.active	50
    environment.build.raweventsdb.max.idle	50
    environment.build.raweventsdb.max.wait	2000
    environment.build.raweventsdb.abandon.when.percentage.full	70
    environment.build.raweventsdb.remove.abandoned	TRUE
    environment.build.raweventsdb.remove.abandoned.timeout	300
    environment.build.raweventsdb.jdbc.interceptors	ConnectionState(useEquals=true);ResetAbandonedTimer
    environment.build.raweventsdb.test.while.idle	TRUE
    environment.build.raweventsdb.test.on.borrow	TRUE
    environment.build.aggreventsdb.initial.size	1
    environment.build.aggreventsdb.min.idle	1
    environment.build.aggreventsdb.max.active	50
    environment.build.aggreventsdb.max.idle	50
    environment.build.aggreventsdb.max.wait	2000
    environment.build.aggreventsdb.abandon.when.percentage.full	70
    environment.build.aggreventsdb.remove.abandoned	TRUE
    environment.build.aggreventsdb.remove.abandoned.timeout	300
    environment.build.aggreventsdb.jdbc.interceptors	ConnectionState(useEquals=true);ResetAbandonedTimer
    environment.build.aggreventsdb.test.while.idle	TRUE
    environment.build.aggreventsdb.test.on.borrow	TRUE

4. Build SSP-Platform

• Use the following command to build, deploy, and initialize the SSP-Platform project:

...