Ellucian Recruiter Installation and Integration. Release 4.1 December 2015

Transcription

1 Ellucian Recruiter Installation and Integration Release 4.1 December 2015

2 Notices Notices Without limitation: Ellucian, Banner, Colleague, and Luminis are trademarks of the Ellucian group of companies that are registered in the U.S. and certain other countries; and Ellucian Advance, Ellucian Course Signals, Ellucian Degree Works, Ellucian PowerCampus, Ellucian Recruiter, Ellucian SmartCall, are also trademarks of the Ellucian group of companies. Other names may be trademarks of their respective owners Ellucian. Contains confidential and proprietary information of Ellucian and its subsidiaries. Use of these materials is limited to Ellucian licensees, and is subject to the terms and conditions of one or more written license agreements between Ellucian and the licensee in question. In preparing and providing this publication, Ellucian is not rendering legal, accounting, or other similar professional services. Ellucian makes no claims that an institution's use of this publication or the software for which it is provided will guarantee compliance with applicable federal or state laws, rules, or regulations. Each organization should seek legal, accounting, and other similar professional services from competent providers of the organization's own choosing. Ellucian 4375 Fair Lakes Court Fairfax, VA United States of America 2015 Ellucian. Confidential & Proprietary 2

3 Contents Contents About Recruiter installation and integration... 6 Who should read this content...6 What this content covers... 6 Microsoft Dynamics CRM 2015 documentation... 7 Download Microsoft Dynamics CRM 2015 documentation...7 Plan your deployment... 8 Plan your Microsoft Dynamics CRM security and server deployment...8 Recruiter software requirements...8 Installation checklist Install the Microsoft software Microsoft software prerequisites Configure security for the SQL Server Create an Organizational Unit for Active Directory CRM security groups Install Microsoft Dynamics CRM Install the Microsoft Dynamics CRM Router (optional)...17 Install the Microsoft Dynamics CRM 2015 Reporting Extensions Install Update 0.2 for Microsoft Dynamics CRM Create a CRM organization Install the supporting software Install bulk Install and configure Banner integration components...21 Retrieve Banner integration components Upgrade the Banner database...22 Verify the banproxy database account Set up a Recruiter integration user in Banner...22 Banner Recruiter Integration Manager security Security access...24 Prepare the Banner Recruiter Integration Manager release package Copy the Banner Recruiter Integration Manager release package Prepare the installer Product home directory structure Install the release file into the product home directory Shared configuration directory...28 Application-specific configuration...28 JMX bean names...29 Logging configuration...29 Output logging file location Ellucian. Confidential & Proprietary 3

4 Contents Central Authentication Service SSO Regenerate the WAR file Configure Banner Event Publisher (BEP) for Recruiter...32 Install BEP Verify the BEP installation...32 Configure BEP for Recruiter...33 Create event metadata Enable and disable BEP events Configure BEP events...34 Configure the confirmed date decision code...35 Configure the confirmed date deposit code Configure the enrolled date decision code...36 Create durable subscribers...36 Deploy the Banner Recruiter Integration Manager...37 Modify the WebLogic configuration for Banner XE applications Create and configure the WebLogic managed server Create the JNDI Data Source Deploy the Banner Recruiter Integration Manager to the WebLogic server...44 Restart the Recruiter managed server...44 Enable Cross Domain Security for BEP and BRIM...45 Install and configure the Colleague integration components Set up a Recruiter administrator in Colleague Create an Operator record for the administrative user Create a user record for the administrative user Change the default password Create a staff record for the administrative user Retrieve the Colleague integration components...50 Install and configure the Colleague Web API...50 Install and configure PowerCampus integration components...52 Retrieve PowerCampus integration components...52 Configure PowerCampus for integration...52 Install the Recruiter software...53 Locate CRM connection details...53 Recruiter pre-installation verification...54 Verify that the CRM administrator has a primary address...54 Verify bulk components Verify ERP integration components Start the required Windows service...54 Deploy Recruiter assemblies to the GAC...55 Install the Recruiter CRM components...56 Install the Recruiter external website...59 Update the external website timezone...61 Prevent cross frame scripting...62 Install the Recruiter ERP response services Set up the ECommerce Website Ellucian. Confidential & Proprietary 4

5 Contents Perform post-installation tasks on the servers...69 Change Internet Information Services (IIS) settings to improve performance Change the IIS application pool refresh cycle Change the IIS application pool timeout settings...70 Perform optional Recruiter diagnostics Verify the CRM installation Verify the integration settings Configure and use the Recruiter software Supported browsers for Recruiter...73 Supported browsers for the Recruiter external website Ellucian. Confidential & Proprietary 5

6 About Recruiter installation and integration About Recruiter installation and integration About Recruiter installation and integration This document includes information about installing and configuring Ellucian Recruiter and the Recruiter integration components on premises at your institution. Who should read this content Anyone responsible for the installation and initial configuration of Recruiter should read this content. Typically, the procedures would be performed by a system administrator. Additional information is provided in the Banner, Colleague, and PowerCampus sections that will need to be shared with users in your institution's business offices.. What this content covers This document includes the following information. Installing the Microsoft Dynamics CRM software that is required for use with Recruiter. Installing and configuring the supporting software that is required for use with Recruiter. Installing and setting up the Recruiter Enterprise Resource Planning (ERP) integration components if you are using Banner by Ellucian, Colleague by Ellucian, or PowerCampus By Ellucian. Installing the Recruiter software. Performing post-installation tasks on the servers. Performing optional Recruiter diagnostics. NOTE: After you have completed the tasks in this document, you must access the Recruiter Help within Microsoft Dynamics CRM. The Recruiter Help contains required post-installation tasks to perform in Recruiter and information about how to initially load data into, configure, and use Recruiter Ellucian. Confidential & Proprietary 6

7 Microsoft Dynamics CRM 2015 documentation Microsoft Dynamics CRM 2015 documentation Microsoft Dynamics CRM 2015 documentation Microsoft provides detailed documentation to help you plan and deploy your Microsoft Dynamics CRM 2015 implementation. Download Microsoft Dynamics CRM 2015 documentation The Deploying and administering Microsoft Dynamics CRM Online and Microsoft Dynamics CRM 2015 guide contains comprehensive information about how to plan for, install, configure, customize, and maintain Microsoft Dynamics CRM Deploying and administering Microsoft Dynamics CRM Online and Microsoft Dynamics CRM 2015 guide includes detailed instructions about hardware and software requirements, installation steps for each component, and configuration details within Microsoft Dynamics CRM You can download the Deploying and administering Microsoft Dynamics CRM Online and Microsoft Dynamics CRM 2015 guide from the following location: details.aspx?id= Administering CRM 2015 for online and on-premises guide is also available and can be used to help manage and configure features of CRM deployments. NOTE: Install the Microsoft software on page 14 includes basic steps for retrieving and installing the Microsoft software that is required before you can install Recruiter. For comprehensive requirements and configuration details, refer to the Deploying and administering Microsoft Dynamics CRM Online and Microsoft Dynamics CRM 2015 guide Ellucian. Confidential & Proprietary 7

8 Plan your deployment Plan your deployment Plan your deployment Review the following sections to plan your Microsoft Dynamics CRM 2015 and Recruiter implementation. Plan your Microsoft Dynamics CRM security and server deployment Microsoft provides key security considerations and supported server configurations that you will need to review when planning your Microsoft Dynamics CRM 2015 implementation. For more information, we recommend that you review the following sections of the Deploying and administering Microsoft Dynamics CRM Online and Microsoft Dynamics CRM 2015 guide that you downloaded in Microsoft Dynamics CRM 2015 documentation on page 7. Security considerations for Microsoft Dynamics CRM 2015 Security best practices for Microsoft Dynamics CRM Administration best practices for on-premises deployments of Microsoft Dynamics CRM Network ports for Microsoft Dynamics CRM Microsoft Dynamics CRM multiple-server deployment Microsoft Dynamics CRM 2015 server roles Recruiter software requirements The following software is required to support Recruiter. The software requirements are listed by server, not by order of installation. To speed up installation time, the Microsoft Dynamics CRM 2015 server setup and ERP system setup can be performed in parallel. For additional details and recommended order of installation components, see Installation checklist on page 10. Microsoft Dynamics CRM 2015 database server Windows Server 2012 or Windows Server 2012 R2.NET Framework SQL Server 2012 SP1 or SQL Server 2014 SQL Server 2012 or 2014 Reporting Services Microsoft Dynamics CRM 2015 Reporting Extensions and Update 0.2 Microsoft Dynamics CRM 2015 asynchronous server Windows Server 2012 or Windows Server 2012 R Ellucian. Confidential & Proprietary 8

9 Plan your deployment.net Framework Windows Identity Foundation Back End Server role for Microsoft Dynamics CRM 2015 and Update 0.2 Microsoft Dynamics CRM 2015 application server Windows Server 2012 or Windows Server 2012 R2.NET Framework Windows Identity Foundation Front End Server and Deployment Administration Server roles for Microsoft Dynamics CRM 2015 and Update 0.2 Microsoft Dynamics CRM Router (optional) Internet Information Services (IIS) 8 or 8.5, depending on the Windows Server version Recruiter 4.1 CRM components Banner. Servers vary. NOTE: Recruiter integrates with Banner, Colleague, or PowerCampus. Banner Student or higher Banner Event Publisher or higher Banner Financial Aid or higher (if licensed) Banner Document Management 8.4 or 8.5 with AX Web Services and AX Web Access.NET 6.5 SP2 (if licensed) Banner Recruiter Integration Manager WebLogic , , or with Java 6 SDK or Java 7 SDK Colleague. Servers vary. NOTE: Recruiter integrates with Banner, Colleague, or PowerCampus. Colleague Release 18 Colleague software updates Colleague Web API 1.9 PowerCampus. Servers vary. NOTE: Recruiter integrates with Banner, Colleague, or PowerCampus. PowerCampus or higher 2015 Ellucian. Confidential & Proprietary 9

10 Plan your deployment Installation checklist We recommend that you install the required software using the sequence of steps in the following table. To speed up installation time, you can install and configure Microsoft Dynamics CRM 2015 components and ERP system components concurrently. Location Task Details Install Microsoft software CRM database server Install Windows Server 2012 or Windows Server 2012 R2, 64- bit version. Enable.NET Framework Set up Active Directory users. Install SQL Server 2012 SP1 or SQL Server Deploy SQL Server 2012 or 2014 Reporting Services. Review the Microsoft Dynamics CRM documentation for SQL Server requirements and recommendations. Configure security for your SQL Server. See the "Software requirements for Microsoft Dynamics CRM Server 2015" section of the Deploying and administering Microsoft Dynamics CRM Online and Microsoft Dynamics CRM 2015 guide. Recruiter requires that you set up two system administrator users. See the "SQL Server installation and configuration" section of the Deploying and administering Microsoft Dynamics CRM Online and Microsoft Dynamics CRM 2015 guide. See the "SQL Server installation and configuration" section of the Deploying and administering Microsoft Dynamics CRM Online and Microsoft Dynamics CRM 2015 guide. See the "SQL Server requirements and recommendations for Microsoft Dynamics CRM" section of the Deploying and administering Microsoft Dynamics CRM Online and Microsoft Dynamics CRM 2015 guide. See Configure security for the SQL Server on page Ellucian. Confidential & Proprietary 10

11 Plan your deployment Location Task Details CRM asynchronous server CRM application server Install Windows Server 2012 or Windows Server 2012 R2, 64- bit version. (Optional) Create an Organization Unit (OU) for security groups created by CRM. Enable.NET Framework Enable Windows Identity Foundation. Install the Back End Server role for Microsoft Dynamics CRM Install Windows Server 2012 or Windows Server 2012 R2, 64- bit version. Enable.NET Framework Enable Windows Identity Foundation. Install the Front End Server and Deployment Administration Server roles for Microsoft Dynamics CRM Install the Microsoft Dynamics CRM Router (optional). See the "Software requirements for Microsoft Dynamics CRM Server 2013" section of the Deploying and administering Microsoft Dynamics CRM Online and Microsoft Dynamics CRM 2015 guide. Creates an OU in your Active Directory infrastructure to maintain CRM security groups instead of placing them in the root directory of the Active Directory structure. See Create an Organizational Unit for Active Directory CRM security groups on page 15. See Install Microsoft Dynamics CRM 2015 on page 16. See the "Software requirements for Microsoft Dynamics CRM Server 2013" section of the Deploying and administering Microsoft Dynamics CRM Online and Microsoft Dynamics CRM 2015 guide. See Install Microsoft Dynamics CRM 2015 on page 16. See Install the Microsoft Dynamics CRM Router (optional) on page Ellucian. Confidential & Proprietary 11

12 Plan your deployment Location Task Details CRM database server CRM asynchronous server, CRM application server, and CRM database server CRM application server Install supporting software Install the Microsoft Dynamics CRM Reporting Extensions. Install Update 0.2 for Microsoft Dynamics CRM 2015 Server, Router (optional), and Reporting Extensions. Create an organization in Microsoft Dynamics CRM. See Install the Microsoft Dynamics CRM 2015 Reporting Extensions on page 18. See Install Update 0.2 for Microsoft Dynamics CRM 2015 on page 18. See Create a CRM organization on page 19. CRM application server Install the bulk solution. See Install bulk on page 20. Install and configure ERP integration. NOTE: Recruiter integrates with Banner, Colleague, or PowerCampus. Banner servers. Colleague servers Install and configure Banner integration with Recruiter. Install and configure Colleague integration with Recruiter. For Banner institutions only. See Install and configure Banner integration components on page 21. For Colleague institutions only. See Install and configure the Colleague integration components on page 48. Install and configure Recruiter software CRM application server Recruiter web front-end server Locate the CRM connection details. Perform pre-installation steps. Start required Windows services. Deploy the Recruiter assemblies to the GAC. Install the Recruiter CRM components. Install the Recruiter external website. See Locate CRM connection details on page 53. See Recruiter pre-installation verification on page 54. See Start the required Windows service on page 54. See Deploy Recruiter assemblies to the GAC on page 55. See Install the Recruiter CRM components on page 56. See Install the Recruiter external website on page Ellucian. Confidential & Proprietary 12

13 Plan your deployment Location Task Details CRM application server Location varies Administrative tasks CRM application server Update the external website timezone. Prevent cross frame scription Install the Recruiter ERP response service. See Update the external website timezone on page 61. See Prevent cross frame scripting on page 62. See Install the Recruiter ERP response services on page 63. Install the ECommerce website. See Set up the ECommerce Website on page 66. Perform post-installation tasks. Perform optional diagnostics. Perform post-installation tasks in Recruiter. See Perform post-installation tasks on the servers on page 69. See Perform optional Recruiter diagnostics on page 71. See the Recruiter Help within Microsoft Dynamics CRM for more information Ellucian. Confidential & Proprietary 13

14 Install the Microsoft software Install the Microsoft software Install the Microsoft software This section contains steps for installing the Microsoft software that is required before you can install Recruiter. Microsoft software prerequisites Before performing the tasks in this section, you must have installed the following software on each server. Database server. The database server must be running Windows Server 2012 or Windows Server 2012 R2,.NET Framework 4.5.2, SQL Server 2012 SP1 or SQL Server 2014, and SQL Server 2012 or 2014 Reporting Services. CRM application server. The CRM application server must be running Windows Server 2012 or Windows Server 2012 R2,.NET Framework 4.5.2, and Windows Identity Foundation. For additional details and recommended order of installation components, see Installation checklist on page 10. Configure security for the SQL Server All CRM data, Recruiter data, and private user information is stored inside of a SQL database and should be protected due to its sensitive nature. NOTE: We recommend that you allow access to the CRM databases to only required CRM services and any other network service for your specific environment, such as a database backup service account. Exclude any other direct access. SQL Server 2012 SP1 or SQL Server 2014 Security and Protection (Database Engine): technet.microsoft.com/en-us/library/bb510589%28v=sql.110%29.aspx SQL Server 2012 SP1 or SQL Server 2014 Best Practices Analyzer: technet.microsoft.com/en-us/library/dn aspx 2015 Ellucian. Confidential & Proprietary 14

15 Install the Microsoft software Create an Organizational Unit for Active Directory CRM security groups You can optionally create an Organizational Unit (OU) for the CRM security groups in Active Directory. Active Directory must be installed and configured before installing SQL Server and Microsoft Dynamics CRM During the Microsoft Dynamics CRM 2015 installation, security groups are created and updated in your Active Directory infrastructure. You can choose to create an OU in your Active Directory infrastructure to maintain these CRM security groups rather than placing them in the root directory of the Active Directory structure. The following table lists the security groups created by CRM. These security groups are automatically maintained by the CRM application. You should not modify them unless you are required to for a process. Security Group PrivReportingGroup PrivUserGroup ReportingGroup SQLAccessGroup Description The Privileged CRM reporting group is for reporting functions. This group is created during the Microsoft Dynamics CRM installation and is configured during the Reporting Extensions installation. The Privileged CRM user group is for special administrative functions, including CRMAppPool identity (domain user or NetworkService). The users who configure CRM must be added to this group. All CRM users are included in this group. This group is updated automatically as users are added and removed from CRM. By default, all CRM Reporting Services reports grant Browse permission to this group. The SQL Access Group is for all server processes and service accounts that require access to SQL Server, including CRMAppPool identity (domain user or NetworkService) Ellucian. Confidential & Proprietary 15

16 Install the Microsoft software Install Microsoft Dynamics CRM 2015 Recruiter requires that you install Microsoft Dynamics CRM About this task The installation files and instructions for this software are available from Microsoft. Microsoft Dynamics CRM 2015 components must be installed on both the Recruiter CRM asynchronous server and the Recruiter CRM application server. NOTE: For Recruiter, the Microsoft Dynamics CRM 2015 "Back End Server" and "Front End Server" roles must be installed on separate servers. 1. On the CRM asynchronous server, install the server roles associated with the "Back End Server" role group for Microsoft Dynamics CRM To download the software, go to id= For instructions on installing the software, see the "Install Back End Server role" section of the following documentation: NOTE: While you are running the Microsoft Dynamics CRM 2015 installer, select No for the option to use the Windows Update feature. NOTE: You will be prompted for a product key during the installation. Use the product key provided to you by Ellucian with your purchase of Microsoft Dynamics CRM 2015, not the temporary license key provided by Microsoft when you downloaded Microsoft Dynamics CRM On the CRM application server, install the server roles associated with the "Front End Server" and "Deployment Administration Server" role groups for Microsoft Dynamics CRM To download the software, go to id= For instructions on installing the software, see the "Install Front End Server role" section of the following documentation: NOTE: While you are running the Microsoft Dynamics CRM 2015 installer, select No for the option to use the Windows Update feature. NOTE: You will be prompted for a product key during the installation. Use the product key provided to you by Ellucian with your purchase of Microsoft Dynamics CRM 2015, not the temporary license key provided by Microsoft when you downloaded Microsoft Dynamics CRM Ellucian. Confidential & Proprietary 16

17 Install the Microsoft software What to do next If you are using Microsoft Dynamics CRM 2015 for Microsoft Office Outlook, you must also install the appropriate 32-bit or 64-bit Microsoft Outlook connector client on each CRM user's computer. Install the Microsoft Dynamics CRM Router (optional) The Router is an optional installation that facilitates communication between Microsoft Dynamics CRM and your system. About this task You can use server-side synchronization (preferred option), CRM for Outlook, or the Router for communications within Microsoft Dynamics CRM. Whether you need to install the Router depends on your service configuration. For information about each option, see technet.microsoft.com/en-us/library/dn832099(v=crm.7).aspx. For information about supported service configurations for server-side synchronization, which is the preferred option, see technet.microsoft.com/en-us/library/dn aspx. You can find configuration details for serverside synchronization and CRM for Outlook in the Microsoft Dynamics CRM Help. NOTE: If you are using server-side synchronization or CRM for Outlook, you do not need to install the Router. The installation files and instructions for the Router are available from Microsoft. The Router must be installed on the Recruiter CRM application server. NOTE: To use the Router, you must be using a Microsoft Exchange Server or have access to a POP3-compliant server. On the CRM application server, install the Router for Microsoft Dynamics CRM To download the Router, go to id= For instructions on installing the Router, see the Microsoft Dynamics CRM 2013 Implementation Guide at id= Ellucian. Confidential & Proprietary 17

18 Install the Microsoft software Install the Microsoft Dynamics CRM 2015 Reporting Extensions The Reporting Extensions are data processing extensions that are required for communication between Microsoft Dynamics CRM and SQL Server Reporting Services. About this task The installation files and instructions for the Reporting are available from Microsoft. The Reporting Extensions must be installed on the Recruiter CRM database server. On the CRM database server, install the Reporting Extensions for Microsoft Dynamics CRM For instructions on locating and installing the Reporting Extensions, go to msdn.microsoft.com/en-us/library/hh aspx. Install Update 0.2 for Microsoft Dynamics CRM 2015 Recruiter requires that you install Update 0.2 for Microsoft Dynamics CRM Before you begin You must have already installed the Microsoft Dynamics CRM 2015 components on each server. About this task The installation files and instructions for this software are available from Microsoft. The Update 0.2 components must be installed on the appropriate CRM server. To download Update 0.2, go to 1. On the CRM database server, install Update 0.2 for the Reporting Extensions. 2. On the CRM asynchronous server, install Update 0.2 for the Microsoft Dynamics CRM 2015 Server. 3. On the CRM application server, install Update 0.2 for the Microsoft Dynamics CRM 2015 Server and Update 0.2 for the Router. NOTE: Install the Router update only if you are using the Router for communications Ellucian. Confidential & Proprietary 18

19 Install the Microsoft software What to do next If you are using Microsoft Dynamics CRM 2015 for Microsoft Office Outlook, you must also install Update 0.2 for the appropriate 32-bit or 64-bit Microsoft Outlook connector client on each CRM user's computer. Create a CRM organization Recruiter requires that you create at least one organization in Microsoft Dynamics CRM 2015 to make the deployment available for users. Before you begin You must have already installed Microsoft Dynamics CRM 2015 on the CRM asynchronous and CRM application servers and the Microsoft Dynamics CRM 2015 Reporting Extensions on the CRM database server. For more information, see Install Microsoft Dynamics CRM 2015 on page 16 and Install the Microsoft Dynamics CRM 2015 Reporting Extensions on page 18. On the CRM application server, create a CRM organization. For instructions on creating an organization in CRM, see library/dn aspx. WARNING! To prevent Recruiter installation issues, you must enter the same value in the Display Name field and Unique Database Name field when creating the CRM organization Ellucian. Confidential & Proprietary 19

20 Install the supporting software Install the supporting software Install the supporting software This section contains steps for installing supporting software that is required before you can install Recruiter Install bulk You must install the bulk solution before installing Recruiter on your CRM application server. Before you begin If you are using the Recruiter Spanish translation, you must install bulk with CRM configured for the Spanish language. About this task For more information about the bulk solution, see en/documentation/integrated_products crm_and_web_analytic_solutions/ marketing_cloud_for_microsoft_dynamics_crm/. 1. Retrieve the bulk solution files. NOTE: The SalesforceMarketingCloud2013-English- Managed zip file contains the bulk solution. This is the file that you will need for this task. 2. Log into Microsoft Dynamics CRM. 3. Go to System Administration > Solutions. 4. Click Import. 5. On the Select Solution Package dialog box, click Browse, and then navigate to the location of the.salesforcemarketingcloud2013-english-managed zip file, and then click Open. 6. Click Next. Microsoft Dynamics CRM uploads the bulk solution. You can view details about the installation by clicking View solution package details. 7. Click Next. 8. In the Post Import Actions section, select the Enable any SDK message processing steps included in the solution option, and then click Import. Microsoft Dynamics CRM imports the bulk solution. 9. On the Importing Solution dialog box, click Close Ellucian. Confidential & Proprietary 20

21 Install and configure Banner integration components Install and configure Banner integration components Install and configure Banner integration components This section provides instructions for preparing your Banner ERP system to integrate with Recruiter. If you are using Colleague or PowerCampus as your ERP system, you do not need to perform the steps in this section. Retrieve Banner integration components If you are integrating Banner with Recruiter, you must retrieve and install the required software components. You can retrieve the software components by using the "Banner, PowerCampus, Advance, and all other Ellucian products" link in the Download Code section of the Ellucian Support Center. The following table shows the software component, description, and where to go to find additional information. Software Banner Student or higher Banner Financial Aid or higher (if licensed) Description Contains the version of Banner Student that integrates with Recruiter 4.1. See the appropriate Banner Student Release Guide for more information. This is a required component for Recruiter integration. Contains the version of Banner Financial Aid that integrates with Recruiter 4.1. See the appropriate Banner Financial Aid Release Guide for more information. This is an optional component for Recruiter integration. Banner Document Management 8.4 or 8.5 with AX Web Services and AX Web Access.NET 6.5 SP2 (if licensed) Contains the version of Banner Document Management that integrates with Recruiter 4.1. See the appropriate Banner Document Management Release Guide for more information. This is an optional component for Recruiter integration. Banner Event Publisher or higher Enables events in Banner to be sent to Recruiter through the Banner Recruiter Integration Manager.See Configure Banner Event Publisher 2015 Ellucian. Confidential & Proprietary 21

22 Install and configure Banner integration components Software Banner Recruiter Integration Manager Description (BEP) for Recruiter on page 32 and the appropriate Banner Event Publisher Handbook for more information. This is a required component for Recruiter integration. Enables communication between Banner and Recruiter. See Integrating Recruiter with Banner manual for more information. This is a required component for Recruiter integration. Upgrade the Banner database You must upgrade the Banner database before you perform any additional integration steps. You can upgrade the Banner database by using the instructions provided in the Banner Recruiter Integration Manager 2.0 Upgrade Guide. Verify the banproxy database account Before you begin the upgrade process, you must verify that the banproxy database account exists. The banproxy account is used for Banner database connections. The database upgrade process will grant the BAN_DEFAULT_M role to this account. If this role is revoked, the application will not start successfully. Set up a Recruiter integration user in Banner You must set up a Recruiter user in Banner. About this task The Banner Recruiter Integration Manager requires this user to be able to pull data from Banner into Recruiter. The user that you create must have the "connect through banproxy" privilege and must have the appropriate security access for the integration functionality that you want to use. NOTE: If Banner has been configured for MEP, the Banner integration user must also be authorized for any VPDI contexts that will be accessed from Recruiter Ellucian. Confidential & Proprietary 22

23 Install and configure Banner integration components 1. Access the GSASECR form. 2. Enter a valid username. 3. Click Alter. 4. Select Authorize banproxy. 5. Click Save. Banner Recruiter Integration Manager security The Banner Recruiter Integration Manager uses native Banner security to control user access. This allows users, with the appropriate security access, to use their existing Banner user accounts to access the Banner Recruiter Integration Manager and perform integration functions. For more information about setting up Banner user security, see the Banner General Security Administration Handbook. The following table lists the objects that have been added to the Banner Object Base Table (GUBOBJS). Object BRIM_UI REST_APPL_CHECKLIST REST_ENTERPRISE_ID REST_FINAID_APPLICATION REST_FINAID_AWARD REST_FINAID_TEMP_PROSPECT REST_RECRUITER_APP_DECISION Description Controls access to all of the pages that make up the Banner Recruiter Integration Manager user interface. Controls access to the application checklist API: applicant-admissions-checklists recruiter-application-ids Controls access to the Enterprise ID API: enterprise-id-transactions Controls access to the FAFSA data API: financial-aid-applications Controls access to the Financial Aid award API: financial-aid-awards Controls access to the Financial Aid new temporary prospect data API: financial-aid-new-prospects Controls access to the Application Decision API: recruiter-application-statuses 2015 Ellucian. Confidential & Proprietary 23

24 Install and configure Banner integration components Object REST_RECRUITER_ID REST_RECRUITER_PROSPECT REST_RECRUITER_TEST_SCORE REST_VALIDATION Description Controls access to the Recruiter/Banner ID linkage API: recruiter-ids Controls access to the Recruiter Prospects API: recruiter-prospects Controls access to the test scores API: recruiter-test-scores Controls access to all of the student validationrelated APIs. A security class definition is created by the database upgrade. By default, the name is BAN_BRIM_SAMPLE_C. This user class has been assigned access to all of the BRIM-related objects listed in table above. You can use this sample user class to pattern your user access to the Banner Recruiter Integration Manager and to the RESTful APIs that are deployed with it. Although you can assign users to this sample class, it is recommended that you create your own classes that grant access to the objects to which you want each class of users to have access. Users may be enrolled in multiple classes. Security access You must assign the Banner integration user to a security class that is granted access to all of the BRIM-related objects listed in the previous table. Additional users, such as functional staff who will be performing integration tasks, should be assigned to security classes that contain access to the integration functions they need to perform. For example, users who perform tasks in the Banner Recruiter Integration Manager should be assigned to a class that has been granted access to the BRIM_UI object. A user should be assigned to at least one class that is granted access to one or more Banner Recruiter Integration objects in order for the user to use Banner Recruiter Integration. Prepare the Banner Recruiter Integration Manager release package You must prepare the Banner Recruiter Integration Manager release package for installation. NOTE: You must have the 64-bit version of the Java 6 JDK or the Java 7 JDK installed on the WebLogic server, and you must make sure that the Java 6 or Java 7 bin directory is defined in the PATH system properly Ellucian. Confidential & Proprietary 24

25 Install and configure Banner integration components NOTE: Do not install the Java JRE. The Banner Recruiter Integration Manager does not support the Java JRE. The release package is created in the BANNER_HOME/student/java subdirectory during the database upgrade. The name of the release package is release-brim-x.x.zip where x.x represents the version number of the release. You must copy the release package zip file to your WebLogic server using File Transfer Protocol (FTP) in binary mode. Copy the Banner Recruiter Integration Manager release package To run the release package, you must first copy it to a temporary directory on your WebLogic server. About this task NOTE: To copy the release package, you must have a valid WebLogic account that has permissions to deploy applications. 1. Log into your WebLogic server. 2. Create a temporary directory using the command mkdir $HOME/bantemp. 3. Copy the release package file using FTP in binary mode into the temporary directory. 4. Unzip the release package into the temporary directory. Prepare the installer To run the release package, you must first prepare the installer. 1. Log into your WebLogic server. 2. Change the directory to the installer directory using the command cd installer. 3. Run the ant command to build the install tool. Unix: chmod +x ant./ant Windows: > ant The message "Build successful" is displayed when the build is successfully completed Ellucian. Confidential & Proprietary 25

26 Install and configure Banner integration components Results NOTE: Banner web applications are modular and are installed independently from each other, though they share a common configuration. The package provides a common structure for releases in addition to a common installer. The product home directory structures that are created are consistent across all Banner modules. We recommend that product homes for Banner modules within a particular environment are placed in sibling directories. For example, the following directory structure illustrates two product homes and a shared configuration directory that all support a common test environment. banner_product_homes_test --> catalog_home_test --> events_home_test --> shared_configuration_test NOTE: If a product home directory or shared configuration directory does not exist, it will be created by the installer. The name of the product home can be specified when running the installer. Product home directory structure A product home directory is created for each deployment. The product home directory is used to support configuration and creation of a deployable WAR file. For example, the home directory that is used to manage the module in a test environment is a different home directory than the one that is used in the production environment. When you are supporting different environments that have multiple home directories for the same solution, this provides the necessary flexibility with respect to configuration, release level, and customizations. The following directory tree shows an example of a product home directory that is created for a test environment using the steps in Install the release file into the product home directory on page 27. In addition to the product home directory, there is a separate shared_configuration_test directory that contains a cross-module configuration file (banner_configuration.groovy) for the test environment that contains the shared JNDI Data Source configuration Ellucian. Confidential & Proprietary 26

27 Install and configure Banner integration components Install the release file into the product home directory You must install the release file into the product home directory. Before you begin Before performing the following steps, ensure that your current working directory is the installer directory. In addition, ensure that your directory names do not contain embedded spaces as it may cause issues during installation. 1. Run the install command to install the release file into the product home directory. Unix: $ bin/install home Windows: > bin\install home 2. Enter the full path of the module home. The module will be installed within the current subdirectory of the home directory, and the previous release will be archived. NOTE: The directory names below are guidelines only. You can change them as needed. Unix: []: $HOME/banner_test_homes/banner_recruiter_integration Windows: []: c:\banner_test_homes\banner_recruiter_integration 3. Enter the full path of the shared configuration home directory. Banner modules configured to refer to this home directory will share the configuration file stored here. NOTE: The directory names below are guidelines only. You can change them as needed. Unix: []: $HOME/banner_test_homes/shared_configuration Windows: []: c:\banner_test_homes\shared_configuration 2015 Ellucian. Confidential & Proprietary 27

28 Install and configure Banner integration components Shared configuration directory The shared configuration directory contains a single cross-module configuration file called banner_configuration.groovy. Database transaction timeout Banner integration with Recruiter is different than other Banner XE applications because the APIs perform bulk database queries for up to 1000 students at a time. Because of this bulk query implementation, the typical Banner XE database transaction timeout might not allow enough time for processing the API database queries. The default transaction timeout is specified as 30 seconds: banner.transactiontimeout = 30 We recommend that you increase the banner.transactiontimeout value to a minimum of 120 (2 minutes) to allow for typical query execution time. If you still experience database query timeouts when provisioning data from Banner to, you will need to change the transaction timeout value from the recommended value of 120 seconds to a higher number. JNDI Data Source You will also need the value of the jndiname property for the JNDI Data Source. The JNDI Data Source is specified as: jndiname = "jdbc/bannerdatasource" You will specify the value of the jndiname property in Create the JNDI Data Source on page 42. Application-specific configuration The application configuration directory PRODUCT_HOME\current\instance\config contains an application-specific file called brim_configuration.groovy. About this task This configuration file contains a number of elements that you can customize for your specific environment. This directory also contains an instance.properties file that references the shared configuration directory. To configure the brim_configuration.groovy file, modify the following properties Ellucian. Confidential & Proprietary 28

29 Install and configure Banner integration components Setting jms.jndi.environment. url="t3://yourweblogicserver: YourPort shutdown.jms.listener. for.error.threshold= 99 shutdown.jms.listener. for.redelivert.threshold= 5 Replacement Value In this setting, replace YourWebLogicServer with URL of the BEP managed server in WebLogic, and replace YourPort with the port of the BEP managed server. In this setting, replace 99 with the number of errors that can be generated by the Banner Recruiter Integration Manager before shutting down the JMS subscrption to the WebLogic channel. In this setting, replace 5 with the number of times the Banner Recruiter Integration Manager will try to resend an XML message from Banner before shutting down the JMS subscrption to the WebLogic channel. JMX bean names The names used to register Mbeans must be unique for all applications deployed into the Java Virtual Machine (JVM). This configuration should be updated for each instance of each application to ensure that each name is unique. jmx { exported { log4j = "brim-log4j" } } Logging configuration Log4J is the common logging framework used with applications that run on the Java Virtual Machine (JVM). For more information about the Log4J framework, see the Log4J documentation. The configuration file includes documentation for various elements that can be modified depending on your environment Ellucian. Confidential & Proprietary 29

30 Install and configure Banner integration components Output logging file location The output logging file location defaults to a target/logs directory that is specific to the application server you are deploying. The default location can be overridden using the following application server start argument: -DlogFileDir=/YourDirectory Replace YourDirectory with the location on the application server in which you want the log files to be stored. You will set this application server start argument in the section Create and configure the WebLogic managed server on page 40. The following log file is created for the application: brim.log. Used for debugging purposes. brim_event.log. Logs each BEP-triggered message that is sent to Recruiter along with the status of each message. NOTE: If you change the logging level, you must restart the running application. NOTE: If you modify the logging levels using JMX, the logging level changes only affect the running application. If you restart the application, any changes that you made using JMX will be lost. Central Authentication Service SSO By default, Banner uses Oracle usernames and passwords for administrative authentication. The following entry in the brim_configuration.groovy file defines the authentication provider for the application. banner { sso { authenticationprovider = 'default' authenticationassertionattribute = 'UDC_IDENTIFIER' } } To enable Central Authentication Server (CAS), change the authenticationprovider property to "cas" as shown below. banner { sso { authenticationprovider = 'cas' authenticationassertionattribute = 'UDC_IDENTIFIER' } } 2015 Ellucian. Confidential & Proprietary 30

31 Install and configure Banner integration components In addition, you must update the following elements by replacing the CAS_HOST:PORT values with the URL to your existing CAS server and the BANNER_HOST:PORT values with the URL to the deployed Banner Recruiter Integration Manager. grails { plugins { springsecurity { cas { serverurlprefix = ' serviceurl = ' j_spring_cas_security_check' servername = ' proxycallbackurl = ' receptor' loginuri = '/login' sendrenew = false proxyreceptorurl = '/secure/receptor' usesinglesignout = true key = 'grails-spring-security-cas' artifactparameter = 'ticket' serviceparameter = 'service' filterprocessesurl = '/j_spring_cas_security_check' } } } } Regenerate the WAR file After the shared and application-specific configurations have been completed, you can regenerate the application s WAR file to include these customizations when it is deployed to your WebLogic server. 1. Log in to your WebLogic server. 2. Change the directory to the product home directory using the command cd PRODUCT_HOME\current\installer. 3. Run the ant command to build the install tool. Unix: chmod +x ant./ant Windows: > ant The message "Build successful" is displayed when the build is successfully completed. 4. Run the systool module to create the WAR file Ellucian. Confidential & Proprietary 31

32 Install and configure Banner integration components Unix: $ bin/systool war Windows: > bin\systool war The generated WAR file is stored in the directory PRODUCT_HOME/current/dist. Although the configuration files have been included in the WAR file, you can specify certain arguments in the managed server. See Create and configure the WebLogic managed server on page 40 for more information. Configure Banner Event Publisher (BEP) for Recruiter You must configure BEP to integrate Banner with Recruiter. The Banner Recruiter Integration Manager uses BEP to monitor changes in the Banner database in real-time. Based on specific changes received from BEP, the Banner Recruiter Integration Manager assembles an XML message containing the changes and performs an HTTP POST to the Recruiter Response Service in order to synchronize data in Recruiter with the data in Banner. Install BEP You should install BEP before you install the Banner Recruiter Integration Manager. You can install the Banner Event Publisher or higher software on a WebLogic server using the instructions provided in the appropriate Banner Event Publisher Handbook. NOTE: BEP and the Banner Recruiter Integration Manager should be installed into separate managed servers in WebLogic if there are enough server resources. The managed server containing BEP should be configured as a target for all the JDBC Data Sources, JMS Servers, JMS Modules, and JNDI objects Verify the BEP installation You can verify that BEP was installed correctly using this procedure. 1. Log in to 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. 4. In the Domain Structure pane, click Security Realms Ellucian. Confidential & Proprietary 32

33 Install and configure Banner integration components 5. In the Realms table, click myrealm. 6. In the settings for myrealm, click the Users and Groups tab. 7. In the Users table, click your BEP administrative user. 8. In the settings for the BEP administrative user, click the Groups tab. 9. In the Parent Groups section, verify that the group "bepadmingroup" is in the Chosen column. If it is not, do the following. a) In the Available column, select the bepadmingroup check box, and then click the > button. b) Click Save. Configure BEP for Recruiter You must configure BEP for integration with Recruiter. BEP monitors changes to the Banner database and publishes those changes as logical change records (LCRs). The Banner Recruiter Integration Manager consumes the LCRs to create XML messages to send to Recruiter. Events must be created and configured in BEP to watch for these changes. In addition, you must also create a subscriber for the LCRs that are generated by BEP which can be assigned to the Banner Recruiter Integration Manager. Create event metadata For BEP to work with Recruiter, you must first create the event metadata in BEP. 1. Connect to your Banner database as the events user, using your preferred database management application. 2. Run the eventconfig_brim.sql script. This file is created in the BANNER_HOME/student subdirectory during the database upgrade. 3. Log into Banner Event Publisher. 4. Click the Events tab. 5. In the list of events, verify that the following 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 2015 Ellucian. Confidential & Proprietary 33