Banner Student Faculty Grade Entry - Bridgewater State · PDF fileIn preparing and providing...

Banner Student Faculty Grade EntryInstallation Guide

Release 9.0March 2012, Revision 1

Banner®, Colleague®, PowerCAMPUS®, Luminis® and Datatel® are trademarks of Ellucian or its affiliates and are registered in the U.S. and other countries. Ellucian, Advance, DegreeWorks, fsaATLAS, Course Signals, SmartCall, Recruiter, MOX, ILP, and WCMS are trademarks of Ellucian or its affiliates. Other names may be trademarks of their respective owners.

©2012 Ellucian. All rights reserved. The unauthorized possession, use, reproduction, distribution, display or disclosure of this material or the information contained herein is prohibited.

Contains confidential and proprietary information of Ellucian and its subsidiaries. Use of these materials is limited to Ellucian licensees, and is subject to the terms and conditions of one or more written license agreements between Ellucian and the licensee in question.

In preparing and providing this publication, Ellucian is not rendering legal, accounting, or other similar professional services. Ellucian makes no claims that an institution's use of this publication or the software for which it is provided will insure compliance with applicable federal or state laws, rules, or regulations. Each organization should seek legal, accounting and other similar professional services from competent providers of the organization’s own choosing.

Prepared by: Ellucian4375 Fair Lakes CourtFairfax, Virginia 22033United States of America

Revision History

Publication Date Summary

January 2012 New version that supports Banner Student Faculty Grade Entry 9.0 software.

March 2012 Revised version that supports Banner Student Faculty Grade Entry 9.0 software.A section was added for “Set up access for application users with administrative account”.

Contents

Banner Student 9.0Faculty Grade Entry Installation Guide

Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Hardware and Software Requirements . . . . . . . . . . . . . . . . . . . . . . . 5

Hardware requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Software requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Oracle dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Java dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Upgrade the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Verify the banproxy and ban_ss_user database accounts . . . . . . . . . . . . . . 6

Verify Oracle user accounts to connect through banproxy . . . . . . . . . . . . . . 7

Data masking conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Set up access for application users with administrative account . . . . . . . . . . 7

Customize the Banner Student Faculty Grade Entry WAR file . . . . . . . . . 8

Prepare the installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Product home directory structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Install into product home directory . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Shared configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Application specific configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Configure student photos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Logging configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Central Authentication Service (SSO) . . . . . . . . . . . . . . . . . . . . . . . . . 16

Link to Banner 8.X . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

CSS customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Customize institution name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Provide custom JavaScript. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Configure session timeouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Configure date format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Regenerate WAR file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

March 2012 Banner Student 9.0 3Faculty Grade Entry Installation Guide

Contents

Configure and Deploy the WAR file to Web Application Server . . . . . . . . 25

Tomcat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

WebLogic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

F5 Load Balancing Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Multi-Entity Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

4 Banner Student 9.0 March 2012Faculty Grade Entry Installation GuideContents

March 2

Introduction

This document details the steps required to install Banner Student Faculty Grade Entry.

Before you install any components of the system, you should review this document thoroughly, so that you have a better understanding of what you are installing and where you will install it.

Hardware and Software Requirements

Banner Student Faculty Grade Entry requires the following hardware and software:

Hardware requirements• Minimum Requirement: Dual core CPU - 2 GB of memory for the application

server

• Recommended: Quad core CPU - 4-8GB of memory for the application server

Software requirements

The following are the application server systems that are supported:

• Application Server: Tomcat 6 or Oracle Fusion Middleware 11.1.1.4 using WebLogic 10.3.4

• Application Server Operating Systems: Redhat 5.3 and 5.6 or Solaris 10 or Window Server 2008

• BEIS 8.1.5 SSOManager is required to support deep linking to a Banner 8 Self-Service URL.

NoteOnly 64-bit versions of the operating systems are supported.

Oracle dependencies

The following table indicates the minimum version of Oracle components that must be installed before Banner Student Faculty Grade Entry installation.

Oracle Database 11.1.0.7 or 11.2.0.2

012 Banner Student 9.0 5Faculty Grade Entry Installation Guide

6

Java dependencies

You must have Java 6 JDK installed on the application server platform. Make sure the Java 6 bin directory is included in the path.

NoteDo not install the Java 6 JRE. The application does not support Java 6 JRE.

The following table indicates the version of Java components that must be installed before installing Banner Student Faculty Grade Entry.

NoteVerify you defined the JDK bin directory in the PATH system property.

The following sections details the installation steps:

• “Upgrade the Database” on page 6

• “Customize the Banner Student Faculty Grade Entry WAR file” on page 8

• “Configure and Deploy the WAR file to Web Application Server” on page 25

Upgrade the Database

For information on Database upgrade process, refer to the Banner Student Faculty Grade Entry Upgrade Guide for Release 9.0.

Verify the banproxy and ban_ss_user database accounts

Both the banproxy and ban_ss_user accounts are used for Banner 9.0 database connections. The database upgrade process creates these accounts and issues the required grants.

You should not revoke any grants made to these accounts. In particular, the BAN_DEFAULT_M role is granted to banproxy. If this role is revoked, the application will not successfully start.

Java 6 JDK Java 1.6.x (64-bit version)

Banner Student 9.0 March 2012Faculty Grade Entry Installation Guide

March 2

Verify Oracle user accounts to connect through banproxy

All Internet Native Banner (INB) or Oracle user accounts must have connect through banproxy privilege.

Use the following procedure to verify the Oracle user accounts are enabled to connect through banproxy:

1. Access the GSASECR form.

2. To modify, enter a valid username.

3. Click Alter.

4. Select the Authorize banproxy check box.

5. Click Save.

Data masking conversion

During the database upgrade process, columns are added to the GORDMSK table, which map INB fields to equivalent fields on the Banner Student Faculty Grade Entry pages.

If you change the data masking rules on GORDMSK form for any of the Banner Student Faculty Grade Entry pages, you will need to run the gupdgordmsk.sql script found in the general or plus subdirectory of your production source tree. This script should be run as the user GENERAL.

Set up access for application users with administrative account

With the install of Banner 9.0 Student Faculty Grade Entry application, you need to create a new security object called SELFSERVICE. You need to assign this new object with BAN_DEFAULT_M privilege to the Student Faculty Grade Entry application users, who have a valid administrative account and can access the Enterprise Access Controls (GOAEACC) Form. The SELFSERVICE object is added to the BAN_GENERAL_C class. Therefore, enrolling such users to this class is another alternative.

NoteWithout performing the above setting, you will be unable to login to the Student Faculty Grade Entry application.


8

Customize the Banner Student Faculty Grade Entry WAR file

NoteIt is required to have JDK 1.6 installed in your system. See “Java dependencies” on page 6.If you are using the UNIX system to install, be sure that the current directory (represented by a ".") is at the start of your PATH to avoid any errors when starting some of the scripts.

The release package is located in the Student\Java subdirectory of the production Banner source tree. The name of the package is release-StudentFacultyGradeEntry-x.x.zip where x.x represents the version number of the release. This file is copied to this location during the migration step of the database upgrade.

Once you locate the release package zip file, it must be copied to your application server. Transfer this file in binary mode using the appropriate File Transfer Protocol (FTP, SFTP, and so on).

Use the following procedure to copy the release package into a temporary directory:

1. Login into the application server.

NoteYou must have a valid account to login and permissions to deploy into the application server container, such as, Tomcat.

2. Create a temporary directory.

For example:

mkdir $HOME/ban9temp

3. Download (FTP) the release package file into a temporary directory:

$HOME/ban9temp

4. Unzip the release package.

For example:

cd $HOME/ban9temp

unzip release-StudentFacultyGradeEntry-9.0.zip


March 2

Prepare the installer

Use the following procedure to prepare the installer:

1. Change the directory to installer directory

cd installer

2. Run the ant command, which will build the installation tool.

On Unix

$ chmod +x ant

$ ./ant

On Windows

> ant

You will receive a message Build successful in the output, which is the confirmation for a successful build.

NoteBanner 9 web applications are modular and are installed independently from each other, though they share common configuration. The package provides a common structure for releases as well as a common installer. The product home directory structures subsequently created are consistent across all Banner 9 modules.

It is recommended that product homes for Banner 9 modules within a particular environment are placed in sibling directories. For example, the following directory structure Illustrates two product homes and a shared_configuration directory that all support a common TEST environment.

banner_test_homes

|--> catalog_schedule

|--> faculty_grade_entry

|--> shared_configuration

NoteIf an identified home (or the directory for shared configuration) does not exist, it will be created by the installer. The name of the product homes is not restricted and you can name them when prompted to do so by the installer.


10

Product home directory structure

A product home directory is created for each deployment. For example, the home directory used to manage the module within a TEST environment is a different home directory than the one used within the production environment. When you are supporting different environments with multiple home directories for the same solution (application), this provides the needed flexibility with respect to configuration, release level, and customer modifications.

The product home directory is used to support configuration and creation of a deployable Web application ARchive (WAR) file.

The following directory tree illustrates the product home directory created using the steps below for the TEST environment:

In addition to the module's product home directory, there is a separate shared_configuration home directory that contains cross-module configuration for the TEST environment. Currently, this directory holds a single file banner_configuration.groovy that contains the shared JNDI DataSource configuration.


March 2

Install into product home directory

Use the following procedure to install the Installer into the product home directory:

NoteWhen prompted, specify a fully qualified path. Make sure you do not use environment variables as they will not be expanded. In the following UNIX examples, substitute the actual value of $HOME for HOME.

1. Once the installer has been prepared using ant, it can be used to install the release file into a product home directory.

NoteYour current working directory must be in the installer directory (ban9temp/installer), before executing the subsequent commands.


12

Invoke the install utility:

On Unix

$ bin/install home

On Windows

> bin\install home

2. Enter the full path of the module home.

The module will be installed within the current subdirectory, inside the home directory, and the previous release will be archived.

3. The installer will prompt to the full path of the module home.

On Unix

[]: $HOME/banner_test_homes/faculty_grade_entry

On Windows

[]: c:\banner_test_homes\faculty_grade_entry

4. Enter the full path of the shared configuration home directory. Banner 9.0 modules configured to this home directory will share the following configuration.

On Unix

[]: “HOME”/banner_test_homes/shared_configuration

On Windows

[]: c:\banner_test_homes\shared_configuration

Shared configuration

The shared configuration directory contains a single cross-module configuration file called banner_configuration.groovy. Do not change this information unless you have configured additional JNDI data sources in your application server and wish to configure and generate war files to connect to them.

Configuration information that is typically shared for multiple Banner 9.0 web applications for a specific environment is the Oracle database connection information. This is defined using the jndiName property. The jndiName property defines the DataSource name used by the application to connect to Oracle. You can optionally change the DataSource name in this shared configuration file to point to the JNDI DataSource configured in your application server.


March 2

Using this approach, you can have a DataSource defined to point to your test database and a different one define to point to your pre-prod database.

For tomcat, DataSources are defined server.xml and context.xml files located in the $CATALINA_HOME/conf directory.

For WebLogic, DataSource definitions are defined in the Services >DataSources frame on the WebLogic server console.

For example:

jndiName = "jdbc/bannerDataSource" and jndiName = "jdbc/bannerSsbDataSource" are the default configuration. You can change this to match the JNDI DataSource name in your environment.

For more information on JNDI DataSource configuration, see “Configure Tomcat server” on page 25.

Application specific configuration

The application configuration directory APPLICATION_HOME\current\instance\config contains an application specific file called StudentFacultyGradeEntry_configuration.groovy. This configuration file contains a number of elements you can customize for your specific environment. This directory also contains an instance.properties file that references the shared configuration location.

Configure student photos

Student photos (graphic elements) can be displayed in the Student Details tab during grading. Banner Student Faculty Grade Entry 9.0 supports the following image file formats:

• .gif

• .bmp

• .jpg

• .png

Here are some examples of IDs and image file names:

• ID of 123456789 and associated image file name of I3456789.bmp




14

Use the following steps to configure photos for display.

1. Set the PHOTOS rule on GTVSDAX to Y.

2. Create a new directory to store the pictures.

2.1. If your images are stored on a separate server from the Banner server, have your system administrator set up a share from the pictures machine to the Banner machine.

2.2. Mount that share on the Banner machine.

This will appear as a directory that can be specified in the picturesPath. The picturesPath is found in the StudentFacultyGradeEntry_configuration.groovy file in the HOME directory, based on the name used for HOME in the bin/install home step in the Banner Student Faculty Grade Entry Upgrade Guide for Release 9.0.

For example:

banner_test_homes/faculty_grade_entry/current/instance/config/StudentFacultyGradeEntry_configuration.groovy

3. Configure the following component to point to the location that contains the image files.banner {

picturesPath = System.getProperty('base.dir') + '/test/images'

}

The value specified must be a fully qualified path to a directory containing the image files, such as: banner {

picturesPath = '/home/banner/test/images'

}

4. Rebuild and redeploy the war file. See “Regenerate WAR file” on page 23.


March 2

Logging configuration

Log4J is the common logging framework used with applications that run on the Java Virtual Machine. For more information, refer to the Log4J documentation.

The configuration file includes documentation on various elements that can be modified depending on your environment.

Output logging file location

For example:

loggingFileDir = "System.properties['logFileDir'] ? "${System.properties['logFileDir']}" : "target/logs"

logAppName = "StudentFacultyGradeEntry"

loggingFileName = "${loggingFileDir}/${logAppName}.log".toString()

Following is an example for overriding log file directory properties:

export JAVA_OPTS = "-DlogFileDir=/PRODUCT_HOME /"

The output logging file location is sensitive to the application server you are deploying. See “Configure Tomcat server” on page 25.

Log level customization

The root logger level is pre-configured to log at the ERROR level. There are multiple class or package level configurations that are set to off status by default. You may set a different logging level for any of these packages or classes. However, it will require a restart of the running application.

For example:

case 'production':

root {

error 'appLog' //change the log level here with the appropriate log level value.

additivity = true

}

NoteChanging the log level to debug or info will produce very large log files.


16

Changes to StudentFacultyGradeEntry_configuration.groovy file will require a restart of the application in order to take effect. Alternatively, you can use JMX to modify logging levels for any of the specified packages or classes, or even at the root level.

NoteWhen you modify the logging levels using JMX, the logging level changes will only affect the running application. If you restart, any changes you made using JMX will be lost. For more information on JMX configuration, see “Configure Java Management Extensions” on page 29.

Central Authentication Service (SSO)

The default authentication mechanism for Banner 9 is provided by Banner 9 Oracle username and password for administrative authentication. The configuration below "banner.sso.authenticationProvider = default" enables Oracle username and password authentication:

banner {

sso {

authenticationProvider = 'default'

To enable Central Authentication Service (CAS), modify the authentication provider to indicate CAS instead of the default authentication.

sso {

authenticationProvider = 'default' // Valid values are: 'default', 'cas'

authenticationAssertionAttribute = 'udcId'

}

In addition, the following elements require updates to the URL information to point to an existing CAS server indicated by the CAS_HOST:PORT elements. You must also update URLs to point to the deployed Banner 9 application indicated by BANNER9_HOST:PORT elements.

plugins {

springsecurity {

cas {

serverUrlPrefix = 'http://CAS_HOST:PORT/cas'


March 2

serviceUrl = 'http://BANNER9_HOST:PORT/APP_NAME/j_spring_cas_security_check'

serverName = 'http://BANNER9_HOST:PORT'

proxyCallbackUrl = 'http://BANNER9_HOST:PORT/APP_NAME/secure/receptor'

loginUri = '/login'

sendRenew = false

proxyReceptorUrl = '/secure/receptor'

useSingleSignout = true

key = 'grails-spring-security-cas'

artifactParameter = 'ticket'

serviceParameter = 'service'

filterProcessesUrl = '/j_spring_cas_security_check'

}

}

}

An example for CAS configuration:

grails {

plugins {

springsecurity {

cas {

serverUrlPrefix = 'https://cas-server/cas'

serviceUrl = 'https://banner-app-server/StudentFacultyGradeEntry/j_spring_cas_security_check'

serverName = 'https://banner-app-server

proxyCallbackUrl = 'https://banner-app-server/StudentFacultyGradeEntry/secure/receptor'


18

loginUri = '/login'

sendRenew = false

proxyReceptorUrl = '/secure/receptor'

useSingleSignout = true

key = 'grails-spring-security-cas'

artifactParameter = 'ticket'

serviceParameter = 'service'

filterProcessesUrl = '/j_spring_cas_security_check'

}

}

} }

Link to Banner 8.X

Banner Student Faculty Grade Entry menus can be used to only access the 8.x applications.

To allow linking from Self-Service 9.0 to Self-Service 8.0, you need the add the following URL, found under “Login with BEIS”, for configuring BEIS SSO Manager in banner_configuration.groovy file.

Login with BEIS

banner8.SS.url='http://beissmpl.university.com:7777/ssomanager/c/SSB?pkg='

The banner8.SS.url will reference the BEIS 8.1.5 SSO manager URL ('http://beissmpl.university.com:7777/ssomanager/c/SSB’) and append the ‘?pkg=’ suffix to support deep linking to a specific Self-Service Banner page.


March 2

The following is an example of Banner 8.0 SSO URL through BEIS:

http://beissmpl.greatvalleyu.com:7777/ssomanager/c/SSB?pgk=bwgkogad.P_SelectAtypView

NoteBEIS is optional. If you have a valid BannerSS8 user name and password you can access BannerSS8 from BannerSS9 without having BEIS.

Login without BEIS

The following is an example of Banner 8.0 SSO URL without BEIS:

banner8.SS.url=' https://ssbserver.institution.edu:9500/smpl/'

The BannerSS9 menus are shown below.

The following sections describes the CSS customization for the appearance of the application and the customization of System/University name.

CSS customization

To customize the appearance of the Banner Student Faculty Grade Entry application, you can provide custom CSS and image files.

Create a CSS file APPLICATION_HOME/current/instance/css/bannerSelfService-custom.css containing the custom CSS directives.


20

If you want to provide custom images, save them in the APPLICATION_HOME/current/instance/css/images directory, and in the CSS, specify their paths as URL ("./images/filename.png").

For example, to customize the university name/logo in the upper left, create a CSS file APPLICATION_HOME/current/instance/css/bannerSelfService-custom.css containing the following:

.institutionalBranding { background-image: url("./images/institutionLogo.png"); }

Save the desired logo image in the following location: APPLICATION_HOME/current/instance/css/images/institutionLogo.png

Then rebuild and redeploy the war file. See “Regenerate WAR file” on page 23.

Customize institution name

The Banner Student Faculty Grade Entry application default layout includes an institutional branding area for display of an institution name or logo.

To customize the System/University name, you must provide a replacement logo image and a custom CSS file to override the default styling for the institutional branding area.

The default layout styles the institutional branding area as follows:

.institutionalBranding {position: relative; float: left; left: 10px; top: 15px; height: 22px; width: 173px; background: url("./images/sgu-logo.png") no-repeat;}

The institution can override just the image displayed by creating a CSS file APPLICATION_HOME/current/instance/css/bannerSelfService-custom.css containing the following:

.institutionalBranding {background-image: url("./images/institutionLogo.png");}

The logo image is saved in the following directory:

APPLICATION_HOME/current/instance/css/images/institutionLogo.png

Then rebuild and redeploy the war file. See “Regenerate WAR file” on page 23.

Provide custom JavaScript

You have an option to add custom JavaScript file. You need to create a custom JavaScript file to add a custom JavaScript file to the Banner Student Faculty Grade Entry application.


March 2

Use the following steps to create a Custom JavaScript file:

1. Create a JavaScript file APPLICATION_HOME/current/instance/js/ bannerSelfService-custom.js

2. You must have the required custom JavaScript code in the custom.js file.

Configure session timeouts

There are two timeouts used in Banner Student Faculty Grade Entry.

• the overall session inactivity timer

• the much shorter “you-have-not-saved-changes-and-have-not-done-anything-in-awhile” timer

Overall session inactivity time

• Configurable in multiple locations.

• banner_configuration.groovy with the configuration property: defaultWebSessionTimeout

• Integer value of the seconds to wait before prompting the user about the session timing out.

• If the configuration is not specified, a default value of 1500 seconds is used.

• Web session timeouts are also configurable for the Web Tailer TWTVROLE.

• Select TWTVROLE_CODE, TWTVROLE_TIME_OUT from TWTVROLE.

• TWTVROLE_CODE corresponds to the ROLE the logged in user has.

The service will then use the longest of all the session timeout values it finds. So if TWTVROLE is set to 1000 seconds for the authentication user, but the default is 1500 seconds, 1500 seconds is used.

Configure date format

The date format follows the MM/DD/YY format, which can be customized in the messages_<ISO_language_code>_<ISO_country_code>.properties file.

The following are attributes that can be customized in the messages_<ISO_language_code>_<ISO_country_code>.properties file

• js.datepicker.closeText

• js.datepicker.prevText

• js.datepicker.nextText


22

• js.datepicker.currentText

• js.datepicker.dayNamesMin

• js.datepicker.weekHeader

• js.datepicker.dateFormat

• js.datepicker.firstDay

• js.datepicker.showMonthAfterYear

• js.datepicker.yearSuffix

For example, if you wish to modify the MM/DD/YY format to a different format you must use the js.datepicker.dateFormat attribute.

To change date formats in the message.properties file currently requires updating two properties in the message.properties file. These two properties are in different formats, but they must specify the same date format. (For example, they must both specify month-day-year or both specify year-day-month.)

default.date.format

Determines the date format for display and data entry in the UI and import process. It must match the Java SimpleDateFormat specification:

http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html

Example:

• MM/dd/yyyy - 05/31/2011

• dd/MM/yyyy - 31/05/2011

js.datepicker.dateFormat

Determines the date format for the interactive date selection control. It must match the jQuery date picker format specification:

http://docs.jquery.com/UI/Datepicker/%24.datepicker.formatDate

Example:

• mm/dd/yy - 05/31/2011

• dd/mm/yy - 31/05/2011


March 2

Regenerate WAR file

Once the shared and application specific configurations are complete, the application WAR file can be regenerated with these customization, such as customize logging, application specific settings, and so on and then deployed into your specific application server.


24

Prepare systool installation tool

The systool is used to create a WAR file.

Use the following procedure to create a WAR file:

1. You must change your current working directory to the product home directory PRODUCT_HOME\current\installer.

2. Run the ant command.

This will build the systool module.

For example:

$ cd PRODUCT_HOME/current/installer

installer $ ant

NoteFor Unix, make sure the ant file is executable.

For example: chmod +x ant

3. Use the systool module to create the WAR file.

Your current working directory must be in the PRODUCT_HOME\current\installer directory before you execute the following command.

On Unix

$ bin/systool war

On Windows

> bin\systool war

NoteYou can use externalized configuration files by setting appropriate system properties, although the configuration files have been included within the WAR file (making the WAR files self sufficient). For information on external configuration see “Configure Tomcat server” on page 25.


March 2

Configure and Deploy the WAR file to Web Application Server

The following sections provides information on how to configure the web application and deploy the WAR file to the Web Application Server (Tomcat server or WebLogic server):

• “Tomcat” on page 25

• “WebLogic” on page 32

Tomcat

The following sections provides information on how to configure the web application and deploy the WAR file to the Tomcat server:

• “Configure Tomcat server” on page 25

• “Configure Java Management Extensions” on page 29

• “Deploy the Banner Student Faculty Grade Entry WAR file to Tomcat server” on page 30

Configure Tomcat server

NoteIf you choose to install the application on a Tomcat server, you do not need to install on Oracle WebLogic.

Use the following procedure to configure Tomcat server:

NoteYou have installed Tomcat version 6. To download and install the Tomcat 6 server, see http://tomcat.apache.org

1. Locate the Oracle JDBC jar file (ojdbc6.jar) in the PRODUCT_HOME\current\lib directory. You will need to copy this file to the application server later in the process.

NoteDuring the Tomcat configuration, you will need the Oracle JDBC jar file included in the release package and copy the jar file into the \lib folder under the Tomcat installation directory.

The account that runs the Tomcat application server, needs to configure environment settings to support Banner Student Faculty Grade Entry.

2. Ensure CATALINA_HOME is defined to reference your Tomcat software installation location.


26

For example, CATALINA_HOME=/opt/apache-tomcat-6.0.xx where xx indicates the point version of Tomcat you installed.

NoteYou must not perform the above step for Windows platform.

3. Define CATALINA_OPTS to configure JVM settings. It is recommended that you have the following settings: CATALINA_OPTS=-server -Xms2048m -Xmx4g -XX:MaxPermSize=256m

This variable can be defined in the account's profile startup script or you can add this definition in $CATALINA_HOME/bin/catalina.sh for Linux or catalina.bat for Windows.

4. (Optional) If you install Tomcat as a Windows service, you must specify the JVM arguments. To specify the JVM arguments, proceed as follows:

4.1. Select Configure Tomcat application from the Windows Start menu.

4.2. Select the Java tab.

4.3. In Java Options field, add the following:

-XX:MaxPermSize=384m.

4.4. Set the Initial memory pool to 2048.

4.5. Set the Maximum memory pool to 4096.

4.6. Save the settings.

4.7. Restart the Tomcat Windows service.

5. (Optional) To setup Tomcat server to enable remote JMX connections, perform the steps in section “Configure Java Management Extensions” on page 29. This is useful for debugging and logging.

6. Define Banner Student Faculty Grade Entry JNDI DataSource resource name.

6.1. Edit $CATALINA_HOME/conf/context.xml.

6.2. Uncomment the <Manager pathname="" /> to disable tomcat session persistence.

For example, change the following:



<!--

March 2

<Manager pathname="" />

-->

to



<Manager pathname="" />

6.3. Add the following ResourceLink definitions inside the <Context> element.

<ResourceLink global="jdbc/bannerDataSource"

name="jdbc/bannerDataSource"

type="javax.sql.DataSource"/>

<ResourceLink global="jdbc/bannerSsbDataSource"

name="jdbc/bannerSsbDataSource"

type="javax.sql.DataSource"/>

NoteThis definition might already exist if other Banner 9.0 applications are already installed and can be skipped.

6.4. Save your changes in context.xml.

6.5. Edit $CATALINA_HOME/conf/server.xml to configure the Banner Student Faculty Grade Entry database JNDI resource name and connection pool configuration.

6.6. Add the Resource definitions inside the <GlobalNamingResources> element.

<Resource name="jdbc/bannerDataSource"

auth="Container"

type="javax.sql.DataSource"

driverClassName="oracle.jdbc.OracleDriver"

url="jdbc:oracle:thin:@//hostname:port/service_name"

username="banproxy"

password="the_banproxy_password"

initialSize="5" maxActive="100" maxIdle="-1" maxWait="30"

28

validationQuery="select 1 from dual"

testOnBorrow="true"/>

<Resource name="jdbc/bannerSsbDataSource" auth="Container"

type="javax.sql.DataSource" driverClassName="oracle.jdbc.OracleDriver"

url="jdbc:oracle:thin:@//hostname:port/service_name"

username="ban_ss_user" password=" the_ban_ss_user_password "

initialSize="5" maxActive="50" maxIdle="-1" maxWait="-1"

validationQuery="select 1 from dual"

testOnBorrow="true"/>

For example if your database server name is myserver.university.edu, and the Oracle TNS Listener is accepting connections on port 1521, and your database service name is SEED, then the URL will be:

jdbc:oracle:thin:@//myserver.university.edu:1521/SEED

NoteThis definition might already exist if other Banner 9.0 applications are already installed and can be skipped.

6.7. Save your changes in the server.xml file.

6.8. Copy the Oracle JDBC jar file (ojdbc6.jar) located in the PRODUCT_HOME/current/lib directory to the $CATALINA_HOME/lib directory.

6.9. Validate the configuration of Tomcat server by starting the application server. To accomplish this, perform the following steps:

6.9.1. Run $CATALINA_HOME/bin/startup.

For Linux

cd $CATALINA_HOME

$ bin/startup.sh

For Windows

cd %CATALINA_HOME%

> bin\startup.bat


March 2

6.9.2. Browse http://server:8080.

NoteTo override the configuration that was added into the WAR file, you may set system properties to point to external configuration files.

For example, to point to a configuration file residing in the PRODUCT_HOME directory, export JAVA_OPTS="-DBANNER_APP_CONFIG=/PRODUCT_HOME/shared_configuration/banner_configuration.groovyDBANNER_FACULTY_GRADE_ENTRY_CONFIG=/PRODUCT_HOME/faculty_grade_entry_home/current/instance/config StudentFacultyGradeEntry_configuration.groovy"

Configure Java Management Extensions

This is an optional step and only needed if you wish to monitor or debug the application. Java Management Extensions (JMX) is a Java technology that supplies tools for managing and monitoring applications, system objects, devices, and service oriented networks.

Enabling JMX connections allows remote monitoring and debugging of the application server.

Use the following procedure to configure the JMX:

1. Add the following options to the catalina.sh or .bat file and then restart the Tomcat server:

set CATALINA_OPTS=-Dcom.sun.management.jmxremote -

Dcom.sun.management.jmxremote.port=8999

-Dcom.sun.management.jmxremote.ssl=false -

Dcom.sun.management.jmxremote.authenticate=false

-Djava.rmi.server.hostname=your.hostname.com

2. Change the java.rmi.server.hostname value to the hostname or IP address of this machine where Tomcat is installed.

For example:

-Djava.rmi.server.hostname=prod.appserver1.com

or

-Djava.rmi.server.hostname=149.24.3.178

3. Change com.sun.mangerment.rmxremote.port=8999 if needed.


30

WarningJMX does not define a default port number to use. It is recommended to connect remotely to the Tomcat server using JMX. Also, the jmxremote.authenticate parameter is set to false, which does not require connections to be authenticated. Do not leave this enabled in a production environment as it represents a security threat, or modify the parameters to enforce authentication.

For more information on Tomcat Remote JMX documentation, see http://tomcat.apache.org/tomcat-6.0-doc/monitoring.html#Enabling_JMX_Remote

Deploy the Banner Student Faculty Grade Entry WAR file to Tomcat server

The systool that is used to create the WAR file can also be used to deploy the WAR file to a Tomcat container. The systool does not provide the capability to undeploy or redeploy an application. If you are redeploying the application, you must use the Tomcat Manager web application to undeploy the existing Student FacultyGradeEntry application.

Environments vary significantly from each other with respect to user privileges, clustering approach, web container version, operating system, and so on. This target may or may not be suitable for your use. The target provides support for deploying the dist/ WAR file using the Tomcat manager application. The WAR file deployment to Tomcat server can also be accomplished by copying the WAR file to the Tomcat webapps/ directory. Therefore the use of this target is not critical. To use the target, you will be required to answer the following:

• The URL of the manager application in tomcat server

For example: http://localhost:8080/manager

• The Tomcat server user who has privileges to deploy. For Tomcat 6.x, you must configure at least one username/password combination in your Tomcat user database <TOMCAT_HOME>\conf\tomcat-users.xml, which includes the manager role.

For example: <user username="tomcat" password="tomcat" roles="manager-gui, manager"/>

• The password of the Tomcat server user

NoteThe roles in Tomcat server have changed between point releases in version 6.x. Refer to Tomcat documentation, specific to your point release on enabling access to provide the appropriate role to a user account for deployment.


March 2

Use the following procedure to deploy the Banner Student Faculty Grade Entry WAR file to Tomcat server:

1. You must be in the PRODUCT_HOME\current\installer directory before you enter any command.

For example:

On Unix

$ bin/systool deploy-tomcat

On Windows

> bin\systool deploy-tomcat

2. Enter the following URL to the Tomcat Manager:

[]: http://localhost:8080/manager

This URL will be accessed in order to deploy the WAR file into the container.

3. Enter a valid Tomcat username to deploy a WAR. You must have the manager-gui role.

[]: tomcat

4. Enter the Tomcat password for the user. This password will not be persisted.

[]: tomcat

5. Access the Banner Student Faculty Grade Entry web application.

http://servername:<port>/StudentFacultyGradeEntry/ssb/facultyGradeEntry

5.1. Use a valid ID that has a faculty role (SIBINST and SORFTRM).

5.2. Use valid password credentials.

To set up a faculty member in Banner baseline, follow these steps:

1. Set up the person on SPAIDEN.

2. (Optional) Set up a Tenure code and Primary Activity of Instructional on SIAFPER.

3. Set up the term range, active status, and faculty status on SIAINST.

4. Assign a PIN on GOATPAD.


32

WebLogic

The following sections provides information on how to configure the web application and deploy the WAR file to the WebLogic server:

Configure WebLogic server

If you choose to install the application on a WebLogic server, you do not need to install on Tomcat.

The following are the prerequisites that must be completed before you configure WebLogic server:

• It is assumed that you have WebLogic already installed. If not, see the Oracle website to download and install WebLogic.

• The minimum requirements are OFM 11.1.14 using WebLogic 10.3.4.

• Both WebLogic node manager and admin server must be started.

• To access the admin server, use the following URL:

http://server:7001/console

Use the following procedure to configure WebLogic server:

1. Create WebLogic machine. See “Create WebLogic machine” on page 32

2. Create WebLogic server. See “Create a WebLogic server” on page 33

3. Create DataSource and Connection Pool. See “Create DataSource and connection pool” on page 34

Create WebLogic machine

NoteIf you have previously created a WebLogic machine definition you may skip this section.

Use the following procedure to create a WebLogic machine:

1. Click Lock & Edit to allow configuration changes in the Change Center frame.

2. In the Domain Structure frame, click (+) to expand and view the list of environments.

3. Select the Machines link item.

4. Click New.

5. Enter a machine name and click Next.


March 2

6. Accept the defaults and click Finish.

7. Click Activate Changes in the Change Center frame.

Create a WebLogic server

Use the following procedure to create a WebLogic server:


2. In the Domain Structure frame, click (+) to expand and view the list of environments.

3. Select the Servers link item.

4. Click New.

5. Enter a Server name and Server Listen Port.

For example, you can have Server name as Banner9 and Server Listen Port as 8080.

6. Click Finish.

7. Select the newly created server link.

8. Under the General tab, assign the machine to this server and then click Save.

9. Select the Server Start tab.

10. Add the following to the Arguments text area:

If you are using Sun JVM, use the following parameters:-server -Xms2048m -Xmx4g -XX:MaxPermSize=512m

If you are using JRocket JVM, use the following parameters:

-Xms2048m -Xmx4g

NoteTo override the configuration that was added into the WAR file, you may set system properties to point to external configuration files.

For example, to point to a configuration file residing in the PRODUCT_HOME directory, append the following to the Arguments text area:-DBANNER_APP_CONFIG=/PRODUCT_HOME/shared_configuration/banner_configuration.groovy DBANNER_FACULTY_GRADE_ENTRY_CONFIG=/PRODUCT_HOME/ faculty_grade_entry_home/current/instance/config StudentFacultyGradeEntry_configuration.groovy


34

11. Click Save.

12. Click Activate Changes.

13. Select Servers link in Domain Structure frame.

14. Select the Control tab.

15. Select the check box next to your new server definition and then click Start.

Create DataSource and connection pool

Use the following procedure to Create a DataSource and connection pool:

NoteYou must configure two data sources, one for the Administrative functions (bannerDataSource) and one for the Self-Service functions (bannerSsbDataSource).


2. In the Domain Structure frame, click (+) to expand Services and then select Data Sources.

3. Click New.

4. Select Generic DataSource.

5. Specify a name.

For example, Banner9DS or Banner9SsbDS.

6. Specify the following JNDI name.

jdbc/bannerDataSource

or

jdbc/bannerSsbDataSource

7. Specify Oracle for Database Type and then click Next.

8. Select Oracle Driver (Thin) for Service Connections and then click Next.

9. On the Transaction Options page, clear the Supports Global Transactions check box and then click Next.


March 2

10. Enter the Database Name, Host Name, Port, Username, Password, confirm the password, and then click Next.

For example:

Database name: BAN9

Host Name: yourhostname.yourdomain.com

Port: 1521

UserName: banproxy

Password: your_password

NoteFor the bannerDataSource, the UserName should be banproxy.

For the bannerSsbDataSource, the UserName should be "ban_ss_user".

11. Click Test Configuration.

12. Click Next for the connection test to be successful.

13. Select the server, Banner9, to allow the jdbc DataSource to be deployed and used by this server.

14. Click Finish.

15. Select the DataSource link that you created.

16. Select the Connection Pool tab.

16.1. Set the Initial Capacity parameter to specify the minimum number of database connections to create when the server starts up.

For example: Initial Capacity = 5.

16.2. Set the Maximum Capacity parameter to specify the maximum number of database connections that can be created.

For example: Maximum Capacity = 100.

17. Change Statement Cache Type = Fixed.

18. Change Statement Cache Size = 0.

19. Click Save.



36

Deploy and Start the Banner Student Faculty Grade Entry web application in WebLogic server

Use the following procedure to deploy and start the Student FacultyGradeEntry web application in WebLogic server:

NoteYou need to access the WebLogic server before you start to deploy the application.

1. To access the admin server, use the following URL:

http://server:7001/console

2. Select the Deployments link in the Domain Structure frame.

3. Select Lock and Edit in the Change Center.

4. Click Install.

5. Select the WAR file to be deployed. It should be located in the

PRODUCT_HOME/current/dist directory

NoteThe WAR file name should be changed to remove the version number. For example, StudentFacultyGradeEntry-9.0.war. should be renamed to StudentFacultyGradeEntry.war.

6. Click Next.

7. Select Install this deployment as an application.

8. Click Next.

9. Select the target server to deploy this application.

For example: Banner9

10. Click Next.

11. Click Finish.


13. Select the deployed application and then click Start.

14. Select Servicing all request.


March 2

15. Access the Banner Student Faculty Grade Entry web application:

15.1. Use the following URL format:

http://servername:<port>/StudentFacultyGradeEntry/ssb/facultyGradeEntry

For example: http://localhost:8080/StudentFacultyGradeEntry

15.2. Use a valid ID that has a faculty role (SIBINST and SORFTRM).

15.3. Use valid password credentials.

To set up a faculty member in Banner baseline, follow these steps:

1. Set up the person on SPAIDEN.

2. (Optional) Set up a Tenure code and Primary Activity of Instructional on SIAFPER.

3. Set up the term range, active status, and faculty status on SIAINST.

4. Assign a PIN on GOATPAD.

F5 Load Balancing Configuration

The solution has been tested using an F5 load balancer configured with the following settings

Load Balancing type = Round Robin

Persistence = Cookie

NoteOther configurations may be supported depending on the Network Load Balancing (NLB).

Multi-Entity Processing

Multi-Entity Processing (MEP) is available for Banner Student Faculty Grade Entry 9.0. The MEP institution name is displayed in the items at the top right of the web page. For more information on using MEP, refer to the Multi-Entity Processing Handbook.

The MEP URL for Self-Service uses a parameter of mepCode that corresponds to the GTVVPDI_CODE value in GTVVPDI table.


38

For example:

For the GTVVPDI_CODE value of INST (GTVVPDI_DESC value of Institution), the URL would be:

http://m037177.sungardhe.com:8080/StudentFacultyGradeEntry?mepCode=INST

For the GTVVPDI_CODE value of BANNER (GTVVPDI_DESC value of Banner College), the URL would be:

http://m037177.sungardhe.com:8080/StudentFacultyGradeEntry?mepCode=BANNER

Use the following steps for MEP with Student Faculty Grade Entry.

1. The user logs in to a specific institution.

The institution is determined by the link the user selects, such as:

• Student Faculty Grade Entry - MEP=INST

• Student Faculty Grade Entry - MEP=BANNER

• Student Faculty Grade Entry - NO MEP CODE

Selecting the link takes the user to the Student Faculty Grade Entry login page where the username and password are entered.


March 2

2. The faculty member is presented with a list of all assigned courses and can select the Midterm Grades tab or the Final Grades tab.

Here is the view where the faculty member can select the Midterm Grade tab to enter midterm grades.


40

3. The faculty member can then select a course and scroll down to enter grades for the students in the course.

Here is the view of Final Grades display for students in the course.


March 2

Here is the view of Midterm Grades display for students in the course.


42

Banner Student Faculty Grade Entry - Bridgewater State · PDF fileIn preparing and providing...

Documents

Transcript of Banner Student Faculty Grade Entry - Bridgewater State · PDF fileIn preparing and providing...