Page Comparison

...

Released on April 24, 2014

...

• 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 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:
    
    • 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
  
  • 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

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:

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

...

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

1. Download the SSP-Platform Release

...

• • 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 server JASIG Issue Tracker serverId 76221f40-4501-3df1-8578-6c87908cbdf7 key SSP-2380

• 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
    
    • 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

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:

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

...

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

         <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

...

• 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.

• ./uportal-war/src/main/data/ssp_entities/portlet-definition/ssp.portlet-definition.xml

  • Note
    Don't forget this step. Without it, you'll experience seemingly random timeout error messages when trying to access the SSP portlet.

  • Change line 28 from <timeout>120</timeout> to <timeout>20000</timeout>

4.  Build SSP-Platform

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

*** 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)

• Additional step for Microsoft SQL Server to update column types

...