Released on November 21, 2014

For all existing installations of 2.0.X and 2.1.X, important upgrade instructions exist in the previous 2.12.2, 2.3, 2.4, 2.5.1 and 2.5.2  Release notes. 

  • To upgrade from 2.0.X follow the upgrade instructions for 2.12.22.3, 2.4, 2.5.1 and 2.5.2 Release Notes before deploying the 2.5.2 code
  • To upgrade from 2.1.X follow the upgrade instructions for the 2.22.3, 2.4, 2.5.1 and 2.5.2 Release Notes before deploying the 2.5.2 code
  • To upgrade from 2.2.X follow the upgrade instructions for the  2.3, 2.4, 2.5.1 and 2.5.2 Release Notes before deploying the 2.5.2 code
  • To upgrade from 2.3.X follow the 2.4, 2.5.1 and 2.5.2 Release Notes before deploying the 2.5.2 code
  • To upgrade from 2.4.X following the 2.5.1 and 2.5.2 Release Notes before deploying the 2.5.2 code
  • New installations of 2.6.0 are not required to make any additional change

If you are running a SSP version prior to 1.1.1, you are strongly encouraged to upgrade or otherwise apply the reporting subsystem security patches described by SSP-701.

If you are running SSP version 2.0.0 or 2.0.0-b3, you are strongly encouraged to upgrade to 2.0.1 or 2.1.0 or 2.2.0 or later or otherwise apply the Confidentiality Level-related patches for the Student Documents tool as described by SSP-1917.

Also please take a few minutes to review additional security-related announcements detailed at the top of the SSP space here in Confluence.

Step by step instructions for building and deploying the SSP 2.6.0 release.

  1. Software Prerequisites (JDK, Tomcat, Maven, Ant, RDBMS)
  2. SSP Platform build and deployment

Software Prerequisites

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

USE [ssp]
GO
IF NOT EXISTS 
(SELECT name FROM sys.filegroups WHERE is_default=1 AND name = 
N'PRIMARY') ALTER DATABASE [ssp] MODIFY FILEGROUP [PRIMARY] DEFAULT
GO
IF NOT EXISTS (SELECT name  FROM sys.database_principals WHERE name = 'ssp')
BEGIN
CREATE USER [ssp] FOR LOGIN [ssp]
EXEC sp_addrolemember N'db_datawriter', N'ssp'
EXEC sp_addrolemember N'db_datareader', N'ssp'
END
GO
CREATE USER [sspadmin] FOR LOGIN [sspadmin]
GO
EXEC sp_addrolemember N'db_owner', N'sspadmin'
GO
For MSSQL 2008 or later (note that these statements must be executed while *no other connections to the current database are open*):

ALTER DATABASE MyDatabase
 SET ALLOW_SNAPSHOT_ISOLATION ON
ALTER DATABASE MyDatabase
 SET READ_COMMITTED_SNAPSHOT ON

Also note that for SQLServer the "operational" SSP database user ('ssp' in the example above) must be allowed to execute stored procedures. In most deployments this does not require special configuration, but in the event your security policies are such that that user must be explicitly granted execute permissions on specific stored procs, here are the statements which you would likely need to run. (Use 'dbo' for <schema> unless you know the value should be something else (db_schema from $SSP_CONFIGDIR/ssp-config.properties); use 'ssp' for <ssp-operational-user> unless you've chosen a different name for that account (db_username from $SSP_CONFIGDIR/ssp-config.properties).):

GRANT EXEC on <schema>.REFRESH_MV_DIRECTORY_PERSON to <ssp-operational-user>;
GRANT EXEC on <schema>.REFRESH_MV_DIRECTORY_PERSON_BLUE to <ssp-operational-user>;
GRANT EXEC on <schema>.update_directory_person_from_view_where_school_id to <ssp-operational-user>;
GRANT EXEC on <schema>.update_directory_person_from_view_where_person_id to <ssp-operational-user>;

Currently SSP supports use of PosgreSQL 9.x and Microsoft SQL Server 2008, or 2008 R2. Starting with 2.5.2, SSP has begun to include patches for SQLServer 2012 compatibility and at least one real-world 2.5.2 deployment is running against SQL Server 2012, although the SSP project team does not officially test against that SQL Server version.

 


Configure and Deploy SSP-Platform

The following configurations are required to build and deploy SSP-Platform.

1. Download the SSP-Platform Release

 

Zip Download
The source files can be downloaded in a zip file

Download Location: SSP-Platform-2-6.0.zip    ("SSP Platform" is a portal application which acts container for SSP itself. The two applications are versioned independently. By default, version 2.6.0 of SSP Platform will include version 2.6.0 of SSP.)

  • Unzip the file into a suitable path (e.g. on Windows C:\ssp\platform-src or on Unix/Linux/Mac /usr/local/ssp/platform-src)

2. SSP Configuration Files

 

logback.xml

<property file="C:/ssp/ssp-local/ssp-config.properties" />

 

3. Modify SSP-Platform Configuration Files

server.home=C:/path/to/your/tomcat/install

4. Build SSP-Platform

 

*** When running a database initialization ant target (initportal, initdb), you need to specify SSP_CONFIGDIR if it isn't already specified as an env var. 

E.g on *nix.... $> SSP_CONFIGDIR=/opt/ssp/sspconfig ant -Dmaven.test.skip=true clean <target> 

Most Common Commands
 
- Re/Initialize the SSP-Platform database, then run the equivalent of deploy-ear. Destructive! Appropriate for first-time deployments.

  $> SSP_CONFIGDIR=/opt/ssp/sspconfig ant -Dmaven.test.skip=true clean initportal

- Build and deploy entire SSP-Platform portal, including SSP:
 
  $> SSP_CONFIGDIR=/opt/ssp/sspconfig ant -Dmaven.test.skip=true clean deploy-ear


Other commonly used ant targets:

testdb: Tests the database settings and connectivity

initdb: Drop SSP-Platform tables in the db & recreate them with configured seed data (src/main/data, not including the "quickstart" folder).

deploy-war: Build & deploy _just the SSP-Platform war_ (i.e. not SSP or other portlets, etc.).

deployPortletApp: Deploy one (already-built) portlet war file to Tomcat (example ant deploPortletApp -DportletApp=../SSP-Open-Source-Project/target/ssp.war)

 

 

Follow steps 2 & 3 from the following page to update appropriate database tables for SSP-PLATFORM

 

 

5. Test Deployment

 

 

6. Production Deployment Tips

If anything in it is incorrect or unclear, please leave a comment below.