Banner Student. Release Guide

Transcription

1 Banner Student Release Guide August 2016

2 TABLE OF CONTENTS ETRANSCRIPTS UPDATES 3 FormFusion Integration with Banner etranscripts 3 1. ETRANSCRIPTS WITH FORMFUSION - FUNCTIONAL 4 Overview 4 Configuration 4 Processing 4 Changed processes 5 2. ETRANSCRIPTS WITH FORMFUSION - TECHNICAL 6 Changed tables 6 New packages 6 Changed packages 6 Changed scripts 6 Data 6 Changed processes 6 3. ETRANSCRIPTS SETUP 6 Using the Default Special Print Parameter/Template 7 Adding Additional Special Print Parameters/Templates 7 Banner etranscripts MEP Setup and Configuration 8 4. RESOLUTIONS 10 Page 2 of 10

3 etranscripts Updates This release guide documents Release of Banner Student. This release contains updates to Banner etranscripts functionality. FormFusion Integration with Banner etranscripts Support for Banner etranscripts PDF and printed transcript production formatted by FormFusion is delivered with this release. When transcript requests are initiated through etranscripts, customers will now have the option to use either the XML PDF etranscripts option, or integrate with FormFusion to produce the PDF transcript. As delivered with Banner Student 8.6.2, PDF transcripts initiated through the etranscripts/vendor entry point are processed through an XML to PDF conversion. At a high level, the XML document is first converted to Extensible Stylesheet Language Formatting Objects (XSL-FO) markup language using an Extensible Stylesheet Language Transformations (XSLT) stylesheet. The XSL-FO object is entered into a Formatting Objects Processor (FOP) engine, where it is converted to a PDF file. With this change, we are providing the option to use FormFusion to take the raw data and transform it into the PDF, instead of using the XML to PDF process through XSLT. If FormFusion is used and configured, PDF transcripts initiated through etranscripts will now use the paper transcript processing logic (SHRTRTC), and send the resulting.lis file to FormFusion for formatting and PDF generation, before sending the file through SFTP to the configured location. Paper transcripts will also be formatted through FormFusion. This enhancement is an either option. Customers may use the XML to PDF through XSLT option for etranscripts, or the FormFusion option for etranscripts. If enabled to use FormFusion, both paper and PDF transcripts will be sent through FormFusion for formatting before being SFTP d (if PDF), or output to a printer (if printed). Page 3 of 10

4 1. etranscripts with FormFusion - Functional This section details the functional changes delivered for the etranscripts enhancement. Overview In this release, etranscripts integrates with FormFusion through configurable settings available on the GTVSDAX form in Banner. Transcript processing through etranscripts uses these settings to determine which process to call and whether to engage FormFusion. If your institution is not using FormFusion, this release can still be used. Just ensure that the FORMFUSION entry in GTVSDAX described below is set to N. Configuration The use of FormFusion with etranscripts is configurable from the GTVSDAX form in Banner. On that form, there are two entries under the ETRANSCRIPTS group. These values are only used with the etranscripts solution and not with other processes within Banner, including INB. Therefore, transcripts submitted from INB will not be impacted by these settings on GTVSDAX. If paper transcripts are submitted from INB, FormFusion will engage as originally designed due to the changes made to the gjabjobs.shl script, but these settings on GTVSDAX in the ETRANSCRIPTS group will not impact paper transcript processing from INB. For the first GTVSDAX entry, the FORMFUSION code in the ETRANSCRIPTS group is used to determine if FormFusion is to be used or not. The initial value of the external code is UPDATE ME. If FormFusion is to be used, that value should be changed to a Y. Anything other than a Y will be treated as an N indicating that FormFusion is not to be used. The second GTVSDAX entry describes a default special print parameter that is to be used with FormFusion. On GTVSDAX in the ETRANSCRIPTS group, the SPCL_PRNT1 code points to an external code of ET_FORMFUSION. The value of ET_FORMFUSION is the name of the default template in FormFusion as described in the documentation from Evisions. The value of the external code for the special print parameter in Banner must match the name of the template in FormFusion. Processing Transcript Processing If the FORMFUSION setting on GTVSDAX is set to N, then etranscript processing will run as it has in the past. However, if the FORMFUSION setting is changed to Y, then the paper transcript (SHRTRTC) process will be leveraged to produce the required.lis data file that FormFusion needs as input. This means that etranscripts will actually run the SHRTRTC paper transcript process for PDF transcript orders if FORMFUSION is set to Y. etranscripts will then simply call FormFusion through the Banner JobSub processes passing FormFusion the location of the.lis paper transcript file. FormFusion will process the file and then call back into Banner when done. Banner will then run the SHRETRN process to SFTP the Page 4 of 10

5 file to the vendor, and execute the SHRPOST process to update the transcript order status in the etranscripts Send cloud application. Paper transcript orders through etranscripts can also leverage FormFusion. In the same way for a paper transcript order, if the FORMFUSION setting is set to Y, then FormFusion will engage and produce the desired output. However when FormFusion calls back into Banner for a paper transcript order, the SHRPOST process is called to update the etranscripts Send cloud application with the order status, but the SHRETRN process is not called because the paper transcript would need to be sent through postal mail. EDI and XML transcript orders are not affected by changes in this release and cannot be processed through FormFusion. etranscripts/formfusion Integration The etranscripts/formfusion integration requires the use of special print parameters in Banner and templates in FormFusion that have the same name. As described above, there is a default special print parameter delivered with this release in the ETRANSCRIPTS group on the GTVSDAX form that should match the default template defined in FormFusion by the same name (ET_FORMFUSION). This default special print/template can be used as an example or as a reference. This solution supports the addition of other templates in FormFusion as well. If other templates are added to FormFusion for use with etranscripts, then additional special print parameters must be added to GTVSDAX under the ETRANSCRIPTS group. However, it is required to follow the naming convention established with the default special print/template. The naming convention requires that the name of the template must begin with the characters ET_. This name of the template has a maximum length of 15 characters due to the size limitation of the external code field in GTVSDAX. Beginning the name of the template in FormFusion with ET_ will identify it as an etranscripts process. This will allow Banner JobSub to know if it is calling FormFusion for an etranscripts job, or for some other type of job. This is important because FormFusion is actually called with the lock flag in place for etranscripts jobs to ensure load capacity is not reached. This allows FormFusion to process each transcript one at a time, while still allowing other non-etranscripts jobs to process immediately through FormFusion. This ability is particularly useful when there are periods of high etranscripts order volume, like at the end of a semester or when a processing date for awarded degrees or posted grades have been met. Changed processes The SHRTRTC paper transcript process was changed to accommodate FormFusion integration. The SHRTRTC process only calls the SHRPOST process to update the transcript order status in the etranscripts Send cloud application if there is an order ID for the order and if FormFusion is not being used, as indicated on GTVSDAX. This is because the SHRPOST process is executed when FormFusion calls back into Banner after generating the output file. In SHRTRTC, the GJBPRUN table only gets cleaned up if there is no order ID for the transcript or if FormFusion is not being used as indicated on GTVSDAX. This is because the GJBPRUN table, which holds the various parameters for the given job in JobSub, will get cleaned up (deleted for the given job) when FormFusion calls back into Banner after the output file is generated. The SHRETRN electronic process was changed to accommodate FormFusion integration. The SHRETRN process will read the output file from FormFusion from the new column added to the SHRSFTP table. It will then send the FormFusion output file to the vendor through SFTP and call the SHRPOST process to update the order status in the etranscripts Send cloud application. Page 5 of 10

6 2. etranscripts with FormFusion - Technical This section details the technical changes delivered for the etranscripts enhancement. Changed tables - SHRSFTP: added a new column: SHRSFTP_FILEPATH_FILENAME. This contains the absolute path including the filename of the file outputted from FormFusion so that the SHRETRN process can read that file and send it to the vendor through SFTP. New packages - SHKETFF: New DB package specific for FormFusion integration. Used by FormFusion to call back into Banner after FormFusion has generated the output file. Changed packages - SHKETRN - SHKEBLD - SHKEXML Changed scripts - create_etranscript_user.sql: runs as part of the DB upgrade. Even if the ETRANSCRIPT user already exists, it should still run. Error messages that can be ignored may display. Data - sgtvsdaxi_ sql: adds the data for FormFusion integration to GTVSDAX. Changed processes - SHRTRTC - SHRETRN - SHRADVQ 3. etranscripts Setup This section describes the various steps necessary to setup Banner etranscripts for FormFusion integration. It is strongly recommended that customers are configured to produce the baseline PDF transcripts using etranscripts before implementing the FormFusion integration. This baseline provides a starting point for troubleshooting any issues encountered with the configuration of the integration. Overall, the implementation steps are as follows: 1. In your test environment first produce a test PDF transcript order to prove your institution s etranscripts configuration with your vendor, the Ellucian Cloud, and your ERP is correct. 2. Configure FormFusion. You can download the Evisions etranscripts Template for FormFusion from their co-op share here. Please refer to the Integration Guide for steps on how to configure FormFusion for compatibility with etranscripts. Page 6 of 10

7 3. Ensure that you have run the create_etranscript_user.sql script. Even if the ETRANSCRIPT user already exists, this script should still be run to ensure the required permissions and privileges for this release have been granted to the ETRANSCRIPT user. Note: See the Banner etranscripts MEP Setup and Configuration section for MEP support. 4. Login to Banner INB as the etranscript user and configure GTVSDAX in Banner to call into FormFusion a. If you are using one Special Print Parameter/Template: i. Set the FORMFUSION setting = Y ii. Set the SPCL_PRINT1 internal code = ET_FORMFUSION (or the name of your template in FormFusion, but preceded by ET_ ) b. If you are using more than one Special Print Parameter/Template: i. Set the FORMFUSION setting = Y ii. Set the SPCL_PRINT1 internal code = ET_FORMFUSION (or the name of your template in FormFusion, but preceded by ET_ ) iii. Add an addition internal code for each additional template, following the required format of ET_ 5. If your institution is using more than one Special Print Parameter: a. Modify and recompile the p_get_cust_spcl_prnt_param procedure in the shketff1.sql file to query and return the correct Special Print Parameter. Using the Default Special Print Parameter/Template This release of Banner etranscripts comes with a default special print parameter described earlier in this document. On the GTVSDAX form in Banner under the ETRANSCRIPTS group, there is an internal code called SPCL_PRNT1 which is mapped to the ET_FORMFUSION external code value. This is the default special print parameter that maps to the default template in FormFusion. The default template name in FormFusion is ET_FORMFUSION and must match the external code value on GTVSDAX for this entry. The only changes required to use the default special print parameter/template would be to ensure that all desired fields are mapped properly in FormFusion to produce the desired output file. More information about setup in FormFusion can be found in the Evisions etranscripts Integration Guide. Adding Additional Special Print Parameters/Templates This release supports the use of many special print parameters/templates with FormFusion. Adding a Special Print Parameter/Template To add a new special print parameter/template, please do the following: 1) Follow the directions described in the Evisions etranscript Integration Guide to setup the new template(s) in FormFusion. Ensure that each template added contains the same Capture Form queries and ScriptDirector configuration as the default template. 2) Login to Banner INB and go to the GTVSDAX form. 3) Under the ETRANSCRIPTS group on GTVSDAX, add the new special print parameter(s)/template(s). For each entry added, provide your own internal code, but ensure that the external code begins with the characters ET_ and that the external code value matches the name of the desired template in FormFusion. The name of the template in FormFusion should also begin with the same ET_ prefix. 4) Add an appropriate description or comment for each entry on GTVSDAX as desired. 5) Save the entry(s) on the GTVSDAX form. Page 7 of 10

8 Supporting Multiple Special Print Parameters for Banner etranscripts To use the newly added special print parameters/templates, custom code must be written to allow the newly added special print parameters to be retrieved during runtime. This release provides a customizable database procedure where such changes can be made. Please do the following to customize your database procedure to retrieve the newly added special print parameters for use with etranscripts: 1) Login to the Banner server with the appropriate user and cd to the $BANNER_HOME/student/dbprocs directory. 2) Make a backup copy of the shketff1.sql file. 3) Edit the shketff1.sql file and locate the p_get_cust_spcl_prnt_param procedure. 4) Refer to the example query and code in that procedure as to how to make changes to return the desired special print parameters. Using the input parameters into that customizable procedure, custom queries can be written for the desired criteria. 5) Based on the results of the custom queries call the FCheckSDAXRULE function using the desired GTVSDAX internal code and ETRANSCRIPTS group. Then assign the returned value from the FCheckSDAXRULE function to the p_special_print_param output parameter of the customizable procedure. That will return the desired special print param from GTVSDAX based on whatever criteria you have coded for. 6) Save the shketff1.sql file and recompile it. If invalid package errors occur, recompile it again, or try first compiling the shketff.sql spec file and then compiling the customized shketff1.sql body file. The p_get_cust_spcl_prnt_param procedure is the only procedure that should be changed and no changes to that procedure signature (the procedure name and input/output parameters) should be made. Banner etranscripts MEP Setup and Configuration To support a Banner Multi Entity Processing (MEP) environment with the release, the following setup and configuration is required. Banner etranscripts MEP Setup The create_etranscript_user.sql script should be run to create an ETRANSCRIPT_<CAMPUS> user for each MEP campus, where <CAMPUS> is the campus name or VPDI code. Do the following to set this up: 1) Make a backup copy of the create_etranscript_user.sql file. 2) Edit the create_etranscript_user.sql script and change the name of the user from ETRANSCRIPT to ETRANSCRIPT_<CAMPUS> throughout that script, where <CAMPUS> is the desired campus code. Also change the name of the user in the string literal values of the insert statements at the bottom of the script. 3) Run the script with the changes you just made as the BANSECR account to create the ETRANSCRIPT_<CAMPUS> user. 4) Repeat steps 2 and 3 for each campus. Banner etranscripts MEP Configuration In a Banner MEP environment, the Banner JobSub ETRANSCRIPT_<CAMPUS> users must be assigned to the correct campus codes so that when FormFusion communicates with Banner, it can query the correct data for each campus. Page 8 of 10

9 To do this, login to Banner INB as the BANSECR user and go to the GSAVPDI form. Click on the User Assignment tab and add a record for each campus specifying the ETRANSCRIPT_<CAMPUS> user. Assign the correct campus code to each user. Ensure that the User Default checkbox is checked for each user so that each ETRANSCRIPT_<CAMPUS> user is its own default. Click the Save button to save the newly added records for the ETRANSCRIPT_<CAMPUS> users. Page 9 of 10

10 4. Resolutions The Banner Student Resolutions Report is a companion to this release guide. The Resolutions Report provides summary information about the change requests that are resolved in Banner Student Use the following steps to access the Resolutions Report on the Ellucian Support Center: 1. Go to the Ellucian Client Support web site: 2. Click the Ellucian Hub button to log in to the Ellucian Hub. 3. Choose the Ellucian Download Center application. or Choose the Ellucian Support Center application. Page 10 of 10