Banner Employee Profile · See the Banner Employee Profile Release Guide for Ellucian software dependencies. Single sign on (SSO) support Banner 9.x applications natively support

Banner Employee ProfileInstallation Guide

Release 9.1March 2016

Without limitation: Ellucian®, Banner®, Colleague®, and Luminis® are trademarks of the Ellucian group of companies that are registered in the U.S. and certain other countries; and Ellucian Advance™, Ellucian Course Signals™, Ellucian Degree Works™, Ellucian PowerCampus™, Ellucian® CRM Recruit , Ellucian SmartCall™, are also trademarks of the Ellucian group of companies. Other names may be trademarks of their respective owners.

©2016 Ellucian.

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

Ellucian4375 Fair Lakes CourtFairfax, VA 22033United States of America

Ba

Contents

Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Known installation issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Hardware requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

CPU and memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Screen resolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Tablets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Mobile devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Software requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Oracle Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Application server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Middle Tier (application server) platforms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Ellucian software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Single sign on (SSO) support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

SAML support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Supported browsers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Chrome Compatibility Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Chrome Java support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Internet Explorer Compatibility View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Java dependencies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Deployment of multiple web applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Navigation among 9.x applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

With CAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Without CAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

F5 load balancer configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Upgrade the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

3nner Employe Profile Installation Guide | Contents

Ba

Perform the Banner DB Upgrade steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Update login.sql . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Verify that the required products are applied . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Verify the ban_ss_user database account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Set up access for application users with an administrative account . . . . . . . . . . 14

Migrate staged files to the permanent directories. . . . . . . . . . . . . . . . . . . . . . . . . . 14

Unix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Update the version number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Install Banner Employee Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Undeploy the existing application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Tomcat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Undeploy using the Tomcat Manager web application . . . . . . . . . . . . . . . . . . . . . . 17Undeploy using a manual procedure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

WebLogic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Customize the WAR file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Unzip the release package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Prepare the installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Install into the product home directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Configure shared settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

JNDI datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Session timeouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Configure application-specific settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

System settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Set up CAS configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

CAS SSO Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Logout URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Functional settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Regenerate the WAR file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Configure and deploy the WAR file to a web application server . . . . . . . . . . . . . . 54

Tomcat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54


Ba

Configure the Tomcat server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Configure Java Management Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Deploy the WAR file to the Tomcat server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

WebLogic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Verify WebLogic prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Create a WebLogic machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Create a WebLogic server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Update Oracle JDBC JAR files on the WebLogic server. . . . . . . . . . . . . . . . . . . . . 62Create an administrative datasource and connection pool . . . . . . . . . . . . . . . . . . . 63Create a self-service datasource and connection pool . . . . . . . . . . . . . . . . . . . . . . 64Configure server communication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Deploy and start the application in the WebLogic server . . . . . . . . . . . . . . . . . . . . 66

Configure the application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Customizing the pay stub PDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Retaining pay stub PDF customizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Pay stub PDF fonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Employee preferred name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Name format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Phone format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Address format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Date format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Multiple calendars. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

CSS customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Institution name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Custom JavaScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74


Ba

Introduction

This installation guide details the steps required to install Banner Employee Profile. Before you install any components of the system, you should review this chapter thoroughly so you have a better understanding of what you are installing and where you will install it.

Known installation issues

Before you install Banner Employee Profile, refer to the following articles on the Ellucian Support Center (http://www.ellucian.com/Solutions/Ellucian-Client-Support/) for any issues that were reported after the release was posted:

• Article 000032806 - Application-specific installation issues

Hardware requirements

The application has the following hardware requirements.

CPU and memory

Screen resolution

The minimum screen resolution for the application is 1024 x 768.

Tablets

The following tablets are supported in the application:

• iPad, iPad Mini, iOS 6.x, and iOS 7.x

• Android OS 4.x

Recommended: Quad core CPU with 4 to 8 GB of memory for the application server

Minimum: Dual core CPU with 2 GB of memory for the application server

6nner Employee Profile Installation Guide | Introduction

http://www.ellucian.com/Solutions/Ellucian-Client-Support/

Ba

Mobile devices

The following mobile devices are supported in the application:

• iPhone 4 and 5

• Nexus 5

• Samsung s4

Software requirements

The application has the following software requirements.

Oracle Database

Supported versions of the Oracle Database depend on multiple factors, including third-party support time lines. For a complete list of supported Oracle technologies, refer to the Ellucian Oracle Support Calendar. The calendar is available in the Interactive Banner Compatibility Guide on the Ellucian Download Center.

Application server

The application was tested on the following application servers:

• Oracle Fusion Middleware 11gR2 using WebLogic 10.3.3, 10.3.4, 10.3.5, and 10.3.6.

• Apache Tomcat 7

Middle Tier (application server) platforms

The application supports the following application server and operating system combinations:

Tomcat (64 bit) WebLogic (64 bit)

Red Hat Linux 6 Red Hat Linux 6

Windows Server 2008 Windows Server 2008

Solaris 10 Solaris 10

AIX 6.1 (JDK 1.7 SR10 or later) AIX 6.1 (JDK 1.7 SR10 or later)

HP-UX HP-UX 11iV3 (11.31)


Ba

Note: Banner 9.x applications are tested on WebLogic using both the Classic Domain template and the Basic Domain template.

For WebLogic server environments, JPA 2.0 support must be enabled. WebLogic server does not enable JPA by default. To enable JPA, use the steps in the appropriate Oracle documentation:

WebLogic 10.3.3: http://docs.oracle.com/cd/E14571_01/web.1111/e13720/using_toplink.htm#i1221315

WebLogic 10.3.4: http://docs.oracle.com/cd/E17904_01/web.1111/e13720/using_toplink.htm#i1221315

WebLogic 10.3.5: http://docs.oracle.com/cd/E21764_01/web.1111/e13720/using_toplink.htm#EJBAD1309

WebLogic 10.3.6:http://docs.oracle.com/cd/E23943_01/web.1111/e13720/using_toplink.htm#autold2

For WebLogic server 12.1.x environments, JPA 2.1 support must be enabled. WebLogic server does not enable JPA by default. To enable JPA, use the steps in the appropriate Oracle documentation:

WebLogic 12.1.3http://docs.oracle.com/middleware/1213/wls/EJBAD/using_toplink.htm#EJBAD1288

Ellucian software

See the Banner Employee Profile Release Guide for Ellucian software dependencies.

Single sign on (SSO) support

Banner 9.x applications natively support SSO. Central Authentication Service (CAS) is the central access manager for SSO.

Refer to the CAS Single Sign On Handbook, available on the Ellucian Support Center, for details on configuring Banner for CAS.


http://docs.oracle.com/cd/E14571_01/web.1111/e13720/using_toplink.htm#i1221315

http://docs.oracle.com/cd/E17904_01/web.1111/e13720/using_toplink.htm#i1221315

http://docs.oracle.com/cd/E21764_01/web.1111/e13720/using_toplink.htm#EJBAD1309

http://docs.oracle.com/cd/E23943_01/web.1111/e13720/using_toplink.htm#autold2

http://docs.oracle.com/middleware/1213/wls/EJBAD/using_toplink.htm#EJBAD1288

Ba

SAML support

Although you might see references to SAML during installation, the Employee Profile application does not support SAML at this time.

Leave the following parameter in the BannerEmployeeProfileApp_configuration file set to the default value of false:

grails.plugin.springsecurity.saml.active = false

The other SAML configuration entries at the bottom of this file must be left commented out.

Supported browsers

The following browsers are compatible with the application:

• Chrome

• Firefox

• Internet Explorer 10 and 11

• Safari 6, 7

For more information about supported browsers, refer to the Interactive Banner Compatibility Guide on the Ellucian Download Center.

Chrome Compatibility Mode

When using Chrome, you must disable Compatibility Mode. If Compatibility Mode is not disabled, errors may occur.

To disable Compatibility Mode in Chrome, perform the following steps:

1. Right-click your Chrome shortcut and select Properties.

2. Select the Compatibility tab.

3. Clear the Run this program in compatibility mode for: check box.

4. Click Apply.

5. Click OK.


Ba

Chrome Java support

The Java plug-in for web browsers relies on the cross-platform plug-in architecture, NPAPI. This is supported by all major web browsers. In September 2013, Google announced its plans to remove NPAPI support from Chrome by the end of 2014.

As of April 2015, starting with Chrome Version 42, Google has added an additional step to configure NPAPI-based plug-ins, like Java, to run. For more information about how to implement this configuration, refer to the article on Oracle Java's website, "Enabling NPAPI support in Chrome."

Internet Explorer Compatibility View

When using Internet Explorer, you must be in Internet Explorer Standard Mode. If not, you might receive the following message:

You are viewing this webpage in Compatibility View. Please turn off Compatibility View in your browser (Tools menu) for optimal viewing experience.

To disable Compatibility View in Internet Explorer, perform the following steps:

1. Select Tools > Compatibility View Settings.

2. Clear the Display intranet sites in Compatibility View and Display all websites in Compatibility View check boxes.

3. Click Close.

You can also deactivate the Compatibility View item in the Tools menu.

Java dependencies

Java 1.7.x (64-bit version) must be installed on the application server before you install the application. The same version of Java must be used to customize and deploy the WAR file.

The JDK bin directory must be defined in the PATH system property.

Note: Development for Banner 9.x is currently supported on Java 7 only.

Note: Java 7 includes security restrictions for Rich Internet Applications. Refer to Article 000030656 on the Ellucian Support Center for details on Java 7 security restrictions with Liveconnect calls to Oracle Forms Applet.


Ba

Deployment of multiple web applications

The following diagram describes various scenarios of deploying multiple web applications:

In the first and second scenarios, you can deploy multiple web applications with different WAR file names on the same or different servers.

In the third scenario, if you want to deploy multiple web applications on the same server, the WAR file names must be different.

In the fourth scenario, you can deploy multiple web applications with the same WAR file name on different servers.

Navigation among 9.x applications

You can navigate among multiple Banner 9.x applications with or without CAS.

With CAS

If CAS single sign on (SSO) is enabled, a user is authenticated only for the first login. Subsequently, the user can access and navigate among any Banner 9.x applications without logging in again. When a user logs out of an application, the user is logged out of all applications that are open.

Refer to the CAS Single Sign On Handbook, available on the Ellucian Support Center, for details on configuring Banner for CAS.

Without CAS

If CAS SSO is not enabled, a user must authenticate before accessing each Banner 9.x application. When a user logs out of an application, the user is logged out of that current application. The user is still logged in to all other applications that are currently open.


Ba

F5 load balancer configuration

The application was tested using an F5 load balancer configured with the following settings:

Load Balancing type = Round Robin

Persistence = Cookie

Note: Other configurations may be supported depending on Network Load Balancing (NLB).


Ba

Upgrade the Database

The following steps are used to upgrade the database:

• “Perform the Banner DB Upgrade steps” on page 13

• “Update login.sql” on page 13

• “Verify that the required products are applied” on page 14

• “Verify the ban_ss_user database account” on page 14

• “Set up access for application users with an administrative account” on page 14

• “Migrate staged files to the permanent directories” on page 14

• “Update the version number” on page 16

Perform the Banner DB Upgrade steps

Some database upgrade steps are common to all Banner 9.x applications. These common database upgrade steps must be performed before you upgrade the database for the Banner Employee Profile application.

Refer to the instructions in the Banner DB Upgrade, Upgrade Guide (banner_db_upgrade90200ug.pdf) for the common database upgrade steps. The Banner DB Upgrade, Upgrade Guide is delivered in the banner-db-upgrade-90200d.trz file.

Update login.sql

You must edit login.sql to update the schema owner’s default password and to specify the path to create log files. To update the delivered login.sql script, perform the following steps:

1. Replace the #UPDATEME# string with the value of a particular schema owner’s password in your environment. Make this update in your environment for each Banner schema owner.

2. Set the value that gets assigned to splpref. The value can be set to the ORACLE_SID or to a directory name. Your options depend on the operating system.

The splpref variable defines the file prefix that the installation process uses to generate listings or intermediate SQL routines. This feature allows you to segregate the generated output when the stage must be applied to more than one instance.

13nner Employee Profile Installation Guide | Upgrade the Database

Ba

Verify that the required products are applied

To check that all prerequisite products are applied to the environment, perform the following steps:

1. Invoke SQL*Plus and run the following procedure:

sqlplus /nolog @ruappready

2. Review the ruappready listing.

Verify the ban_ss_user database account

The ban_ss_user account is used for database connections. The database upgrade process grants the BAN_DEFAULT_M role to ban_ss_user. If this role is revoked, the application will not start successfully.

Set up access for application users with an administrative account

A new security object named SELFSERVICE is created during the installation of the self-service application. Application users who have an administrative account associated with their login on the Enterprise Access Controls (GOAEACC) page must be assigned this new object with BAN_DEFAULT_M privilege.

Note: The SELFSERVICE object was also added to the BAN_GENERAL_C class. As an alternative, you can associate your administrative users with this class.

Migrate staged files to the permanent directories

This release provides migration scripts for Unix and Windows platforms. These scripts expect your directory structure to match the directory structure created by the Banner installation process. If you choose a different directory structure, you must modify the scripts. The release does not include migration scripts for other platforms due to their highly customized structures. You can, however, use the file PAYMIGR.TXT as a starting point for writing your own migration scripts.


Ba

Unix

The file PAYMIGR.TXT lists all files that must be deleted from your permanent directories, and all files that should be copied from the staging directory to your permanent directories. The destination is indicated in UNIX format. The format is different on other platforms.

The file paymigr.shl does the appropriate removes, copies, and links. The local LN variable at the top of paymigr.shl determines the type of links that are used in the migration. If you want to use symbolic links, set LN=‘ln -s’ so that the command ${LN} file $BANNER_HOME/links is translated to ln -s file $BANNER_HOME/links. If you want to force the removal of any existing targets before linking files, set LN=‘ln -f’.

To run the migration script in background on a Unix platform, perform the following steps:

1. Ensure that the directory path names in paymigr.shl are correct.

2. Ensure that the environment variable $BANNER_HOME in paymigr.shl is set to the appropriate directory.

3. Sign on to an operating system account that has write permission into the target Banner directories.

4. If you are a cshell user (your operating system prompt is a percent sign), enter sh and press Enter to enter the Bourne shell.

5. Navigate to the staging directory for the product.

6. Run the migration script as follows:

sh paymigr.shl >paymigr.log 2>&1 &

7. If you were a cshell user and want to return to that mode, press CTRL-D or enter exit. Then press Enter.

8. Review paymigr.log. This file contains the results of the migration.

Note: Even if your directory structure matches the baseline perfectly, some link commands will fail (that is, where the link currently exists). Other link errors might indicate that you had two copies of an object when the migration script was executed. This condition must be corrected. The duplication is probably between links and the product subdirectory.

Windows

The file paymigr.pl does the appropriate deletes and copies. To run the migration script on a Windows platform, perform the following steps:


Ba

1. Check the value of the BANENV environment variable by executing the SET command from the DOS prompt.

• If the value of BANENV is REG, the value used for BANNER_HOME will be taken from the registry entry:

HKEY_LOCAL_MACHINE\SOFTWARE\BANNER\BANNER_HOME

• If the value of BANENV is ENV, the value used for BANNER_HOME will be taken from the environment variable BANNER_HOME.

2. Ensure that the directory path names in paymigr.pl are correct.

3. Sign on to an operating system account that has write permission into the target Banner directories.

4. Navigate to the staging directory for the product.

5. Run the migration script as follows:

perl paymigr.pl >paymigr.log 2>&1

6. Review paymigr.log. This file contains the results of the migration.

Update the version number

To insert the release version number into the Web Application (GURWAPP) table, perform the following steps:

1. Invoke SQL*Plus and run the following procedure:

sqlplus general/passwordstart versionupdate.sql

2. Review the versionupdate listing.


Ba

Install Banner Employee Profile

The following sections detail the installation steps for Banner Employee Profile:

• “Undeploy the existing application” on page 17

• “Customize the WAR file” on page 19

• “Regenerate the WAR file” on page 53

• “Configure and deploy the WAR file to a web application server” on page 54

• “Configure the application” on page 67

Undeploy the existing application

Before you install Banner Employee Profile, you must undeploy previous 9.x versions of Banner Employee Profile. If no previous 9.x versions of Banner Employee Profile are installed, skip this section.

The following sections give the required steps to undeploy existing Banner 9.x applications in Tomcat and WebLogic servers.

Tomcat

You can either use the Tomcat Manager web application to undeploy the existing application or you can shut down Tomcat and manually remove the files.

Undeploy using the Tomcat Manager web application

Use the following procedure to undeploy the application using the Tomcat Manager web application:

1. Access the Tomcat Manager web application at one of the following URLs:

http://server:8080/manager

or

http://server:8080/manager/html

2. Access the deployment page using a valid user name and password.

3. Under the Commands area, click Stop to stop the existing application.

4. In the confirmation dialog box, click OK.

17nner Employee Profile Installation Guide | Install Banner Employee Profile

Ba

5. Under the Commands area, click Undeploy.

6. In the confirmation dialog box, click OK to undeploy the application.

Undeploy using a manual procedure

The following sections give the steps to manually undeploy the existing application on Unix and Windows operating systems.

Unix

Use the following procedure to manually undeploy the existing application on a Unix operating system:

1. Log in to the server where Tomcat is running, using the same account credentials that were used to start Tomcat.

2. Shut down Tomcat by running the shutdown script:

$CATALINA_HOME/bin/shutdown.sh

3. Remove the current deployment and associated WAR file:

cd $CATALINA_HOME

rm -rf $CATALINA_HOME/webapps/banner9application

rm -rf $CATALINA_HOME/webapps/banner9application.war

Windows

Use the following procedure to manually undeploy the existing application on a Windows operating system:

1. Use the command prompt to shut down Tomcat.

Note: If you installed Tomcat as a service, use the Service Control panel to stop the application. Otherwise, use the shutdown script %CATALINA_HOME%\bin\shutdown.bat.

2. Remove the current deployment and associated WAR file:

rmdir %CATALINA_HOME%\webapps\banner9application /s/q

del %CATALINA_HOME%\webapps\banner9application.war /q

WebLogic

Use the following procedure to stop and undeploy the Banner 9.x application:

1. Access the administration server using the following URL:

http://server:7001/console


Ba

2. In the Domain Structure frame, click Deployments.

3. In the Change Center, click Lock and Edit.

4. Select the check box to the left of the Banner 9.x application.

5. Click Stop.

6. Click Force Stop Now.

7. In the Force Stop Application Assistant page, click Yes.

8. Select the check box to the left of the Banner 9.x application.

9. Click Delete.

10. In the Delete Application Assistant page, click Yes.

11. In the Change Center frame, click Activate Changes.

Customize the WAR file

The name of the release package is release-BannerEmployeeProfileApp-9.1.zip. This release package is moved to the BANNER_HOME\payroll\java subdirectory during the database upgrade. Use the following steps to unzip the release package and customize the WAR file for your institution.

Note: JDK 1.7 must be installed on your system. See the Java dependencies section for more information.

Unzip the release package

To unzip the release package into a temporary directory, perform the following steps:

1. Log in to the application server platform.

Note: You must have a valid application server account to deploy into the application server container (Tomcat or WebLogic).

2. Create a temporary directory. For example:

mkdir $HOME/ban9temp

3. Locate the release package release-BannerEmployeeProfileApp-9.1.zip.

4. Transfer this file in binary mode using File Transfer Protocol (FTP) file into the temporary directory. For example:

$HOME/ban9temp


Ba

5. Unzip release-BannerEmployeeProfileApp-9.1.zip into the temporary directory.

Prepare the installer

To prepare the installer, perform the following steps:

1. Change the directory to the installer directory:

cd installer

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

Note: For Unix, make sure the ant file is executable. For example, chmod +x ant.

Example:

ban9temp $ cd installerban9temp/installer $ ./ant

The message Build successful confirms a successful build.

Install into the product home directory

The product home directory supports the configuration and creation of a deployable WAR file. Although Banner 9.x web applications are modular and are installed independently, they share a common configuration. The package provides a common installer that creates consistent product home directory structures across all Banner 9.x applications.

Within a particular environment, you should place the product home directories for Banner 9.x applications in sibling directories. For example, the following directory structure includes five product home directories and a shared_configuration directory that support a common test environment.

banner_test_homes

|--> BannerEmployeeProfileApp

|--> Catalog 9.1

|--> Schedule 9.1

|--> StudentOverall

|--> StudentRegistration

|--> shared_configuration

A product home directory is created for each deployment. For example, the home directory that is used to manage the application within a test environment is a different home directory than the one used for the production environment. When you are supporting different environments for multiple home directories for the same solution, this provides the necessary configuration, release level, and custom modification flexibility.

The following directory tree illustrates the product home directory that is created for the test environment:


Ba

In addition to the application’s product home directory, there is a separate shared_configuration home directory that contains cross-module configuration for the test environment. This directory holds the banner_configuration.groovy file, which contains the shared JNDI datasource configuration.

To install the installer into the product home directory, perform the following steps:

1. Ensure that the installer is prepared using ant.

2. Use the installer to install the release file into a product home directory.

Note: Your current working directory must be in the installer directory (ban9temp/installer) before executing the following commands.

On Unix:$ bin/install home

On Windows:> bin\install home

3. When prompted, enter the full path of the application home directory. The application will be installed within the current subdirectory within this home directory and the previous release will be archived.

On Unix:[]: Current_home_directory/banner_test_homes/BannerEmployeeProfileApp

On Windows:[]: c:\banner_test_homes\BannerEmployeeProfileApp

4. Enter the full path of the shared_configuration home directory. Banner 9.x applications that are configured to refer to this home share this configuration file.

On Unix:[]: Current_home_directory/banner_test_homes/shared_configuration


Ba

On Windows:[]: c:\banner_test_homes\shared_configuration

Note: If an identified home directory or the shared_configuration home directory does not exist, the installer creates it. The name of a product home directory is not restricted. You can name it when prompted by the installer.

Configure shared settings

The shared_configuration home directory contains a cross-application configuration file called banner_configuration.groovy. You can change settings in this file.

JNDI datasource

You can optionally change the datasource name in the configuration file to point to the JNDI datasource that is configured in your application server. For example, jndiName = "jdbc/bannerSsbDataSource" is the default configuration. You can change this to match the JNDI datasource name in your environment.

Session timeouts

The following timeouts are used in the self-service application:

• “banner.transactionTimeout” on page 22

• “AJAX timeout” on page 23

• “defaultWebSessionTimeout” on page 23

When you determine the timeout settings for CAS and Banner 9.x applications, consider the time limits imposed for each. For example, if the Banner 9.x timeout setting is less than the CAS timeout setting, SSO authentication might still be valid even though the user is exited from the Banner 9.x application. As long as the CAS authentication remains valid, the user can re-enter the Banner 9.x application without re-authenticating.

banner.transactionTimeout

The banner.transactionTimeout setting is used to prevent excessive delays due to long database transactions. This setting is configured in the banner_configuration.groovy file. To use this timeout, set the banner.transactionTimeout setting to 300 seconds.

Ensure that either the configuration file is deployed with the application, or the application is using the configuration file where it is currently located.

If a database transaction takes longer than banner.transactionTimeout seconds, the transaction is aborted and any change is rolled back.


Ba

Note: In some cases, the web user interface might ignore the database timeout/error notification and not remove the loading spinner. If this occurs, you must refresh the page to continue using the application.

AJAX timeout

The AJAX timeout terminates HTTP requests that exceed the specified time limit. The self-service application sets the timeout value based on the banner.transactionTimeout setting plus an increment to allow for communication and processing of the request.

You do not need to override the AJAX timeout, but the timeout value can be overridden in JavaScript by calling $.ajaxSetup( { timeout: timeoutValue } );

Note: The timeoutValue must be in milliseconds.

Note: Although the web user interface continues after an AJAX timeout, the server might continue processing the request until it completes or reaches a database transactionTimeout.

defaultWebSessionTimeout

The defaultWebSessionTimeout setting is used to terminate user sessions that are idle or abandoned without logging out. This setting is used to set the overall session inactivity time. The defaultWebSessionTimeout setting is configured in the banner_configuration.groovy file.

Note: If the defaultWebSessionTimeout setting is not specified, a default value of 1500 seconds is used.

Role-based web session timeouts are also configurable in Banner Web Tailor. In Banner WebTailor, TWTVROLE is the logged in user role and TWTVROLE_TIME_OUT is the timeout for users with that role.

Note: An individual's session timeout is the longer of the defaultWebSessionTimeout and the role-based timeout from TWTVROLE.

Configure application-specific settings

The installer creates the BannerEmployeeProfileApp_configuration.example file. Copy this file and change the name to BannerEmployeeProfileApp_configuration.groovy. Place the copied file in the BannerEmployeeProfileApp\current\instance\config directory. This


Ba

application-specific configuration file contains settings that you can customize for your specific environment.

System settings

The BannerEmployeeProfileApp_configuration.groovy file includes the following system settings:

• JMX MBean name

• Location of the lgging file

• Logging level

• Proxied Oracle users

• Logout URL

• Password reset

• Self-service end point

JMX MBean name

The name that is used to register MBeans must be unique for each application that is deployed into the Java Virtual Machine. This configuration should be updated for each instance of each application to ensure uniqueness.

jmx {

exported {

log4j = "BannerEmployeeProfileApp-log4j"

} }

Location of the lgging file

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.

The following is an example of how to override the location where the log file is saved.

loggingFileDir = "System.properties['logFileDir'] ?

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

logAppName = "BannerEmployeeProfileApp"

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

The following is an example of how to override the log file directory properties:

export JAVA_OPTS = "-DlogFileDir=/PRODUCT_HOME /"

The output logging file location is relative to the application server you are deploying.


Ba

Logging level

The root logging level is pre-configured to the ERROR level. Multiple class or package level configurations, by default, are set to a status of "off." You can set a different logging level for any package or class. However, the running application must be restarted.

For example:

case 'production':

root {

error 'appLog' //change the log level here with the

appropriate log level value.

additivity = true

}

Note: Changing the logging level to DEBUG or INFO produces very large log files.

Changes to the BannerEmployeeProfileApp_configuration.groovy file require a restart of the application before those changes take effect.

Alternatively, you can use JMX to modify logging levels for any specified package or class, or even at the root level. When using JMX, the logging level changes only affect the running application. When you restart the application, changes that you made using JMX are lost. For more information on JMX configuration, see “Configure Java Management Extensions” on page 58.

Institutional home page redirection support

With previous versions of the application, users did not have the option to go back to a home page if they encountered any SSO access issues. This configuration allows Employee Profile to provide an institutional home page to which users can navigate back to if they encounter access issues specific to insufficient privileges when accessing the application.

/*********************************************************************

* Home Page link when error happens during authentication. *

*********************************************************************/

grails.plugin.springsecurity.homePageUrl='http://URL:PORT/'

Proxied Oracle users

When connecting to self-service applications, the ssbOracleUsersProxied setting specifies whether the Oracle account is used for the connection. This also controls whether Value Based Security (VBS) is enabled in the self-service application. The following values can be used for this setting:

• False - The Oracle account is not used for the connection, and VBS is not enabled in the self-service application. If the Oracle account is locked, the user is not prevented from logging in to the self-service application.


Ba

• True - The Oracle account is used for the connection, and VBS is enabled in the self-service application. If the Oracle account is locked, the user is prevented from logging in to the self-service application.

Password reset

The ssbPassword.reset.enabled setting determines whether users can reset their passwords. If the value of the setting is true, users can reset their passwords. If the value of the setting is false, a "disabled" error message is displayed.

Redirect pages in a MEP environment

Two settings in the configuration file must be configured if your environment is enabled for Multi-Entity Processing (MEP). You do not need to configure these settings if your environment is not enabled for MEP.

If a user tries to access a self-service URL that does not include a valid MEP code, an error prompt is displayed. The user responds by clicking the Logout or Return Home button. Configuration settings determine where each button redirects the user:

• grails.plugin.springsecurity.logout.afterLogoutUrl - This setting contains the URL of the institution-specific page where the user is redirected if the Logout button is clicked. An example is a portal page:

"https://cas-server/logout?url=http://myportal/main_page.html" (CAS environment)

"http://myportal/main_page.html" (non-CAS environment)

• grails.plugin.springsecurity.logout.mepErrorLogoutUrl - This setting contains the URL of the institution-specific page where the user is redirected if the Return Home button is clicked.

Each URL can be any page that does not require a MEP-enabled database connection, or any page outside the self-service application.

Self-service end point

The ssbEnabled setting is set to true for instances that expose self-service end points. Banner Employee Profile is a self-service application, so the default value is always true.

Set up CAS configuration

CAS SSO Configuration

Shown below is a sample of the configuration you can enable for SSO between Employee Profile and an identity management system that supports CAS SSO protocol. Make sure to set the value of "active" to true when CAS SSO is enabled.


Ba

// +++ CAS CONFIGURATION +++

************************************************************

banner {

sso {

authenticationProvider = 'default'

authenticationAssertionAttribute = 'UDC_IDENTIFIER'

if(authenticationProvider != 'default') {

grails.plugin.springsecurity.failureHandler.defaultFailureUrl = '/login/error'

}

}

grails {

plugin {

springsecurity {

cas {

active = true

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

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 = 'SAMLart'

serviceParameter = 'TARGET'

filterProcessesUrl = '/j_spring_cas_security_check'

serverUrlEncoding = 'UTF-8'

if (useSingleSignout){

grails.plugin.springsecurity.useSessionFixationPrevention = false

}

}

logout {

afterLogoutUrl = 'https://cas-server/logout?url=http://myportal/main_page.html'

}

}

}

Note: Depending on your needs, you can customize the serverUrlPrefix, serviceUrl, and serverName settings.

Logout URL

You can specify where a user should be directed after logging out of the application by updating the BannerEmployeeProfileApp_configuration.groovy file. There are two ways the application can handle logouts:


Ba

• Logouts can display the CAS logout page with a redirect URL.

• Logouts can automatically go to a redirect URL (without displaying the CAS logout page).

The redirect URL can be different for each Banner application, depending on where you wish to send the user. If the redirect URL is the same for all Banner applications, you can define the redirect URL in the global banner_configuration.groovy file.

To display the CAS logout page with a redirect URL

With this method of handling logouts, users see the CAS logout page when they log out of the application. The CAS logout page displays a URL that users must click to continue.

Use the logout.afterLogoutUrl setting to configure the logout URL:

logout.afterLogoutUrl='https://<CAS_HOST>:<PORT>/<cas>/logout?url=http://myportal/main_page.html'

To go directly to a redirect URL

With this method of handling logouts, users automatically go to a redirect URL. Configure logout URL information as follows:

1. Configure logout information, replacing "url" with "service."

Example:

grails.plugin.springsecurity.logout.afterLogoutUrl='https://<CAS_HOST>:<PORT>/cas/logout?service=http://myportal/main_page.html'

2. Set the property followServiceRedirects to true on the LogoutController that is defined in cas-servlet.xml:

<bean id="logoutController" class="org.jasig.cas.web.LogoutController"

p:centralAuthenticationService-ref="centralAuthenticationService"

p:logoutView="casLogoutView"

p:warnCookieGenerator-ref="warnCookieGenerator"

p:ticketGrantingTicketCookieGenerator-ref="ticketGrantingTicketCookieGenerator"

p:followServiceRedirects="true" />

Functional settings

The BannerEmployeeProfileApp_configuration.groovy file includes functional settings for Banner Employee Profile. The following tables describe the functional settings:

• Table 1 - Employee photos

• Table 2 - Employee preferred first name

• Table 3 - Employer logos

• Table 4 - Pay stub PDF generation


Ba

• Table 5 - Link to Banner Employee Self-Service 8.x

• Table 6 - Buttons on the Employee Profile

• Table 7 - Benefits links on the Employee Dashboard

• Table 8 - My Activities links on the Employee Dashboard

• Table 9 - Tax links on the Employee Dashboard

• Table 10 - Canadian tax links on the Employee Dashboard

• Table 11 - Pay information links on the Employee Dashboard

• Table 12 - Open enrollment links

• Table 13 - Time approval and Leave Reporting links on the My Activities page

• Table 14 - Campus directory links on the My Activities page

• Table 15 - Banner 8.x link on the My Activities page

• Table 17 - Banner display options


30B

anner Em

ployee Profile Installation G

uide|

Install Banner E

mployee P

rofile

S

e mployee Dashboard, My

yee does not have a photo, a

images.

y 200px.

d .bmp. The preferred format is

ee ID. Employee photo file t with a number, use the For example:

d I12345678.d S12345678 or IS12345678.

name. To ensure that a photo an employee ID, as long as the of valid files names:

Table 1: Employee photos

etting Default value Description

ss.displayComponent.Photo Y This setting controls the display of employee photos on the EProfile, and My Team pages.

Y - Employee photos are enabled in all locations. If an emplodefault photo is displayed.

N- Employee photos are disabled in all locations.

It is important that you maintain a square aspect ratio for all

The resolution of your photos can be a maximum of 200px b

The following image formats are supported: png .jpg, .gif, anpng.

The name of a photo file is based on the associated employnames must start with a character. If your employee IDs starcharacter I as the starting character of the photo file names.

• An employee with ID 12345678 requires a photo file name• A employee with ID S12345678 can use a photo file name

Some file systems restrict the number of characters in a file can be displayed, you can remove the first two characters ofID has five or more characters. The following are examples

• IS12345678.png, SI12345678.png, I2345678.png• IS12345678.jpg, SI12345678.jpg, I2345678.jpg• IS12345678.gif, SI12345678.gif, I2345678.gif• IS12345678.bmp, SI12345678.bmp, I2345678.bmp

31B

anner Em


uide|

Install Banner E

mployee P

rofile

b example:

ir’) + ‘/test/images’

tory appended with /test/

contains the photo files. For

’

photos are stored on a server must set up a share from the Banner machine. Specify this

b displayed for employees who

S

anner.picturesPath /test/images This is the directory where employee photos are stored. For

banner {picturesPath = System.getProperty(‘base.d

In this example, the path equals the application’s base direcimages.

The value must be a fully qualified path to the directory that example:

banner {picturesPath = ‘/home/banner/test/images

A new directory must be created for employee photos. If theseparate from the Banner server, your system administrator photos server to the Banner server. Mount that share on thedirectory in the banner.picturesPath setting.

anner.defaultPhoto None This is the fully qualified file name of the default photo that isdo not have a photo.

Table 1: Employee photos (continued)


32B

anner Em


uide|

Install Banner E

mployee P

rofile

S

e Identification (PPAIDEN) page, e Dashboard, Profile (Employee

EN, the first name from PPAIDEN

t name by using the ibute in the file. By default, the value of this the attribute value to N.

ts the way the name is tion.

Table 2: Employee preferred first name


ss.display.preferredFirstName None If an employee's preferred first name exists on theby default, this name is displayed on the EmployeProfile), and My Team pages.

If the preferred first name does not exist on PPAIDis displayed on the Employee Profile pages.

You can configure the display of the preferred firsess.display.preferredFirstName attrBannerEmployeeProfileApp_configuration.groovyattribute is Y. To hide the preferred first name, set

Note: This configuration option only affecdisplayed in the Employee Profile applica

33B

anner Em


uide|

Install Banner E

mployee P

rofile

S

b playing on pay stubs. The value e logo files.

er/test/empr_logos'

gos are stored on a server must set up a share from the anner machine.

stem. The following image file

<file extension>

de.

Table 3: Employer logos


anner.hr.employerLogoPath None This is the directory where employer logos are stored for dismust be a fully qualified path to the directory that contains th

For example:

banner.hr.employerLogoPath = '/home/bann

A new directory must be created for employer logos. If the loseparate from the Banner server, your system administrator logos server to the Banner server. Mount that share on the B

Store a unique logo for each employer in your Banner HR syformats are supported: .png, .jpg, and .bmp.

Logo image filenames must have the following format:

hr_logo_<PTREMPR_CODE for the employer>.

Example: hr_logo_bu.png where bu is the employer co

34B

anner Em


uide|

Install Banner E

mployee P

rofile

S

b es that are used to generate the

ectory /WEB-INF/fop will be used. r location on the web server, enter be a fully qualified path to the

ome/employer_profile/

from the Banner server, your re from the FOP server to the Banner machine.

ore information about the folder tion.

Table 4: Pay stub PDF generation


anner.pdf.fopBaseUrl Null This is the base directory where resourcpay stub PDF files are located.

A null value indicates that the default dirIf you've moved the resources to anothethe new folder location. The value mustdirectory.

For example:

banner.pdf.fopBaseUrl = '/hfop'

If the new folder is on a server separatesystem administrator must set up a shaBanner server. Mount that share on the

See Customizing the pay stub PDF for mstructure used for pay stub PDF genera

35B

anner Em


uide|

Install Banner E

mployee P

rofile

S

b Employee Self Service 8.x. to be displayed in Banner 9.x.

ervice Banner 8.x application.

/'

o.org/cas) is required as an nts must be configured to

enticate using CAS.to enable Self-Service Banner component of Banner

s to Self-Service Banner 8.x,

m:7777/ssomanager/c/

anager URL ('http://er/c/SSB') and appends c Self-Service Banner 8.x page.

through the SSO Manager:

ger/c/

setting does not reference a displayed in the Banner 9.x

o Banner 8.x is not seamless. A d Self-Service Banner 8.x user Service Banner 8.x main menu

Table 5: Link to Banner Employee Self-Service 8.x


anner8.SS.url 'http://<host>:<port>/<banner8>/' This link directs Banner Employee Profile 9.x to BannerThis linking allows existing 8.x menus and breadcrumbs

Update this setting with the URL to your existing Self-SFor example:

banner8.SS.url = 'http://localhost:8002/ssb8x

Jasig Central Authentication Service (CAS) (www.apereexternal authentication provider. The following componeauthenticate using CAS:

• The Banner 9.x application must be configured to auth• The SSO Manager must be deployed and configured

8.x authentication using CAS. The SSO Manager is aEnterprise Identity Services (BEIS).

To allow linking from Banner 9.x self-service applicationadd the following setting:

banner8.SS.url='http://beissmpl.university.coSSB?pkg='

The banner8.SS.url setting references the SSO Mbeissmpl.university.com:7777/ssomanagthe ‘?pkg=’ suffix to support deep linking to a specifi

The following is an example of a Banner 8.x SSO URL

http://beissmpl.greatvalleyu.com:7777/ssomanaSSB?pgk=bwgkogad.P_SelectAtypView

Note: For SPRIDEN users, if the banner8.SS.url valid URL, Banner 8.x menus and breadcrumbs are notself-service application.

Note: Without CAS and the SSO Manager, navigation tuser must log in to Self-Service Banner 8.x using a valiname and password. Navigation terminates at the Self-page.

www.apereo.org/cas

36B

anner Em


uide|

Install Banner E

mployee P

rofile

S

b d Phones - Select Address urrent and future addresses, information.

b ether the edit address button is e Profile. Valid values are Y and

b ss page displays the user’s rouped by email type.

b hether the edit email address Employee Profile. Valid values

b ontacts page displays ation in ascending priority order.

b hether the edit emergency on the Employee Profile. Valid

Table 6: Buttons on the Employee Profile


anner8.SS.addressUpdateURL bwgkogad.P_SelectAtypUpdate The Update Addresses anpage displays the user’s cplus the associated phone

anner8.SS.addressUpdate Y This setting determines whdisplayed on the EmployeN.

anner8.SS.emailUpdateURL bwgkogad.P_SelectEmalUpdate The Update E-Mail Addreactive email addresses, g

anner8.SS.emailUpdate Y This setting determines wbutton is displayed on theare Y and N.

anner8.SS.emergencyContactUpdateURL bwgkoemr.P_SelectEmrgContacts The Update Emergency Cemergency contact inform

anner8.SS.emergencyContactUpdate Y This setting determines wcontact button is displayedvalues are Y and N.

37B

anner Em


uide|

Install Banner E

mployee P

rofile

S

b ent menu holds the benefits s.

b es whether the benefits played. Valid values are Y and

b d Dependents page is used to iciaries and dependents.

b es whether the beneficiaries is displayed. Valid values are Y

b y page merges all related into a single page that can be

ultaneously accessed by fits administrators in Banner ce.

b es whether the current benefits layed. Valid values are Y and N.

Table 7: Benefits links on the Employee Dashboard


anner8.SS.benefitsEnrollmentURL bwpkdsta.P_ShowEnrollmentMenu The Benefits Enrollmenrollment menu item

anner8.SS.benefitsEnrollment8xLinkAvailable Y This setting determinenrollment link is disN.

anner8.SS.currentBeneficiariesURL bwpkdbcv.P_NamesAndBenefits The Beneficiaries anupdate current benef

anner8.SS.currentBeneficiaries8xLinkAvailable Y This setting determinand dependents link and N.

anner8.SS.currentSummaryURL bwpkebst.P_DispIDSelect The Benefit Summarbenefits information synchronized and simemployees and beneEmployee Self-Servi

anner8.SS.currentSummary8xLinkAvailable Y This setting determinsummary link is disp

38B

anner Em


uide|

Install Banner E

mployee P

rofile

S

b tion page is used to select the d for entering time sheet

bA

s whether the link for time d. Valid values are Y and N. If ot use time entry in Banner e, this entry should be set to N.

b election page is used to select eriod for requesting leave.

bL

s whether the link for time off Valid values are Y and N. If ot use leave requests in Banner e, this entry should be set to N.

bA

nel Action Form menu is used personnel action forms.

bA

s whether the link for electronic s is displayed.

ed for users who have the eb Tailor role.

layed. If your institution does sonnel action forms in Banner e, this entry should be set to N.

bC

ation Administration menu is date compensation packages ime faculty members based on ments, and based on rules Banner Student and Banner

Table 8: My Activities links on the Employee Dashboard


anner8.SS.enterTimeURL bwpktais.P_SelectTimeSheetRoll The Time Sheet Selecposition and pay perioinformation.

anner8.SS.enterTime8xLinkvailable

Y This setting determinesheet entry is displayeyour institution does nEmployee Self-Servic

anner8.SS.requestTimeOffURL bwpktais.P_SelectLeaveRequestRoll The Leave Request Sthe position and pay p

anner8.SS.requestTimeOff8xinkAvailable

Y This setting determinerequests is displayed.your institution does nEmployee Self-Servic

anner8.SS.electronicPersonalctionFormsURL

bwpkepaf.P_DispEpafMenu The Electronic Personto process electronic

anner8.SS.electronicPersonalctionForms8xLinkAvailable

Y This setting determinepersonnel action form

Y - The link is displayappropriate Banner W

N - The link is not dispnot use electronic perEmployee Self-Servic

anner8.SS.facultyLoadompensationURL

twbkwbis.P_GenMenu?name=pmenu.P_FacMenu The Faculty Compensused to create and upfor full-time and part-ttheir individual assigndefined and set up in Human Resources.

39B

anner Em


uide|

Install Banner E

mployee P

rofile

bC

s whether the link for faculty n is displayed.

ed for users who have the eb Tailor role or are identified

layed. If your institution does and Compensation in Banner e, this entry should be set to N.

b enu allows authorized nel such as HR managers and evaluate, plan, and create year.

bA

s whether the link for salary


layed. If your institution does r in Banner Employee Self-uld be set to N.

b page is used for effort rally mandated process that n to certify that the salary projects is reasonable for the ose projects.

bL

s whether the link for effort ed. Valid values are Y and N. If ot use effort reporting in Banner e, this entry should be set to N.

S

anner8.SS.facultyLoadompensation8xLinkAvailable

Y This setting determineload and compensatio

Y - The link is displayappropriate Banner Was faculty members.

N - The link is not dispnot use Faculty Load Employee Self-Servic

anner8.SS.salaryPlannerURL twbkwbis.P_GenMenu?name=pmenu.P_SalaMenu The Salary Planner madministrative persondepartment heads to budgets for any fiscal

anner8.SS.salaryPlanner8xLinkvailable

Y This setting determineplanner is displayed.


N - The link is not dispnot use salary planneService, this entry sho

anner8.SS.effortReportingURL bwpkolib.p_launch_flex The Effort Certificationreporting, a U.S. federequires your institutiocharged to sponsoredeffort expended on th

anner8.SS.effortReporting8xinkAvailable

Y This setting determinecertification is displayyour institution does nEmployee Self-Servic

Table 8: My Activities links on the Employee Dashboard (continued)


40B

anner Em


uide|

Install Banner E

mployee P

rofile

bU

n page is used to redistribute FOAPAL elements in a

b8

s whether the link for labor yed. Valid values are Y and N. If ot use labor redistribution in

lf-Service, this entry should be

bA

y Stub Employee Selection and search on employee cting the employee, year, and or pay stub review.

bA

s whether the link for pay stub


layed.

bA

age is used by the benefit he benefits and deductions that loyees in an organization.

ed by employee, or filtered for a

bA

s whether the link for filter .


layed.

S

anner8.SS.laborRedistributionRL

bwpkolib.p_launch_flex The Effort Certificatiolabor costs charged toprevious pay period.

anner8.SS.laborRedistributionxLinkAvailable

Y This setting determineredistribution is displayour institution does nBanner Employee Seset to N.

anner8.SS.paystubdministratorURL

bwpkhstb.P_ChoosePayStubEmpAdmin The Administrative Papage is used to enter information when selepay stub information f

anner8.SS.paystubdministrator8xLinkAvailable

Y This setting determinereview is displayed.


N - The link is not disp

anner8.SS.benefitsdministratorURL

bwpkdsta.P_DisplayFilterMain The Filter Selection padministrator to view tare confirmed by empInformation is displaysingle employee.

anner8.SS.benefitsdministrator8xLinkAvailable

Y This setting determineselection is displayed


N - The link is not disp



41B

anner Em


uide|

Install Banner E

mployee P

rofile

bU

tion menu is used to maintain manage passwords, manage d answer surveys.

bU

s whether the link for personal d. Valid values are Y and N.

S

b tory Consent page is used to ent to receive W-2 Wage and 95-C Employer-Provided and Coverage page online yee Self-Service.

b whether the link for confirming tements is displayed. Valid your institution does not use in Banner Employee Self-uld be set to N.

b Provided Health Insurance ge allows U.S. employees to C statements for a specific

b s whether the link for accessing atements is displayed. Valid your institution does not use r Employee Self-Service, this

N.

S

anner8.SS.morePersonalInfopdateURL

twbkwbis.P_GenMenu?name=bmenu.P_GenMnu The Personal Informapersonal information, security questions, an

anner8.SS.morePersonalInfopdate

Y This setting determineinformation is displaye

Table 9: Tax links on the Employee Dashboard


anner8.SS.electronicW2ConsentURL bwpkxtxs.P_W2Consent The Electronic Regulaconfirm or revoke consTax Statements and 10Health Insurance Offerthrough Banner Emplo

anner8.SS.electronicW2Consent8xLinkAvailable Y This setting determinesonline year-end tax stavalues are Y and N. If U.S. W-2s or 1095-Cs Service, this entry sho

anner8.SS.yearEnd1095CStatementURL bwpkxtxs.P_Choose1095cKey The 1095-C Employer-Offer and Coverage paaccess and print 1095-year.

anner8.SS.yearEnd1095CStatementLinkAvailable Y This setting determineand printing 1095-C stvalues are Y and N. If U.S. 1095-Cs in Banneentry should be set to



42B

anner Em


uide|

Install Banner E

mployee P

rofile

b x Statement page allows U.S. nd print W-2 statements for a

b s whether the link for accessing ents is displayed. Valid values

titution does not use U.S. W-2s elf-Service, this entry should be

b age and Tax Statement page to view W-2c statements for a

bL

s whether the link for accessing ments is displayed. Valid

your institution does not use mployee Self-Service, this entry

bC

ithholding Allowance ys the W-4 information for U.S. ’s date.

bC

s whether the link for displaying layed. Valid values are Y and

es not use U.S. W-4s in Banner , this entry should be set to N.

S

anner8.SS.w2WageTaxStatementURL bwpkxtxs.P_ChooseW2Key The W-2 Wage and Taemployees to access aspecific year.

anner8.SS.w2WageTaxStatement8xLinkAvailable Y This setting determineand printing W-2 statemare Y and N. If your insin Banner Employee Sset to N.

anner8.SS.w2CorrectedWageTaxStatementURL bwpkxtxs.P_ChooseW2cKey The W-2c Corrected Wallows U.S. employeesspecific year.

anner8.SS.w2CorrectedWageTaxStatement8xinkAvailable

Y This setting determineand printing W-2c statevalues are Y and N. If U.S. W-2s in Banner Eshould be set to N.

anner8.SS.w4EmployeeWithholdingAllowanceertificateURL

bwpkxtxs.P_ViewW4 The W-4 Employee’s WCertificate page displaemployees as of today

anner8.SS.w4EmployeeWithholdingAllowanceertificate8xLinkAvailable

Y This setting determineW-4 information is dispN. If your institution doEmployee Self-Service

Table 9: Tax links on the Employee Dashboard (continued)


43B

anner Em


uide|

Install Banner E

mployee P

rofile

S

b turn page displays the tax slip ge is accessed through the Tax

b ther the link for displaying tax es are Y and N. If your adian tax slips in Banner entry should be set to N.

b e allows Canadian employees t to receive their Canadian tax Banner Employee Self-Service. 4A, T4ANR, NR4, and TD1.

bL

ther the link for accessing and displayed. Valid values are Y s not use Canadian consent Self-Service, this entry should

bD

its/TP-10153 Source Quebec residents only.

bD

ther the link for accessing and ax Credits/TP-10153 Source d. Valid values are Y and N. If Canadian TD1 Personal Tax eductions in Banner Employee ld be set to N.

Table 10: Canadian tax links on the Employee Dashboard


anner8.SS.taxReturnURL bwvkxtax.P_SelectAdminOption The Slips for Income Tax Refor the selected year. This paForms menu.

anner8.SS.taxReturn8xLinkAvailable Y This setting determines wheslips is displayed. Valid valuinstitution does not use CanEmployee Self-Service, this

anner8.SS.electronicTaxFormsConsentURL bwvkecns.P_TaxFormsConsent The Tax Forms Consent pagto confirm or revoke consenforms electronically throughThe tax forms include T4, T

anner8.SS.electronicTaxFormsConsent8xinkAvailable

Y This setting determines wheprinting the consent page isand N. If your institution doepages in Banner Employee be set to N.

anner8.SS.personalTaxCreditsSourceeductionsURL

bwvktd1a.P_TD1MainPage The TD1 Personal Tax CredDeductions page applies to

anner8.SS.personalTaxCreditsSourceeductions8xLinkAvailable

Y This setting determines wheprinting the TD1 Personal TDeductions page is displayeyour institution does not useCredits/TP-10153 Source DSelf-Service, this entry shou

44B

anner Em


uide|

Install Banner E

mployee P

rofile

S

b ation page shows the actual ee’s pay check under the Pay > section. This page shows any ed with an employee’s record Distribution section.

bA

whether the link for displaying n is displayed. Valid values are n does not use direct deposits f-Service, this entry should be

b whether the link to the Direct ailable. Valid values are Y and not use the Direct Deposit

ould be set to N.

b llows users to access the Direct

b page shows deduction history date range.

bA

whether the link for displaying ation is displayed. Valid values tution does not use deductions Banner Human Resources,

to N.

Table 11: Pay information links on the Employee Dashboard


anner8.SS.directDepositAllocationURL bwpkhpay.P_ViewDirectDeposit The Direct Deposit Allocdistribution of an employDistribution As Of <datefuture changes associatunder the Proposed Pay

anner8.SS.directDepositAllocation8xLinkvailable

Y This setting determines direct deposit informatioY and N. If your institutioin Banner Employee Selset to N.

anner.SS.directDepositAppLinkAvailable N This setting determines Deposit application is avN. If your institution doesapplication, this entry sh

anner.SS.directDepositURL The Direct Deposit link aDeposit application.

anner8.SS.deductionsHistoryURL bwpkhded.P_ChooseDedn The Deductions History information for a specific

anner8.SS.deductionsHistory8xLinkvailable

Y This setting determines deduction history informare Y and N. If your instior does not run payroll inthis entry should be set

45B

anner Em


uide|

Install Banner E

mployee P

rofile

S

b benefit administrator to view that were confirmed by etails are filtered by last name, ID.

bA

whether the link for viewing is displayed.

for users who have the ole.

yed.

b menu is used to process open

bA

whether the link for the benefits or new hire enrollments.

, based on the new hire BCAT.

yed.

b ge displays current benefit ses.

b whether the link for accessing s is displayed.

, based on the open enrollment

yed.

b menu is used to process open

Table 12: Open enrollment links


anner8.SS.openEnrollmentAdminURL bwpkduti.f_disp_BENADMIN_link This page is used by thebenefits and deductionsemployees. Employee dfirst name, or employee

anner8.SS.openEnrollmentAdmin8xLinkvailable

Y This setting determines benefits and deductions

Y - The link is displayedappropriate PTRUSER r

N - The link is not displa

anner8.SS.openEnrollmentNewHireURL bwpkdsta.P_ShowEnrollmentMenu The Benefits Enrollmentenrollments.

anner8.SS.openEnrollmentNewHire8xLinkvailable

Y This setting determines enrollment is displayed f

Y - The link is displayedenrollment rules on PTR


anner8.SS.openEnrollmentURL bwpkdcmn.P_OpenEnrollment The Open Enrollment paselections and their statu

anner8.SS.openEnrollment8xLinkAvailable Y This setting determines current benefit selection

Y - The link is displayedrules on PTRBCAT.


anner8.SS.lifeEventChangeURL bwpkdsta.P_ShowEnrollmentMenu The Benefits Enrollmentenrollments.

46B

anner Em


uide|

Install Banner E

mployee P

rofile

b whether the link for the benefits or event changes.

if the period is outside open nrollment.

yed.

S

anner8.SS.lifeEventChange8xLinkAvailable Y This setting determines enrollment is displayed f

Y - The link is displayedenrollment or new hire e


Table 12: Open enrollment links (continued)


47B

anner Em


uide|

Install Banner E

mployee P

rofile

S

b s and approvers to look at time

bA

whether the link for displaying ed. Valid values are Y and N. If use time entry in Banner this entry should be set to N.

b tion page lists the positions for ccess leave reports.

bA

hether the link for leave reports are Y and N. If your institution

rts in Banner Employee Self-d be set to N.

Table 13: Time approval and Leave Reporting links on the My Activities page


anner8.SS.timeSheetURL bwpktais.P_SelectTimeSheetRoll This will allow employeesheets.

anner8.SS.timeSheet8xLinkvailable

Y This setting determines the time sheet is displayyour institution does not Employee Self-Service,

anner8.SS.leaveApprovalsURL bwpktais.P_SelectLeaveReportRoll This Leave Report Selecwhich you can enter or a

anner8.SS.leaveApprovals8xLinkvailable

Y This setting determines wis displayed. Valid valuesdoes not use leave repoService, this entry shoul

48B

anner Em


uide|

Install Banner E

mployee P

rofile

S

b displays contact information, phone number, about other n.

bA

ther the link for displaying yed. Valid values are Y and N. se the campus directory in ice, this entry should be set to

S

bU

elf-Service menu is used to e Self-Service pages.

bL

ther the link for the Banner 8.x n menu is displayed. Valid institution does not use the ice main menu, this entry

bD

k allows users with the access the Position Description

bD

ther the link to the Position ailable. Valid values are Y and t use the Position Description

d be set to N

Table 14: Campus directory links on the My Activities page


anner8.SS.campusDirectoryURL bwpkedir.P_DisplayDirectory The Campus Directory pagesuch as email address and employees in your institutio

anner8.SS.campusDirectory8xLinkvailable

Y This setting determines whecontact information is displaIf your institution does not uBanner Employee Self-ServN.

Table 15: Banner 8.x link on the My Activities page


anner8.SS.employeeMenuRL

twbkwbis.P_GenMenu?name=pmenu.P_MainMnu The Banner 8.x Employee Saccess Banner 8.x Employe

anner8.SS.employeeMenuinkAvailable

Y This setting determines wheEmployee Self-Service maivalues are Y and N. If your Banner Employee Self-Servshould be set to N.

anner.SS.positionescriptionURL

The Position Description linappropriate permissions to application.

anner.SS.positionescriptionLinkAvailable

Y This setting determines wheDescription application is avN. If your institution does noapplication, this entry shoul

49B

anner Em


uide|

Install Banner E

mployee P

rofile

S

b ID Entry page allows the nually enter the receipt ID and

or the transmission of U.S. y those users who have been x Administrator in the Web o access the link.

b ines whether the link for eipt Entry ID page is displayed. and N. If your institution does -Cs in Banner Employee Self-should be set to N.

Table 16: 1094 Receipt ID Entry link on the My Activities page


anner8.SS.yearEnd1094ReceiptIDEntryURL bwpkxtxs.P_Disp1094ReceiptIDs The 1094 Receipt administrator to maupdate the status f1095-C forms. Onldesignated as a TaTailor will be able t

anner8.SS.yearEnd1094ReceiptIDEntryLinkAvailable Y This setting determentering 1094 RecValid values are Y not use U.S. 1095Service, this entry

50B

anner Em


uide|

Install Banner E

mployee P

rofile

S

e ployee status from the d. Valid values are Y and N.

e ployee’s home organization displayed. Valid values are Y

e ployee’s check distribution MPL) form is displayed. Valid

e ployee classification from the d. Valid values are Y and N.

e ployee’s full time or part time L) form is displayed. Valid

e ployee’s original hire date from layed. Valid values are Y and N.

e ployee’s current hire date from layed. Valid values are Y and N.

e ployee’s adjusted hire date displayed. Valid values are Y

e ployee’s seniority date from the d. Valid values are Y and N.

e ployee’s first work date from layed. Valid values are Y and N.

e ployee’s hiring job location from layed. Valid values are Y and N.

Table 17: Banner display options


ss.displayComponent.EmployeeStatus Y This setting determines whether the emEmployee (PEAEMPL) form is displaye

ss.displayComponent.HomeOrganization Y This setting determines whether the emfrom the Employee (PEAEMPL) form isand N.

ss.displayComponent.DistOrganization Y This setting determines whether the emorganization from the Employee (PEAEvalues are Y and N.

ss.displayComponent.Ecls Y This setting determines whether the emEmployee (PEAEMPL) form is displaye

ss.displayComponent.PartTimeFullTimeIndicator Y This setting determines whether the emindicator from the Employee (PEAEMPvalues are Y and N.

ss.displayComponent.OriginalHire Y This setting determines whether the emthe Employee (PEAEMPL) form is disp

ss.displayComponent.CurrentHire Y This setting determines whether the emthe Employee (PEAEMPL) form is disp

ss.displayComponent.AdjustedHire Y This setting determines whether the emfrom the Employee (PEAEMPL) form isand N.

ss.displayComponent.Seniority Y This setting determines whether the emEmployee (PEAEMPL) form is displaye

ss.displayComponent.FirstWorkDay Y This setting determines whether the emthe Employee (PEAEMPL) form is disp

ss.displayComponent.JobLocation Y This setting determines whether the emthe Employee (PEAEMPL) form is disp

51B

anner Em


uide|

Install Banner E

mployee P

rofile

e ployee’s hiring college from the d. Valid values are Y and N.

e ployee’s hiring campus from layed. Valid values are Y and N.

e ployee’s district or division from layed. Valid values are Y and N.

e ployee’s job from the Job lues are Y and N.

e me of the employee’s m is displayed. Valid values are

e ployee’s job’s time sheet form is displayed. Valid values

e ployee’s year-to-date earnings d N.

e nefits section is displayed on are Y and N. If your institution anner, this entry should be set

he current benefits summary, a button for enrollment. The les that govern open

ollment.

e ployee’s beneficiary/dependent N.

ated in Banner, the initial "self"

S

ss.displayComponent.College Y This setting determines whether the emEmployee (PEAEMPL) form is displaye

ss.displayComponent.Campus Y This setting determines whether the emthe Employee (PEAEMPL) form is disp

ss.displayComponent.DistrictOrDivision Y This setting determines whether the emthe Employee (PEAEMPL) form is disp

ss.displayComponent.PositionSuffix Y This setting determines whether the em(NBAJOBS) form is displayed. Valid va

ss.displayComponent.Supervisor Y This setting determines whether the nasupervisor from the Job (NBAJOBS) forY and N.

ss.displayComponent.TimeSheetOrgn Y This setting determines whether the emorganization from the Job (NBAJOBS) are Y and N.

ss.displayComponent.YtdEarnings Y This setting determines whether the emtotal is displayed. Valid values are Y an

ss.displayComponent.BenefitsSection Y This setting determines whether the Bethe Employee Dashboard. Valid valuesdoes not store benefits information in Bto N.

The Benefits section displays a link to tlink to beneficiaries/dependents, and aenrollment button is controlled by the ruenrollment, life event, and new hire enr

ss.displayComponent.BeneficiaryLink Y This setting determines whether the emlink is displayed. Valid values are Y and

Note: When an Employee record is crebeneficiary record is created.

Table 17: Banner display options (continued)


52B

anner Em


uide|

Install Banner E

mployee P

rofile

e x Information section is if your institution does not use (Canada) deduction types. tion does not store tax be set to N.

e nter friendly button is displayed es are Y and N. The value N rsions of their pay stubs.

e y Information section is . Valid values are Y and N. If Banner, this entry should be set

e rnings section is displayed on are Y and N. If your institution try should be set to N.

e ployee Summary section is . Valid values are Y and N. If his information to employees,

S

e ployee’s hire date is displayed.

e ployee’s birth month and day .

S

ss.displayComponent.TaxSection Y This setting determines whether the Tadisplayed on the Employee Dashboard01 (U.S. federal), 04 (U.S. state), or 50Valid values are Y and N. If your instituinformation in Banner, this entry should

ss.displayComponent.PayStubPdf Y This setting determines whether the prion the Pay Stub Detail page. Valid valuprevents users from accessing PDF ve

ss.displayComponent.PaySection Y This setting determines whether the Padisplayed on the Employee Dashboardyour institution does not run payrolls in to N.

ss.displayComponent.EarningsSection Y This setting determines whether the Eathe Employee Dashboard. Valid valuesdoes not run payrolls in Banner, this en

ss.displayComponent.EmployeeSummarySection Y This setting determines whether the Emdisplayed on the Employee Dashboardyour institution does not wish to show tthis entry should be set to N.

Table 18: Banner display Profile


ss.displayComponent.HireDate Y This setting determines whether the emValid values are Y and N.

ss.displayComponent.BirthDate Y This setting determines whether the emare displayed. Valid values are Y and N

Note: The year is never displayed.

Table 17: Banner display options (continued)


Ba

Regenerate the WAR file

Once the shared and application-specific configurations are complete, the application WAR file can be regenerated to include your customizations. The systool is used to create the WAR file.

To set up the systool and to create the WAR file, perform the following steps:

1. Change your current working directory to the product home directory:

BannerEmployeeProfileApp/current/installer

2. Run the ant command. This will build the systool module.

Note: For Unix, make sure the ant file is executable. For example, chmod +x ant.

Example:

$ cd BannerEmployeeProfileApp/current/installerBannerEmployeeProfileApp/current/installer $ ./ant

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

Your current working directory must be in the BannerEmployeeProfileApp/current/installer directory before you execute the following command.

On Unix:$ bin/systool war

On Windows:> bin\systool war

The WAR file is created in the BannerEmployeeProfileApp/current/dist directory.

You can use external configuration files by setting appropriate system properties, although the configuration files are included in the WAR file, making the WAR file self-sufficient. For information on external configuration, see “Tomcat” on page 54 or “WebLogic” on page 60.


Ba

Configure and deploy the WAR file to a web application server

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

• “Tomcat” on page 54

• “WebLogic” on page 60

Tomcat

The following sections provide information on configuring the web application and deploying the WAR file to the Tomcat server.

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

Note: Tomcat version 7 is required. To download and install the Tomcat 7 server, see http://tomcat.apache.org.

Configure the Tomcat server

Use the following procedure to configure the Tomcat server:

1. Locate the Oracle JDBC jar files (ojdb6.jar and xdb6.jar) in the BannerEmployeeProfileApp\current\lib directory.

Note: Later in the Tomcat configuration process, you will copy the Oracle JDBC jar file into the \lib folder under the Tomcat installation directory.

The account that runs the Tomcat application server must configure environment settings to support the application.

2. On Linux, ensure CATALINA_HOME is defined to reference your Tomcat software installation location. For example, CATALINA_HOME=/opt/apache-tomcat-7.0.xx where xx indicates the point version of Tomcat you installed.

Warning! Do not perform this step on the Windows platform.

3. Define CATALINA_OPTS to configure JVM settings. The following settings are recommended:

CATALINA_OPTS=-server -Xms2048m -Xmx4g -XX:MaxPermSize=512m


http://tomcat.apache.org

Ba

Note: If you are deploying multiple Banner 9.x applications to the same Tomcat server, increase the max heap (-Xmx) by 2g and -XX:MaxPermSize by 128m. You should deploy Banner 9.x administrative applications to one Tomcat server instance and Banner 9.x self-service applications to a separate Tomcat server instance.

You can define this variable 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, specify the JVM arguments as follows:

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

4.2. Select the Java tab.

4.3. In the Java Options field, add the following:

-XX:MaxPermSize=384m

4.4. Set the initial memory pool = 2048.

4.5. Set the maximum memory pool = 4096.

4.6. Save the settings.

4.7. Restart the Tomcat Windows service.

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

6. Define the JNDI datasource resource name for the application as follows:

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

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

For example, change the following:





to:



<Manager pathname="" />


Ba

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"/>

6.4. Save your changes in context.xml.

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

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

For Tomcat 8

<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" maxTotal="100" maxIdle="-1"

maxWaitMillis="30000"

validationQuery="select 1 from dual"

accessToUnderlyingConnectionAllowed="true"

testOnBorrow="true"/>

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




username="ban_ss_user" password="ban_ss_user_pasword"

initialSize="5" maxTotal="100" maxIdle="-1"

maxWaitMillis="30000"


accessToUnderlyingConnectionAllowed="true"


For Tomcat 7

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




username="banproxy" password="the_banproxy_password"

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

maxWait="30000"



Ba


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




username="ban_ss_user" password="ban_ss_user_pasword"

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

maxWait="30000"



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 is jdbc:oracle:thin:@//myserver.university.edu:1521/SEED.

6.7. Save your changes in server.xml.

6.8. Copy the Oracle JDBC jar file (ojdbc6.jar) from the BannerEmployeeProfileApp/current/lib directory to the $CATALINA_HOME/lib directory.

6.9. Copy the Oracle XDB jar file (xdb6.jar) from the BannerEmployeeProfileApp/current/lib directory to the $CATALINA_HOME/lib directory.

Note: This step is not required for Tomcat 8.

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

– Run $CATALINA_HOME/bin/startup

For Linux:cd $CATALINA_HOME$ bin/startup.sh

For Windows:cd %CATALINA_HOME%> bin\startup.bat

– Browse http://servername:<port>.

To override the configuration that was added into the WAR file, you must 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.groovy -DBANNER_EMPLOYEE_PROFILE_SSB_APP=/PRODUCT_HOME/BannerEmployeeProfileApp/current/instance/config/BannerEmployeeProfileApp_configuration.groovy"


Ba

Configure Java Management Extensions

This optional step is needed only if you want 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 you to remotely monitor and debug the application server.

To enable Java Management Extensions, perform the following steps:

1. Add the following options to the catalina.sh or catalina.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 the machine where Tomcat is installed. For example:

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

or

-Djava.rmi.server.hostname=149.24.3.178

3. JMX does not define a default port number to use. If necessary, change com.sun.management.jmxremote.port=8999.

Note: You should connect remotely to the Tomcat server using JMX.

Warning! Ensure that the jmxremote.authenticate parameter is not set to false in a production environment. If it is set to false, it does not require connections to be authenticated and will create a security threat in a production environment. For more information on Tomcat Remote JMX documentation, see http://tomcat.apache.org/tomcat-6.0-doc/monitoring.html#Enabling_JMX_Remote.

Deploy the WAR file to the 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. You should deploy 9.x administrative applications and 9.x self-service applications to separate Tomcat servers to increase performance.

Note: 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 application.


http://tomcat.apache.org/tomcat-6.0-doc/monitoring.html#Enabling_JMX_Remote

http://tomcat.apache.org/tomcat-6.0-doc/monitoring.html#Enabling_JMX_Remote

Ba

The target supports deploying the dist/WAR file using the Tomcat Manager web application. Because environments vary significantly with respect to user privileges, clustering approach, web container version, operating system, and more, the target may or may not be suitable for your use.

Note: You can also deploy the WAR file to the Tomcat server by copying the WAR file to the Tomcat webapps/ directory.

To use the target, you must provide the following information:

Username/password combinations are configured in your Tomcat user database <TOMCAT_HOME>\conf\tomcat-users.xml. For Tomcat 7.x, you must configure at least one username/password combination with the manager role. For example:

<user username="tomcat" password="tomcat" (your password) roles="manager-gui, manager"/>

To deploy the WAR file to the Tomcat server, perform the following steps:

1. Navigate to the BannerEmployeeProfileApp\current\installer directory.

2. Enter one of the following commands:

On Unix:$ bin/systool deploy-tomcat

On Windows:> bin\systool deploy-tomcat

3. Enter the following URL for the Tomcat Manager:

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

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

4. Enter a valid Tomcat username to deploy the WAR file. For example:

[]: tomcat

Note: This user must have the manager-gui role.

5. Enter the Tomcat password for the user.

URL This is the URL of the manager application in the Tomcat server. For example:

http://localhost:8080/manager

Username This Tomcat server username must have privileges to deploy WAR files.

Password This is the password of the Tomcat server user.


Ba

[]: password

Note: This password will not be persisted.

6. Access the web application.

http://servername:<port>/BannerEmployeeProfileApp

WebLogic

The following sections provide information on configuring the web application and deploying the WAR file to the WebLogic server:

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

Verify WebLogic prerequisites

Before configuring your WebLogic server, ensure that the following prerequisites are met:

• WebLogic must be installed. If it is not, download and install WebLogic from the Oracle web site.

• The minimum requirements are OFM 11.1.14 using WebLogic 10.3.4.


Ba

• Both the WebLogic node manager and the administration server must be started. The administration server can be accessed using the following URL:


Create a WebLogic machine

Note: If you previously created a WebLogic machine definition, you can skip this section.

To create a WebLogic machine, perform the following steps:

1. In the Change Center frame, click Lock & Edit.

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

3. Click the Machines link.

4. Click New.

5. Enter a machine name and click Next.

6. Accept the defaults and click Finish.


Create a WebLogic server

Note: If you previously created a WebLogic server, you can skip this section.

Note: If you previously created a WebLogic server for the application, you can use the same server.

To create a WebLogic server, perform the following steps:


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

3. Click the Servers link.

4. Click New.

5. Enter a server name and server listen port. For example, you can have server name as Banner9-SS and server listen port as 8180.

6. Click Finish.

7. Click the newly created server link.

8. Under the General tab, assign the machine to this server.

9. Click Save.


Ba

10. Select the Server Start tab.

11. Add the following to the Arguments text area:

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

-server -Xms2048m -Xmx4g -XX:MaxPermSize=512m

Note: If you are deploying multiple Banner 9.x applications to the same WebLogic server, increase the max heap (-Xmx) by 2g and -XX:MaxPermSize by 128m. You should deploy Banner 9.x administrative applications to one WebLogic server instance and Banner 9.x self-service applications to a separate WebLogic server instance.

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

-Xms2048m -Xmx4g

Note: For JRockit, increase the max heap -Xmx by 2G for each Banner 9.x application that is deployed.

To override the configuration that was added into the WAR file, you can set system properties to point to external configuration files. Append the following to the arguments text area:

-DBANNER_APP_CONFIG=<full file path to banner_configuration.groovy> -DBANNER_EMPLOYEE_PROFILE_SSB_APP=<full file path to BannerEmployeeProfileApp_configuration.groovy>

12. Click Save.


14. In the Domain Structure frame, click the Servers link.

15. Select the Control tab.

16. Select the check box next to your new server definition.

17. Click Start.

Update Oracle JDBC JAR files on the WebLogic server

1. Copy the Oracle JAR files (ojdbc6.jar and xdb6.jar) from the $PRODUCT_HOME/current/lib directory to the $MIDDLEWARE_HOME/modules directory.

$PRODUCT_HOME is where the Employee Profile release zip file is unpacked and installed.

$MIDDLEWARE_HOME is the location where Oracle WebLogic is installed.

2. For Linux/Unix servers, edit the setDomainEnv.sh file under the $MIDDLEWARE_HOME/user_projects/domains/<CUSTOM_DOMAIN>/bin folder and add these two lines after the ADD EXTENSIONS comment as shown by the example below:


Ba

#ADD EXTENSIONS TO CLASSPATH

export MIDDLEWARE_HOME="/u01/app/oracle/Middleware"

export WLS_MODULES="${MIDDLEWARE_HOME}/modules"

export EXT_PRE_CLASSPATH="${WLS_MODULES}/

xdb6.jar:${WLS_MODULES}/ojdbc6.jar"

Note: If you plan to copy and paste the configuration settings into the setDomainEnv.sh file, ensure that no typos or special characters are carried over (especially with double quotes on the variable declarations). If you see Class NotFoundException in your logs, chances are there was a typo when you edited the setDomainEnv.sh file and the xdb6.jar or ojdbc.jar file cannot be found during application startup.

3. For MS Windows servers, edit the setDomainEnv.cmd under the $MIDDLEWARE_HOME/user_projects/domains/<CUSTOM_DOMAIN>/bin folder and add these two lines after the ADD EXTENSIONS comment as shown by the example below:

@REM ADD EXTENSIONS TO CLASSPATH

set MIDDLEWARE_HOME="D:\Oracle\Middleware"

set WLS_MODULES="%MIDDLEWARE_HOME%\modules"

set EXT_PRE_CLASSPATH="%WLS_MODULES%\xdb6.jar;%WLS_MODULES%\ojdbc

6.jar"

Note: If you plan to copy and paste the configuration settings into the setDomainEnv.cmd file, ensure that no typos or special characters are carried over (especially with double quotes on the variable declarations). If you see Class NotFoundException in your logs, chances are there was a typo when you edited the setDomainEnv.cmd file and the xdb6.jar or ojdbc.jar file cannot be found during application startup.

4. Restart the WebLogic Managed Server.

Create an administrative datasource and connection pool

Note: If you previously created an administrative datasource, you can skip this section.

To create an administrative datasource and connection pool, perform the following steps:


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

6. Specify the JNDI name (for example, jdbc/bannerDataSource).


Ba

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.

10. Enter the database name, host name, port, user name, password, and password confirmation, and then click Next. For example:

11. Click Test Configuration.

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

13. Select the server that you previously created to allow the 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.


Create a self-service datasource and connection pool

Note: If you previously created a self-service datasource, you can skip this section.

To create a self-service datasource and connection pool, perform the following steps:

Database name: BAN9

Host name: yourhostname.yourdomain.com

Port: 1521

UserName: banproxy

Password: your_password


Ba


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, Banner9SsbDS).

6. Specify the JNDI name (for example, 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.

10. Enter the database name, host name, port, user name, password, and password confirmation, and then click Next. For example:

11. Click Test Configuration.

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

13. Select the server that you previously created to allow the 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 = LRU.

18. Change Statement Cache Size = 20.

19. Click Save.


Database name: BAN9

Host name: yourhostname.yourdomain.com

Port: 1521

UserName: ban_ss_user

Password: your_password


Ba

Configure server communication

When using different servers for administrative and self-service applications, perform the following steps:


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

3. Select the datasource for the administrative application (for example, Banner9DS).

4. Select the Targets tab.

5. Select the check box for the self-service server (for example, Banner9-SS).

6. Click Save.


Deploy and start the application in the WebLogic server

To deploy and start the web application in the WebLogic server, perform the following steps:

1. Change the name of the WAR file to remove the version number. For example, change:

BannerEmployeeProfileApp/current/dist/BannerEmployeeProfileApp-9.1.war

to

BannerEmployeeProfileApp/current/dist/BannerEmployeeProfileApp.war

2. Access the administration server at the following URL:


3. In the Domain Structure frame, select the Deployments link.

4. In the Change Center frame, select Lock and Edit.

5. Click Install.


Ba

6. Select the WAR file to be deployed. It is located in the following directory:

BannerEmployeeProfileApp/current/dist

7. Click Next.

8. Select Install this deployment as an application.

9. Click Next.

10. Select the target server on which to deploy this application (for example, Banner9-SS).

11. Click Next.

12. Click Finish.


14. Select the deployed application and then click Start.

15. Select Servicing all request.

16. Access the application using the following URL format:

http://servername:<port>/<web application>

For example:http://localhost:8080/BannerEmployeeProfileApp

17. Log in to the application using a valid username and password.

Configure the application

The following aspects of the application can be configured.

Customizing the pay stub PDF

The pay stub PDF is generated using XSL-FO and Apache FOP. The Employee Profile application transforms a well-formed XML file containing employee pay stub data into a pay stub PDF document using XSLT (Extensible Style Sheet Language Transformations).

Below is the FOP tree structure showing all artifacts used in generating the pay stub PDF file. All style sheets have been organized in a way that separates style from layout (similar to the HTML/CSS concept).


Ba

You can customize the pay stub PDF by overriding the default styles, called attribute sets, in the payStub-styles-custom.xsl file. You can find examples of how to do this in the file.

Retaining pay stub PDF customizations

Any customizations to the pay stub styling or layout style sheets will be overwritten during subsequent deployments of the application.

You must reapply your customizations after each new deployment of Employee Profile. Ellucian recommends two options for minimizing the time this will require.

• Keep all customizations limited to the payStub-styles-custom.xsl.

OR

• Copy the entire FOP folder to another location on the web server so that customizations will be retained after a new deployment. The new location of the FOP folder must be configured prior to restarting the application. For details about how to set a new location of the FOP folder, refer to the banner.pdf.fopBaseUrl setting under Pay stub PDF generation.

Pay stub PDF fonts

By default, Employee Profile uses the Open-Sans font (open-source) for languages with left-to-right text direction.


Ba

For Arabic languages, Employee Profile uses the open-source Lateef font.

You can embed additional fonts by adding the font files to the font folder and defining them in fop-config.xml.

Note: Check the licensing requirements before embedding any fonts.

Your browser’s locale determines which font to use based on the settings in common-config.xml.

Employee preferred name

If an employee's preferred first name exists on the Identification (PPAIDEN) page, by default, this name is displayed on the Employee Dashboard, Profile (Employee Profile), and My Team pages.

If the preferred first name does not exist on PPAIDEN, the first name from PPAIDEN is displayed on the Employee Profile pages.

You can configure the display of the preferred first name by using the ess.display.preferredFirstName attribute in the BannerEmployeeProfileApp_configuration.groovy file. By default, the value of this attribute is Y. To hide the preferred first name, set the attribute value to N.

Note: This configuration option only affects the way the name is displayed in the Employee Profile application.

Name format

You can define the format of employee names that are displayed on the Employee Dashboard, My Profile, Pay Stub, and My Team pages. You can define which parts of an employee name are displayed, the order in which the parts are displayed, what punctuation is used, and the number of characters displayed for each part of the employee name.

Within the BannerEmployeeProfileApp/current/i18n folder, find the message.properties file for your language. The default for American English is the message.properties file. Open the file with a text editor. Add an entry for the default.name.format setting, using the following elements:


Ba

The default name format is First Middle Last. You can change the format to any order for any locale. The surname prefix only affects the pay stub.

Examples

default.name.format=$firstName $mi $lastNamedefault.name.format=$lastName $firstName

Phone format

You can define the format of phone numbers that are displayed on Banner Employee Profile pages.

Within the BannerEmployeeProfileApp/current/i18n folder, find the message.properties file for your language. The default for American English is the message.properties file. Open the file with a text editor. Add an entry for the default.personTelephone.format setting. This setting uses the following elements to define the phone format:

Address format

You can define the format of addresses that are displayed on My Profile pages for employees and emergency contacts. Each address can have up to eight address lines.

Within the BannerEmployeeProfileApp/current/i18n folder, find the message.properties file for your language. The default for American English is the message.properties file. Open the file with a text editor. Add an entry for up to eight address lines. At a minimum, you must add entries for address lines 1, 2, 3, and 4.

Last name: $lastName

First name: $firstName

Middle name: $mi

SurnamePrefix: $surnamePrefix

$phoneArea

$phoneNumber

$phoneExtension

$phoneCountry

$phoneInternational


Ba

Each address line uses the following elements to define the address format:

The following address format is delivered:

If you change the address format, you need address lines 1, 2, 3, and 4 at a minimum. If you do not want data on the fourth address line, make the following entry:

default.personAddress.line4.format=

default.personAddress.line1.format




#default.personAddress.line5.format




$houseNumber

$streetLine1

$streetLine2

$streetLine3

$streetLine4

$city

$state

$zip

$county

$country

default.personAddress.line1.format=$streetLine1

default.personAddress.line2.format=$streetLine2

default.personAddress.line3.format=$city

default.personAddress.line4.format=$state $zip


Ba

Do not use a separator (such as a comma or period) if the preceding address line can be null.

Masking rules control the display of the house number and street line 4 on the My Profile page and pay stub:

• For the My Profile page, use the four rules that exist for **SSB_MASKING and block EMPLOYEEPROFILE.

• For the pay stub, use the four rules that exist for **SSB_MASKING and block EMPLOYEEPAYSTUB.

Date format

You can define the format of dates for display and data entry in the user interface. The date format must match the ICU specification and can be changed based on locale. For more information, refer to the following URL: http://userguide.icu-project.org/formatparse/datetime.

Within the BannerEmployeeProfileApp/current/i18n folder, find the message.properties file for your language. The default for American English is the message.properties file. Customize the default.date.format setting.

Example

For the default.date.format for June 1, 2012, use either of the following variables for the year:

For the default.date.format for June 1, 2012, use one of the following variables for the month:

Year format Interpretation Comment

yy 12 Two digit year

yyyy 2012 Four digit year

Month format Interpretation Comment

M 6 Single digit month (no leading zero)

MM 06 Double digit month

MMM Jun Short month name

MMMM June Long month name


http://userguide.icu-project.org/

http://userguide.icu-project.org/

Ba

For the default.date.format for June 1, 2012, use one of the following variables for the day:

Multiple calendars

Customization of multiple calendars is implemented for the Arabic language (AR). The file name for Arabic is messages_ar.properties.

To display multiple calendars in the application, you must use the following keys:

• default.calendar

• default.calendar1

• default.calendar2

Note: The default.calendar2 key is optional.

In the following example, the keys set your default calendar format as Islamic, the first alternate calendar displayed as Gregorian, and the second alternate calendar as Arabic.

default.calendar=islamic

default.calendar1=gregorian

default.calendar2=islamic

Depending on the order you want to view the calendars, you can interchange the following values:

• islamic

• gregorian

CSS customization

To customize the appearance of the self-service application, you can provide custom CSS and image files.

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

Day format Interpretation Comment

d 1 Single digit day in a month (no leading zero)

dd 01 Double digit day in a month


Ba

If you want to provide custom images, save them in the BannerEmployeeProfileApp/current/instance/css/images directory, and in the CSS, specify their paths as a URL. For example:

(./images/filename.png)

Note: If this directory structure does not exist, create the directory structure.

Institution name

The default layout includes an institutional branding area that displays the institution name or logo. The default layout styles the institutional branding area as follows:

.institutionalBranding {

position:relative;

float:left;

left:10px;

top:11px;

height:19px;

width:179px;

background:url("images/ellucian-university-logo-sm.png") no-repeat;}

To customize the system or university name, you must provide a replacement logo image and a custom CSS file to override the default styling. To override the image, create a CSS file named BannerEmployeeProfileApp/current/instance/css/bannerSelfService-custom.css that contains the following:

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

Place the logo image in the following directory:

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

To deploy your updates, you must rebuild and redeploy the WAR file. For more information, see “Regenerate the WAR file” on page 53.

Custom JavaScript

You can optionally add a custom JavaScript file by placing your JavaScript file named bannerSelfService-custom.js in the following location:

BannerEmployeeProfileApp/current/instance/js/bannerSelfService-custom.js

Documents

Banner Employee Profile · See the Banner Employee Profile Release Guide for Ellucian software dependencies. Single sign on (SSO) support Banner 9.x applications natively support