Page Comparison

...

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 Tools (current version 2.0.0.0 beta 3
- Download Location: http://www.sencha.com/products/sdk-tools/download/
- 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.)
  
  Tip
  title Sencha SDK Tools
  PATH= append the Sencha SDK Tools installation directory (not the bin)

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 2005 2008 or 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

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

ALTER DATABASE ssp
 SET ALLOW_SNAPSHOT_ISOLATION ON;
 SET TRANSACTION ISOLATION LEVEL SNAPSHOT
ALTER DATABASE ssp
 SET READ_COMMITTED_SNAPSHOT ON;
 SET TRANSACTION ISOLATION LEVEL READ COMMITTED

For MSSQL 2008 or later:

ALTER DATABASE ssp
 SET ALLOW_SNAPSHOT_ISOLATION ON
ALTER DATABASE ssp
 SET READ_COMMITTED_SNAPSHOT ON

Info

title	RDBMS Platform Flexibility

Currently SSP supports use of PosgreSQL and Microsoft SQL Server 2005, 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.

...

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:

Value	Description	Note
system_id	Unique identifier of the SSP instance
db_username	Values for connecting to the SSP database
db_password	Values for connecting to the SSP database
db_admin_username	Values for connecting to the SSP database
db_admin_password	Values for connecting to the SSP database
db_name	Value for the SSP database
db_url	jdbc connection syntax	For Microsoft SQL Server, either specify a port (the default is 1433) or ensure that the SQL Server Browser service is running because the SQL Server JDBC driver defaults to port 1434 which is the SQL Server Server Browser service default port. Depending on the server configuration, either may work, or you may want to explicitly specify the port and instance name, if applicable.
db_driver_class	jdbc database connectivity syntax
db_dialect	Hibernate dialect	Use of one of the `org.jasig.ssp.util.hibernate.ExtendedSQLServer*Dialects` is strongly encouraged if running against SQLSever. The default `ssp-config.properties` has an example.)
db

...

_conns_max_active	Values for the database connection pool	The default value will need to be increased for test and product
db_conns_max_idle	Values for the database connection pool	The default value will need to be increased for test and product
db_conns_max_wait	Values for the database connection pool
db_conns_validation_query	Values for the database connection pool
db_liquibase_enabled	Enables the liquibase script for database table management
db_liquibase_changelog	Location for the liquibase change log
db_liquibase_set_mssql_snapshot_isolation	Parameter for configuring a MSSQL database	IMPORTANT The default value is 'true'. Set this value to 'false for MSSQL. The liquibase changeset 000014.xml will be ignored. The sql above configures the database correctly.
db_liquibase_strip_journal_comment_markup	Parameter to enable a script to convert HTML Journal Entries to plain text
db_liquibase_strip_tuition_paid_is_y	True value will delete the existing values forced into the database in v1.2.0, False will leave the existing values alone	This only applies to implementers who installed v1.2.0 or earlier AND populated the external_registration_status_by_term.tuition_paid field with external data
db

...

_liquibase_convert_external_term_timestamps

True value in external_term.start_date and external_term.end_date will be interpreted in ${db_time_zone_legacy

...

} and re-written in ${db_time_zone_legacy}.	True usually makes sense for both upgrades and fresh installs. Would only set to false if for some reason these fields have already been converted to ${db_time_zone) via some external process.
db_batchsize	The number of records to process for database transactions.	The default value is 300. Use of the parameter can increase performance of queries writing large sums of data into the database. This is primarily used in the Caseload Re-assignment tool.
cacheLifeSpanInMillis	This property will dictate how long lived a cache will be only external courses uses a cache	default is 86400000 = 1 day
db_time_zone_legacy	Parameter to set the timezone for data migration	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. Default is CURRENT_JVM_DEFAULT
db_time_zone	Timezone ID for the JVM	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
smtp_username	Value for email relay
smtp_password	Value for email relay

...


smtp_host	Value for email relay
smtp_port	Value for email relay
smtp_protocol	Protocol for email	Default is smtp
ssp_admins_email_addresses	Recipient of system generated messages
scheduled_coach_sync_enabled	Parameter to enable coach sync process
per_coach_sync_transactions	Parameter to enable the sync process to run per coach instead of one large transaction for all coaches
scheduled_task_cleanup_wait_millis	Max amount of time, in milliseconds, the app will wait during shutdown for any background tasks to abandon their work.	Default is 10000
uportal_session_keep_alive_timeout	Length of time for uPortal sessions KeepAliveFilter
spring.profiles.active	Deployment options	dev-standalone: completely free of uPortal standalone: as the only portlet in a uPortal instance uPortal: as one of many portlets in a uPortal instance
ssp_main_use_minifed_js	Parameter to determine the javascript file used in the deployment	When set to true, ssp-main.jsp will include a minified js called app-all.js When set to false, ssp-main.jsp will include the non-minified app.js

...

logback.xml
- The logback.xml controls the log location and level
- File Location: src/main/config/external to /usr/local/etc/ssp or C:\ssp (depending on the environment
- Action: copy the logback.xml file to the local configuration directory (ie: C:\ssp\ssp-local)
- Configuration Values: property file
Code Block
title logback.xml
<property file="C:/ssp/ssp-local/ssp-config.properties"
- 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

...

Versions Compared

Old Version 12

New Version 13

Key