App Navigator 1.4 Handbook

Application NavigatorHandbookRelease 1.4March 2016/nWithout limitation: Elluci an®, Banner®, Colleague®, and Luminis® are trademarks of the Ellucian group of companies that are reg istered in the U.S. and certain other countries; and Elluci an AdvanceŽ, Ellucian Course SignalsŽ, Ellucian Degree WorksŽ, Ellucian PowerCampus Ž, Ellucian RecruiterŽ, Ellucian Sm artCallŽ, are also trademarks of the Ellucian gr oup of companies. Other names may be trademarks of their respective owners. © 2016 Ellucian. Contains confidential and proprietary inform ation 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 li cense agreements between Ellucian and the licensee in question. In preparing and providing this publicati on, Ellucian is not rendering legal, accounti ng, or other similar professional service s. Ellucian makes no claims that an institution's use of this publication or the soft ware for which it is provided will guarantee compliance with ap plicable federal or state laws, rules, or regulations. Each organiza tion should seek legal, accounting, and other similar professional services from comp etent providers of the organization's own choosing. Ellucian 4375 Fair Lakes Court Fairfax, VA 22033 United States of America Revision History Publication DateSummary October 2015New version that supports Application Navigator 1.3.1 software. March 2016New version that supports Application Navigator 1.4 software. /n 3Application Navigator Handbook |Contents Contents Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 Seamless Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Application Navigator Landing Page Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Page display bar elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Unified Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Unsaved changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Search capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Prevent users from directly accessing pages or forms . . . . . . . . . . . . . . . . . . . . . 11 Job Submission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Module, Page, and Object Maintenance. . . . . . . . . . . . . . . . . . . . . . . . . .12 Module and page maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 General Common module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Object maintenance and Banner 8.x/9.x display option . . . . . . . . . . . . . . . . . . . . . 14 Automatic updates of GUAOBJS display option based on GUAPAGE data . . . . . . . . 14 GUAPAGE records and effect on GUAOBJS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Facilitate menu rebuild. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Form and page access comparison . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Display results comparison. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 /n 4Application Navigator Handbook |Contents Timeout Handling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Java Administrative Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21 Module Configuration Override. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Override setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Deep-Linking. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Parameter definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Luminis to an Internet Native Banner link. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Luminis to a Banner 9.x administrative page link. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Luminis to a Banner 9.x Human Resources Java page link. . . . . . . . . . . . . . . . . . . . . 25 Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26 Invalid user interface version error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Access Banner menu data logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Global variables not passed between Banner 8.x and Banner 9.x . . . . . . . . . . . . 26 User not able to open a second INB form when running seamless navigation . . 27 Pointers for running seamless navigation with Banner Forms . . . . . . . . . . . . . . . 27 Pointers for enabling seamless navi gation for Banner 9.x applications . . . . . . . 27 Oracle Forms Javascript error after upgrading Banner General release . . . . . . . 28 /n 5Application Navigator Handbook |Introduction IntroductionThis handbook discusses how to set up and use the Application Navigator software component with Banner 8.x and Banner 9.x. The following chapters are in this book: fiSeamless Navigation fl on page6 fiModule, Page, and Object Maintenance fl on page13 fiTimeout Handling fl on page19 fiJava Administrative Pages fl on page22 fiModule Configuration Override fl on page23 fiDeep-Linking fl on page25 fiTroubleshooting fl on page27 /n 6Application Navigator Handbook |Seamless Navigation Seamless NavigationThis chapter discusses setting up and using seamless navigation with Application Navigator. OverviewApplication Navigator facilitates seamless navigation between Banner 8 .x forms and Banner 9.x pages, allowing them to behave lik e a single application. Application Navigator includes a unified menu, unified search, and uses a common authentication mechanism to provide an integrated user experience. User s can navigate between the Banner modules using a single interface. Note: Application Navigator is delivered and installed separately from the Banner administrative applications. For specific information on installing and configuring Application Navigator, refer to the Application Navigator Installation Guide .Key block globals are shared across Banner 8.x and Banner 9.x. The GURTRAN table facilitates this exchange by providing a cr osswalk between the Ba nner 8.x globals and Banner 9.x globals. IntegrationThe following 9.x administrative applications can be integrated with Application Navigator. ŁBanner Finance ŁBanner General Event Management ŁBanner General ŁBanner Human Resources ŁBanner Student Academic History ŁBanner Student Attendance Tracking ŁBanner Student Course Catalog ŁBanner Student Class Schedule ŁBanner Student Overall ŁBanner Student Registration /n 7Application Navigator Handbook |Seamless Navigation The following 8.x products can be integrated with Application Navigator. ŁBanner INB ŁBanner Workflow The Ellucian Identity Service can be integrated with Application Navigator. Refer to the Banner Digital Campus Product Compatibility Tool for the applications that can be integrated with Application Navigator and the minimum required versions. This tool is accessed using a link in the Ellucian Customer Support Download and Documentation Center. To access this link, you must log into the Support Center using the following steps. 1.Access the Customer Support Center ( http: connect.ellucian.com ).2.Log in using your assigned user ID and password. If you do not have an ID or password, you can request one through the link provided in the login menu. 3.Click the link for the Documentation and Download Center in the Self-Service menu. 4.Select the Documentation tab. 5.From the right-hand Quick Access menu, locate the Common Interest heading, and select the New-Interactive Banner DC Compatibility Guide option. Implementation Use the following steps to implement seamle ss navigation using Application Navigator. The order of some steps may vary based on your institutional objectives. For more information on each step, refer to the Application Navigator Installation Guide .1.Implement a Single Sign On (SSO) protocol. ŁYou can implement CAS SSO for all your Banner 8.x and 9.x administrative applications. For more information, refer to the CAS Single Sign On Handbook. - or- ŁYou can implement SAML2 SSO for Banner 9.x applications with Ellucian Identity Service (EIS) as the Identity Provider. See the Application Navigator Installation Guide for detailed instructions on installing CAS or SAML2, including checklist appendices. 2.Enable seamless navigation for Banner 8.x forms. For more information, refer to the "Enable seamless navigation for Banner 8.x forms" section in the Application Navigator Installation Guide. 3.Run the seamless navigation utility for those Banner 8.x baseline administrative forms that you want to include in the unified menu. This is done as part of the seamless navigation implementation and enables seamless navigation and globals sharing between the Banner 9.x pages and the Banner 8.x /n 8Application Navigator Handbook |Seamless Navigation baseline administrative forms. For more information, refer to the Banner General Release Guide 8.6.4 .4.Set the configuration parameter to true ( applicationNavigator=true ) for the Banner 9.x administrative application that you want to run with Application Navigator. Then redeploy the application. For more information, refer to the "Configure Banner 9.x Applications" section in the Application Navigator Installation Guide . 5.On GUAPAGE, update the module Integration indicator to checked ( Yes) for the applications that are being integrated. For more information, refer to the "Change the setting using GUAPAGE" section in the Application Navigator Installation Guide .6.On GUAPAGE, review the setting of Platform Type field and verify that the value for the platform type associated with the Banner 9.x module is one of two codes. ŁADMJF - Java Forms Administrative ŁADMZK - ZK Administrative 7.The module code and related GUBPAGE records that are required with Application Navigator are inserted through seed data scripts. This occurs during the installation of an integrated Banner 9.x application. 8.Rebuild the menu. For more information, refer to "Rebuild the Banner Menus" section in the Application Navigator Installation Guide .9.Install the Application Navigator software component. Application Navigator Landing Page FeaturesThe following icons are used with Application Navigator. ŁThe Menu icon (group of three horizontal lines at top left) indicates the unified menu is in use. Select the Menu icon to view the Banner and My Banner menus in the unified menu panel. You can choose to display (or hide) the seven letter object identifier on the menu by checking or unchecking the Display Form Name on Menu indicator on GUAUPRF. ŁThe Envelope (Folder) icon on the top left is displayed after the first form or page has been opened. When the Envelope icon is selected, the panel will slid e open, and a list of the recently opened forms and pages is displayed. /n 9Application Navigator Handbook |Seamless Navigation The number of recently opened forms and pages appears in a circle attached to the Envelope icon. ŁA Triangle icon with an exclamation point next to the form or page name indicates that the form or pages has unsaved changes. ŁA Search icon (magnifying glass) on the top left can be used to find pages or forms using key words or the seven letter object identifier for the form or page. This search is performed on the menu data, therefore if the form or page is not included on the menu, it is not included in the search results. ŁThe Online Help icon (question mark) on the top right calls the online help for either a Banner 9.x page or a Banner transformed page. The Online Help icon (question mark) is also displa yed in the Application Navigator for Banner 8.x forms, but is not yet enabled for use in Banner 8.x. Use the Online Help icon (question mark in a circle) on the Banner 8.x toolbar to open the online help for a Banner 8.x form. ŁA home button (represented by the title in the navigation bar) can be used to return to the landing page. The text on this link is customizable by the institution. ŁThe landing page contains a search field which can be used to search for forms, pages, jobs, menus, and quickflows. If a form or page is selected, that form or page will open. If a menu item is selected from the landing page search results, the menu panel will open and the selected menu will be displayed. When an item is selected from the search results, the search results list is cleared. Page display bar elements Banner 9.x applications that are integrated with Application Navigator do not display the breadcrumb trail in the bar at the top of administrative pages that is used for navigation. Instead, the bar contains the following elements that can be displayed using indicators in the Display Options section on the General User Preferences Maintenance Page (GUAUPRF). ŁPage name long name and seven letter identifier The seven letter page name can be displayed by checking the Display Form Name on Title Bar indicator. ŁApplication version number The application version number can be displayed by checking the Display Release Number on Title Bar indicator. ŁDatabase instance The database instance can be displayed by checking the Display Database Instance on Title Bar indicator. /n 10Application Navigator Handbook |Seamless Navigation Unified MenuThe unified menu displays the existing Ba nner administrative menu system and is provided in addition to the Go To... and Related to Current list of pages used in Banner 9.x. The unified menu panel is displayed on the left side of the page and can be opened and closed. You can navigate up and down the menu tree in this panel and refer to the Recently Opened list.If the version of the application you are us ing cannot be integrated with Application Navigator, the application will not display the full Banner administrative menu system. Instead, the application will only display menu items related to pages that have not yet been integrated. The breadcrumb trail will still be displayed at the top of the page for navigation purposes. For exampl e, Banner Student C ourse Catalog 9.x will display Course Catalog pages as standalone pa ges, but those pages will not be displayed with in the unified menu in the Application Navigator. Unsaved changesApplication Navigator tracks the state of unsaved data in applications with which it has been integrated. The Recently Opened list displays an icon next to a page or application that has unsaved changes, as a visual cue for users. Additionally, when a user attempts to sign out of Application Navigator, he/she will be prompted when any page or form still has unsaved changes. QuickflowsBanner Quickflows can be launched from Appl ication Navigator. The Quickflow support is limited to launching a Quickflow that has forms or pages of a single technology type (In either INB or a Transformed Application with a Platform type of ADMJF on GUAPAGE). Each Quickflow must contain Forms/Pages in only one platform type in order for the Quickflow to run from Application Navigator. If the Quickflow has a mix of forms and pages of multiple types, the Quickflow will appear in the Application Navigator menu/search but when launched, the app lication will prevent th e Quickflow from runni ng. The user will see a message that the Quickflow cannot be executed. Pages that exist in a module with a platform type of ADMZK (on GUAPAGE) are not supported in Quickflows. In order to accommodate the ability to search for a Quickflow that has a length of less than three characters, the Application Navigator search was modified. The Application Navigator search field returns search results (which now includes forms, pages, jobs, menus and quickflows) when the user has entered three or more characters in the search field. /n 11Application Navigator Handbook |Seamless Navigation Search capabilities Perform a search by entering three or more characters in the search field. Note: Quickflows are an exception to the three-character rule. If you perform a search for the name of a quickflow that contains one or two characters it will be displayed in the search results. If it contains three or more characters, you will need to enter at least three characters. The Application Navigator search field returns search results that include the following. Łforms Łpages ŁjobsŁmenus Łquickflows Some forms and pages are opened by Banner when needed for processing, but the user cannot see or access them directly. These are included in the baseline version of the applicationNavigator_configuration file for ex clusion from the search, menu and Recently Opened. To prevent additional pages and forms from being displayed in the Search, Menu, and Recently Opened, add the page or form mnemonic to the delivered list included in the following parameter in the configuration file. seamless.excludeObjectsFromSearch = ["GUAGMNU","GUAINIT","GUQSETI"," FOQMENU","SOQMENU","TOQMENU","AO QMEMU","GOQMENU","ROQMENU" ,"NOQMENU","POQMENU" ] Job SubmissionYou can select a Banner job from the Application Navigator Menu or Search field. When you select a job, the Job Submission Controls form (GJAPCTL) will be displayed with the job name entered in the Process field. The version of GJAPCTL displayed is depende nt on the Banner8/Banner9 Display Option for that job on the Object Maintenance form (GUAOBJS). value of Banner8/Banner9 Display Option on GUAOBJSversion displayed All (Banner8 & Banner9)INB version Banner8 OnlyINB version /n 12Application Navigator Handbook |Seamless Navigation Banner9 OnlyNot supported Unified Menu All (Ban8 & Ban9)Banner 9 version Unified Menu Ban9 onlyBanner 9 version value of Banner8/Banner9 Display Option on GUAOBJSversion displayed /n 13Application Navigator Handbook |Module, Page, and Object Maintenance Module, Page, and Object MaintenanceThis chapter discusses using options on the Banner9 Module and Page Maintenance Form (GUAPAGE) and the Object Maintenance Form (GUAOBJS) with Application Navigator. Module and page maintenance The Banner9 Module and Page Maintenance Form (GUAPAGE) is used to create records for modules and pages and then assign the pages to specific modules. An object can only exist in one module. Here is a list of the fields with descriptions for GUAPAGE. FieldDescription The following fields are in the Module Code section. Module CodeBanner 9.x module code. Module codes are delivered with each application through an upgrade script. Module DescriptionBanner 9.x module description. Related application pages are delivered with the application as part of the upgrade. Platform TypePlatform type code that identifies a platform type used with Banner modules. Values come from GTVPLAT. Example codes could be ADMJF (Java Forms Administrative) and ADMZK (ZK Administrative).URLBanner 9.x administrative pages web application URL. The URL must be updated by the institution. IntegratedCheckbox used to indicate whether the module is integrated with the unified menu. This indicator should be updated after an institution has installed Application Navigator and wishes to run that module in an integrated mode (such as a Banner 9.x administrative application and Banner 8.x baseline administrative forms under one user interface, sharing the same menu). The following fields are in the Page Code section. /n 14Application Navigator Handbook |Module, Page, and Object Maintenance General Common moduleWhen using Application Navigator, a URL must be specified on GUAPAGE for the General Common (GC) module. Since the General Common module is delivered as part of each ADMZK administrative application, to ensure that the most recent version of those pages will be accessed, the General Common URL shou ld be specified as the URL of the most recent ADMZK administrative application that has been installed. There are several Banner 9.x application modu les that have delivered GUBPAGE records. However, these pages are not yet included in the application WAR files. The pages are: The affected Banner 9.x applications are: ŁBanner General Event Management ŁBanner Student Attendance Tracking ŁBanner Student Class Schedule ŁBanner Student Course Catalog It is not advisable to configure the General Common module URL with any of the four Banner 9.x modules listed abov e when installing either the Banner Student Registration (administrative), Banner Student Overall, or Banner Student Academic History modules. The General Common module URL must be same as one of the three Banner Student modules, preferably the one that was most recently installed. Object CodeObject code (form name) that is mapped to the Banner 9.x page. Values come from GUAOBJS. Page NameBanner 9.x page name. For Java administrative pages, the page name is delivered as seed data and is the same as the object code name. PageBanner 9.x page name GUIALTIalternateidsearch GUISRCHtelemailsearch GUQSRCHextendedsearch SOACOMPnonpersonsearch SOAIDENpersonsearch FieldDescription /n 15Application Navigator Handbook |Module, Page, and Object Maintenance Object maintenance and Banner 8.x/9.x display optionThe Banner8/Banner9 Display Option field is used within the Banner 8.x and Banner 9.x applications, and the Application Navigator to determine which menus should contain the object. On the Object Maintenance Form (GUAOBJS), this field displays the user interface version as one of the following options: ŁAll (Banner8 & Banner9) ŁBanner8 Only ŁBanner9 Only ŁUnified Menu All (Ban8&Ban9) ŁUnified Menu Ban9 Only Automatic updates of GUAOBJS display option based on GUAPAGE data During the installation of an application, new records for the module code, module description, and associated module pages (object codes and page names) are created and can be viewed on GUAPAGE. Each module includes a setting for the Integrated indicator. The unified menu is in use when the Integrated indicator for the module is selected on GUAPAGE. This setting is used to determine the setting of the Banner8/Banner9 Display Option field on GUAOBJS for all pages in that module. Applications with a platform type of ADMZK also contain a parameter in a configuration file that must be updated to integrate with Application Navigator. For more information, see the topic "Steps to implement seamless navigation". GUAPAGE records and effect on GUAOBJS Here are some scenarios about how the setting of the Banner8/Banner9 Display Option field on GUAOBJS affect page di splay for objects on GUAPAGE. Example 1The current value of the display option is Banner 8 Only for an object. The object is added to GUAPAGE in a newly installed module which has the Integrated indicator unchecked or N./n 16Application Navigator Handbook |Module, Page, and Object Maintenance After the menu rebuild, the disp lay option will be updated to All (Banner8 & Banner9) for pages in that module. Example 2The current value of the display option is Banner 8 Only for an object. The object is added to GUAPAGE in a newly installed module which has the Integrated indicator checked or Y.After the menu rebuild, the disp lay option will be updated to Unified Menu All (Ban8&Ban9) for pages in that module. Example 3A module has been previously installed and then is subsequently released with support for Application Navigator. The setting of the Integrated indicator can be manually updated for that module. After the menu rebuild, the disp lay option will be updated to Unified Menu All (Ban8&Ban9) for pages in that module. Facilitate menu rebuild If you are using a version of GUAPAGE that is at Banner General 8.7.5 Controlled Release or higher, the menu rebuild is run automatically after the Integrated indicator setting is changed on GUAPAGE. If you are using a version of GUAPAGE that is prior to Banner General 8.7.5 Controlled Release, the menu rebuild is not run automatically after the Integrated indicator setting is changed on GUAPAGE. In this case, you can perform one of the following tasks to trigger the menu rebuild. ŁUpdate a record on the Menu Maintenance Form (GUTGMNU). ŁUpdate the Description field for an object on GUAOBJS. The user interface version in the Banner8/Banner9 Display Option field does not need to be manually updated from All (Banner8 & Banner9) to Unified Menu All (Ban8&Ban9) , since the menu rebuild will automatica lly set the correct values based on the data in GUAPAGE. Form and page access comparison Here is a comparison of where forms and pages are accessed, based on the user interface version on GUAOBJS. /n 17Application Navigator Handbook |Module, Page, and Object Maintenance The user interface version can be manually updated to prevent the Banner 8.x version of a form from being accessed. ŁWhen the value is All (Banner8 & Banner9) , change it to Banner9 Only . ŁWhen the value is Unified Menu All (Ban8&Ban9) , change it to Unified Menu Ban9 Only .After the manual update is done, run the menu rebuild. If no GUBPAGE record exists for Unified Menu All (Ban8&Ban9) , the menu rebuild will sw itch the value back to Banner8 Only .Display results comparison Here is a comparison of the expected results for Application Navigator and standalone display, based on the user interface setting on GUAOBJS. User Interface VersionDisplayed In Banner8 Only Banner 8.x All (Banner8 & Banner9) Banner 8.x Banner 9.x applications that have not been integrated with the Application Navigator Banner9 Only Banner 9.x applications that have not been integrated with the Application Navigator Unified Menu All (Ban8&Ban9) Banner 8.x Banner 9.x applications that have been integrated with the Application Navigator Unified Menu Ban9 Only Banner 9.x applications that have been integrated with the Application Navigator GUBOBJS User Interface Version Using Application NavigatorRunning Standalone All (Banner8 & Banner9) The Banner 8.x version of the form is opened, as this option is not unified. The Banner 8.x form is opened. The Banner 9.x administrative page is opened when the administrative application is in use.Banner8 Only The Banner 8.x version of the form is opened. N/A/n 18Application Navigator Handbook |Module, Page, and Object Maintenance Banner9 Only The administrative page is not included on the unified menu. A message is displayed in Banner 8.x that the user is not authorized for access. The Banner 9.x administrative page is opened when the administrative application is in use.Unified Menu All (Ban8&Ban9) The Banner 9.x version of the administrative page is opened. The Banner 8.x form is opened. The Banner 9.x administrative page is not included in Banner 9.x menu. Unified Menu Ban9 Only The Banner 9.x version of the administrative page is opened. A message is displayed in Banner 8.x that the user is not authorized for access. The Banner 9.x administrative page is not included in Banner 9.x menu. GUBOBJS User Interface Version Using Application NavigatorRunning Standalone /n 19Application Navigator Handbook |Timeout Handling Timeout Handling This chapter discusses using timeouts with Application Navigator and other integrated applications. OverviewApplication Navigator keeps the user session a live while the user performs activities such as accessing the main menu, searching for menu items, selecting pages from the Recently Open list, and opening online help. Timeouts can be set up in Application Navigator for all users. These timeouts work with embedded applications and are separate from Banner timeouts. Users are notified when their session is abou t to expire, and they have the option to refresh the session and continue working. When the user refreshes the session, the timeout counter is reset. The session remains acti ve as long as Application Navigator is in use. The session expires if Application Naviga tor remains inactive for a specific amount of time. Once the timeout threshold has been reached and the user is notified that the session is about to expire, the user is also notified when any unsaved changes exist. When the session expires, any unsaved changes will be lost. Note: It is expected behavior that once the timeout threshold has been passed and session timeout is inevitable, even if the user performs an action in the final seconds of the timeout countdown, the timeout may still occur. Administrators can specify the timeout threshold for user sessions, as well as the threshold for user notification that the session is about to expire. When the session expires, the user is logged out of Application Navigator and all integrated applications. It is recommended that the setting of the timeou t threshold for the individual applications be set to a value that is much greater than the timeout setting for Application Navigator. When all applications are in active, Application Navigator will still handle the synchronized logout when the user is inactive for longer than the specified timeout threshold. Note: When an embedded application has not yet been updated to support timeout integration with Application Navigator, the user can be active in Application Navigator and still experience an unexpected timeout in the application, without being aware of that timeout until the application is selected as the primary active window. When a user has multiple applications open, timeout messages for those applications may be displayed through Application Navigator. When a user has multiple browser windows open and is not on the browser window that is displaying the Application Navigator timeout /n 20Application Navigator Handbook |Timeout Handling warning message, he/she can miss the message and fail to extend the session. In this situation, the application will time out, and the user will be logged out of Application Navigator and all integrated applications. A scenario exists where the Banner 9.x application can time out while Application Navigator remains active. Here are the details. The Banner 9.x administrative applicatio ns that are integrated with Application Navigator do not yet support the Timeou t Integration API. (This capability will be added in future releases.) But, all applications, regardless of whether or not they support the Timeout Integration API, contain their own built-in timeout processing. In this case, the existi ng embedded applications will respond to the specific application's built-in ti meout processing but will have li mited response to Application Navigator™s timeout processing. A limited nu mber of activities performed in that application can keep Application Navigator active, (such as entering Key block values or opening and closing pages). If a user has multiple Banner 9.x administrative applications open (and those applications do not have integrated timeout support with Application Navigator) and he/she is active in one of the applications, the other applications can time out due to lack of activity, without the user bei ng aware that the timeout has occurred. ConfigurationApplication Navigator contains a configurable timeout property (seamless.sessionTimeout ) in the applicationNavigator_ configuration.groovy file that overrides the value set in the web.xml file. This variable sets the application HTTP session to the new value in minutes. The seamless.sessionTimeoutNotification property is used to display the prompt and notify the user that the session is about to expire. Here is an example of setting the timeout values in the applicationNavgator_configuration.groovy file.seamless.sessionTimeoutNotification = 5 // mins seamless.sessionTimeout = 30 // mins /n 21Application Navigator Handbook |Timeout Handling Here is a summary of the seamless timeout configuration properties. PropertyDescription seamless.sessionTimeout Time in minutes before session timeout occurs. ŁValue of -1 indicates the session will not time out. Warning: When this setting is used, the session will not expire unless the user signs out. ŁValue of 0 indicates the session will expire immediately. ŁDefault value is 30 minutes. seamless.sessionTimeout Notification Notification prompt in minutes before session timeout occurs. Default value is 5 minutes. /n 22Application Navigator Handbook |Java Administrative Pages Java Administrative PagesThis section discusses Application Navigator and Banner Java administrative pages. The Banner Menu Package (GUKMENU) and the Banner9 Module and Page Maintenance Form (GUAPAGE) support using Java administrative pages. ŁThe GUKMENU package is used to determine which version of the Banner form or page is to be displayed, based on the platform ty pe, when the form or page is accessed from a menu in Application Navigator. ŁThe Platform Type field on GUAPAGE is used to indicate the platform type code associated with the Banner module. Platform type codes are defined on the Platform Type Validation Form (GTVPLAT) and are used specifically with Application Navigator. The ADMJF code (Java Forms Administrative) is used with applications that have Java administrative pages. Please refer to the Banner General Release Guide 8.7.5 for more information. /n 23Application Navigator Handbook |Module Configuration Override Module Configuration OverrideThis chapter discusses overriding the module configuration used with the Banner menus and the Menu Service. This functionality allows for multiple deployments of Application Navigator, where each deployment points to a different deployment of Banner 9.x modules that are running against a single Banner database instance. Note: This functionality is intended for technical users in a test or pre- production environment. OverviewApplication Navigator displays Banner menu items in the Menu and Search option for the Banner administrative applications. Previous ly, only URLs from the GUBMODU table were used. This setup created a one-to-one dependency between Application Navigator and the database instance. Users could not install more than one version of the same application within a single database (such as pointing a development environment and a test environment to Application Navigator). Now, when your institution has Banner Applications deployed on different application servers but pointing to a centralized Banner Database and CAS server, you can override the GUBMODU module URL configuration using module URL overrides as mappings to the applicationNavigator_configuration.groovy file. For example: module.deployments = [ "" : "","" : ""] MODULE_URL format same as GUBMODU_URL which is in the format of http:// :// ]Note: The MODULE_CODE value above should be same as GUBMODU_CODE value. Override setupWhen menus are generated by the Menu Servic e, Application Navigator checks whether a configuration override exists for any GUBMODU_CODE value. If an override is found, the MODULE_URL value is used. When no configuration override exists, the Menu Service uses the GUBMODU_URL value./n 24Application Navigator Handbook |Module Configuration Override Here is an example of GUAPAGE form/G UBMODU table entries for the module configuration override in the applicationNavigator_configuration.groovy file.Here is an example of the configuration entries in the applicationNavigator_ configuration.groovy file.module.deployments = [ "SF" : "http://TEST_SERVER_HOST:PORT/StudentRegistration/", "SO" : "http://TEST_SERVER_HOST:PORT/StudentOverall/" ] In this example, Application Navigator would render the Registration and Overall application menu URLs to point to the TEST_SERVER_HOST instead of the PREPROD_SERVER_HOST that was originally configured in the database (GUBMODU table). GUBMODU_CODEGUBMODU_URL SFhttp://PREPROD_SERVER_HOST:PORT/ StudentRegistration/ SOhttp://PREPROD_SERVER_HOST:PORT/ StudentOverall/ /n 25Application Navigator Handbook |Deep-Linking Deep-LinkingThis chapter discusses using Application Navigator with deep-linking. OverviewApplication Navigator supports parameter pass ing for deep-linking. This means that it can recognize parameters passed by an external system and then forward these parameters to the target application. Parameters can be passed from the following external applications: Luminis portlets and Banner Workflow. Parameter definitionThe parameters are defined as inbound_args in the following format: [param-name]::[param-value]::[param-name]::[param-value] Parameters for the param-name are defined in the GURTRAN table. You must define the query parameter inbound_args in the URL construct for deep- linking. If your external application does not have a valid parameter name or value to pass, then ensure the placeholders are still part of the URL request as shown in the example below. http://:/applicationNavigator/ channels?launch_form=PEAREW&inbound_args=param-name::param-value Here are examples for calling Internet Native Ba nner (INB) and Bann er 9.x applications from Luminis. Luminis to an Internet Native Banner linkhttp://:/applicationNavigator/ channels?launch_form=SFAALST&inbound_args=term::199310::crn::20064 ParameterParam-nameParam-value termKEY_TERMglobal.term.lookup bannerIdKEY_IDNOglobal.bannerid.lookup CRNKEY_CRNglobal.crn.lookup /n 26Application Navigator Handbook |Deep-Linking Luminis to a Banner 9.x administrative page link http://:/applicationNavigator/ channels?launch_form=SOATERM&inbound_args=term::213016 Luminis to a Banner 9.x Human Resources Java page linkhttp://:/applicationNavigator/ channels?launch_form=PEAREW&inbound_args=bannerId::SYS000022 /n 27Application Navigator Handbook |Troubleshooting Troubleshooting Here is troubleshooting information for seamless navigation between Banner 8.x forms and Banner 9.x administrative applications. Invalid user interface version errorOn the GUAOBJS form, when the Banner8/Banner9 Display Option field is set to a value that indicates the page is a Banner 9.x page and the Banner 9.x page does not exist in the environment, the Application Navigator displays the page on the menu. However, when the page is selected from the menu, it is not displayed. Instead, a 404 error is displayed, and the user is forced to sign out. To correct this issue, the Banner 9.x page entry must be removed from the GUAPAGE form, and the menu rebuild procedure must be executed. When the page is not listed on GUAPAGE, the Banner8/Banner9 Display Option field value can be manually updated on GUAOBJS to Banner8 Only . After this has been done, the Application Navigator displays the page on the menu and when the page is selected, it is properly displayed. The 40 4 error will not be displayed. Access Banner menu data logs When you do not have access to Banner menu data and try to authenticate to the Application Navigator, no menus will be display ed on the user interface. If this occurs, contact your administrator, who can check the Application Navigator logs and identify the root cause. The menu servic e captures all the exceptions and writes them to the Application Navi gator log file. Global variables not p assed between Banner 8.x and Banner 9.xIf global variables (Key block data) are not being transferred between Banner 8.x forms and Banner 9.x pages, there may be a problem with data in the GURTRAN table. GURTRAN provides a cross-reference between Banner 8.x global variable names and Banner 9.x global variable names. This table is updated by the scui_gurtrani.sql script as part of the Banner 9.x database upgrade process. /n 28Application Navigator Handbook |Troubleshooting You must query the GURTRAN table to determine whether the variables are populated. If the variables are not populated, re-run the scui_gurtran.sql script to add the translation values. Note: If you have modified the Key block of any Banner 9.x application, or if you have developed your own administrative pages, you may need to add further translation values to GURTRAN. The scui_gurtran.sql script can be modified to populate the required translation values. User not able to open a second INB form when running seamless navigationSee these articles for more information. ŁArticle 000033474 - Ru nning Application Navigator and only one INB form will open - Liveconnect Security Exception ŁArticle 000030656 - Java 7 secu rity restrictions with Liveconnect calls to Oracle Forms AppletPointers for running seamless navigation with Banner FormsSee these articles for more information. ŁArticle 000032407 - Implemen ting Seamless Navigation En hancement Utility on Linux/ UnixŁArticle 000032952 - Banner 9.x and Cygwin and Seamless Navigation seamapiBanner.shl java.lang.Exception _jni _initialize when not using an X-Windows session on Linux ŁArticle 000033237 - Running seamApiBanner.shl and getting java.lang.Exception _jni_initialize Failed to create new forms context Pointers for enabling seamless navigation for Banner 9.x applicationsSee these articles for more information. /n 29Application Navigator Handbook |Troubleshooting ŁArticle 000032067 - Implementing Seamless Navigation and Application Navigator in Banner 9.x ŁArticle 000031168 - Setting up Application Navigator and getting the error: "FRM-92190: JavaScript is unable to evaluate expression" when opening any form ŁArticle 000031814 - How to enable or disabl e the Banner XE Admin integration with Application Navigator Oracle Forms Javascript error after upgrading Banner General releaseAs part of the Banner General upgrade, make sure to update the banner8_integration.js file from the Banner source tree. If this is not done, the following error is displayed at run time when INB is accessed: Oracle FRM-92190: Javascript is unable to evaluate expression Make sure to restart your Oracle Forms Server for the new changes to take effect. /n

Application_Navigator_Handbook_1.4.pdf (461.8 KB)
Helpful?

Related Articles: