Deployment Guide - Regent Education

Regent Enterprise Carbon Edition
Deployment Guide
Version 4.37.GA
Page 1
_________________________________________________________________________________________________
This document contains proprietary information of Regent Education Inc. The contents are confidential and any disclosure to
persons other than the officers, employees, agents, or subcontractors of the owner or license of this document, without consent of
Regent Education Inc. is strictly prohibited
1.
Introduction
Regent Enterprise Version 4.37.GA (RE) is the latest Financial Aid Management
System offered by Regent. This guide will help you in installing and configuring
product pre-requisites and deploying the system. Please read this guide entirely
before proceeding with the deployment of RE.
2.
Pre-Requisites
RE is designed as a portable, scalable and secure Java Platform, Enterprise Edition
(Java EE) server side application. Java EE is a set of industry standard technologies
for developing, deploying and managing multi-tier, server centric applications. The
Java EE platform extends the Java Platform, Standard Edition (Java SE) by adding
core capabilities that provide a complete, stable, secure and fast Java platform for
the enterprise.
RE requires a minimum hardware configuration that is listed in Appendix E; please
make sure that your servers satisfy these requirements. You can decide whether to
go with a single server or dual server configuration based on your expected usage of
the product, for e.g. (number of students, number of users, response time etc.). If
you are unsure, you can always start with a single server configuration and add
additional servers based on actual performance measurements.
RE requires the following technologies and/or platforms to be installed prior to
deployment:
1. Microsoft Windows Server 2003
2. Java SE Development Kit (JDK) Version 6
http://java.sun.com/javase/downloads/index.jsp
3. Apache Tomcat Version 6.0.
http://tomcat.apache.org/download-60.cgi
4. Microsoft SQL Server 2005
In addition to the server side components, end users of the product will need to
install one of the supported web browsers on their computer. Refer to Appendix A for
a list of supported web browsers.
Please refer to the documentation bundled with each pre-requisite for specific
installation instructions. If you are having trouble installing these components or
need help, please contact your technical engineer or customer account manager.
You may also contact customer support via email at [email protected]
Page 2
_________________________________________________________________________________________________
This document contains proprietary information of Regent Education Inc. The contents are confidential and any disclosure to
persons other than the officers, employees, agents, or subcontractors of the owner or license of this document, without consent of
Regent Education Inc. is strictly prohibited
3.
Deployment
RE is composed of three independently deployable components – the Financial Aid
Management (FAM) module, Background Server (BGS), and the Student Financial
Aid Portal (SP).
Please make sure that the following environment variables are set correctly before
you proceed:
1. JAVA_HOME, this should be set to your JDK installation,
e.g., c:/jdk1.6.0_14
2. CATALINA_HOME, this should be set to your Tomcat server installation, e.g.,
c:/Apache Software Foundation/Tomcat 6.0
Please make sure that the Tomcat is stopped before proceeding any further.
3.1.
Deploy a New Instance of Regent Enterprise
RE deployment is a multi-step process:
• Deploy Financial Aid Management (FAM)
• Installation of Background Server (BGS)
• Deploy Student Financial Aid Portal (SP)
• Deploy Regent Help
To begin this process, please uncompress RE_4.37.GA.zip to a local folder.
Once uncompressed please verify the structure with release structure listed in
Appendix F.
The following instructions assume that you have unzipped it to c:\RE_4.37.GA
3.1.1. Create a New Database
1. Create a new database user; RE will use this user to connect to the database.
At this time only SQL Server Authentication is supported.
2. Create a new database for Regent Enterprise using the provided SQL script
c:\RE_4.37.GA\db\fam_sql_4.37.GA.sql.
Please make sure that the user you created in step 1 is the owner of this
database. The script will create a database called REGENT_FAM by default;
you can search and replace REGENT_FAM with your preferred name before
running the script.
Page 3
_________________________________________________________________________________________________
This document contains proprietary information of Regent Education Inc. The contents are confidential and any disclosure to
persons other than the officers, employees, agents, or subcontractors of the owner or license of this document, without consent of
Regent Education Inc. is strictly prohibited
3.1.2. Deploy Financial Aid Management
1. Copy JDBC database driver jtds-1.2.2.jar to %CATALINA_HOME%\lib. You
can download the database driver jar from http://jtds.sourceforge.net/.
2. Copy mail.jar to %CATALINA_HOME%\lib.
You can download javamail 1.4.2 from
http://java.sun.com/products/javamail/downloads/index.html; uncompress
javamail1.4.2.zip and you will find mail.jar.
3. Copy c:\RE_4.37.GA\tools\EncryptionTool.jar to %CATALINA_HOME%\lib
4. Create a new directory %CATALINA_HOME%\webapps\famanagement
5. Uncompress the contents of c:\RE_4.37.GA\dist\deploy\famanagement.war to
the directory you created in step 4.
6. Copy the deployment descriptor called famanagement.xml from
c:\RE_4.37.GA\conf\tomcat to %CATALINA_HOME%\conf\Catalina\localhost.
Please note that you might need to create the directory. This file is used to
declare the database that RE will connect to; you can edit this file later if you
decide to change your database server connection properties. The relevant
section is shown below:
<Resource
name="jdbc/finaid_db"
auth="Container"
type="javax.sql.DataSource"
factory="org.apache.tomcat.dbcp.dbcp.BasicDataSourceFactory"
maxActive="100"
maxIdle="30"
maxWait="10000"
username="[username]"
password="[password]"
driverClassName="net.sourceforge.jtds.jdbc.Driver"
url="jdbc:jtds:sqlserver://[hostname]:[port]/[database name];
sendStringParametersAsUnicode=false"
defaultTransactionIsolation="READ_UNCOMMITTED"
/>
Replace [username] and [password] with the database user name and
password. Replace [database name] with the name of the database you
created in section 3.1.1, [hostname] and [port] with database server IP
address and port.
Optional Configuration (performance optimization):
maxActive-
The maximum number of active instances that can be allocated
from this connection pool. Current configuration provides maximum of 100
connections at the same time.
maxIdle- Maximum number of idle dB connections to retain in pool.
Page 4
_________________________________________________________________________________________________
This document contains proprietary information of Regent Education Inc. The contents are confidential and any disclosure to
persons other than the officers, employees, agents, or subcontractors of the owner or license of this document, without consent of
Regent Education Inc. is strictly prohibited
maxWait- Maximum time to wait for a dB connection to become available in
ms, in this example 10 seconds.
All the above mentioned optional parameters can be modified per
requirements. Also, please consider vendor and heap/memory compatibility
when you are setting these values to higher number.
7. The famanagement.xml file is also used to declare the email SMTP host that
RE will connect to. You can edit this file later if you decide to change your
mail server configuration. The relevant section is shown below:
<Resource
name="mail/Session"
auth="Container"
type="javax.mail.Session"
mail.smtp.host="[mail server]"
/>
Replace [mail server] with your out-going SMTP mail server IP address.
8. Create a folder (E.g. c:/share), which will be used as a shared file repository
between FAM and BGS. This folder should have two sub-folders called “input”
and “output”. You can create this folder on a network share if you prefer.
9. Edit %CATALINA_HOME%\webapps\famanagement\WEBINF\classes\fam.properties:
• Set file.repository.location to the folder created in step above.
Please make sure that you use forward slash “/” instead of back-slash
“\” in the folder path. E.g. c:/share, not c:\share. The same applies for
network shared folders as well, E.g. //computer/share (not
\\computer\share)
• Set context.filename value to
%CATALINA_HOME%/conf/Catalina/localhost/famanagement.xml
(replace %CATALINA_HOME% with the path of your Tomcat
installation, e.g. c:/Apache Software Foundation/Tomcat 6.0)
10. Edit %CATALINA_HOME%\webapps\famanagement\WEB-INF\classes\
ACJDesigner.properties:
• Set Install_Directory path to the application WEB-INF location i.e.,
/%CATALINA_HOME%/webapps /famanagement/WEB-INF
e.g. /c:/Apache Software Foundation/Tomcat 6.0/ webapps
/famanagement/WEB-INF, please note the leading / (slash)
• Set Compiler_Location value to /%JAVA_HOME%/lib/tools.jar (replace
% JAVA_HOME% with the path of your Java installation, e.g.
/c:/jdk1.6.0/lib/tools.jar, please note the leading / (slash)
11. Edit %CATALINA_HOME%/webapps/famanagement/WEBINF/classes/log4j.properties set log4j.appender.A2.File value as
Page 5
_________________________________________________________________________________________________
This document contains proprietary information of Regent Education Inc. The contents are confidential and any disclosure to
persons other than the officers, employees, agents, or subcontractors of the owner or license of this document, without consent of
Regent Education Inc. is strictly prohibited
%CATALINA_HOME%/logs/famanagement.log. Replace
%CATALINA_HOME% with your tomcat installation directory.
e.g. c:/Apache Software Foundation/Tomcat 6.0/logs/famanagement.log
3.1.3. Install Background Server
1. Uncompress c:\RE_4.37.GA\dist\deploy\Background.zip to a suitable
installation location for the Background Server. E.g., c:\BackgroundServer
2. Edit c:\BackgroundServer\config\ACJDesigner.propertes;
• Set Install_Directory to /c:/BackgroundServer, please note the
leading / (slash)
• Set Compiler_Location to /%JAVA_HOME%/lib/tools.jar (replace
%JAVA_HOME% with the path to your JDK installation). E.g.
/c:/jdk1.6.0/lib/tools.jar, please note the leading / (slash)
3. Update c:\BackgroundServer\config\batch.properties by providing email
configuration such as mail.smtp.host, mail.smtp.user, mail.smtp.password,
mail.sender.name, and mail.sender.address.
Also provide file.repository.location which is the folder location created in
step 8 of section 3.1.2.
4. Edit the following report.url in batch.properties
http://[host]:[port]/famanagement/background/showTaskResult.do?id=
Replace [host] with Server IP address on which Tomcat server is installed.
Also replace the [port] with tomcat server listening port, by default 8080.
5. Edit c:\BackgroundServer\config\dbconnectionprovider.propertes to set the
following configuration details
• Replace [username], [password] with username, password you use to
connect to database.
•
Replace [hostname] with database server IP address, [port] with
database port and [databasename] with name of the database you
have created.
6. Edit C:\BackgroundServer\config\log4j.properties set log4j.appender.A1.File
value as C:/BackgroundServer/log/background.log
7. To install BGS as a Windows Service, edit
c:\BackgroundServer\bin\BackgroundServerServiceInstall.bat
• Replace $BG_SERVER_HOME$ with BackgroundServer installation directory
e.g., C:\BackgroundServer
•
Replace $BACKGROUND_SERVICE_NAME$ with BackgroundServer, this name is
used to identify the server when started as a service.
Page 6
_________________________________________________________________________________________________
This document contains proprietary information of Regent Education Inc. The contents are confidential and any disclosure to
persons other than the officers, employees, agents, or subcontractors of the owner or license of this document, without consent of
Regent Education Inc. is strictly prohibited
•
Edit c:\BackgroundServer\bin\BackgroundServerServiceUnInstall.bat,
replace $BACKGROUND_SERVICE_NAME$ with BackgroundServer. You can run
this file if you ever need to uninstall the BGS Windows service. Make sure
the service is stopped before you uninstall it.
8. Run c:\BackgroundServer\bin\BackgroundServerServiceInstall.bat to install
BackgroundServer as windows service.
3.1.4. Deploy Student Financial Aid Portal
1. Create a new directory %CATALINA_HOME%\webapps\regent_portal
2. Uncompress the contents of c:\RE_4.37.GA\dist\deploy\regent_portal.war to
the directory you created above.
3. Create a new directory %CATALINA_HOME%\webapps\regent_ws
4. Uncompress the contents of c:\RE_4.37.GA\dist\deploy\regent_ws.war to the
directory you created above.
5. Copy c:\RE_4.37.GA\conf\tomcat\regent_ws.xml to
%CATALINA_HOME%\conf\Catalina\localhost.
This file is used to declare the database that RE will connect to; you can edit
this file later if you decide to change your database server connection
properties. The relevant section is shown below:
<Resource
name="jdbc/finaid_db"
auth="Container"
type="javax.sql.DataSource"
factory="org.apache.tomcat.dbcp.dbcp.BasicDataSourceFactory"
maxActive="100"
maxIdle="30"
maxWait="10000"
username="[username]"
password="[password]"
driverClassName="net.sourceforge.jtds.jdbc.Driver"
url="jdbc:jtds:sqlserver://[hostname]:[port]/[database name];
sendStringParametersAsUnicode=false"
defaultTransactionIsolation="READ_UNCOMMITTED"
/>
Replace [username] and [password] with the database user name and
password. Replace [database name] with the name of you RE database and
[hostname] and [port] with the database server IP address and port.
Page 7
_________________________________________________________________________________________________
This document contains proprietary information of Regent Education Inc. The contents are confidential and any disclosure to
persons other than the officers, employees, agents, or subcontractors of the owner or license of this document, without consent of
Regent Education Inc. is strictly prohibited
Optional Configuration (performance optimization):
maxActive-
The maximum number of active instances that can be allocated
from this connection pool. Current configuration provides maximum of 100
connections at the same time.
maxIdle- Maximum number of idle dB connections to retain in pool.
maxWait- Maximum time to wait for a dB connection to become available in
ms, in this example 10 seconds.
All the above mentioned optional parameters can be modified per
requirements. Also, please consider vendor and heap/memory compatibility
when you are setting these values to higher number.
6.
Copy c:\RE_4.37.GA\conf\tomcat\regent_portal.xml to
%CATALINA_HOME%\conf\Catalina\localhost
7. Edit %CATALINA_HOME%\webapps\regent_portal\WEBINF\classes\portal.properties to configure email settings. Set the values for
following configuration parameters:
1. MAIL_SMTP_HOST – out-going mail server IP e.g. mail.regent.com
2. MAIL_SMTP_PORT – SMTP port e.g. 25
3. MAIL_SMTP_USER – mail user e.g. admin
4. MAIL_SMTP_PASSWORD – password e.g. pass123
5. MAIL_SMTP_FROM– from address to send emails from system e.g.
[email protected]
6. MAIL_SMTP_FROMNAME– from name e.g. Regent Enterprise Student Portal
7. MAIL_SMTP_REPLYTO– on replying mails will be received by this address e.g.
[email protected]
8. ATTACHMENT_UPLOAD_NOTIFICATION – email address to send attachment
notifications
9. EFAFSA_SUBMIT_NOTIFICATION – email address to send eFAFSA
completion notifications
3.1.4.1.
Optional configuration
Following configuration changes are required if you setup portal to run on
multiple instances.
1. Modify the URL that points to the Common Web Service.
COMMON_WEB_SERVICE_URL=http://<IP>:<port>/<regent_ws_xyz>/services/
CommonWebService
Set the values for:
• IP – IP/DNS of the machine e.g. fam.regenteducation.com
• port-Port on which application is deployed e.g. 8080
Page 8
_________________________________________________________________________________________________
This document contains proprietary information of Regent Education Inc. The contents are confidential and any disclosure to
persons other than the officers, employees, agents, or subcontractors of the owner or license of this document, without consent of
Regent Education Inc. is strictly prohibited
•
regent_ws_xyz-replace ‘xyz’ with program code e.g. regent_ws_620
2. Modify the URL that that points to the FAM Web Service
FAM_WEB_SERVICE_URL=http://<IP>:<port>/<regent_ws_xyz>/services/FAM
WebService
Set the values for:
• IP – IP/DNS of the machine e.g. fam.regenteducation.com
• port-Port on which application is deployed e.g. 8080
• regent_ws_xyz-replace xyz with program code e.g. regent_ws_620
3.1.5. Student Information System(SIS) Configuration
Following configuration changes are required in order to integrate SIS system
with FAM.
Edit %CATALINA_HOME%\webapps\famanagement\WEBINF\classes\fam.properties
•
Uncomment the specific integration-class present in “Student System
integration module” section.
e.g. to integrate CampusCafe SIS, you need to uncomment the
following integration class
integrationclass=com.computingoptions.finaid.integration.impl.CampusCafeS
tudentSystem
•
Uncomment and make modifications to relevant data-source
configuration section i.e., in this case, data-source details specific to
CampusCafeStudentSystem.
Replace [username] and [password] with the database user name and
password, [database name] with the name of the SIS specific
database, [hostname] and [port] with database server IP address
and port
#cc-database-url: jdbc:jtds:sqlserver://[hostname]:[port]/[database
name];sendStringParametersAsUnicode=false
#cc-jdbc-driver-name=net.sourceforge.jtds.jdbc.Driver
#cc-username=[username]
#cc-password=[password]
Restart Tomcat server.
3.1.6. Deploy Regent Help
Page 9
_________________________________________________________________________________________________
This document contains proprietary information of Regent Education Inc. The contents are confidential and any disclosure to
persons other than the officers, employees, agents, or subcontractors of the owner or license of this document, without consent of
Regent Education Inc. is strictly prohibited
1. Copy c:\RE_4.37.GA\dist\deploy\safershelp.war to
%CATALINA_HOME%\webapps
3.1.7. General Tomcat Setup
1. Run the %CATALINA_HOME%\bin\tomcat6w.exe application.
2. Click on the Java tab and add -XX:MaxPermSize=256m to java options.
3. Set Initial memory pool 1024, maximum memory pool 1024 and thread stack
size to 4096.
4. Start Tomcat
5. Open a web browser and navigate to http://localhost:8080/famanagement
6. You will be prompted to enter username and password. Log-in using
“administrator” as the username and “changethis” for the password.
Congratulations, you have successfully deployed Regent Enterprise!
Page 10
_________________________________________________________________________________________________
This document contains proprietary information of Regent Education Inc. The contents are confidential and any disclosure to
persons other than the officers, employees, agents, or subcontractors of the owner or license of this document, without consent of
Regent Education Inc. is strictly prohibited
3.2.
Upgrade an Existing Instance of Regent Enterprise
Assuming Regent Enterprise Version 4.27.GA (RE) is already installed.
This section helps you to upgrade RE version 4.27.GA, to make it compatible
with Regent Enterprise Version 4.37.GA (RE), the latest Financial Aid
Management System offered by Regent.
Assume Regent Enterprise Version 4.27.GA installed at
c:/Apache Software Foundation/Tomcat 6.0, also environment variable
CATALINA_HOME set to c:/Apache Software Foundation/Tomcat 6.0
Assume Background Server (BGS) installed at c:\BackgroundServer.
Please stop Tomcat server and Background Server (BGS).
To begin this process, please uncompress RE_4.37.GA.zip to a local folder.
Once uncompressed please verify the structure with release structure listed in
Appendix F.
The following instructions assume that you have unzipped it to c:\RE_4.37.GA.
1. Uncompress the contents of
c:\RE_4.37.GA\dist\upgrade\famanagement.war to
%CATALINA_HOME%\webapps\ famanagement,
When you prompted with “confirm file overwrite” please select yestoAll.
2. Uncompress the contents of
c:\RE_4.37.GA\dist\upgrade\regent_portal.war to
%CATALINA_HOME%\webapps\regent_portal, when you prompted with
“confirm file overwrite” please select yestoAll.
3. Uncompress the contents of c:\RE_4.37.GA\dist\upgrade\regent_ws.war
to %CATALINA_HOME%\webapps\regent_ws, when you prompted with
“confirm file overwrite” please select yestoAll.
4. Uncompress the contents of c:\RE_4.37.GA\dist\upgrade\Background.zip
to c:\BackgroundServer
5. Start Tomcat server, and then start Background server.
Page 11
_________________________________________________________________________________________________
This document contains proprietary information of Regent Education Inc. The contents are confidential and any disclosure to
persons other than the officers, employees, agents, or subcontractors of the owner or license of this document, without consent of
Regent Education Inc. is strictly prohibited
4. Advanced Configuration
This section documents the advanced configuration options supported by Regent
Enterprise. You can configure these options any time after deploying the product.
4.1.
LDAP Configuration for FAM
You can configure FAM to authenticate users against the database or a LDAP
compliant directory server like Microsoft Active Directory. The release bundle is
configured to use database authentication by default. Please follow the instructions
given below to switch the authentication mechanism to use LDAP.
Edit %CATALINA_HOME%\webapps\famanagement\WEBINF\classes\securityservice.properties:
1.
Comment out the following line by adding a # at the beginning:
classname=com.computingoptions.core.service.security.impl.JDBCSecurityS
ervice
2.
Uncomment the following line which is required for LDAPSecurityService:
classname=com.computingoptions.core.service.security.impl.LDAPSecurityS
ervice
3. Modify the following
a. Uncomment line admin=$LDAP_ADMIN$ and replace $LDAP_ADMIN$ with
LDAP admin with admin privileges.
E.g. Administrator
b. Uncomment line admin-password=$LDAP_ADMIN_PASSWORD$ and
replace $LDAP_ADMIN_PASSWORD$ with password name.
E.g. Regent#@123
c. Uncomment line server=$LDAP_SERVER$ and replace $LDAP_SERVER$
with LDAP server IP/domain name. E.g.
ldap://ldap.regenteducation.com:389 or
ldaps://ldap.regenteducation.com:636
d. Uncomment line domain=$LDAP_DOMAIN$ and replace $LDAP_DOMAIN$
with LDAP Domain value. E.g. regent
e. Uncomment line base-dn=$LDAP_BASE_DN$ and replace
$LDAP_BASE_DN$ with correct base dn. E.g.
OU=Users,OU=MyBusiness,DC=Regent,DC=local
f. Uncomment line useSSL=$LDAP_USE_SSL$ and replace
$LDAP_USE_SSL$ with true or false, please make sure you set the
appropriate port in step c based on this setting; for SSL use port 636 and
for non-SSL user port 389. If you decide to use SSL, you will have to
import your LDAP server’s certificate into the java cacerts keystore.
4. Copy this file to c:\BackgroundServer\config as well.
Page 12
_________________________________________________________________________________________________
This document contains proprietary information of Regent Education Inc. The contents are confidential and any disclosure to
persons other than the officers, employees, agents, or subcontractors of the owner or license of this document, without consent of
Regent Education Inc. is strictly prohibited
Make sure you restart Tomcat and BGS after these changes. Once server is
restarted you can login to FAM using a valid LDAP username and password.
4.2.
LDAP Configuration for Student Portal
You can configure the Student Portal to authenticate users against the database or
a LDAP compliant directory server. The release bundle is configured to use
database authentication by default. Please follow the instructions given below to
switch the authentication mechanism to use LDAP.
Edit %CATALINA_HOME%\webapps\regent_ws\WEBINF\classes\securityservice.properties
1.
Comment the following line by adding a # at the beginning:
classname=com.computingoptions.service.common.security.dao.SelfServiceS
ecurityService
2.
Uncomment the following line which is required for LDAPSecurityService:
classname=com.computingoptions.service.common.security.dao.LDAPSecurity
Service
3. Modify the following
a. Uncomment line ldap-bind-user-dn = $LDAP_ADMIN$ and replace
$ldap-bind-user-dn$ with LDAP administrator with admin privileges. E.g.
Administrator
b. Uncomment line ldap-bind-password = $LDAP_ADMIN_PASSWORD$
and replace $LDAP_ADMIN_PASSWORD$ with password
c. Uncomment line ldap-url = $LDAP_SERVER$ and replace $LDAP_SERVER$
with LDAP server IP/domain name. E.g.
ldap://ldap.regenteducation.com:389 or
ldaps://ldap.regenteducation.com:636
d. Uncomment line ldap-base-dn = $LDAP_BASE_DN$ and replace
$LDAP_BASE_DN$ with correct base dn. E.g.
OU=Users,OU=MyBusiness,DC=Regent,DC=local
e. Uncomment line ldap-pid-attribute = $PID$ and replace $PID$ with the
name of the LDAP attribute that contains the student’s alternate ID. E.g.
alternateId
f. Uncomment line ldap-uid-attribute =$UID$ and replace $UID$ with the
name of the LDAP attribute that contains the student’s username. E.g.
portalUsername
g. Uncomment the line useSSL=false
The default configuration is set not to use SSL. If you want to enable SSL
then, change useSSL flag to “true”. Please make sure you set the
appropriate port in step c based on this setting; for SSL use port 636 and
for non-SSL user port 389. If you decide to use SSL, you will have to
import your LDAP server’s certificate into the java cacerts keystore.
Make sure you restart Tomcat after these changes.
Page 13
_________________________________________________________________________________________________
This document contains proprietary information of Regent Education Inc. The contents are confidential and any disclosure to
persons other than the officers, employees, agents, or subcontractors of the owner or license of this document, without consent of
Regent Education Inc. is strictly prohibited
4.3.
Encrypting Passwords
The passwords used in database connection properties and LDAP configurations
are stored in plain text format by default. You can use the following instructions to
encrypt these passwords.
1. First, encrypt your passwords using the c:\RE_4.37.GA\tools\encrypt.bat utility:
encrypt <password>
Replace <password> with your password, the output of this utility will be the
encrypted password.
-8 56 0 86 -99 81 -92 -32 -109 -114 -15 -59 -78 -42 43 86
4.3.1. Encrypting FAM passwords
1. The release bundle is configured to use plain-text passwords for JDBC
connection pooling. You can change the configuration to use an encrypted
password, edit %CATALINA_HOME%\conf\Catalina\localhost
\famanagement.xml. Set the following values in  section:
• factory to com.computingoptions.dbcp.EncryptedDataSourceFactory
• password to the encrypted password value from step 1
2. The release bundle is configured to use plain-text password for LDAP
authentication. To use an encrypted password for LDAP authentication, edit
%CATALINA_HOME%\webapps\famanagement\WEB-INF\classes
securityservice.properties. Set the following in “LDAPSecurityService” section:
•
classname=com.computingoptions.core.service.security.impl.Encrypt
edLDAPSecurityService
• admin-password to encrypted password value from step 1
4.3.2. Encrypting Background Service Passwords
1. Copy c:\RE_4.37.GA\tools\EncryptionTool.jar to C:\BackgroundServer\lib folder
2. Edit C:\BackgroundServer\config\dbconnectionprovider.properties. Set the
following values:
•
providerclassname=com.computingoptions.core.service.dbconnection.impl.Enc
ryptedJDBCConnectionProvider
• password to encrypted password value from step 1
3. Edit C:\BackgroundServer\config\securityservice.properties. Set the following
values:
•
classname=com.computingoptions.core.service.security.impl.Encrypt
edLDAPSecurityService
• admin-password to encrypted password value from step 1
Page 14
_________________________________________________________________________________________________
This document contains proprietary information of Regent Education Inc. The contents are confidential and any disclosure to
persons other than the officers, employees, agents, or subcontractors of the owner or license of this document, without consent of
Regent Education Inc. is strictly prohibited
4.3.3. Encrypting Student Portal Passwords
1. Copy c:\RE_4.37.GA\tools\EncryptionTool.jar to
%CATALINA_HOME%\webapps\regent_ws\WEB-INF\lib folder
2. Copy c:\RE_4.37.GA\tools\EncryptionTool.jar to
%CATALINA_HOME%\webapps\regent_portal\WEB-INF\lib folder
3. Edit %CATALINA_HOME%\conf\Catalina\localhost\regent_ws.xml. Set the
following values:
• factory to com.computingoptions.dbcp.EncryptedDataSourceFactory
• password to encrypted password value from step 1
Make sure you restart Tomcat and BGS after these changes.
4.4.
Customizing Message Resources
You can customize the titles, labels etc. in FAM by following these instructions.
1. Create a file called %CATALINA_HOME%\webapps\famanagement\WEBINF\classes\FAMMessageResources_en_US.properties
2. Copy the resource from %CATALINA_HOME%\webapps\famanagement\WEBINF\classes\FAMMessageResources.properties that you want to change and set
it to the desired value in this file.
Make sure you restart Tomcat after these changes.
4.5.
Legacy SAFER/SOAR Database Configuration
Please edit the following configurations to setup the SAFER/SOAR legacy datasource.
1. Edit %CATALINA_HOME%\conf\Catalina\localhost \famanagement.xml. Set the
values for the following variables in the url attribute:
•
•
•
•
•
•
•
•
LEGACY_SERVER_NAME
LEGACY_SERVER_PORT
LEGACY_USER
LEGACY_USER_PASSWORD
LEGACY_GROUP
LEGACY_GROUP_PASSWORD
LEGACY_ACCOUNT
LEGACY_ACCOUNT_PASSWORD
Page 15
_________________________________________________________________________________________________
This document contains proprietary information of Regent Education Inc. The contents are confidential and any disclosure to
persons other than the officers, employees, agents, or subcontractors of the owner or license of this document, without consent of
Regent Education Inc. is strictly prohibited
•
•
•
•
LEGACY_SECURITY_PASSWORD
LEGACY_CATALOG_PASSWORD
LEGACY_JOBNAME
LEGACY_DATABASE
2. Edit the c:\BackgroundServer\config\legacyconnectionprovider.properties. Set
the values for following variables in “url” property:
•
•
•
•
•
•
•
•
•
•
•
•
LEGACY_SERVER_NAME
LEGACY_SERVER_PORT
LEGACY_USER
LEGACY_USER_PASSWORD
LEGACY_GROUP
LEGACY_GROUP_PASSWORD
LEGACY_ACCOUNT
LEGACY_ACCOUNT_PASSWORD
LEGACY_SECURITY_PASSWORD
LEGACY_CATALOG_PASSWORD
LEGACY_JOBNAME
LEGACY_DATABASE
Make sure you restart Tomcat and BGS after these changes.
Page 16
_________________________________________________________________________________________________
This document contains proprietary information of Regent Education Inc. The contents are confidential and any disclosure to
persons other than the officers, employees, agents, or subcontractors of the owner or license of this document, without consent of
Regent Education Inc. is strictly prohibited
Appendix A. Supported Web Browsers
•
Internet Explorer 8.0
•
Firefox 3.5.6
Appendix B. Supported Database Servers
• Microsoft SQL Server 2005
Appendix C. Supported Web Servers
• Tomcat 6.0
Appendix D. Supported Operating System and JDKs
• JDK 6
• Microsoft Windows Server 2003
Dual Server Configuration
Single Server
Configuration
Appendix E. Minimum Hardware Requirements
Application and Database Server
2 Processor Intel Xeon
2GB RAM
*
80GB of available disk space
10/100 Network Card
Application Server
2 Processor Intel Xeon
4GB RAM
40GB of available disk space
Two 10/100 Network Card
Database Server
2 Processor Intel Xeon
4GB RAM
*
80GB of available disk space
Two 10/100 Network Card
Actual disk usage may vary, based on the size of your
database.
*
Page 17
_________________________________________________________________________________________________
This document contains proprietary information of Regent Education Inc. The contents are confidential and any disclosure to
persons other than the officers, employees, agents, or subcontractors of the owner or license of this document, without consent of
Regent Education Inc. is strictly prohibited
Appendix F. Release Structure
RE_[release.number]
dist
upgrade
Use these files to upgrade an existing instance. See section 3.2 for
specific instructions.
famanagement.war
regent_ws.war
regent_portal.war
Background.zip
deploy
Use these files to deploy a new instance. You will have to customize
configuration files after deployment. See the section 3.1 for specific
instructions.
famanagement.war
regent_ws.war
regent_portal.war
Background.zip
safershelp.war
tools
EncryptionTool.jar
encrypt.bat
decrypt.bat
doc
ReleaseNotes_[release.number].pdf
Contains a summary of enhancements, bug fixes and
knows issues with this release of the product.
DeploymentGuide_[release.number].pdf
Contains instructions on how to deploy and upgrade
this product.
db
fam_sql_[release.number].sql
fam_sql_upgrade_[release.number].sql
Use these database scripts to create or update your
database.
Use this script to create a new schema.
Use this script to update an existing schema to this
release.
Page 18
_________________________________________________________________________________________________
This document contains proprietary information of Regent Education Inc. The contents are confidential and any disclosure to
persons other than the officers, employees, agents, or subcontractors of the owner or license of this document, without consent of
Regent Education Inc. is strictly prohibited