Page Comparison

...

The following software prerequisites must be installed with the appropriate environment variables to build and run SSP:

• JDK 1.6 update 21 or later (JDK 1.7 is not supported as of 2013/01)7 only starting with v2.6.0 (master branch as of 9/1/2014).
  
  • Download Location: http://java.sun.com (openjdk works as well)

    Environment Variable: JAVA_HOME

    Tip

    title	Java Environment Variable

    JAVA_HOME=/path/to/your/java (ie: /usr/local/java or C:\java  Download Location: http://java.sun.com     Increasingly 1.7 is being hidden, the last known good link is here: JAVA 1.7 If that doesn't work, use the query "java jdk 1.7 download" in a search engine.

  • 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 20132014/0104)
  

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

    Warning

    .  Last known good link to download Tomcat is here: Tomcat 6.

    Warning
    title Tomcat Configuration
    It is important to complete sections: Environment Variables, Shared Libraries, Shared Sessions, Java Heap

  • The following are the key parts of the document linked above if you have already installed tomcat.
    
    
  • Download Loation: http://maven.apache.org

  • Environment Variable: MAVEN_HOME

    Tip

    title	Maven Environment Variables

    MAVEN_HOME= /path/to/your/maven

    • Edit CATALINA_BASE/conf/catalina.properties to include the shared library folders in the tomcat directory. You may need to create these folders depending on your system permissions, as well as include an absolute path instead of ${catalina.base} if the environment variables are not set correctly.

      Code Block
      shared.loader=${catalina.base}/shared/classes,${catalina.base}/shared/lib/*.jar

      Warning
      title Symptoms of not including this change
      localhost.<date>.log file will throw java.lang.ClassNotFoundException: javax.portlet.PortletMode exception as you start tomcat.

    • Edit CATALINA_BASE/conf/server.xml to allow the portlets to share user session data.

      Code Block
      <Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" emptySessionPath="true"/>

      Warning
      title Symptoms of not including this change
      If you go to localhost:8080/ssp-platform and login successfully, upon loading the SSP Portlet does not appear.

    • Edit CATALINA_BASE/bin/startup, or add an environment variable called CATALINA_OPTS as follows (note on Unix/Linux/OS X you should permanently export the environment variable)

      On Windows, Edit the file $TOMCAT_HOME\bin\startup.bat and insert or alter the following line, substituting for the desired values. The line you add should go just before the line starting call “%EXECUTABLE%”…:
      

      Code Block
      set CATALINA_OPTS=-XX:MaxPermSize=300m -Xmx1024m

    • On Linux/Unix/OS X, Edit the file $TOMCAT_HOME/bin/startup.sh and insert the following line, substituting for the desired value, eg. Bash Shell:

      Code Block
      export CATALINA_OPTS="-XX:MaxPermSize=300m -Xmx1024m"

    Warning
    title Symptoms of not including this change
    there will be a permGenSpace error reported in catalina.out as tomcat attempts to start.

  Maven 3.0.3 or later
  

  • • setenv.[sh|bat]

      Warning

      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

       

      Warning
      title Symptoms of not including this change
      PermGen space errors reported in catalina.out as tomcat attempts to start.

    • 
      

    • 
      

• Maven 3.0.3 or later
  
  • Download Location: 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    Last known good link: Ant Binaries

  • 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 Tools (current version 2.0.0.0 beta 3
  
  • Download Location: http://www.sencha.com/products/sdk-tools/download/   Note: Sencha CMD may not work well, particularly on Linux. If so use this query "SenchaSDKTools-2.0.0-beta3" in a search engine and pick the appropriate version from an alternate download source.
  • Environment Variable not required, but helpful in adding to path
  • Windows x64 users will also need to install a 32-bit Java SDK/JRE for the sencha build command to work properly (one of the jars in sencha looks for the 32-bit runtime and won't play nicely with the 64-bit SDK/JRE.)
  •  See  SSP Sencha Build Tool Usage for additional installation steps on 64-bit OSs
    

     

    Tip
    title Sencha SDK Tools
    PATH= append the Sencha SDK Tools installation directory (not the bin)

• RDBMS (support for PostgreSQL and Microsoft SQL Server)
  

...

default is ${db_username}

...

Examples:

Postgres: public

SQLServer: dbo

...

...

db_liquibase_manage_external_database_by_default

...

...

db_batchsize 

...

...

...

...

The initial types are pdf,gif,jpg,jpeg,doc,docx,xls,png. 

It is important to not include the period/dot in the definition.  Only the type abbreviation is required.

...

cacheLifeSpanInMillis 

...

...

Used for migrating persistent timestamps. Prior to work on SSP-1002, SSP-1035, and SSP-1076, timestamps were stored in the JVM default timezone.  After that the application assumes they are stored in ${db_time_zone}. In order to correctly migrate existing data, though, the app needs to know the original timezone. This is almost always going to be the current JVM default timezone, hence the default value here, which is a special value instructing the app to lookup and inject that timezone into this config property. In the rare event you need to change that value, you can do so here. This would likely only be necessary if, for whatever reason you change the JVM default *after* the migrations run, which would result in a Liquibase checksum error. To avoid that, just set the relevant timezone here when and if you make that change.

...

JVM-recognized TimeZone ID for the zone in which persistent date/time values should be interpreted. Should rarely if ever need to be overridden. If overridden, should always be set to a TimeZone that does not observe Daylight Savings Time unless trying to cope with legacy data that was stored in a DST-aware TimeZone. Once set, should never be changed else date/time values in the database will be interpreted incorrectly. (SSP does not store timezone data on persistent date/time values and implements no logic for  detecting and/or handling changes to this configuration option.)

Default is UTC

...

Action: copy the  logback.xml file to the local configuration directory (ie: C:\ssp\ssp-local)

...

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

...

4.  Build SSP

Use the following command to build the SSP-Open-Source-Project and install it in the local Maven repository:

C:\ssp\SSP-master>mvn install

C:\ssp\SSP-rel-1-1-0> mvn -Dmaven.test.skip=true install

C:\ssp\SSP-rel-1-1-0> mvn -PSKIP_SENCHA clean install

To build ssp as a developer stand alone environment that does not require uPortal;

...

Edit $SSP_CONFIGDIR/ssp-config.properties to set it as a standalone environment instead of a uportal environment:

# Spring profiles to activate:  can be comma delimited
# Can choose one of dev-standalone or uportal
spring.profiles.active=dev-standalone
#spring.profiles.active=uportal  <-- this will be uncommented by default

...

Copy the embedded LDAP file to $SSP_CONFIGDIR so that the user can authenticate:

• Linux/OSX:

  Code Block
  cp (ssp source folder)/SSP/src/main/config/devExternal/users.ldif $SSP_CONFIGDIR

...

Build the SSP War:

C:\ssp\SSP-master> mvn -PSTANDALONE -Dmaven.test.skip=true clean install

Copy the generated war to Tomcat, then restart tomcat (shutdown/startup)

cp (ssp source folder)/SSP/target/ssp.war $CATALINA_BASE/webapps

Note: prior to the above step you might need to delete an existing ssp directory and ssp.war file from the tomcat webapps directory if you have previously deployed this portlet.

...

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

1. Clone the SSP-Platform repository from GitHub

The SSP-Platform repository in GitHub contains the tool suite for SSP.  Installation begins with cloning the repository.  Two methods exist for obtaining the source files.

C:\\SSP-Platform>git clone -b ssp-master git@github.com:Jasig/uPortal.git

2. Modify SSP-Platform Configuration Files

• build.properties
  
  • The build.properties.sample file is copied or renamed in the current directory.  The parameter defines the location of Tomcat.
  • File Location: (uPortal-ssp-1-0-0)
  • Configuration Values: server.home parameter

server.home=D:/apps/tomcat6

• pom.xml (ONLY for non-JTDS jdbc driver installations on Microsoft SQL Server.  SSP-Platform now supports JTDS driver in the package)
  

• JDBC driver for SSP-Platform if not using PostgreSQL

  Warning
  The pom.xml should only be changed with extreme care.  This is only required for Microsoft SQL Server installations not using the default JTDS jdbc driver packaged with SSP-Platform.  The parameter defines the location of the driver in the local repository.

• File Location: (uPortal-ssp-1-0-0)

• Configuration Values: parameters

Action: modify the exist parameters defined for PostgreSQL


Code Block
title JDBC driver identified in the pom.xml
<!-- The JDBC Driver used by SSP --> <jdbc.groupId> </jdbc.groupId> <jdbc.artifactId> </jdbc.artifactId> <jdbc.version> </jdbc.version>

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:

ValueDescriptionenvironment.build.hibernate.connection.driver_classjdbc driver fileenvironment.build.hibernate.connection.urljdbc connection syntaxenvironment.build.hibernate.connection.usernamejdbc connection database usernameenvironment.build.hibernate.connection.passwordjdbc connection database passwordenvironment.build.hibernate.dialectjdbc connection dialect
• 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 or , 2008 R2, 2012, 2014
  
  • 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
  title SQL 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 ssp SET ALLOW_SNAPSHOT_ISOLATION ON ALTER DATABASE ssp SET READ_COMMITTED_SNAPSHOT ON

...

The following configurations are required to build and deploy SSP.

1. Create Directories

...

• Unix/Linux/Mac example: /usr/local/ssp

• Windows example: C:\ssp

Make the directory only readable by the user that is running Tomcat

• Unix/Linux/Mac example: /usr/local/ssp/ssp-local

• Windows example: C:\ssp\ssp-local

...

Set an Environment Variable for the local configuration file location

SSP_CONFIGDIR=/path/to/your/local-configuration (ie: /usr/local/ssp/ssp-local or C:\ssp\ssp-local)

2. Clone the SSP Open Source Project repository from GitHub

The SSP-Open-Source-Project repository in GitHub contains the tool suite for SSP.  Installation begins with cloning the repository.  Two methods exist for obtaining the source files.

C:\\ssp>git clone git@github.com:Jasig/SSP.git

3. Modify SSP Configuration Files

• Context.xml
  
  • A context.xml file is copied into the conf directory of Tomcat once the SSP application starts.  It can be edited prior to deployment or the file can be edited after the deployment.
  • File Location: src/main/webapp/META-INF/context.xml
  • Configuration Values: SSP configdir parameter

    <Parameter name="SSP_CONFIGDIR" value="C:/ssp/ssp-local" /> 

• ssp-config.properties
  
  • The ssp-config.properties file must be modifed for database connectivity and email settings
  • File Location: src/main/config/external to /usr/local/etc/ssp or C:\ssp (depending on the environment

  • Action: copy the  ssp-config.properties file to the local configuration directory (ie: C:\ssp\ssp-local)

  • Configuration Values:

...

...

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

    No Format
    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>;

...

Anchor
SSP Build SSP Build

Configure and Deploy SSP

The following configurations are required to build and deploy SSP.

1. Create Directories

• Create a home project directory for the project files
  
  • Unix/Linux/Mac example: /usr/local/ssp    or  /home/ssp   or /opt/ssp

  • Windows example: C:\ssp   

• Create a directory for the SSP and SSP-Platform config files
  • Unix/Linux/Mac example: /usr/local/ssp/ssp-config     or    /home/ssp/ssp-config   or    /opt/ssp/ssp-config
  • Windows example: C:\ssp\ssp-config    
    
    

• Make the directory readable by the user that is running Tomcat 

• Set an Environment Variable for the local configuration file location

  Tip
  SSP_CONFIGDIR=/path/to/your/local-configuration (ie: /usr/local/ssp/ssp-config or C:\ssp\ssp-config)

• If this is a server environment typically the project lives in: /opt/ssp/  (*nix) or C:\ssp (Windows). For most development installs, it's preferable to unzip Tomcat and not install through the source OS package manager. It's easier to configure, clear logs, and start/stop/restart that way. A /etc/init.d/ssp startup script or modification of setenv/startup.sh/bat script is also required before Tomcat starts to add the SSP_CONFIGDIR variable.

2. Clone the SSP Open Source Project repository from GitHub

The SSP-Open-Source-Project repository in GitHub contains the tool suite for SSP.  Installation begins with cloning the repository.  Two methods exist for obtaining the source files.

C:\\ssp>git clone git@github.com:Jasig/SSP.git

3. Modify SSP Configuration Files

• Context.xml
  
  • A context.xml file is copied into the conf directory of Tomcat once the SSP application starts.  It can be edited prior to deployment or the file can be edited after the deployment.
  • File Location: src/main/webapp/META-INF/context.xml
  • Configuration Values: SSP configdir parameter

    <Parameter name="SSP_CONFIGDIR" value="C:/ssp/ssp-config/ssp-config.properties" /> 

• ssp-config.properties
  
  • The ssp-config.properties file must be modifed for database connectivity and email settings
  • File Location: src/main/config/external

  • Action: copy the  ssp-config.properties file to the local configuration directory SSP_CONFIGDIR. (ie: C:\ssp\ssp-config or \home\ssp\ssp-config)

  • NOTE: There are more configuration values then present here. It's always a good idea to take the default config file copy to SSP_CONFIGDIR and make changes there

  • Configuration Values:

db_liquibase_manage_external_database_by_default

db_batchsize 

cacheLifeSpanInMillis 

• logback.xml
  
  • The logback.xml controls the log location and level
  • File Location: src/main/config/external

  • Action: copy the  logback.xml file to the local configuration directory SSP_CONFIGIDR (ie: C:\ssp\ssp-config or /home/ssp/ssp-config)

  • Configuration Values: property file
    
    

  Code Block
  title logback.xml
  <property file="C:/ssp/ssp-config/logback.xml"

   

  • Additional configuration options
    
    • Adjust the log levels for each log appender as necessary
    • Enable the smtpAppender (disabled by default)
    • Further details regarding managing the logback.xml are included in XML comments within the file
  • Common loggers used in past development have been:

    • Code Block
      title Common loggers
      <logger name="org.jasig.ssp.service.external.impl.ExternalPersonServiceImpl" level="debug" /> <!-- Turns on ExternalPersonSync task logging which by default runs at 1a.m. and does magic of updating person records from records --> <logger name="org.jasig.ssp.service.external.impl.ExternalPersonSyncTaskImpl" level="trace" />     <!-- Turns off Coach Sync logging which can be mundane --> <logger name="timing.org.jasig.ssp.service.impl.PersonServiceImpl" level="error" />   <logger name="org.jasig.ssp.service.impl.MapStatusReportCalcTaskImpl" level="debug" />   <!-- Turns off some Email errors which can be annoying if there is no SMTP server spun up--> <logger name="org.jasig.ssp.service.impl.MessageServiceImpl" level="error" />

       

       

       

4.  Build SSP

Use the following command to build the SSP-Open-Source-Project and install it in the local Maven repository (use quotes "-Dmaven.test.skip=true" for Windows):

C:\ssp\SSP\mvn clean -e -U -Dmaven.test.skip=true install

C:\ssp\SSP\mvn -PSKIP_SENCHA -Dmaven.test.skip=true clean -e -U install

...

Anchor
SSP-Platform Build SSP-Platform Build

Configure and Deploy SSP-Platform

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

1. Clone the SSP-Platform repository from GitHub

The SSP-Platform repository in GitHub contains the tool suite for SSP.  Installation begins with cloning the repository.  Two methods exist for obtaining the source files.

C:\ssp\git clone -b ssp-master git@github.com:Jasig/SSP-Platform.git

2. Modify SSP-Platform Configuration Files

• build.properties
  
  • The build.properties.sample file is copied or renamed in the SSP-Platform directory.  The server.home parameter defines the location of Tomcat (TOMCAT_HOME) and must be configured.
  • File Location: (uPortal/  or SSP-Platform/)
  • Configuration Values: server.home parameter

server.home=C:/ssp/tomcat

• pom.xml (ONLY for non-JTDS jdbc driver installations on Microsoft SQL Server.  SSP-Platform now supports JTDS driver in the package)
  

  • JDBC driver for SSP-Platform if not using PostgreSQL

    Warning
    The pom.xml should only be changed with extreme care.  This is only required for Microsoft SQL Server installations not using the default JTDS jdbc driver packaged with SSP-Platform.  The parameter defines the location of the driver in the local repository.

  • File Location: (uPortal/ or SSP-Platform/)

  • Configuration Values: parameters

  • Action: modify the exist parameters defined for SQL Server
    
    

    Code Block
    title JDBC driver identified in the pom.xml
    <!-- The JDBC Driver used by SSP --> <jdbc.groupId> </jdbc.groupId> <jdbc.artifactId> </jdbc.artifactId> <jdbc.version> </jdbc.version>

• ssp-platform-config.properties
  
  • The ssp-platform-config.properties file must be modifed for database connectivity and email settings
    • Original File Location: <SSP_PLATFORM_DIR>/uportal-war/src/main/resources/properties/ssp-platform-config.default.properties
    • Edit the file and save in the SSP_CONFIGDIR make sure to remove the "default" so it's named: "ssp-platform-config.properties"
  • Run-Time File Location: <SSP_CONFIGDIR>/ssp-platform-config.properties
    

     

  • Configuration Values:  NOTE: There are more values in the file than listed here. It's always a good idea to copy the file to SSP_CONFIGDIR, rename and then make modifications as necessary there.
    

    Value	Description
    environment.build.hibernate.connection.driver_class	jdbc driver file (See ssp-config.properties, this uses the same value) For best results with SQL Server, the JTDS driver included with the Platform installation is recommended.
    environment.build.hibernate.connection.url	jdbc connection syntax (See ssp-config.properties, this uses the same value) 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 (See ssp-config.properties, this uses the same value)
    environment.build.hibernate.connection.password	jdbc connection database password (See ssp-config.properties, this uses the same value)
    environment.build.hibernate.dialect	jdbc connection dialect (See ssp-config.properties, this uses the same value) 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) (All production should be https!)
    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

3.  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.... $> SSP_CONFIGDIR=/opt/ssp/sspconfig  ant -Dmaven.test.skip=true clean initdb deploy-ear: Build entire uPortal (incl. all wars), deploy entire uPortal to Tomcat.! ***

BuildE.g the full site and database by running ant initportal


Other deployment options:

dbtest: Tests the database settings and connectivity

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

deploy-war: Build & deploy _just the uPortal war_ (i.e. not portlets, etc.).

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

Build the full site and database: C:\ssp\uPortal-ssp-1-0-0>ant initportal


Other deployment options:

dbteston *nix.... $> SSP_CONFIGDIR=/opt/ssp/sspconfig ant -Dmaven.test.skip=true clean <target> 
   or 
export SSP_CONFIGDIR=/opt/ssp/sspconfig ; ant -Dmaven.test.skip=true clean <target> 

-----------
Most Common Commands

- Initialize the SSP-Platform database, then runs deploy-ear. (Basically initdb + deploy-ear) *Destructive!* Appropriate for first-time deployments only.

  $> ant -Dmaven.test.skip=true clean initportal

- To Build and deploy the entire SSP-Platform portal and the SSP war to Tomcat (most commonly used since initportal is only used once):

  $> 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-ear: Build entire uPortal (incl. all wars), deploy entire uPortal to Tomcat.

deploy-war: Build & deploy _just the uPortal war_ (i.e. not portlets, etc.).

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

• Additional step for Microsoft SQL Server to update column types

• Restart Tomcat

4. Test Deployment

• Start Tomcat and point your browser to http://localhost:8080/ssp-platform
  Click Sign In, and use the credentials user: admin password: admin

...

To install the SSP Demo Data

1. Update SSP & SSP-Platform Source

• Update ssp to either the 'master' branch or the 'rel-1-2-patches' branch depending on your needs for the environment
• Update ssp-platform to either the 'ssp-master' or the 'ssp-rel-1-1-patches' branch

2. Edit the config file

...

edit the line that reads;

db_liquibase_changelog=classpath:org/jasig/ssp/database/masterChangeLog.xml

to

db_liquibase_changelog=classpath:org/jasig/ssp/database/masterChangeLog-demo.xml

...

 configured seed data (src/main/data, not including the "quickstart" folder). *Destructive if database isn't empty/new!*

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
  
   $> ant -Dmaven.test.skip=true deployPortletApp -DportletApp=../SSP/target/ssp.war
 

• Additional step for Microsoft SQL Server to update column types

• Restart Tomcat     (../tomcat/bin/shutdown.sh ...  ../tomcat/bin/startup.sh  OR /etc/init.d/ssp/restart   OR  windows service tomcat restart)

4. Test Deployment

• Start Tomcat and point your browser to http://localhost:8080/ssp-platform
  Click Sign In, and use the credentials    user: admin     password: admin
  
  

...

Anchor
ssp-demo-data ssp-demo-data

SSP Demo Data Installation

To install the SSP Demo Data

1. Update SSP & SSP-Platform Source

• Demo data was introduced starting with SSP v1.2.0 and SSP-Platfrom v1.1.0. You'll need to be running those or later versions.

2. Edit the config file

• open 'ssp-config.properties' in your SSP_CONFIGDIR directory 

• edit the line that reads;

  Code Block
  db_liquibase_changelog=classpath:org/jasig/ssp/database/masterChangeLog.xml

  to

  Code Block
  db_liquibase_changelog=classpath:org/jasig/ssp/database/masterChangeLog-apiTest.xml

  Warning
  title Demo Data
  The "masterChangeLog-demo.xml" is old and not supported post SSP 2.2.0. Use the above masterChangeLog-apiTest.xml (which is also older but more up to date) or the ssp-training data at https://github.com/Jasig/ssp-training for the most up to date demo, training, and CI data. If you must use masterChangeLog-demo data see this: Before re-building and restarting Tomact, if you're on SSP v2.0.1 or later you'll likely need to drop some database constraints in order for the demo data to load. See  https://issues.jasig.org/browse/SSP-1877. There is also an open PR that patches the demo data itself as an alternative to manipulating db constraints Rebuild SSP and Deploy Portlet as below. Navigate to the SSP-Platform source directory and run the following command to import the uPortal user files so you can login Code Block ant -Dmaven.test.skip=true -Ddir=uportal-war/src/main/data/ssp_demo_entities data-import You should see a long list of various usernames loaded in with this step To test this, login as one of the coaches listed on the SSP Demo Data Documentation page and ensure that you can see students and their associated data listed for the coach you login as.

• Save this change. It will be picked up on the next Tomcat restart. 
  
  
  
• 3. Build and Deploy SSP

• Navigate to the SSP source directory and Run the following command to build SSP

  Code Block
  C:\ssp\master>SSP mvn clean -Dmaven.test.skip=true -e -U install

• Navigate to your SSP-Platform source directory and run the following command to deploy SSP

  Code Block
  ant deployPortletApp -DportletApp=(Your SSP source directory)/target/ssp.war

• Stop/Start (or restart) tomcat
• If you watch the catalina.out log file you should see liquibase acquire the changeset and run the changeset for adding demo data. 

4. Import uPortal Userfiles

...

ant -Dmaven.test.skip=true -Ddir=uportal-war/src/main/data/ssp_demo_entities data-import

...

• , localhost.log, and/or stderr.log/stdout.log  log file(s) depending on the Tomact instance, you should see liquibase acquire the changeset and run the changeset for adding the demo data. 

   To test this, login as  admin, admin or coach1, password0 and ensure that you can see students and their associated data listed for the coach you login as.

...

Running the API Integration Tests

...

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