Ellucian Recruiter Integrating Recruiter with Banner. Recruiter Release 3.1 Banner Student Release September 27, 2013

Transcription

1 Ellucian Recruiter Integrating Recruiter with Banner Recruiter Release 3.1 Banner Student Release September 27, 2013

2 Banner, Colleague, Luminis and Datatel are trademarks of Ellucian or its affiliates and are registered in the U.S. and other countries. Ellucian, PowerCampus, Advance, Degree Works, fsaatlas, Course Signals, SmartCall, Recruiter, and ILP are trademarks of Ellucian Company L.P. or its affiliates. Other names may be trademarks of their respective owners Ellucian Company L.P. and its affiliates. The unauthorized possession, use, reproduction, distribution, display or disclosure of this material or the information contained herein is prohibited. Contains confidential and proprietary information of Ellucian and its subsidiaries. Use of these materials is limited to Ellucian licensees, and is subject to the terms and conditions of one or more written license agreements between Ellucian and the licensee in question. In preparing and providing this publication, Ellucian is not rendering legal, accounting, or other similar professional services. Ellucian makes no claims that an institution's use of this publication or the software for which it is provided will 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. Prepared by: Ellucian 4375 Fair Lakes Court Fairfax, Virginia United States of America

3 Contents Introduction About This Manual Who Should Read This Manual What This Manual Covers How This Manual Is Organized Installation Order Locating the Software Where to Find More Information Banner Recruiter Integration Manager Installation Preparing Banner for Recruiter Before You Begin Create a Banner Recruiter Integration User Install the Banner Recruiter Integration Seed Data Banner Recruiter Integration Seed Data Windows Installer Banner Recruiter Integration Seed Data Unix Installer Manually Creating Seed Data Using SQL Scripts Configuring BEP for Banner Recruiter Integration Understanding the BEP Events Installing BEP Verifying the BEP 1.2 Installation Integration Recruiter with Banner Contents 3

4 Configuring BEP 1.2 for Banner Recruiter Integration Create Event Metadata Enabling and Disabling BEP Events Configuring the Confirmed Date Decision Code Configuring the Confirmed Date Deposit Detail Code Configuring the Enrolled Date Decision Code Create Durable Subscribers Installing and Configuring the Banner Recruiter Integration Manager. 33 Before You Begin Installation Considerations Managed Server Considerations Create and Configure the Recruiter Managed Server Install the Banner Recruiter Integration Manager Create the JNDI Data Source for Banner Recruiter Integration Create Banner Recruiter Integration Manager Users Create Banner Recruiter Integration Manager Security Roles Assign Users to the Banner Recruiter Integration Manager Security Roles Configure Banner Recruiter Integration Manager Restart the Recruiter Managed Server Provisioning and Integration Importing Data Provisioned From Banner Application Decision Codes Validation Code Provisioning Files Institution Provisioning Files Prospect Provisioning Files Integration Recruiter with Banner Contents 4

5 Importing Provisioned Data Into Recruiter Exporting Custom Fields to Banner Export Additional Fields From Recruiter Create PL/SQL Code PL/SQL Example PL/SQL Package Specification PL/SQL Package Body Removing the Link Between Records in Banner and Recruiter Create a Workflow to Remove Integration Link for Deactivated Prospects Banner Recruiter Integration Manager Using the Banner Recruiter Integration Manager Configuration Configuring the Banner Recruiter Integration Manager Testing the Banner Recruiter Integration Manager Connection Loader Errors Match/Push Messages Match Errors Push Errors Event Errors Troubleshooting Banner Recruiter Integration Troubleshooting Record Sent From Recruiter Not Received By Banner Test Recruiter Connection to Banner Check for Loader Errors Check for Match Errors Integration Recruiter with Banner Contents 5

6 Check for Push Errors Record Sent From Banner Not Received By Recruiter Test Banner Connection to Recruiter Verify that the JMS Subscription Is Running Verify that Banner Event Publishing Is Running Restart the BEP Managed Server Enable Logging in the Banner Recruiter Integration Manager Integration Recruiter with Banner Contents 6

7 Integration Recruiter with Banner Contents 7

8 Integrating Recruiter with Banner Introduction

9 About This Manual Who Should Read This Manual Anyone responsible for configuring and integrating Ellucian Recruiter with Banner by Ellucian should read this manual. Typically, the procedures in this manual would be performed by a Banner administrator in conjunction with a Recruiter administrator. What This Manual Covers Recruiter is designed to work with Colleague by Ellucian, Banner, or another Enterprise Resource Planning (ERP) system. This manual contains procedures for installing the Banner Recruiter Integration Manager and integrating with the Banner ERP system. For information about integrating with Colleague, see the Integrating Recruiter with Colleague manual. For information about integrating with another ERP system, see the "ERP Integration" section of the Recruiter Installation Procedures manual. How This Manual Is Organized The Introduction section, which you are reading now, provides information about this manual and its organization. The Banner Recruiter Integration Manager Installation section provides information and procedures about installing and configuring the Banner Recruiter Integration Manager. The Provisioning and Integration section provides information and procedures about provisioning data from Banner and importing the provisioned data into Recruiter. It also provides information about exporting custom fields to Banner and removing links between records in Banner and Recruiter. The Banner Recruiter Integration Manager section provides information about using the Banner Recruiter Integration Manager. The Banner Recruiter Integration Troubleshooting section provides information about troubleshooting communication and data transfer issues between Recruiter and Banner. Integrating Recruiter with Banner About This Manual 9

10 Installation Order It is recommended that you install Recruiter and Banner products in the following order. 1. Recruiter Web Services Recruiter Recruiter External Site Payment Gateway 1.2 Optional 5. Banner Student Release Banner Event Publisher Banner Recruiter Integration Manager 1.0 Locating the Software The Recruiter and Banner software is available on the Ellucian Support Center website. You can download the following software by using the "Colleague, Recruiter and related products" link in the Download Code section of the Ellucian Support Center website: Recruiter Web Services 3.1 Recruiter CRM 3.1 Recruiter External Website 3.1 You can download the following software by using the "Banner, PowerCampus, Advance and all other Ellucian products" link in the Download Code section of the Ellucian Support Center website: Banner Student Release Banner Event Publisher 1.2 Banner Recruiter Integration Manager 1.0 Payment Gateway 1.2 Integrating Recruiter with Banner About This Manual 10

11 Where to Find More Information Table 1 lists sources of information to help you install and administer Recruiter. Note: Recruiter documentation is available from the Ellucian Support Center, "Ellucian Recruiter" documentation library. You can view all of the documentation for the Recruiter 3.1 release in the Recruiter 3.1 content pack. Table 1: Additional Sources of Information for Installation Type of Information New features and changes in this release Installing Recruiter 3.1, or upgrading to Recruiter 3.1 from Recruiter 2.6 or 3.0. Installing and setting up the e-commerce Payment Gateway Microsoft products and support Microsoft Dynamics CRM Conceptual information for understanding the Recruiter software, its features, and the processes that you can manage using Recruiter Specific Recruiter concepts and tasks Source Recruiter 3.1 Release Highlights Recruiter Installation Procedures Payment Gateway 1.2 Installation Procedures Default.aspx Guide to Using Recruiter Recruiter Online Help In Recruiter, in the Navigation Pane, click Workplace. In the Recruiter Help section, click Help Articles. To view the Table of Contents, click the Help tab, and then click Recruiter Help. Specific Microsoft Dynamics CRM concepts and tasks Microsoft Dynamics CRM Online Help In Recruiter, click File > Help > Contents (or click Help on This Page for context-sensitive help). Information about the Banner Student release that integrates with Recruiter 3.1 Configuring Recruiter for your institution Styling the Recruiter external website for your institution Banner Student Release Guide Recruiter Configuration Styling the Recruiter Website Integrating Recruiter with Banner About This Manual 11

12 Integrating Recruiter with Banner About This Manual 12

13 Integrating Recruiter with Banner Banner Recruiter Integration Manager Installation

14 Preparing Banner for Recruiter Before you can provision data from Banner for use in Recruiter, you must prepare the Banner database to store information that will be sent from Recruiter. This chapter will guide you through the process of running the Banner Recruiter Integration Seed Data installer. The Banner Recruiter Integration Seed Data installer is available as a Windows installer and as a Unix/Linux installer. In addition, steps are included to create the necessary seed data using provided SQL scripts. Before You Begin Before running the Banner Recruiter Integration Manager installer, you must install Banner Student See the Banner Student Upgrade Guide manual for Release for more information. Create a Banner Recruiter Integration User An Oracle user must be created that will be used by the Banner Recruiter Integration Manager to push data from Recruiter into the Banner database. This user can be created using a database script provided by Ellucian or by following your institution s procedures for creating new users. Note: If you do not use the provided database script, you must ensure that you create a new user, create a new role, and assign that role to the user. 1. Connect to your Banner database as the privileged baninst1 user, using your preferred database management application. 2. Run the following script against the database: Note: The script below is the sample_create_user_and_role.sql file included in the BannerRecruiterIntegrationManager.jar file. Change the default values for username, password, tablespace, and rolename to suit your institution s standards Create Oracle User and Role for use with Banner -- Recruiter Integration Manager -- Integrating Recruiter with Banner Preparing Banner for Recruiter 14

15 DEFINE username = 'BRIM_USER' DEFINE password = 'brimpassword' DEFINE tablespace = 'USERS' DEFINE rolename = 'BRIM_ROLE' -- CREATE USER &username IDENTIFIED BY &password DEFAULT TABLESPACE &tablespace QUOTA UNLIMITED ON &tablespace; ALTER USER &username ACCOUNT UNLOCK; GRANT CONNECT TO &username; -- CREATE ROLE &rolename; -- GRANT &rolename TO &username; Install the Banner Recruiter Integration Seed Data The Banner Recruiter Integration Seed Data installer is available as a Windows installer and as a Unix/Linux installer. In addition, SQL scripts are provided that can be used to manually create the seed data instead of using the Windows or Unix/Linux installers. The following information is required when creating the seed data. You will need to consult with Banner functional staff to determine the values that they want to use for the PREL, INFC, and SQPR codes. Banner Recruiter Integration username and role. This is the user and role that was created in Create a Banner Recruiter Integration User on page 14. PREL code. This code is used for integration. The PREL code is limited to four characters, and cannot already exist on STVPREL or STVEGRP because Banner requires the PREL code and the EGRP code to be set to the same value. INFC code. This code is used when converting data from Recruiter to Banner. The INFC code is limited to four characters and cannot already exist on STVINFC SQPR code. This code is used for building the new curriculum crosswalk table. The SQPR code is limited to four characters and cannot already exist as a process code on GTVSQPR. In addition, no existing rules on GTVSQRU or parameters on GTVSQPA should start with this code. Note: Typically, the INFC and the SQPR codes are the same as the PREL code. Recruiter Response Service URL. This is the URL to the ERP Response Service website that is installed as part of Recruiter 3.1. Note: If you do not know your Recruiter Response Service URL, you can enter any validly formatted URL, such as You can enter the correct Recruiter Response Service URL later in the Banner Integrating Recruiter with Banner Preparing Banner for Recruiter 15

16 Recruiter Integration Manager. See Configuring the Banner Recruiter Integration Manager on page 59 for more information. Banner Recruiter Integration Seed Data Windows Installer To load the Banner seed data using the Windows installer, perform the following steps. Note: The following procedure must be performed on your Banner database server. The installer uses the value of the ORACLE_SID environment variable as the database to which it connects. Verify that this value is set correctly before running the installer. Note: The installer requires Java. Ensure that Java is in your PATH environment variable before running the installer. 1. Extract the brim_setup.exe file from the BannerRecruiterIntegrationManager.jar file. 2. Right-click the brim_setup.exe file, and select Run as administrator. 3. On the Introduction screen, click Next. 4. On the BANINST1/SYSTEM Password screen (Figure 1), enter the following information: The password for the Oracle BANINST1 user. The password for the Oracle SYSTEM user. Figure 1: The BANINST1 and SYSTEM Password Screen 5. Click Next. Integrating Recruiter with Banner Preparing Banner for Recruiter 16

17 On the Prerequisites Have Been Met screen (Figure 2), the installer verifies that your system meets the minimum requirements. Figure 2: The Prerequisites Have Been Met Screen 6. Click Next. 7. On the Seed Data to Insert screen (Figure 3), enter the following information: The Banner Recruiter Integration username. The role name for the Banner Recruiter Integration user. The PREL code to use for integration. The INFC code to use when converting data from Recruiter to Banner. The SQPR code that will be used for building the new curriculum crosswalk table. The URL for the Recruiter Response Service. Note: If you do not know your Recruiter Response Service URL, you can enter any validly formatted URL, such as You can enter the correct Recruiter Response Service URL later in the Banner Recruiter Integration Manager. See Configuring the Banner Recruiter Integration Manager on page 59 for more information. Integrating Recruiter with Banner Preparing Banner for Recruiter 17

18 Figure 3: The Seed Data to Insert Screen 8. Click Next. 9. On the Choose Staging Directory screen (Figure 4), enter the location where you want to save the scripts that are run by the Banner Recruiter Integration Manager installer. You can review the contents of the scripts that are generated, or make changes and rerun them if necessary. Figure 4: The Choose Staging Directory Screen 10. Click Next. Integrating Recruiter with Banner Preparing Banner for Recruiter 18

19 11. On the Pre-Installation Summary screen (Figure 5), review the information, and then click Install. Figure 5: The Pre-Installation Summary Screen 12. When the installation is finished, click Done to exit the installer. Integrating Recruiter with Banner Preparing Banner for Recruiter 19

20 Banner Recruiter Integration Seed Data Unix Installer To load the Banner seed data using the Unix installer, perform the following steps. You can also run the Banner Recruiter Integration Manager Unix installer in a Linux environment. Note: The following procedure must be performed on your Banner database server. The installer uses the value of the ORACLE_SID environment variable as the database to which it connects. Verify that this value is set correctly before running the installer. Note: The installer requires Java. Ensure that Java is in your PATH environment variable before running the installer. 1. In the Unix command-line, extract the brim_setup.bin file from the BannerRecruiterIntegrationManager.jar file. 2. Navigate to the directory containing the brim_setup.bin file. 3. Enter chmod +x brim_setup.bin to give the installer execute permission. 4. Enter./brim_setup.bin to launch the installer, and then press Enter. 5. On the Introduction screen, press Enter. 6. On the Password for BANINST1 screen (Figure 6), type the password for the Oracle BANINST1 user, and then press Enter. Figure 6: The Password for BANINST1 Screen Password for BANINST Enter requested information baninst1 password will be used to insert seed data Password for Oracle BANINST1 User: * 7. On the Password for SYSTEM screen (Figure 7), type the password for the Oracle SYSTEM user, and then press Enter. Integrating Recruiter with Banner Preparing Banner for Recruiter 20

21 Figure 7: The Password for SYSTEM Screen Password for SYSTEM Enter requested information SYSTEM password will be used to give BANINST1 user DBA privileges Password for Oracle SYSTEM User : * On the Prerequisites Have Been Met screen (Figure 8), the installer verifies that your system meets the minimum requirements. Figure 8: The Prerequisites Have Been Met Screen Prerequisites have been met Banner Student Version : Your system meets the requirements and hence you may proceed with the installation. PRESS <ENTER> TO CONTINUE: 8. Press Enter. 9. On the Seed Data to Insert screen (Figure 9), enter the following information, pressing Enter after each entry: Note: The default value for each prompt is blank when you first enter the Seed Data to Insert screen. If any of your entries fail the validation check, the Seed Data to Insert screen will be displayed again, and your initial entries will be displayed as the default values. The Banner Recruiter Integration username. The role name for the Banner Recruiter Integration user. The URL for the Recruiter Response Service. Note: If you do not know your Recruiter Response Service URL, you can enter any validly formatted URL, such as You can enter the correct Recruiter Response Service URL later in the Banner Recruiter Integration Manager. See Configuring the Banner Recruiter Integration Manager on page 59 for more information. Integrating Recruiter with Banner Preparing Banner for Recruiter 21

22 The PREL code to use for integration. The INFC code to use when converting data from Recruiter to Banner. The SQPR code that will be used for building the new curriculum crosswalk table. Figure 9: The Seed Data to Insert Screen Seed Data to Insert Enter requested information The values entered in this panel will be validated If Validation fails you will be asked to enter again If validation succeeds the values will be inserted into the database Banner Recruiter Integration Username(This field cannot be left empty.) (DEFAULT: ): Rolename for Banner Recruiter Integration User(This field cannot be left empty.) (DEFAULT: ): Recruiter Response Service URL(This field cannot be left empty.) (DEFAULT: ): PREL Code(This field cannot be left empty.) (DEFAULT: ): INFC Code(This field cannot be left empty.) (DEFAULT: ): SQPR Code(This field cannot be left empty.) (DEFAULT: ): 10. On the Choose Staging Directory screen (Figure 10), enter the location where you want to save the scripts that are run by the Banner Recruiter Integration Manager installer, and then press Enter. You can review the contents of the scripts that are generated, or make changes and rerun them if necessary. Integrating Recruiter with Banner Preparing Banner for Recruiter 22

23 Figure 10: The Choose Staging Directory Screen Choose Staging Directory The seed data scripts that are generated and installed as a part of this installation will be placed in this folder. Where would you like to Save the Scripts? Default Install Folder: /tmp/brim ENTER AN ABSOLUTE PATH, OR PRESS <ENTER> TO ACCEPT THE DEFAULT : 11. On the Pre-Installation Summary screen (Figure 11), review the information, and then press Enter. Figure 11: The Pre-Installation Summary Screen Pre-Installation Summary Please Review the Following Before Continuing: Product Name: BRIM Install Folder: /tmp/brim Disk Space Information (for Installation Target): Required: 51,174 bytes Available: 4,169,969,664 bytes PRESS <ENTER> TO CONTINUE: 12. On the Ready To Install screen, review the installation location, and then press Enter to begin the installation. 13. When the installation has finished, press Enter to exit the installer. Integrating Recruiter with Banner Preparing Banner for Recruiter 23

24 Manually Creating Seed Data Using SQL Scripts To manually create the seed data using the provided SQL scripts, perform the following steps. 1. Extract the create_grants.sql and create_seed_data.sql files from the BannerRecruiterIntegrationManager.jar file. 2. Connect to your Banner database as the privileged baninst1 user, using your preferred database management application. 3. Open the create_grants.sql file in the database management application. 4. Locate the following entry: DEFINE rolename = 'BRIM_ROLE' 5. Replace BRIM_ROLE with the name of the role you created in Create a Banner Recruiter Integration User on page Run the script against the database. 7. Open the create_seed_data.sql file in the database management application. 8. Locate the following entries: DEFINE recrintg_user_id = 'BRIM_USER' DEFINE prel_code = 'BRIM' DEFINE infc_code = 'BRIM' DEFINE sqpr_code = 'BRIM' DEFINE response_service_url = ' Datatel.ERcruiting.Erp.Response.Services' 9. Replace the following in the above entries: BRIM_USER. Replace with the Banner Recruiter Integration username. BRIM. Replace with the appropriate PREL, INFC, and SQPR codes. Datatel.ERcruiting.Erp.Response.Services. Replace with the URL for the Recruiter Response Service. Note: If you do not know your Recruiter Response Service URL, you can leave the default value. You can enter the correct Recruiter Response Service URL later in the Banner Recruiter Integration Manager. See Configuring the Banner Recruiter Integration Manager on page 59 for more information. 10. Run the script against the database. Integrating Recruiter with Banner Preparing Banner for Recruiter 24

25 Configuring BEP for Banner Recruiter Integration The Banner Recruiter Integration Manager uses the Banner Event Publisher (BEP) interface to monitor changes in the Banner database and, based on specific changes, send XML messages containing those changes to Recruiter. These XML messages are then used by Recruiter to synchronize data in Recruiter with the data in Banner. Understanding the BEP Events The BEP events monitor certain fields in Banner, and when information is entered into these fields, sends messages to Recruiter. By default, all of the delivered events are enabled, but you will need to disable certain events depending on the needs of your institution. See Enabling and Disabling BEP Events on page 29 for more information about enabling or disabling BEP events. The following events should remain enabled: RECRUITER_ERP_ID This event causes a prospect s Banner ID and Enterprise Identifier to be sent to Recruiter when the prospect s unique ID from Recruiter is inserted into the SRBRCID table. The unique ID is saved in SRBRCID the first time a prospect s profile or application is sent from Recruiter. This event facilitates successful integration between the Banner and Recruiter systems. RECRUITER_APPLICATION_STATUS This event causes the full set of admissions decisions applied to an application to be sent to Recruiter any time one of the decisions is inserted, changed, or deleted in Banner. The application must have originated from Recruiter, and the applicant must have a Recruiter GUID recorded in the SRBRCID table. The decisions are displayed as Application Statuses in Recruiter on the profile and the application. Each time the message is received in Recruiter it replaces the existing set of application statuses with the new set. This event ensures that application statuses are kept up to date in Recruiter. The following events send an Admit Date message to Recruiter. You should enable one and disable the other: RECRUITER_ADMIT_DATE_APPLACCEPT This event causes the decision date to be sent to Recruiter when a decision is applied to an application, and that decision has the Applicant Acceptance indicator selected. The application must have originated from Recruiter, and the applicant must have a Recruiter GUID recorded in the SRBRCID table. The date is displayed as the Admit Date on the profile in Recruiter. Integrating Recruiter with Banner Configuring BEP for Banner Recruiter Integration 25

26 If the Admit date has already been sent to Recruiter for the prospect, term, and application ID, a new message is not sent to Recruiter. Note: If the RECRUITER_ADMIT_DATE_INSTACCEPT event is enabled, this rule should be disabled. It is also recommended that the admit and enrolled date events be coordinated. This event should not be used if the RECRUITER_ENROLLED_DATE_APPLACCEPT event is enabled to send the admit date to Recruiter. RECRUITER_ADMIT_DATE_INSTACCEPT This event causes the decision date to be sent to Recruiter as the admit date when a decision is applied to an application, and that decision has the Institution Acceptance indicator selected. The application must have originated from Recruiter, and the applicant must have a Recruiter GUID recorded in the SRBRCID table. The date sent is displayed as the Admit Date on the profile in Recruiter. If the Admit date has already been sent to Recruiter for the prospect, term, and application ID, a new message is not sent to Recruiter. Note: If this event is enabled, the RECRUITER_ADMIT_DATE_APPLACCEPT event should be disabled. The following events send a Confirmed Date message to Recruiter. You should enable one, and disable the others: Note: If you do not track confirmed events, you can disable all of the Confirmed Date messages. The Confirmed Date messages will automatically be sent when the Enrolled Date messages are sent to Recruiter, and these dates will match. RECRUITER_CONFIRMED_DATE_DECISIONCODE This event causes the decision date to be sent to Recruiter as the confirmed date when a specific decision is applied to an application. The application must have originated from Recruiter, and the applicant must have a Recruiter GUID recorded in the SRBRCID table. The decision code must be specified in this event. The date sent is displayed as the Confirmed Date on the profile in Recruiter. If this event is enabled, the other CONFIRMED_DATE events should be disabled. Note: If you enable the RECRUITER_CONFIRMED_DATE_DECISIONCODE event, you must also specify the decision code used by your institution for confirmed students. See Configuring the Confirmed Date Decision Code for more information. RECRUITER_CONFIRMED_DATE_DEPOSITPAID This event causes the deposit entry date to be sent to Recruiter as the confirmed date when a prospect pays a specific deposit in the same term as on an application that Integrating Recruiter with Banner Configuring BEP for Banner Recruiter Integration 26

27 originated from Recruiter. While the confirmed date is not associated with a specific application in Recruiter, the existence of an application from Recruiter is used to determine if the deposit is relevant to Recruiter. The deposit detail code must be specified in this event. The date sent is displayed as the Confirmed Date on the profile in Recruiter. If this event is enabled, the other CONFIRMED_DATE events should be disabled. Note: If you enable the RECRUITER_CONFIRMED_DATE_DESPOSITPAID event, you must also specify the deposit detail code used by your institution for confirmed students. See Configuring the Confirmed Date Deposit Detail Code for more information. RECRUITER_CONFIRMED_DATE_REGISTERED This event causes the registration date to be sent to Recruiter as the confirmed date when a prospect registers for a course in the same term as on an application that originated from Recruiter. While the confirmed date is not associated with a specific application in Recruiter, the existence of an application from Recruiter is used to determine if the registration is relevant to Recruiter. The date sent is displayed as the Confirmed Date on the profile in Recruiter. If this event is enabled, the other CONFIRMED_DATE events should be disabled. The following events send an Enrolled Date message to Recruiter. You should enable one, and disable the others: RECRUITER_ENROLLED_DATE_APPLACCEPT This event causes the decision date to be sent to Recruiter when a decision is applied to an application and that decision has the Applicant Acceptance indicator selected. The application must have originated from Recruiter, and the applicant must have a Recruiter GUID recorded in the SRBRCID table. The date sent is displayed as the Enrolled Date on the profile in Recruiter. If this event is enabled, the other ENROLLED_DATE events should be disabled. It is also recommended that this event not be used if the RECRUITER_ACCEPTED_DATE_APPLACCEPT event is enabled to send the Accepted Date to Recruiter. RECRUITER_ENROLLED_DATE_DECISIONCODE This event causes the decision date to be sent to Recruiter when a specific decision is applied to an application. The application must have originated from Recruiter, and the applicant must have a Recruiter GUID recorded in the SRBRCID table. The decision code must be specified in this event. The date sent is displayed as the Enrolled Date on the profile in Recruiter. If this event is enabled, the other ENROLLED_DATE events should be disabled. Note: If you enable the RECRUITER_ENROLLED_DATE_DECISIONCODE event, you must also specify the decision code used by your institution for enrolled students. See Configuring the Enrolled Date Decision Code for more information. Integrating Recruiter with Banner Configuring BEP for Banner Recruiter Integration 27

28 RECRUITER_ENROLLED_DATE_REGISTERED This event causes the course registration date to be sent to Recruiter when a student first registers for a course in a term that matches the application term, and the course registration status is one that counts in enrollment. The application must have originated from Recruiter, and the applicant must have a Recruiter GUID recorded in the SRBRCID table. The date sent is displayed as the Enrolled Date on the profile in Recruiter. If this rule is event, the other ENROLLED_DATE events should be disabled. Installing BEP 1.2 Install the Banner Event Publisher 1.2 software using the instructions provided in the Banner Event Publisher Release Guide. Verifying the BEP 1.2 Installation To verify that the Banner Event Publisher 1.2 installation was successful, perform the following steps. 1. Log into your Oracle WebLogic Server Administration Console. 2. In the Domain Structure pane, click Deployments. 3. In the Deployments table, verify that the BannerEventPublisher application is installed and that it is in an "Active" state. Configuring BEP 1.2 for Banner Recruiter Integration The BEP service sends XML messages to the Banner Recruiter Integration Manager based on changes in the Banner database. Events must be created in BEP to watch for these changes. In addition to creating events to watch for changes in the Banner database, you must also create a subscriber for the XML messages that are generated by BEP based on those events. Create Event Metadata To create the event metadata in BEP, perform the following steps. Integrating Recruiter with Banner Configuring BEP for Banner Recruiter Integration 28

29 1. Connect to your BEP database as the events user, using your preferred database management application. 2. Run the eventconfig.sql script from the BannerRecruiterIntegrationManager.jar file against the database. 3. Log into the Banner Event Publisher. 4. Click the Events tab. 5. In the list of Events, verify that the following ten events were created: RECRUITER_ADMIT_DATE_APPLACCEPT RECRUITER_ADMIT_DATE_INSTACCEPT RECRUITER_APPLICATION_STATUS RECRUITER_CONFIRMED_DATE_DECISIONCODE RECRUITER_CONFIRMED_DATE_DEPOSITPAID RECRUITER_CONFIRMED_DATE_REGISTERED RECRUITER_ENROLLED_DATE_APPLACCEPT RECRUITER_ENROLLED_DATE_DECISIONCODE RECRUITER_ENROLLED_DATE_REGISTERED RECRUITER_ERP_ID Enabling and Disabling BEP Events To enable or disable a BEP event, perform the following steps. 1. Log into BEP. 2. Click the Events tab. 3. In the list of events, select the event you want to enable or disable, and then click Open. 4. In the Event Overview, click the Edit button. The edit button is in the upper right of the overview window, in line with the name of the event. 5. In the Edit Event window, select the Enable or Disable option, and then click Save. Repeat Step 3 through Step 5 for each BEP event you want to enable or disable. 6. Click the Administration tab. 7. Click Activate Changes. Configuring the Confirmed Date Decision Code To specify the confirmed date decision code used by your institution, perform the following steps. Integrating Recruiter with Banner Configuring BEP for Banner Recruiter Integration 29

30 Note: This procedure is only necessary if you have enabled the RECRUITER_CONFIRMED_DATE_DECISIONCODE BEP event. 1. Log into BEP. 2. Click the Events tab. 3. In the list of events, select the RECRUITER_CONFIRMED_DATE_DECISIONCODE event, and then click Open. 4. Click the Publish Rules tab. 5. In the Key Column, select SRBRAID_RECRUITER_APPL_ID, and then click Open. 6. In the Publish Rule window, click the Edit button. The edit button is in the upper right of the overview window, in line with the name of the event. 7. In the User Defined Condition field on the Edit Publish Rule window, enter the decision code that is used by your institution inside the single quotes. For example, if your decision code is 22, the entry in the User Defined Condition field should be SARAPPD_APDC_CODE IN ('22'). 8. Click Save. 9. Click the Administration tab. 10. Click Activate Changes. Note: You must also update the confirmed.date.decision.code entry in the r2b_configuration.groovy file on your WebLogic server to match the value you entered in Step 7. If the values do not match, messages that should be sent by this event will not be sent to Recruiter. See Configure Banner Recruiter Integration Manager on page 40 for more information about updating the r2b_configuration.groovy file. Configuring the Confirmed Date Deposit Detail Code To specify the confirmed date deposit detail code used by your institution, perform the following steps. Note: This procedure is only necessary if you have enabled the RECRUITER_CONFIRMED_DATE_DEPOSITPAID BEP event. 1. Log into BEP. 2. Click the Events tab. 3. In the list of events, select the RECRUITER_CONFIRMED_DATE_DEPOSITPAID event, and then click Open. 4. Click the Publish Rules tab. 5. In the Key Column, select SRBRAID_RECRUITER_APPL_ID, and then click Open. Integrating Recruiter with Banner Configuring BEP for Banner Recruiter Integration 30

31 6. In the Publish Rule window, click the Edit button. The edit button is in the upper right of the overview window, in line with the name of the event. 7. In the User Defined Condition field on the Edit Publish Rule window, enter the deposit detail code that is used by your institution inside the single quotes. For example, if your deposit detail code is TDEP, the entry in the User Defined Condition field should be SARAPPD_APDC_CODE IN ('TDEP'). 8. Click Save. 9. Click the Administration tab. 10. Click Activate Changes. Note: You must also update the deposit.detail.code entry in the r2b_configuration.groovy file on your WebLogic server to match the value you entered in Step 7. If the values do not match, messages that should be sent by this event will not be sent to Recruiter. See Configure Banner Recruiter Integration Manager on page 40 for more information about updating the r2b_configuration.groovy file. Configuring the Enrolled Date Decision Code To specify the enrolled date decision code used by your institution, perform the following steps. Note: This procedure is only necessary if you have enabled the RECRUITER_ENROLLED_DATE_DECISIONCODE BEP event. 1. Log into BEP. 2. Click the Events tab. 3. In the list of events, select the RECRUITER_ENROLLED_DATE_DECISIONCODE event, and then click Open. 4. Click the Publish Rules tab. 5. In the Key Column, select SRBRAID_RECRUITER_APPL_ID, and then click Open. 6. In the Publish Rule window, click the Edit button. The edit button is in the upper right of the overview window, in line with the name of the event. 7. In the User Defined Condition field on the Edit Publish Rule window, enter the decision code that is used by your institution inside the single quotes. For example, if your decision code is IA, the entry in the User Defined Condition field should be SARAPPD_APDC_CODE IN ('IA'). 8. Click Save. 9. Click the Administration tab. 10. Click Activate Changes. Note: You must also update the enrolled.date.decision.code entry in the r2b_configuration.groovy file on your WebLogic server to Integrating Recruiter with Banner Configuring BEP for Banner Recruiter Integration 31

32 match the value you entered in Step 7. If the values do not match, messages that should be sent by this event will not be sent to Recruiter. See Configure Banner Recruiter Integration Manager on page 40 for more information about updating the r2b_configuration.groovy file. Create Durable Subscribers To create a durable subscriber for BEP messages, perform the following steps. 1. Log into your Oracle WebLogic Server Administration Console. 2. In the Domain Structure pane, expand Services, expand Messaging, and then click JMS Modules. 3. In the JMS Modules table, click BEPJMSModule. 4. In the Summary of Resources table for the BEPJMSModule, click BusinessEventTopic. 5. In the settings for the BusinessEventTopic, click the Monitoring tab. 6. On the Monitoring tab, click the Durable Subscribers subtab. 7. In the Durable Subscribers table, click New. 8. On the Create a New JMS Durable Subscriber form, enter the following information, and then click OK: Subscription Name. Enter a name for the durable subscriber, such as BepRecruiterEventConsumer. Client ID. Enter the same name that you entered in the Subscription Name field, such as BepRecruiterEventConsumer. Integrating Recruiter with Banner Configuring BEP for Banner Recruiter Integration 32

33 Installing and Configuring the Banner Recruiter Integration Manager The Banner Recruiter Integration Manager is a communications layer that sits between your Banner and Recruiter systems and passes the XML messages from each system to the other. The following procedures must be performed in the order listed below to successfully install and configure the Banner Recruiter Integration Manager on your WebLogic server: Procedure Page Create and Configure the Recruiter Managed Server 34 Install the Banner Recruiter Integration Manager 36 Create the JNDI Data Source for Banner Recruiter Integration 37 Create Banner Recruiter Integration Manager Users 38 Create Banner Recruiter Integration Manager Security Roles 39 Assign Users to the Banner Recruiter Integration Manager Security Roles 39 Configure Banner Recruiter Integration Manager 40 Restart the Recruiter Managed Server 42 Before You Begin Before performing the procedures described in this section, ensure that you have performed the procedures found in the following sections of this manual: Preparing Banner for Recruiter on page 14 Configuring BEP for Banner Recruiter Integration on page 25 Installation Considerations Consider the following before you install the Banner Recruiter Integration Manager on Oracle WebLogic Server 11g: Banner Recruiter Integration Manager, Banner Event Publisher, Banner Enterprise Identity Services, and other middle-tier applications must be deployed into a Basic Integrating Recruiter with Banner Installing and Configuring the Banner Recruiter Integration Manager 33

34 Domain. The Classic Domain is used for Internet-Native Banner (INB) and Self-Service Banner (SSB). However, the Classic Domain is not suitable for other Ellucian middle-tier applications. We recommend that you create a Managed Server dedicated to Banner Recruiter Integration components. The Banner Recruiter Integration Manager must be deployed into this Managed Server within the same domain as the Banner Event Publisher. We recommend that INB and SSB be deployed into a separate WebLogic Server on a separate virtual machine or physical server. Another virtual machine or physical server can host another WebLogic Server that hosts other middle-tier applications. We recommend this because most institutions like to have clear, partitioned control over the resources that drive INB and SSB as the mission critical core administrative applications for the institution. You can install all applications into one WebLogic Server on one virtual machine or physical server, but this is not considered a best practice. Managed Server Considerations The following recommendations apply to a stand-alone Oracle WebLogic Server. Different configurations may be used depending on available server resources. Component CPU Memory Disk Space Recommendation Two cores minimum Recruiter managed server JVM heap size: Minimum 1 GB Maximum 2 GB The server startup arguments for the managed server should be -Xms1024m -Xmx2048m. Minimum 10 GB free disk space is required for the Recruiter Managed Server. This is in addition to disk space required for the Oracle WebLogic server infrastructure and any other applications deployed to the same application server. Disk space requirements for the Recruiter Managed Server are affected by logging verbosity in log4j. If logging verbosity is set high, log files must be removed or rotated off the server more frequently. Create and Configure the Recruiter Managed Server To create the Recruiter managed server in WebLogic, perform the following steps. Note: The Recruiter managed server must be created in the same domain as BEP 1.2. Integrating Recruiter with Banner Installing and Configuring the Banner Recruiter Integration Manager 34

35 Note: The Recruiter managed server must use Java 1.6. The Banner Recruiter Integration Manager is not compatible with Java Log into your Oracle WebLogic Server Administration Console. 2. In the Domain Structure pane, expand Environments, and then click Servers. 3. In the Change Center, click the Lock & Edit button. 4. In the Servers table, click New. 5. On the Create a New Server form, enter the following information, and then click Finish: Server Name. Enter Recruiter as the server name. Server Listen Port. Enter a unique port number for the Recruiter server. Should this server belong to a cluster. Select No, this is a stand-alone server. 6. After the new server has been created, in the Servers table, click Recruiter. 7. From the Machine drop-down list on the Configuration tab, select the machine that will run the Recruiter managed server. 8. Click Save. 9. On the Configuration tab of the settings for Recruiter, click the Server Start subtab. 10. In the Arguments field, enter the following: -Xms1024m This is the minimum amount of memory to use when starting the server. -Xmx2048m This is the maximum amount of memory to use when starting the server. -XX:MaxPermSize=1024m This is the maximum size of the Java heap. -DlogFileDir=<YourLogFilePath> This is the directory path on the WebLogic server where the log files for Banner Recruiter Integration Manager are created. It can be any directory on the server that WebLogic has write permissions. -DR2B_APP_CONFIG=<YourFilePath>/r2b_configuration.groovy This is the file path on the WebLogic server where you placed the configuration file used by the Banner Recruiter Integration Manager. The WebLogic server must have read permissions for the directory and configuration file. Note: If a proxy server is required for HTTP communications, you must add the following arguments, otherwise skip to Step 11: Integrating Recruiter with Banner Installing and Configuring the Banner Recruiter Integration Manager 35

36 11. Click Save. -Dhttp.proxyEnabled=true -Dhttp.proxyHost=<YourProxyServer> -Dhttp.proxyPort=<YourProxyPort> 12. In the Change Center, click Activate Changes. Install the Banner Recruiter Integration Manager To install the Banner Recruiter Integration Manager on your WebLogic server, perform the following steps. 1. Log into your Oracle WebLogic Server Administration Console. 2. In the Domain Structure pane, click Deployments. 3. In the Change Center, click the Lock & Edit button. 4. In the Deployments table, click Install. If you have already copied the BannerRecruiterIntegrationManager.war file provided in the BannerRecruiterIntegrationManager.jar file to your WebLogic server, enter the path to the BannerRecruiterIntegrationManager.war file in the Path field, and then skip to Step 7. Otherwise, continue to Step 5 below to upload the BannerRecruiterIntegrationManager.war file from your local machine to your WebLogic server. 5. On the Locate Deployment to Install and Prepare for Deployment form, click the upload your file(s) link. 6. In the Deployment Archive section of the Upload a Deployment to the Admin Server form, click Choose File, locate the BannerRecruiterIntegrationManager.war file on your local file system, and then click Next. This will upload the BannerRecruiterIntegrationManger.war file to your WebLogic server. Note: The BannerRecruiterIntegrationManager.war file is included in the BannerRecruiterIntegrationManager.jar file. 7. On the Locate Deployment to Install and Prepare for Deployment form, select the BannerRecruiterIntegrationManager.war file, and then click Next. 8. On the Choose Targeting Style form, select Install this deployment as an application, and then click Next. 9. On the Select Deployment Targets form, select the Recruiter managed server, and then click Next. 10. In the Security section of the Optional Settings form, select Custom Roles: Use roles that are defined in the Administration Console; use policies that are defined in the deployment descriptor, and then click Next. Integrating Recruiter with Banner Installing and Configuring the Banner Recruiter Integration Manager 36

37 11. In the Additional Configuration Section of the Review Your Choices and Click Finish form, select No, I will review the configuration later, and then click Finish. 12. In the Change Center, click Activate Changes. Create the JNDI Data Source for Banner Recruiter Integration To create the JNDI data source that will allow the Banner Recruiter Integration Manager to connect to your Banner database, perform the following steps. 1. In the Domain Structure pane, expand Services, and then click Data Sources. 2. In the Change Center, click Lock & Edit. 3. In the Data Sources table, click New > Generic Data Source. 4. On the JDBC Data Source Properties form, enter the following information: Name. Enter a name for the data source, such as R2B DataSource. JNDI Name. Enter jdbc/bannerrecrintg. Database Type. Select Oracle. 5. Click Next. Note: Although the specific name of the data source is not important, you must enter the JNDI Name as it appears above for the Banner Recruiter Integration Manager to function properly. 6. From the Database Driver drop-down list, select the Oracle Driver (Thin XA) database driver that is appropriate for your WebLogic implementation. 7. Click Next. 8. On the Transaction Options form, click Next. 9. On the Connection Properties form, enter the following information: Database Name. Enter the ORACLE_SID of your Banner database. Host Name. Enter the host name of your Banner database server. Port. Enter the port number of your Banner database server. Database User Name. Enter the user name of your Banner Recruiter Integration user. This user was created in the procedure Create a Banner Recruiter Integration User on page 14. Password. Enter the password for the Banner Recruiter Integration user. Confirm Password. Re-enter the password for the Banner Recruiter Integration user. 10. Click Next. Integrating Recruiter with Banner Installing and Configuring the Banner Recruiter Integration Manager 37

38 11. On the Test Database Connection form, review the information, and then click the Test button. 12. If the test was successful, click Next. If the test was unsuccessful, review the connection properties and make any necessary changes. 13. On the Select Targets form, select the Recruiter managed server, and then click Finish. 14. In the Change Center, click Activate Changes. Create Banner Recruiter Integration Manager Users To create the users that have access to the Banner Recruiter Integration Manager, perform the following steps. 1. Log into your Oracle WebLogic Server Administration Console. 2. In the Domain Structure pane, click Security Realms. 3. In the Realms table, click myrealm. 4. In the settings for myrealm, click the Users and Groups tab. 5. In the Users table of the Users and Groups tab, click New. 6. On the Create New User form, enter the following information: Name. Enter a name for the Banner Recruiter Integration Manager administrative user, such as r2b_admin. Description. Enter R2B Admin. Password. Enter a password for the user. Confirm Password. Re-enter the password for the user. 7. Click OK. Note: This user will be used to access the Banner Recruiter Integration Manager user interface. 8. In the Users table of the Users and Groups tab, click New. 9. On the Create New User form, enter the following information: Name. Enter a name for the low privileged Banner Recruiter Integration Manager user, such as r2b_user. Description. Enter R2B Recruiter App. Password. Enter a password for the user. Confirm Password. Re-enter the password for the user. Integrating Recruiter with Banner Installing and Configuring the Banner Recruiter Integration Manager 38

39 10. Click OK. Note: This user will be used by Recruiter to send XML messages to the Banner Recruiter Integration Manager, and will not have access to the user interface. Create Banner Recruiter Integration Manager Security Roles To create security roles in WebLogic that will be assigned to users of the Banner Recruiter Integration Manager, perform the following steps. 1. Log into your Oracle WebLogic Server Administration Console. 2. In the Domain Structure pane, click Security Realms. 3. In the Realms table, click myrealm. 4. In the settings for myrealm, click the Roles and Policies tab. 5. In the Roles table, expand Global Roles, click Roles. 6. In the Global Roles table, click New. 7. In the Name field of the Role Properties form, enter R2B_ROLE_ADMIN, and then click OK. Note: You must enter the role name as it appears above for the Banner Recruiter Integration Manager to function properly. 8. In the Global Roles table, click New. 9. In the Name field of the Role Properties form, enter R2B_ROLE_RECRUITERAPP, and then click OK. Note: You must enter the role name as it appears above for the Banner Recruiter Integration Manager to function properly. Assign Users to the Banner Recruiter Integration Manager Security Roles To assign the Banner Recruiter Integration Manager users to the roles you created, perform the following steps. 1. Log into your Oracle WebLogic Server Administration Console. Integrating Recruiter with Banner Installing and Configuring the Banner Recruiter Integration Manager 39

40 2. In the Domain Structure pane, click Security Realms. 3. In the Realms table, click myrealm. 4. In the settings for myrealm, click the Roles and Policies tab. 5. In the Roles table, expand Global Roles, click Roles. 6. In the Global Roles table, click the R2B_ROLE_ADMIN role. 7. On the Edit Global Role form, click Add Conditions. 8. From the Predicate List drop-down list, select User, and then click Next. 9. In the User Argument Name, enter the name of the user you created in Step 6 of the Create Banner Recruiter Integration Manager Users procedure, click Add, and then click Finish. 10. On the Edit Global Role form, click Save. 11. In the Domain Structure pane, click Security Realms. 12. In the Realms table, click myrealm. 13. In the settings for myrealm, click the Roles and Policies tab. 14. In the Roles table, expand Global Roles, click Roles. 15. In the Global Roles table, click the R2B_ROLE_RECRUITERAPP role. 16. On the Edit Global Role form, click Add Conditions. 17. From the Predicate List drop-down list, select User, and then click Next. 18. In the User Argument Name, enter the name of the user you created in Step 9 of the Create Banner Recruiter Integration Manager Users procedure, click Add, and then click Finish. 19. On the Edit Global Role form, click Save. Configure Banner Recruiter Integration Manager To configure the Banner Recruiter Integration Manager, perform the following steps. The following information is required when configuring the Integration Manager. You will need to consult with Banner functional staff and Recruiter functional staff to determine the values that they want to use. Recruiter organization. This is the CRM organization used by Recruiter. Confirmed student decision code. This the custom decision code that is used in Banner for confirmed students. This code is only necessary if the RECRUITER_CONFIRMED_DATE_DECISIONCODE XML message type is enabled in BEP. Deposit detail code. This is the deposit detail code that is used in Banner for confirmed students that have paid the specified deposit. This code is only necessary if the Integrating Recruiter with Banner Installing and Configuring the Banner Recruiter Integration Manager 40

41 RECRUITER_CONFIRMED_DATE_DEPOSITPAID XML message type is enabled in BEP. Deposit minimum amount. This is the minimum deposit amount that must be paid by the prospect. This property is only necessary if the RECRUITER_CONFIRMED_DATE_DEPOSITPAID XML message type is enabled in BEP. Enrolled decision code. This is the custom decision code that is used in Banner for enrolled students at your institution. This code is only necessary if the RECRUITER_ENROLLED_DATE_DECISIONCODE XML message type is enabled in BEP. 1. Copy the r2b_configuration.groovy file provided in the BannerRecruiterIntegrationManager.jar file to the file path on your WebLogic server that you specified in Step 10 of the procedure Create and Configure the Recruiter Managed Server on page 34. Note: The r2b_configuration.groovy file must be accessible by your Oracle WebLogic instance. Verify that the ownership and permissions on the file are correct before attempting to start the Integration Manager application. 2. Open the r2b_configuration.groovy file in a text editor, and modify the following properties: jms.jndi.environment.url="t3://<yourweblogicserver>:<yourport>" In this setting, replace <YourWebLogicServer> with the URL of the BEP 1.2 managed server in WebLogic, and replace <YourPort> with the port of the BEP 1.2 managed server. http.recruiter.endpoint.organization="<yourrecruiterorg>" In this setting, replace <YourRecruiterOrg> with the name of the CRM organization of your Recruiter implementation. shutdown.jms.listener.for.error.threshold=99 In this setting, you can specify the number of errors generated by the Banner Recruiter Integration Manager, when processing XML messages from BEP, that can occur before the Banner Recruiter Integration Manager automatically stops consuming XML Messages from BEP. shutdown.jms.listener.for.redelivery.threshold=10 In this setting, you can specify the number of times the Banner Recruiter Integration Manager will try to resend an XML message from Banner to Recruiter before the Banner Recruiter Integration Manager automatically stops consuming XML messages from BEP. confirmed.date.decision.code="<yourcode>" In this setting, replace <YourCode> with the custom decision code that is used in Banner for confirmed students at your institution. You must enter a decision code if the RECRUITER_CONFIRMED_DATE_DECISIONCODE XML message type is enabled. Integrating Recruiter with Banner Installing and Configuring the Banner Recruiter Integration Manager 41

42 Note: The value you enter above must match the value in the RECRUITER_CONFIRMED_DATE_DECISIONCODE event in BEP. If the values do not match, messages that should be sent by this event will not be sent to Recruiter. See Configuring the Confirmed Date Decision Code on page 29 for more information about updating the RECRUITER_CONFIRMED_DATE_DECISIONCODE event in BEP. deposit.detail.code="<yourcode>" In this setting, replace <YourCode> with the deposit detail code that is used in Banner for confirmed students that have paid the specified deposit. You must enter a deposit detail code if the RECRUITER_CONFIRMED_DATE_DEPOSITPAID XML message type is enabled. Note: The value you enter above must match the value in the RECRUITER_CONFIRMED_DATE_DEPOSITPAID event in BEP. If the values do not match, messages that should be sent by this event will not be sent to Recruiter. See Configuring the Confirmed Date Deposit Detail Code on page 30 for more information about updating the RECRUITER_CONFIRMED_DATE_DEPOSITPAID event in BEP. deposit.minimum.amount="<yourminimumdeposit>" In this setting, replace <YourMinimumDeposit> with the minimum deposit amount that must be paid by the prospect. This property is only used if the RECRUITER_CONFIRMED_DATE_DEPOSITPAID XML message type is enabled. enrolled.date.decision.code="<yourcode>" In this setting, replace <YourCode> with the custom decision code that is used in Banner for enrolled students at your institution. You must enter a decision code if the RECRUITER_ENROLLED_DATE_DECISIONCODE XML message type is enabled. Note: The value you enter above must match the value in the RECRUITER_ENROLLED_DATE_DECISIONCODE event in BEP. If the values do not match, messages that should be sent by this event will not be sent to Recruiter. See Configuring the Enrolled Date Decision Code on page 31 for more information about updating the RECRUITER_ENROLLED_DATE_DECISIONCODE event in BEP. 3. Save the r2b_configuration.groovy file. Restart the Recruiter Managed Server To restart the Recruiter managed server, perform the following steps. Integrating Recruiter with Banner Installing and Configuring the Banner Recruiter Integration Manager 42

43 1. Log into your Oracle WebLogic Server Administration Console. 2. In the Domain Structure pane, expand Environment, and then click Servers. 3. In the Servers table, click Recruiter. 4. In the settings for Recruiter, click the Control tab. 5. In the Server Status table of the Control tab, select Recruiter, and then click Shutdown > Force Shutdown Now. 6. After the Recruiter server shuts down, select Recruiter, and then click Start. 7. After the Recruiter server restarts, verify that the State of the Recruiter server in the Server Status table is RUNNING. 8. In the Domain Structure pane, click Deployments. 9. In the Deployments table, verify that the State of the BannerRecruiterIntegrationManager application is Active. If the State is Prepared, perform the following steps to start the deployment: 9.1. In the Deployments table, select the BannerRecruiterIntegrationManager application Click Start > Servicing all requests. You can now access the Banner Recruiter Integration Manager. The URL for the Banner Recruiter Integration Manager is made up of the URL of your WebLogic server, the port of the Recruiter Managed server on the WebLogic server, and the context root of the Banner Recruiter Integration Manager application (brim, by default). For example, Integrating Recruiter with Banner Installing and Configuring the Banner Recruiter Integration Manager 43

44 Integrating Recruiter with Banner Provisioning and Integration

45 Importing Data Provisioned From Banner Importing provisioned data allows you to load validation values, institutions, and prospects from Banner into Recruiter. For example, you can provision academic information, status codes, campus information, and prospect information. See "Provisioning Recruiter with Banner data" in the Banner Student Release Guide manual for more information about and procedures for creating provisioning data. The provisioned data from Banner is stored in.csv files. The.csv files that are produced from Banner fall into one of three major categories: Validation Codes Institution Information Prospect Information Note: For the provisioned data to be correctly imported and related, you must import the provisioned data in the order that it appears above. Note: System locale variables in Banner must be set to UTF-8 for Unicode compatibility (for example, "LANG=en_US.UTF-8"), because the.csv files that are generated by the provisioning processes contain a Byte Order Mark at the beginning of the file. If you copy the files using an FTP application, it must be done in binary mode as ASCII mode will corrupt the Byte Order Mark. Please refer to FAQ1-3YSCJ8 for more information about Banner UTF-8 configuration. Application Decision Codes Banner contains codes for both Application Decision and Application Status on the Admissions Application Form (SAAADMS). These codes are stored in separate tables and are not related within Banner. Recruiter contains a single table, Application Status Type, that will hold all of the codes that can be used for both application decision and application status history. The SRRRVAL process provisions the Decision Codes and evaluates each code based on the flag settings on STVAPDC and matches them to an existing Application Status Type category in Recruiter. If there is not a good match, the category is default to "Applied." The.csv file that is generated contains the name, description, and category for the Decision Codes, and will then be imported into Recruiter. After the.csv file is imported into Recruiter, all of the codes from STVAPDC will be available in the Validation List Management area of Recruiter. Integrating Recruiter with Banner Importing Data Provisioned From Banner 45

46 When a Decision Code is assigned in the Application Folder in Recruiter and sent to Banner, only the abbreviation (the actual code on STVAPDC) is sent to Banner. Banner then uses the abbreviation to evaluate the flag settings for that code and determines the admissions processing that is required. The Category for the Decision Code is not sent to Banner, and is only used in Recruiter for processing, such as funnel counts and reporting. Validation Code Provisioning Files Table 2 lists the.csv files that are generated when you provision the validation codes from Banner. It also lists the corresponding Microsoft Dynamics CRM record type that will be associated with the validation codes in Recruiter. Table 2: Validation Code Provisioning Files Validation Code.csv File ProvisionAcadProgram.csv ProvisionAdmissnDcsn.csv ProvisionAdmissnType.csv ProvisionBuilding.csv ProvisionCampus.csv ProvisionChklstCont.csv ProvisionCitizenType.csv ProvisionDisability.csv ProvisionEducatnGoal.csv ProvisionFullPartTime.csv ProvisionInterest.csv ProvisionLanguage.csv ProvisionLevel.csv ProvisionMrtlStatus.csv ProvisionPersonSource.csv ProvisionPrefix.csv ProvisionReligion.csv ProvisionStudentType.csv ProvisionSuffix.csv ProvisionTerm.csv Recruiter Record Type Academic Program Application Status Type Decision Plan Building Location Activity Code Citizenship Code Disability Type Offered Graduate Degree Academic Load Extracurricular Activity Type Language Academic Level Marital Status Source Prefix Denomination Admit Type Suffix Academic Term Integrating Recruiter with Banner Importing Data Provisioned From Banner 46

47 Table 2: Validation Code Provisioning Files (continued) Validation Code.csv File ProvisionVisaType.csv Recruiter Record Type Visa Type In addition to mapping the ProvisionCampus.csv file to the Location record type, you may also want to map it to the Campus record type in Recruiter. Although mapping to the Campus record type does not affect Banner Recruiter Integration, it does provide you with the location information when creating an Event in Recruiter. Note: If you plan to also map the ProvisionCampus.csv file to the Campus record type in Recruiter, you should perform that mapping separately after mapping the other validation code provisioning files. It is recommended that you place all of the validation code provisioning.csv files into a single.zip file to make it easier to import the validation codes into Recruiter. Institution Provisioning Files Table 3 lists the.csv file that is generated when you provision institution information from Banner. It also lists the corresponding Microsoft Dynamics CRM record type that will be associated with the institutions in Recruiter. Table 3: Institution Provisioning File Institution.csv File ProvisionInstitution.csv Recruiter Record Type Account Depending on the settings you used when you provisioned the institution records from Banner, you may have more than one.csv file containing institutions. If you have multiple.csv files, it is recommended that you place all of the institution provisioning.csv files into a single.zip file to make it easier to import the institutions into Recruiter. Prospect Provisioning Files Table 4 lists the.csv files that are generated when you provision prospect information from Banner. It also lists the corresponding Microsoft Dynamics CRM record types that will be associated with the prospects in Recruiter. Integrating Recruiter with Banner Importing Data Provisioned From Banner 47

48 Note: The ProvisionPrefix.csv and ProvisionSuffix.csv files must be imported before you import prospects. Table 4: Prospect Provisioning Files Prospect.csv Files ProvisionProspect.csv ProvisionProspectColl.csv ProvisionProspectHS.csv ProvisionProspectInts.csv Recruiter Record Types Contact College Academic History High School Academic History Extracurricular Activities It is recommended that you place all of the prospect provisioning.csv files into a single.zip file to make it easier to import the prospect records into Recruiter. Importing Provisioned Data Into Recruiter To import the provisioned.csv files from Banner into Recruiter, perform the following steps. 1. In a browser, access the home page of your Recruiter website. 2. In the Navigation Pane, click Recruiting Imports. 3. In the Ribbon, click Home > Import Data. 4. On the Upload Data File window, click Browse, locate the.zip file or.csv file that contains the provisioning data you want to import, and then click Open. 5. Click Next. 6. On the Review File Upload Summary window, review the.csv files that were uploaded, and then click Next. 7. On the Select Data Map window, select the appropriate data map for the type of.csv files you are importing. Validation Codes. Select the Default (Automatic Mapping) data map. Institutions. Select the Organization Data Map - Default data map. Prospects. Select the Provision Prospects - Organization Code data map. 8. Click Next. Integrating Recruiter with Banner Importing Data Provisioned From Banner 48

49 9. On the Map Record Types window (Figure 12), select the Microsoft Dynamics CRM Record Type to use when mapping the imported provisioned data. Figure 12: The Map Record Types Window See Validation Code Provisioning Files on page 46, Institution Provisioning Files on page 47, and Prospect Provisioning Files on page 47 for more information about which record types to choose for the various provisioning.csv files. 10. Click Next. 11. On the Map Fields window, ensure that all record types have been successfully mapped, and then click Next. 12. On the Review Mapping Summary window, verify that all provisioned.csv files have been successfully mapped to CRM record types, and then click Next. If you need to make any changes, click Edit. This will take you back to the Map Record Types window. See Step 9 for more information. 13. In the Allow Duplicates section of the Review Settings and Import Data window, select No, and then click Submit. 14. On the Data Submitted for Import window, click Finish. Repeat this procedure for all of the.csv files you have provisioned from Banner. Integrating Recruiter with Banner Importing Data Provisioned From Banner 49

50 Exporting Custom Fields to Banner Banner Recruiter Integration allows you to export custom fields and additional fields from the prospect and application records in Recruiter that are not part of the basic integration with Banner. This is accomplished by configuring Recruiter to send these additional fields with the XML messages sent to Banner, and also by creating custom PL/SQL code that will be used to handle the validation and storage of the additional fields in Banner. Note: If you set up custom fields and do not enter data in those fields in Recruiter, the custom fields will be sent to Banner as null values. Export Additional Fields From Recruiter To specify the additional fields that should be exported from Recruiter, perform the following steps. 1. In a browser, access the home page of your Recruiter website. 2. In the Navigation Pane, click Settings. 3. From the Settings pane, click Real Time Configuration. 4. Create a record for the prospect form or application type for which you want include additional fields. Note: You can define only one real-time configuration for each prospect form or application type. 5. Select the check boxes for the additional fields that you want to export to Banner. 6. Save the record. Create PL/SQL Code After you have configured Recruiter to add additional fields to the XML message that is sent to Banner, you must create PL/SQL code that will validate and push the additional data into the Banner database. When creating your PL/SQL code, be aware of the following: The PL/SQL code is executed as the last step of the PUSH process. The PL/SQL code should be fully tested in a TEST environment. Integrating Recruiter with Banner Exporting Custom Fields to Banner 50

51 The PL/SQL code can be secured by compiling the package as a non-privileged Oracle user and then granting specific access to the necessary tables and packages. The PL/SQL code should use Banner APIs where available. After you have created the PL/SQL, you will then add a reference to the PL/SQL in the Banner Recruiter Integration Manager. The reference should contain the schema where the PL/SQL is stored in the database, the name of the PL/SQL package, and the name of the procedure in the PL/SQL code. For example, if the owner of the PL/SQL package is an Oracle user named recrintg, the name of the PL/SQL package is custom_package and the name of the procedure is p_custom_procedure, the reference in the Banner Recruiter Integration Manager would be recrintg.custom_package.p_custom_procedure. See Configuring the Banner Recruiter Integration Manager on page 59 for more information. PL/SQL Example This section provides a code sample of the PL/SQL package specification and package body that would import the Incarceration indicator custom field from Recruiter. The custom fields are sent in an XML message from Recruiter. The following shows an example of the XML message: <Prospect> <Term>201010</Term> <Level>UG</Level> <LastName>Smith</LastName> <FirstName>John</FirstName> <RecruiterId>d5ada70e-981d-41ee-9b5a-6a1effeee16d</RecruiterId> <ClientExtension> <CustomFields> <CustomField> <EntitySchema>contact</EntitySchema> <AttributeSchema>my_incar_ind</AttributeSchema> <Value>True</Value> </CustomField> </CustomFields> </ClientExtension> </Prospect> The custom field information from the XML message will be stored in the following columns of the SRTCSTM table in the Banner database: SRTCSTM_ENTITY will contain the Recruiter entity, for example contact. SRTCSTM_ATTRIBUTE will contain the name of the additional field, for example my_incar_ind. SRTCSTM_VALUE will contain the value from the XML message, for example True. Integrating Recruiter with Banner Exporting Custom Fields to Banner 51

52 PL/SQL Package Specification The following shows an example of the PL/SQL package specification: CREATE OR REPLACE PACKAGE custom_package AS Execute Custom Push SQL -- PROCEDURE p_custom_procedure(p_ridm NUMBER); END custom_package PL/SQL Package Body The following shows an example of the PL/SQL package body: CREATE OR REPLACE PACKAGE BODY custom_package AS Example: Set incarceration indicator on bio/demo record -- PROCEDURE p_custom_procedure(p_ridm NUMBER) IS -- Declare local variables lv_pidm srtiden.srtiden_pidm%type := null; lv_cstm_incar_ind srtcstm.srtcstm_value%type := null; lv_incar_ind spbpers.spbpers_incar_ind%type := null; -- Declare a cursor to retrieve custom field data cursor srtcstm_c(p_cstm_ridm srtcstm.srtcstm_ridm%type, p_cstm_entity srtcstm.srtcstm_entity%type, p_cstm_attribute srtcstm.srtcstm_attribute%type) is select srtiden_pidm, srtcstm_value from srtcstm inner join srtiden on srtiden_ridm = srtcstm_ridm where srtcstm_ridm = p_cstm_ridm and srtcstm_entity = p_cstm_entity and srtcstm_attribute = p_cstm_attribute and srtcstm_value is not null and srtiden_pidm is not null; BEGIN -- Get the custom value OPEN srtcstm_c(p_ridm, contact', 'my_incar_ind'); FETCH srtcstm_c INTO lv_pidm, lv_cstm_incar_ind; IF srtcstm_c%notfound THEN CLOSE srtcstm_c; Integrating Recruiter with Banner Exporting Custom Fields to Banner 52

53 RETURN; END IF; CLOSE srtcstm_c; -- Verify that the custom value is valid IF (upper(to_char(lv_cstm_incar_ind)) not in ('TRUE','FALSE')) THEN raise_application_error(-20001, g$_nls.get('srkrcws_cstm_example- 0003','SQL','Invalid incarceration indicator: %01%',to_char(lv_cstm_incar_ind))); END IF; -- Translate the value select decode(upper(to_char(lv_cstm_incar_ind)),'true','y','n') into lv_incar_ind from dual; BEGIN gb_bio.p_update(p_pidm => lv_pidm, p_incar_ind => lv_incar_ind); EXCEPTION WHEN OTHERS THEN raise_application_error(-20001, g$_nls.get('srkrcws_cstm_example-0004','sql','error occurred attempting to update bio/demo record; %01%',SQLERRM)); END; END p_custom_procedure; END custom_package; Integrating Recruiter with Banner Exporting Custom Fields to Banner 53

54 Removing the Link Between Records in Banner and Recruiter After a prospect or application record has been sent to Banner from Recruiter, the Recruiter ID is stored in Banner. The Banner Enterprise System ID (and the Banner ID) are sent back to Recruiter to link the records across both systems. To break this link, you must delete the ERP ID from the prospect record in Recruiter or delete the prospect. This allows you to correct records that have been linked together incorrectly or when duplicate records have been merged in Recruiter. When the ERP ID is deleted from the prospect record or the prospect is deleted from Recruiter, Recruiter sends a Recruiter ID Delete message to Banner. The Recruiter ID is deleted from the Banner database, breaking the link between Recruiter and Banner for that record. Application data that is integrated between Recruiter and Banner is more complex than prospect data. The application link may still be valid even after the prospect link has been broken. Therefore, the Recruiter ID Delete message does not affect application records. You can only break the application link by deleting the application in Banner. To delete the ERP ID from the prospect record in Recruiter, perform the following steps. 1. In a browser, access the home page of your Recruiter website. 2. In the Navigation Pane, click Recruiting. 3. In the People & Organizations section, click Prospects. 4. From the list of prospects, open the record of the prospect whose ERP ID you want to delete. 5. In the Codes & Ratings section of the prospect record, locate the Erp Id field. 6. Delete the ERP ID from the field, and then click Save & Close. The Recruiter ID Delete message will be sent to Banner, and the link between the records in Recruiter and Banner will be broken. Create a Workflow to Remove Integration Link for Deactivated Prospects Recruiter checks for duplicate records automatically and as a manual process. If duplicate records are found, one of the records will be deactivated. The deactivated record may have an ERP ID, which ties it to Banner. Because the record is only deactivated In Recruiter, the prospect will still be active in Banner. To remove the duplicate in Banner, you must delete the ERP ID for that prospect. Integrating Recruiter with Banner Removing the Link Between Records in Banner and Recruiter 54

55 You can create a workflow in Recruiter that will automatically delete the ERP ID from a record when it is deactivated, which will in turn send a Recruiter ID Delete message to Banner, breaking the link between the two records. To create this workflow, perform the following steps. 1. In a browser, access the home page of your Recruiter website. 2. In the Navigation Pane, click Settings. 3. In the General Settings section, click Processes. 4. In the Processes pane, click New. 5. In the Create Process dialog box, enter the following information, and then click OK: Process Name. Enter a name for the process. Entity. Select Contact. Category. Select Workflow. Type. Select New Blank Process. 6. In the Available to Run section of the Processes dialog box, select the As an On- Demand Process check box. 7. From the Scope drop down list in the Options for Automatic Processes section, select Organization. 8. In the Options for Automatic Processes section, clear the Record is Created check box, and then select the Record Status Changes check box. 9. Click Add Step > Check Condition. 10. Click the Click to Configure link. 11. In the Specify Condition dialog box, click Select, and then select the following options in the drop down lists across the first row: Contact Status Equals 12. In the value field, enter Inactive, and then click Save and Close. 13. Select the row below the new conditional statement, and then click Add Step > Check Condition. 14. Click the Click to Configure link. 15. In the Specify Condition dialog box, click Select, and then select the following options in the drop down lists across the first row: Contact erpid Contains Data 16. Click Save and Close. 17. Select the row below the new conditional statement, and then click Add Step > Update Record. Integrating Recruiter with Banner Removing the Link Between Records in Banner and Recruiter 55

56 18. Click Set Properties. 19. In the Update Contact dialog box, select the Erp Id field. 20. From the Operator drop down list in the Form Assistant pane to the right, select Clear. 21. Click Save and Close. 22. On the Processes dialog box, click Save and Close. 23. From the list of processes, select the process you just created, and then click Activate. 24. In the Process Activate Confirmation dialog box, click OK. Integrating Recruiter with Banner Removing the Link Between Records in Banner and Recruiter 56

57 Integrating Recruiter with Banner Banner Recruiter Integration Manager

58 Using the Banner Recruiter Integration Manager The Banner Recruiter Integration Manager is part of the communications layer between Banner and Recruiter, and also provides a user interface for reviewing errors that occur during the processing of those XML messages. In addition, it also allows you to configure and test the connection information between the Banner Recruiter Integration Manager and Recruiter. Figure 13 shows an example of the Banner Recruiter Integration Manager. The URL for the Banner Recruiter Integration Manager is made up of the URL of your WebLogic server, the port of the Recruiter Managed server on the WebLogic server, and the context root of the Banner Recruiter Integration Manager application (brim, by default). For example, Figure 13: The Banner Recruiter Integration Manager The Banner Recruiter Integration Manager user interface contains tabs that allow you to view the following information: Configuration. Allows you to view the basic configuration information about the Banner Recruiter Integration Manager, and to test its connection to the Recruiter Response Service. Integrating Recruiter with Banner Using the Banner Recruiter Integration Manager 58

59 Loader Errors. Allows you to view errors that were generated when a value in an XML message sent to Banner from Recruiter did not pass validation, and allows you to modify the XML message and resend it to Banner. Match/Push Messages. Allows you to view errors and information messages generated when a person cannot be identified as a new person in Banner or cannot be uniquely matched to a person that already exists in Banner. In addition, it also allows you to view errors and information messages generated when pushing data from the Banner temporary tables to the Banner permanent tables. Event Errors. Allows you to view errors generated when a value in an XML message sent to Recruiter from Banner generates an error in Recruiter. In addition, the number of errors of that particular type is displayed next to each tab. Configuration The Configuration tab (Figure 13) allows you to manage the basic configuration settings of the Banner Recruiter Integration Manager. In addition, it allows you to test the Integration Manager s connection to the Recruiter ERP Response Service. Configuring the Banner Recruiter Integration Manager To configure the Integration Manager, perform the following steps. 1. In the Recruiter Response Service URL field, enter the URL, including port number, of the Recruiter Response Service. For example, Datatel.ERecruiting.Erp.Response.Services. The URL for the Recruiter Response Service was created in the "Running the Recruiter 3.1 CRM InstallShield" procedure in the Recruiter Installation Procedures manual. Note: The Recruiter Response Service URL field may already be populated if you entered the Recruiter Response Service URL in the procedure Install the Banner Recruiter Integration Seed Data on page In the URL Authentication Username field, enter the basic authentication username. The basic authentication username is only necessary if the website containing the Recruiter Response Service has been configured in IIS to require basic authentication. If the website does not require basic authentication, skip to Step 4 3. In the URL Authentication Password field, enter the password for the basic authentication user. 4. In the Custom Push SQL Reference field, enter the PL/SQL reference that will be used to validate and store custom fields that are being sent to Banner from Recruiter. The custom push SQL reference is only necessary if you are sending custom fields Integrating Recruiter with Banner Using the Banner Recruiter Integration Manager 59

60 from Recruiter into Banner. If you are not sending custom fields, skip to Step 5. The reference should contain the schema where the PL/SQL is stored in the database, the name of the PL/SQL package, and the name of the procedure in the PL/SQL code. See Exporting Custom Fields to Banner on page 50 for more information. 5. Click Save. Testing the Banner Recruiter Integration Manager Connection To test the connection between the Banner Recruiter Integration Manager and the Recruiter Response Service, click the Test Connection button. If you have made any changes to the configuration settings, you must click the Save button before testing the connection. If the test was successful, a check mark is displayed next to the Recruiter Response Service URL section (Figure 14). Figure 14: Successful Connection Test If the test was not successful, the details of the connection are displayed in the Recruiter Response Service URL section (Figure 15). Figure 15: Unsuccessful Connection Test If the connection test was unsuccessful, review the error message that is displayed and verify the following: The URL in the Recruiter Response Service URL field is correct and that it contains the port number. You can verify the URL using IIS on the server that is hosting the Recruiter Response Service, typically the same server that is hosting Recruiter. The username and password have been entered and are correct in the URL Authentication Username and URL Authentication Password fields if the Recruiter Response Service website has been configured in IIS to require basic authentication. Integrating Recruiter with Banner Using the Banner Recruiter Integration Manager 60

61 Loader Errors The Loader Errors tab (Figure 16) displays the errors that were generated due to a value in the XML message sent from Recruiter not passing a validation check in Banner. Figure 16: The Loader Errors Tab Sort the list by clicking on the column headings. To clear old messages from the list, enter a number of days in the Days old field, and then click Bulk Delete. Any messages more than that number of days old will be deleted from the error list. Enter a 0 in the Days old field to delete all messages. Click on the ID of any error to view detailed information about the error, including the details of the XML message that was sent from Recruiter (Figure 17). Integrating Recruiter with Banner Using the Banner Recruiter Integration Manager 61

62 Figure 17: The Loader Error Details The Loader Error Details form allows you to view the details of the loader error, such as the type of message, the content of the message, the error message, and a stack trace of the error. You can use the Previous and Next buttons to page through the loader errors based on the sort order of the error list on the Loader Errors tab. You can make changes to the XML message, and resend the message to Banner without needing to go back to Recruiter to make the changes. To resend the XML message, make changes in the Message Content field, if necessary, and then click Resend. The XML message will be resent to Banner, the loader error will be deleted, and you will be shown the details of the next loader error. To delete the loader error without resending it to Banner, click the Delete button. After the error has been deleted, you will be shown the details of the next loader error. Integrating Recruiter with Banner Using the Banner Recruiter Integration Manager 62

63 Match/Push Messages The Match/Push Messages tab (Figure 18) displays two types of errors that can occur as data is prepared to be added to the Banner database. See Match Errors and Push Errors for more information about these types of errors. Figure 18: The Match/Push Messages Tab Sort the list by clicking on the column headings. To clear old messages from the list, enter a number of days in the Days old field, and then click Bulk Delete. Any messages more than that number of days old will be deleted from the error list. Enter a 0 in the Days old field to delete all messages. Click the ID of a match or push error to view detailed information about the error that was generated (Figure 19). Integrating Recruiter with Banner Using the Banner Recruiter Integration Manager 63

64 Figure 19: The Match/Push Message Details The Match/Push Message Details form allows you to view the details of the match or push error, such as the Banner ID of the record, the prospect s first and last name, the prospect s Recruiter ID, the type of error message, and the details of the error message. You can use the Previous and Next buttons to page through the match/push errors based on the sort order of the error list on the Match/Push Messages tab. To delete the match/push error, click the Delete button. After the error has been deleted, you will be shown the details of the next match/push error. Match Errors Match errors are generated when a person being sent from Recruiter to Banner has multiple possible matches in the Banner database. When this occurs, the incoming record is put into suspense in Banner. You can then go into Banner to view the suspended record and use duplicate checking to determine which of the existing records is a match, or if the person is truly new and can be manually pushed into the database. Push Errors Push errors are generated when a value or values in the XML message do not pass the business rules in Banner, for example if start date is later than an end date. In addition, a push error can be generated if a value in the custom fields section of the XML message cannot be put into the Banner database. Integrating Recruiter with Banner Using the Banner Recruiter Integration Manager 64

65 Event Errors The Event Errors tab (Figure 20) displays errors that occur in Recruiter because of data problems in the XML message that was sent from Banner. For example, an event error occurs if the ID of the prospect does not match an existing user in Recruiter. Figure 20: The Event Errors Tab Sort the list by clicking on the column headings. If more errors are recorded above the threshold set in the shutdown.jms.listener.for.error.threshold property of the r2b_configuration.groovy file, then the Banner Recruiter Integration Manager will stop consuming messages from BEP (Figure 21). Note: The threshold applies to the total number of event errors in the Banner Recruiter Integration Manager. Figure 21: JMS Subscription Stopped If the threshold has been met, you should review the errors on the Event Errors tab and delete some or all of the older errors. When the number of errors is below the threshold, you can click the Start Consuming button. The subscription service will be restarted, and Integrating Recruiter with Banner Using the Banner Recruiter Integration Manager 65

66 XML messages will continue to be sent to Recruiter (Figure 22). Figure 22: JMS Subscription Running To clear old messages from the list, enter a number of days in the Days old field, and then click Bulk Delete. Any messages more than that number of days old will be deleted from the error list. Enter a 0 in the Days old field to delete all messages. You can click the ID of an event error to view detailed information about the error that was generated (Figure 23). Figure 23: The Event Error Details The Event Error Details form allows you to view the details of the event error, such as the JMS message ID, the BEP event name, the XML of the event, the XML message sent to the Recruiter Response Service, the error message, and additional details about the error. You can use the Previous and Next buttons to page through the event errors based on the sort order of the error list on the Event Errors tab. To delete the event error, click the Delete button. After the error has been deleted, you will be shown the details of the next event error. Integrating Recruiter with Banner Using the Banner Recruiter Integration Manager 66