Banner Student International Patch Upgrade Guide
Release 8.17.1 March 2019 Notices and Privacy
© 2014-2019 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.
Ellucian's Privacy Statement is available at: www.ellucian.com/privacy.
Ellucian shall have the right to (a) use, store, process, modify, reproduce, distribute and display customer data, and to grant sublicenses to third parties, for the sole purposes of providing the software, performing Ellucian's obligations under its agreements with customers and complying with applicable law or legal requirements; (b) use, store, process, modify and reproduce customer data for Ellucian's internal business purposes, including development, diagnostic, forecasting, planning, analysis and corrective purposes in connection with the software, and for otherwise improving and enhancing the software; and (c) use, store, process, modify, reproduce, display, perform, distribute, disclose and otherwise exploit in any manner Aggregated Data for Ellucian's business purposes, including disclosure within its public statements and marketing materials describing and/or promoting Ellucian and/or the software. “Aggregated Data” means any data obtained or generated by Ellucian, including data pertaining to the software, Ellucian's systems and software, and the use of any of the foregoing, and includes data derived from customer data, which in all instances (i) does not identify any individual and (ii) is not attributed or attributable to a specific customer. Aggregated Data includes data that has been combined into databases which include third party data.
Ellucian 2003 Edmund Halley Drive Reston, VA 20191 United States of America
Revision History
Publication Date Summary
March 2019 New version that supports Banner Student 8.17.1 International Patch software.
RELEASE 8.17.1
Table of Contents Overview ...... 4 Step Description and Dependencies Table ...... 4 Step 1 Distribute Release Documents ...... 5 Step 2 Verify Environment Prerequisites ...... 5 Step 3 Installation/Upgrade Prerequisites ...... 7 Step 4 Installation/Upgrade Preparation ...... 7 Step 5 Modify Database Objects ...... 7 Step 6 Migrate From Stage to Permanent Directories ...... 9 UNIX ...... 9 For MICROSOFT WINDOWS ...... 10 Step 7 Compile C programs ...... 11 UNIX ...... 11
RELEASE 8.17.1
Overview
This International Patch delivers a full install of C and Pro*C ROOT resources for Banner Student 8.17.1.
This document describes the steps required to perform a full install. It is designed to be used in conjunction with the SCB Release Interdependencies document which is available for download from the Ellucian Customer Support Center at http://www.ellucian.com/Solutions/Ellucian-Client-Support/.
The SCB Release Interdependencies document outlines the release interdependencies for all Banner, SCB, International Patches and language releases within the Digital Campus (DC). Before you install or upgrade a product within the DC, use this document to determine which other DC products you must install first.
IMPORTANT NOTE:
In line with the code tree merge carried out before installation of Banner 8.2 and International Patch 8.2, the International Patch scripts will migrate into the main BANNER_HOME directories, i.e. not into BANNER_HOME/scb subdirectories.
NOTE: The "Some translation releases are not supported via ESM for Windows clients" Article 000042576 is available via the Ellucian Support Center (http://www.ellucian.com/Solutions/Ellucian-Client- Support/). It is necessary that you check this document prior to applying the release by querying for Article 000042576.
Step Description and Dependencies Table
The following list of steps is consistent from release to release. Any steps that are not required are marked N/A in the "Applies to this Upgrade" column in this table.
Step Applies Description Dependent to this on Step upgrade 1 Distribute Release Documents — 2 Verify Environment Prerequisites Previous 3 Installation/Upgrade Prerequisites Previous 4 Installation/Upgrade Preparation Previous 5 Modify Database Objects Previous 6 Migrate from stage to permanent directories Previous 7 Compile C programs/resources Previous
If any errors or problems occur during the upgrade process, login to the Ellucian Customer Support Center at http://www.ellucian.com/Solutions/Ellucian-Client-Support/ to search for solutions or to submit a service request for assistance with the issue. RELEASE 8.17.1
Read All Instructions Before Beginning; Review the Contents of All Scripts (SQL, SHL, PL and, BAT files)
Step 1 Distribute Release Documents
Distribute the enclosed Release Guide found in the doc subdirectory, to the appropriate departments. This document explains the modifications that have been made to the system in functional terms and explains those actions that must be taken by the users in preparation for or as part of the release upgrade.
Do not proceed until the responsible users indicate that any current processes or cycles have completed and will not be affected by the upgrade.
Step 2 Verify Environment Prerequisites
Part A This upgrade requires a minimum of Oracle Database Release 11.1.0.7.0.
In order to maintain technical currency, for Banner Human Resources 8.30 Oracle 10g is no longer supported. It is required that you upgrade to Oracle 11gR1 in order to use this release of Banner Human Resources and take advantage of the functionality and the continuity it provides across Banner Digital Campus.
“FAQ 1-AUTYZE - Oracle 11G Database and Application Server” can be referenced for additional details.
For more information on 11G database requirements, refer to the Banner Human Resources release documentation.
Be sure all Oracle users are logged off and cannot or will not log on. International Patch installation scripts only require DBA for BANINST1. BANINST1 will grant DBA to &UPGRADE_OWNER who is used to do the installation. The DBA role is revoked from &UPGRADE_OWNER if installation finishes OK (granted/revoked for each product upgrade).
COMPLETE BACKUPS OF YOUR EXISTING SYSTEM BEFORE CONTINUING!
Make sure Oracle is down when the backup is taken. This ensures a consistent backup. Verify that all database files, redo logs, and control files have been successfully backed up.
Part B Apply this upgrade to your SEED instance first. Never apply it to production without familiarizing yourself with the process by executing it against a non-critical database. This stage must be applied to all of your Banner «product» environments.
For all platforms set SQLPATH equal to ORACLE_PATH.
If you are running under UNIX, be sure that the current directory (represented by a ".") is at the front of your ORACLE_PATH, SQLPATH and UNIX path to avoid any problems when starting some of the upgrade SQL scripts and shells. RELEASE 8.17.1
If you are running under MICROSOFT WINDOWS, be sure that the plus subdirectory of every Banner product you license has been added to the HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\SQLPATH registry entry and/or the SQLPATH environment variable to avoid any problems when starting the upgrade SQL scripts. Please also note that the commands you use to import files and to start SQL*Plus will depend on the version of Oracle Server you are using. To perform an upgrade on the MICROSOFT WINDOWS platform, you must open up an MS-DOS window and execute all commands from the MS-DOS command prompt.
ATTENTION: In order to comply with USA Federal Audit Standard GAO-09-232G, ALL Ellucian releases, effective August, 2011, will no longer deliver code with clear A NOTE text passwords. REGARDING DELIVERED This affects the delivered file login.sql as well as C and COBOL compile scripts ELLUCIAN and form generate scripts for the UNIX and Windows environments. CODE AND CLEAR TEXT You will now be responsible for editing the delivered login.sql script for every PASSWORDS upgrade and replacing the string “#UPDATEME#” with whatever value the particular schema owner’s password is in your environment. You will be required to do this for all Banner schema owners that exist in your particular environment.
The compile scripts (C/ COBOL/ form generate scripts/ report generate scripts) in the upgrade, for all supported platforms, have been modified to include environment variables that need to be defined at your site in order to successfully compile/generate the Ellucian delivered objects.
For the UNIX/LINUX environment, issue the following command:
export DFLT_BANINST1_PASS=the_value_of_baninst1_password;
For the Windows environment issue the following command:
SET DFLT_BANINST1_PASS=the_value_of_baninst1_password
The delivered generate and compile scripts will expect these environment variables to be present in your environment, defined and available to be used at the appropriate times.
RELEASE 8.17.1
Step 3 Installation/Upgrade Prerequisites
Part A Banner, SCB and International Patch Prerequisites
For more information you may refer to the SCB Release Interdependencies Matrix.
NOTE: Note that all unilingual as well as multilingual Banner language systems require SCB 8.1/8.1.0.0.1 and International Patch 8.2/8.3.
Any modifications you have made to the base product will remain your responsibility. Each object that has been modified contains descriptive text about the purpose of the modification. This text can be found at the beginning of each object, except for forms, for which the comments are found in Form level procedures named AUDIT_TRAIL_”release_number”.
Step 4 Installation/Upgrade Preparation . Make sure the required Banner Baseline, SCB and International Patch versions are installed as described under Step 3 before proceeding to install this patch.
Step 5 Modify Database Objects
Although no database objects are delivered with this release, the installation file needs to be run in order to updated the release version table GKRVERS.
CAUTION: The following installation steps will affect your existing installation. Please make sure your system is backed up accordingly including all your customizations. Customizations will need to be re-applied after this installation is completed.
Part A In this part you will update the GKRVERS version table as required. Changes that you have made to your existing installation may be affected by this process.
RELEASE 8.17.1
CAUTION: Make sure ALL prerequisites specified in the Overview and Installation Requirements sections have been met before proceeding.
FOR MICROSOFT WINDOWS: If performing the install from a MS windows environment ensure that the sqlplus 'Start In' directory is set to the location on your server of the new sql sub-directory.
The installation will be executed against your default database as set with LOCAL (Windows) or TWO_TASK (Unix).
CAUTION: Before beginning this upgrade, please review Step 2 Part B for additional instructions regarding establishment of environment variables and edits to the file login.sql.
Do not proceed until the necessary edits have been finished.
From the new install sub-directory, invoke SQL*Plus and connect as any user or use the nolog flag to invoke SQL*Plus without connecting. When you get an SQL*PLUS prompt, type in the name of the .sql file (incl. the @ sign) as follows:
sqlplus /nolog @Error! Reference source not found._intp.sql Enter
The installation will be spooled to the file Error! Reference source not found._intp.lst. Review this file for any errors to determine the install has been successful before moving on to the next product.
Part B On completion of each sql installation check to ensure that no other database objects have been invalidated as a result of installing this release.
Please use a database tool for example Toad or PL/SQL Developer to recompile or use gurutlrp (new guraltr).
In this part you will run the gurutlrp.sql utility script to compile database objects that are in an invalid state. The gurutlrp.sql script runs ORACLE's utlrp utility script (as SYS) and then displays a list of the remaining invalid database objects. This script is run to shorten the time required to perform subsequent steps of this upgrade in which the rdbms would otherwise have to recompile invalid database objects as they are referenced. This will also enable the successful generation of all Oracle Forms modules which may not have successfully generated in the past because the rdbms considered the identifiers for invalid database objects to be insufficiently declared, but when the same modules were regenerated, the executables for RELEASE 8.17.1
those modules were created without error. All errors should be investigated before continuing to the next step.
To compile objects which are currently in an invalid state perform the following:
sqlplus /nolog @gurutlrp Enter
Review: gurutlrp listing
All errors should be resolved before continuing to the next step. You may need to repeat this process several times until all dependencies are validated.
Step 6 Migrate From Stage to Permanent Directories
Before executing any of the migration scripts make sure you are signed on to an operating system account that has write permission into the target directories.
The migration scripts provided for the UNIX and MICROSOFT WINDOWS platforms expect your directory structure to match the one created by the Banner install process. You will have to modify the scripts if you chose a different directory structure. Migration scripts for other platforms are not provided due to their highly customized structures but you may use the STUMIGR.TXT file as a starting point for writing your own migration script.
In this step you will migrate the staged files to your permanent directories.
The file Error! Reference source not found._INTPMIGR.TXT lists all files that need to be deleted from your permanent directories, and all files which should be copied from the staging directory to your permanent directories. The destination is indicated in UNIX format, and will be different on other platforms.
UNIX
The file Error! Reference source not found._intpmigr.shl will do the appropriate removes, copies, and links. Review for correct directory path names and make sure that the environment variable $BANNER_HOME is set to the appropriate directory before executing.
NOTE: The Error! Reference source not found._intpmigr.shl file defines a local variable, LN, at the top of the file which determines the type of links which should be used in the migration. This change enables clients who wish to use symbolic links, for example, to set LN=‘ln -s’ instead of the default value of ‘ln’ so that the command ${LN} file $BANNER_HOME/links is translated to ln -s file $BANNER_HOME/links. Similarly, clients who wish to force the removal of any existing targets before linking files can set LN=‘ln -f’. RELEASE 8.17.1
Note that even if your directory structure matches the baseline perfectly, some of the link commands will fail (that is, where the link currently exists). Other link errors may 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.
You may wish to run the migration shell in background so that you may review any errors when it is complete. To submit into background and produce an error log, do the following:
1. If your operating system prompt is a percent sign, you are a cshell user. Enter the Bourne shell by typing:
sh Enter
2. Position to the staging directory for this product.
3. Run the migration script by typing:
sh Error! Reference source not found._intpmigr.shl >Error! Reference source not found._intpmigr.log 2>&1 & Enter
4. If you were a cshell user and want to return to that mode, press CTRL-D or type:
Review: Error! Reference source not found._intpmigr.log
This file contains the results of the migration.
For MICROSOFT WINDOWS
The file Error! Reference source not found._intpmigr.p will do the appropriate deletes and copies. Before running the migration script you must check the BANENV environment variable. This value may be determined by executing the SET command from the DOS prompt.
If BANENV has a value of REG, the value used for BANNER_HOME will be taken from the registry entry:
HKEY_LOCAL_MACHINE\SOFTWARE\BANNER\BANNER_HOME
If BANENV has a value of ENV, the value for BANNER_HOME will be taken from the environment variable BANNER_HOME.
Review the script for correct directory path names.
To run the migration script and produce an error log for the migration, do the following:
1. Position to the staging directory for this product.
2. Run the migration script by typing:
perl Error! Reference source not found._intpmigr.pl >Error! Reference source not found._intpmigr.log 2>&1 RELEASE 8.17.1
Review: «xxx»migr.log
This file contains the results of the migration.
Step 7 Compile C programs
Part A The Root resources for C and Pro*C objects are delivered as part of the Banner International Patches. Translated versions of Banner C and Pro*C use the ICU resource bundle mechanism to look up translations for messages.
For more information, refer to the International Patch C and Pro*C Resources Installation Information document included in this release.
In this step you will compile any affected C programs. A script is provided to do the required compiles in the correct order. The output from the compile routine is placed into the exe subdirectory owned by GENERAL. If your compile routine has been modified to write into the current directory, the output will have to be migrated to GENERAL‘s exe subdirectory before it can be accessed by the users. This release does not include compilation scripts for C. Please recompile C using Banner baseline scripts after the migration.
This procedure must be run from an operating system account that has write permission into the target directory.
UNIX
1. Position yourself in the stage or Banner_Home directory.
2. If your operating system prompt is a percent sign, you are a cshell user. Enter the Bourne shell by typing:
sh Enter
3. Start the compiles by typing:
sh «x»ccomp.shl >«x»ccomp.log 2>&1 & Enter
4. If you were a cshell user and want to return to that mode, press CTRL-D or type:
exit
5. You may continue with the next step of the upgrade. When you need to check if this step has completed, review the audit file called «x»ccomp.log. If you have not logged off, you can see if the task is still running by issuing the UNIX ps command. RELEASE 8.17.1
Part B For source code files there can be a number of associated resource bundle files with message ID’s and message strings. The resource bundle files come in two flavors, plain text files (*.txt) and binary files (*.res). The binary .res files are created by compiling the .txt files with ICU tool genrb. It is assumed that ICU is installed and that genrb can be located when executed in the shell. The default deploy method for language systems will be to install .res files in a specific directory tree structure as described below. The organization of the binary .res files has to be according to ICU rules.
The SCB 8.1 includes script genres to simplify the set up of resource bundle files in Unix or Linux like environments. No Microsoft Windows scripts are provided - Windows users can use Cygwin or similar.
The genres script is located in directory ../general/misc. Please copy the script to your favorite scripts directory and include this directory in your $PATH. The following instructions use Unix conventions for environment variables and paths. Note that for other OSs it works the same, but conventions differ slightly.
The shell commands are written in courier and start with $ when directly entered in the shell.
The compiled resources for all International Patch products will be installed in $BANNER_HOME/resources and an environment variable is created to point to this location.
$ export BANNER_RES=$BANNER_HOME/resources
$ mkdir $BANNER_RES
At runtime this directory has to be included in $ICU_DATA. This has the same format as $PATH (multiple directories separated by colon (:), the separator is OS dependent).
To set this up permanently you can include the following in the .profile for the OS user that execute the jobs:
export BANNER_RES=$BANNER_HOME/resources
export ICU_DATA=$BANNER_RES:$ICU_DATA
The directory and file structure will be setup as follows:
$BANNER_RES/
Prog1.pc/
root.res
es.res
Prog2.pc/
root.res
es.res RELEASE 8.17.1
This example tree contains only the root and Spanish resource files. Directory names end with a slash (/). $BANNER_RES will contain a directory per C source file (.c, .cpp, .pc, .h). In this directory there will be files
If genres is ‘installed’ as described you can enter genres without parameters to display a little help text:
$ genres
Script to generate Resource bundle files for a file or directory
Usage genres version 1.1:
genres BuildTarget [sourcedir [targetdir]]
where BuildTarget is ALL, UPDATE, CLEAN or the C file name like gjrrpts.pc
sourcedir and targetdir default to current directory
Locales that will be generated: root en es fr ar .
Set extra locales using e.g. export locales="nl nl_NL"
before executing this script.
Optional Environment Variables to change behavior
TM_BUNDLE_DEBUG=Y to show which bundle is generated
GENRBOPT=... options to pass to genrb like -v for verbose
To compile and deploy a directory with resource files:
1. Ftp, copy or link all resource .txt files to $BANNER_RES
2. Make sure all locales you wish to compile are listed when you execute genres without parameters, follow instructions to add missing locales when needed
3. cd to the folder where your text resources are located
$ cd $BANNER_RES
4. generate all resource files
$ genres ALL
RELEASE 8.17.1
5. (alternatively you can use $ genres UPDATE to only compile .txt files that are newer than the corresponding .res file)
Check for errors and warnings.
The steps describe the case that you have all resource .txt files in $BANNER_RES and also have this as the root for the binary .res files.
Script genres_all has been included in scb/general/misc to traverse through all product directories in the current directory and call genres if a directory resources exists in this product directory. The following is an example of usage:
$ cd $BANNER_HOME/esMX $ genres_all ALL
It is also possible to compile per product and language (locale):
$ genres ALL $BANNER_HOME/general/resources $BANNER_RES
$ genres ALL $BANNER_HOME/frfr/general/resources $BANNER_RES
You can use UPDATE instead of ALL if you do not want to touch unchanged resource files.
This Banner Student 8.17.1 International Patch installation is now complete.
RELEASE 8.17.1
Ellucian 2003 Edmund Halley Drive Reston, VA 20191 United States of America www.ellucian.com