Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Released on April 24, 2014

Info

Update June 24, 2014: Several significant bug fix patches have accumulated in the 2.4.x maintenance branch since 2.4.0 was released. Until a 2.4.1 GA is announced, upgrades and new installs targeting 2.4.x are strongly encourages to build and deploy the tip of the maintenance branch.

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

  • To upgrade from 2.0.X follow the upgrade instructions for 2.12.22.3 and 2.4 Release Notes before deploying the 2.4 code
  • To upgrade from 2.1.X follow the upgrade instructions for the 2.22.3 and 2.4   Release Notes before deploying the 2.4 code
  • To upgrade from 2.2.X follow the upgrade instructions for the  2.3 and 2.4  Release Notes before deploying the 2.4 code
  • To upgrade from 2.3 follow the 2.4 Release Notes before deploying the 2.4 code
  • New installations of 2.4.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 All implementers of this release should consider installing the patches listed in the commit section of the SSP-2721 issue details.

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

...

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

      Tip
      titleMaven 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
    titleAnt 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 statementSencha 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:
    • 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
       
      Blacklist several known-bad repos. If you don't already have a ~/.m2/settings.xml, use the following:
      • No Format
        <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                              http://maven.apache.org/xsd/settings-1.0.0.xsd">
          <profiles>
            <profile>
              <id>exclude-bad-repos</id>
              <activation>
                <activeByDefault>true</activeByDefault>
              </activation>
              <repositories>
                <repository>
                  <id>codehaus</id>
                  <url>http://repository.codehaus.org</url>
                  <releases>
                    <enabled>false</enabled>
                  </releases>
                  <snapshots>
                    <enabled>false</enabled>
                  </snapshots>
                </repository>
                <repository>
                  <id>sonatype-nexus-snapshots</id>
                  <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
                  <releases>
                    <enabled>false</enabled>
                  </releases>
                  <snapshots>
                    <enabled>false</enabled>
                  </snapshots>
                </repository>
                <repository>
                  <id>sonatype-nexus-staging</id>
                  <url>http://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
                  <releases>
                    <enabled>false</enabled>
                  </releases>
                  <snapshots>
                    <enabled>false</enabled>
                  </snapshots>
                </repository>
              </repositories>
            </profile>
          </profiles>
        </settings>

        This issue is being tracked by 

        Jira Legacy
        serverJASIG Issue Tracker
        serverId76221f40-4501-3df1-8578-6c87908cbdf7
        keySSP-2380

  • Ant 1.8.2 (use this exact version)
    • Download Location: http://ant.apache.org

    • Environment Variable: ANT_HOME

      Tip
      titleAnt 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
  • RDBMS (support for PostgreSQL and Microsoft SQL Server)
    • PostgreSQL 9.1 or later
      • Download Location: http://www.postgresql.org
        • On Unix:
        • 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
      • 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
Code Block
titleSQL Server Configurations
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
Code Block
For MSSQL 2008 or later:

ALTER DATABASE MyDatabase
 SET ALLOW_SNAPSHOT_ISOLATION ON
ALTER DATABASE MyDatabase
 SET READ_COMMITTED_SNAPSHOT ON
Info
titleRDBMS Platform Flexibility

Currently SSP supports use of PosgreSQL and Microsoft SQL Server 2008, or 2008 R2.  The project team develops and tests against PostgreSQL and Microsoft SQL Server.

Future support for Oracle and other RDBMS is planned.

 

...

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-4-0.zip     ("SSP Platform" is a portal application which acts container for SSP itself. The two applications are versioned independently. By default, version 2.4.0 of SSP Platform will include version 2.4.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)
Tip
In order to build SSP-Platform directly from the Github repository, follow the developer environment instructions.  The requisite software and configurations are similar but add the git component to maintain a local repository.
sspadmin] FOR LOGIN [sspadmin]
GO
EXEC sp_addrolemember N'db_owner', N'sspadmin'
GO
Code Block
For MSSQL 2008 or later:

ALTER DATABASE MyDatabase
 SET ALLOW_SNAPSHOT_ISOLATION ON
ALTER DATABASE MyDatabase
 SET READ_COMMITTED_SNAPSHOT ON
Info
titleRDBMS Platform Flexibility

Currently SSP supports use of PosgreSQL and Microsoft SQL Server 2008, or 2008 R2.  The project team develops and tests against PostgreSQL and Microsoft SQL Server.

Future support for Oracle and other RDBMS is planned.

 

...

Anchor
SSP-Platform Build
SSP-Platform Build
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-4-0.zip     ("SSP Platform" is a portal application which acts container for SSP itself. The two applications are versioned independently. By default, version 2.4.0 of SSP Platform will include version 2.4.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)
Tip

In order to build SSP-Platform directly from the Github repository, follow the developer environment instructions.  The requisite software and configurations are similar but add the git component to maintain a local repository.

Update June 24, 2014: Those instructions also describe how to build SSP from source, which you'll need to do if you're targeting the latest 2.4.x patches ahead of the 2.4.1 GA. If you're deploying the 2.4.0 GA of Platform, but want to target SSP 2.4.1-SNAPSHOT (i.e. the latest 2.4.x), build SSP first, then update the SSP dependency in <platform-src>/uportal-portlets-overlay/ssp/pom.xml before building Platform. Find the <dependency> referring to ssp and update the <version> as shown below:

No Format
         <dependency>
            <groupId>org.jasig.ssp</groupId>
            <artifactId>ssp</artifactId>
            <version>2.4.1-SNAPSHOT</version>
            <type>war</type>
            <exclusions>
                <exclusion>
                    <groupId>javax.portlet</groupId>
                    <artifactId>portlet-api</artifactId>
                </exclusion>
            </exclusions> 
        </dependency>

2. SSP Configuration Files

...

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

 

Code Block
*** 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....** 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 <target> 
initportal
Most
Common Commands
- Build entire uPortal (incl. all wars),and deploy entire uPortal, ant deploy-ear

- Build the full site and database, ant initportal (Warning- this will reset the entire uPortal database)


Other deployment optionsSSP-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 uPortalSSP-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 uPortalSSP-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)
Info
titleNOTE
This command will download the SSP .war file and bundle it into the output of the SSP-Platform build

 

  • Additional step for Microsoft SQL Server to update column types

...