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

34 Install and configure Banner integration components RECRUITER_ENROLLED_DATE_DECISIONCODE RECRUITER_ENROLLED_DATE_REGISTERED RECRUITER_ERP_ID Enable and disable BEP events You can enable or disable BEP events as needed. About this task By default, all of the delivered BEP events are enabled, but you might want to disable certain events depending on the needs of your institution. We recommend that you consult with Banner functional staff to determine which BEP events should be enabled or disabled. 1. Log into Banner Event Publisher. 2. Click the Events tab. 3. In the list of events, select the event that you want to enable or disable, and then click Open. 4. On the Overview tab, click the Edit icon. The Edit icon 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. 6. Repeat Step 3 through Step 5 for each BEP event that you want to enable or disable. 7. Click the Administration tab. 8. Click Activate Changes. Configure BEP events BEP allows you to add User Defined Conditions to the publish rules of an event in order to provide further filtering to determine whether and event is sent to Recruiter. See the publish rules section of the RECRUITER_ADMIT_DATE_APPLACCEPT and RECRUITER_ADMIT_DATE_INSTACCEPT event definitions for examples. The following BEP events, if enabled, must have a code from Banner specified in their configuration in order to function properly. You will need to consult with Banner functional staff to determine which code must be specified for these events. RECRUITER_CONFIRMED_DATE_DECISIONCODE. See Configure the confirmed date deposit code on page 35 for more information. RECRUITER_CONFIRMED_DATE_DEPOSITPAID. See Configure the confirmed date deposit code on page 35 for more information. RECRUITER_ENROLLED_DATE_DECISIONCODE. See Configure the enrolled date decision code on page 36 for more information Ellucian. Confidential & Proprietary 34

35 Install and configure Banner integration components After you have finished configuring the BEP event rules, click the Administration tab, and then click Activate Changes. Configure the confirmed date decision code If you are using the RECRUITER_CONFIRMED_DATE_DECISIONCODE BEP event, you must specify the confirmed date decision code used by your institution. 1. Log into Banner Event Publisher. 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 SARAPPD_PIDM, and then click Open. 6. In the Publish Rule window, click the Edit button. The Edit button is in the upper right of the window, in line with the name of the event. 7. In the User Defined Condition field on the Edit Publish Rule window, add or modify the SARAPPD.SARAPPD_APDC_CODE as necessary following Oracle SQL syntax. For example, if you only want BEP to send codes 22 and 35 to Recruiter, the user defined condition would be: SARAPPD.SARAPPD_ADPC_CODE IN ('22','35') AND SRBRAID.SRBRAID_RECRUITER_APPL_ID IS NOT NULL 8. Click Save. Configure the confirmed date deposit code If you are using the RECRUITER_CONFIRMED_DATE_DEPOSITPAID BEP event, you must specify the confirmed date decision code used by your institution. 1. Log into Banner Event Publisher. 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 TBRDEPO_PIDM, and then click Open. 6. In the Publish Rule window, click the Edit button. The Edit button is in the upper right of the window, in line with the name of the event Ellucian. Confidential & Proprietary 35

36 Install and configure Banner integration components 7. In the User Defined Condition field on the Edit Publish Rule window, add or modify the TBRDEPO_TBRDEPO_DETAIL_CODE_DEPOSIT and TBRDEPO.TBRDEPO_AMOUNT as necessary following Oracle SQL syntax. For example, if you only want BEP to send codes TDEP and HDEP to Recruiter for deposit amounts greater than $1000, the user defined condition would be: TBRDEPO.TBRDEPO_DETAIL_CODE_DEPOSIT IN ('TDEP','HDEP') AND TBRDEPO.TBRDEPO_AMOUT > 1000 AND SRBRAID.SRBRAID_RECRUITER_APPL_ID IS NOT NULL 8. Click Save. Configure the enrolled date decision code If you are using the RECRUITER_ENROLLED_DATE_DECISIONCODE BEP event, you must specify the confirmed date decision code used by your institution. 1. Log into Banner Event Publisher. 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 SARAPPD_PIDM, and then click Open. 6. In the Publish Rule window, click the Edit button. The Edit button is in the upper right of the window, in line with the name of the event. 7. In the User Defined Condition field on the Edit Publish Rule window, add or modify the SARAPPD.SARAPPD_APDC_CODE as necessary following Oracle SQL syntax. For example, if you only want BEP to send codes IA and RT to Recruiter, the user defined condition would be: SARAPPD.SARAPPD_ADPC_CODE IN ('IA','RT') AND SRBRAID.SRBRAID_RECRUITER_APPL_ID IS NOT NULL 8. Click Save. Create durable subscribers You must create durable subscribers in WebLogic to receiver BEP messages. 1. Log into your Oracle WebLogic Server Administration Console Ellucian. Confidential & Proprietary 36

37 Install and configure Banner integration components 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 BuinessEventTopic. 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 necessary information, and then click OK. Field Subscription Name Client ID Description Enter the name for the durable subscriber, such as BepRecruiterEventConsumer. Enter the same name you entered in the Subscription Name field, such as BepRecruiterEventConsumer. Deploy the Banner Recruiter Integration Manager This section contains information about configuring and deploying the Banner Recruiter Integration Manager on a WebLogic server. NOTE: The Banner Recruiter Integration Manager and other middle-tier applications must be deployed into a Basic Domain on the WebLogic server. 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. Banner XE requires that WebLogic be configured to use JPA Version 2 libraries. In addition, WebLogic must also be configured to pass Basic Authentication credentials directly to Banner XE applications that implement RESTful APIs, such as the Banner Recruiter Integration Manager. WARNING! The Basic Authentication configuration change to WebLogic applies to all applications running in the WebLogic domain. You cannot deploy any non-banner XE applications that make use of Basic Authentication to the WebLogic domain after you make this change. BEP does not make use of Basic Authentication, and can be deployed to the same WebLogic domain as the Banner Recruiter Integration Manager Ellucian. Confidential & Proprietary 37

38 Install and configure Banner integration components Modify the WebLogic configuration for Banner XE applications You must configure WebLogic to use JPA 2.0 libraries and to pass Basic Authentication credentials directly to Banner XE applications that implement RESTful APIs, such as the Banner Recruiter Integration Manager. About this task NOTE: In the following steps, MIDDLEWARE_HOME refers to your WebLogic directory. For example, /u01/app/oracle/middleware. 1. Log into your WebLogic server. 2. Change the directory to MIDDLEWARE_HOME/wlserver_10.3/common/nodemanager. 3. Edit the nodemanager.properties file. 4. Search for the StartScriptEnabled property, and set the value of the property true. If there is no StartScriptEnabled property, add it to the file as: StartScriptEnabled=true 5. Change the directory to MIDDLEWARE_HOME/user_projects/domains/base_domain/ config. 6. Edit the config.xml file. 7. Before the closing </security-configuration> tag, add the following entry: <enforce-valid-basic-auth-credentials> false </enforce-valid-basic-auth-credentials> 8. Use the Oracle Smart Update to configure WebLogic to use JPA 2.0. See for more information. Alternatively, you can use the following steps to manually configure your WebLogic server. It is recommended that you use the Oracle Smart Update, if possible: a) Change the directory to MIDDLEWARE_HOME/user_projects/ domains/ base_domain/bin. b) Edit the following file: Unix: setdomainenv.sh Windows: setdomainenv.cmd c) Replace the following entry: if [ "${PRE_CLASSPATH}"!= "" ] ; then CLASSPATH="${PRE_CLASSPATH}${CLASSPATHSEP}${CLASSPATH}" export CLASSPATH fi 2015 Ellucian. Confidential & Proprietary 38

39 Install and configure Banner integration components with # MOD GOES HERE # if [ "${PRE_CLASSPATH}"!= "" ] ; then # CLASSPATH="${PRE_CLASSPATH}${CLASSPATHSEP}${CLASSPATH}" # export CLASSPATH # fi WLS_MODULES="ExactPathToMiddlewareHomeModules" if [ "${PRE_CLASSPATH}"!= "" ] ; then CLASSPATH="${WLS_MODULES}/ javax.persistence_ _2-0.jar$ {CLASSPATHSEP}${WLS_MODULES}/ com.oracle.jpa2support_ _2-1.jar ${CLASSPATHSEP}$ {PRE_CLASSPATH}${CLASSPATHSEP}${CLASSPATH}" export CLASSPATH else CLASSPATH="${WLS_MODULES}/ javax.persistence_ _2-0.jar$ {CLASSPATHSEP}${WLS_MODULES}/ com.oracle.jpa2support_ _2-1.jar ${CLASSPATHSEP}$ {CLASSPATH}" export CLASSPATH fi # MOD ENDS HERE where ExactPathToMiddlewareHomeModules is the location of your MIDDLEWARE_HOME/modules directory. In addition, make sure that the javax.persistence_ _2-0.jar and com.oracle.jpa2support_ _2-1.jar files exist in the MIDDLEWARE_HOME/ modules directory. NOTE: The lines that begin with "CLASSPATH=" should not contain line breaks in the setdomainenv file. NOTE: Earlier versions of WebLogic might have javax.persistence_ _2-0-0.jar and com.oracle.jpa2support_ _2-0.jar files in the MIDDLEWARE_HOME/ modules directory. These versions are compatible, but you must modify the code above to reference these versions of the files. 9. Shut down the WebLogic NodeManager and the WebLogic instance, including all managed and admin servers. 10. Restart the WebLogic NodeManager and the WebLogic instance. NOTE: Be sure that the setdomainenv file is executed before restarting the WebLogic instance Ellucian. Confidential & Proprietary 39

40 Install and configure Banner integration components NOTE: If you receive an error similar to "java.lang.nosuchmethoderror:javax.persistence. OneToOne.orphanRemoval()" when attempting to deploy the Pilot Banner APIs to WebLogic, WebLogic is still configured to use JPA 1.0 libraries. Review the code above, and ensure that the changes in the setdomainenv file are correct. Create and configure the WebLogic managed server You can either create a new WebLogic managed server for the Banner Recruiter Integration Manager or use an existing managed server. Before you begin You must have started the WebLogic NodeManager and admin server. The admin server can be accessed using the following URL: About this task Multiple web applications can run in the same WebLogic managed server. If you already have a managed server configured, you can deploy the Banner Recruiter Integration Manager to the existing managed server. If you deploy the Banner Recruiter Integration Manager to an existing managed server, you can skip this task, but you must increase the MaxPermSize server start argument by 128 MB if there are other Banner XE applications deployed, or 256 MB if this is the first Banner XE application on the managed server. In addition, review the server start arguments that are specific to Banner XE and the Banner Recruiter Integration Manager. NOTE: Banner Event Publisher (BEP) and the Banner Recruiter Integration Manager should be installed into separate managed servers in WebLogic if there are enough server resources. Also, the managed server that contains the Banner Recruiter Integration Manager must be in the same domain as BEP. WARNING! The managed server that contains the Banner Recruiter Integration Manager must use Java 1.6. The Banner Recruiter Integration Manager is not compatible with Java Log in to your Oracle WebLogic Server Administration Console. 2. In the Domain Structure pane, expand Environments, and then click Servers. 3. In the Change Center, click Lock & Edit. 4. In the Servers table, click New. 5. On the Create a New Server form, enter the necessary information, and then click Finish. Field Server Name Description Enter Recruiter (or other unique name) as the server name Ellucian. Confidential & Proprietary 40

41 Install and configure Banner integration components Field Server Listen Port Should this server belong to a cluster Description Enter a unique port number for the Recruiter server. Select No, this is a stand-alone server. 6. After the new server has been created, in the Servers table, click Recruiter (or name of the server). 7. Click the Configuration tab. 8. In the Machine list, select the machine that will run the Recruiter managed server, and then click Save. 9. On the Settings for Recruiter form, click the Configuration tab, and then click the Server Start subtab. 10. In the Arguments field, enter the following arguments. NOTE: The server start arguments entered in this field are ignored when the managed server is started from the command line. If you start the managed server from a command line or script, you must specify these arguments in the setdomainenv file in order for them to take effect. Argument -Xms768m -Xmx1280m -XX:MaxPermSize=384m -DlogFileDir=YourFilePath -DBRIM_APP_CONFIG=YourFilePath/ shared_configuration/ banner_configuration.groovy Description This is the minimum amount of memory to use when starting the server. For production environments, Oracle recommends setting the initial (minimum) heap size to be equal to the maximum heap size for optimal performance (for example, -Xms1280m). This is the maximum amount of memory to use when starting the server. This is the maximum size of the section of memory that is reserved for permanent generation. Replace YourFilePath with the directory path on the WebLogic server where the log files for the Banner Recruiter Integration Manager are created. It can be any directory on the server for which WebLogic has write permissions. This will override the logging location that was specified in the WAR file and is an optional argument. Replace YourFilePath with the file path of the shared Banner configuration file on the WebLogic server. This will override the configuration that was specified in the WAR file and is an optional argument Ellucian. Confidential & Proprietary 41

42 Install and configure Banner integration components Argument -DBRIM_APP_CONFIG=YourFilePath/ brim_configuration.groovy -Dhttp.proxyEnable=true -Dhttp.proxyHost=YourProxyServer -Dhttp.proxyPort=YourProxyPort -DUseSunHttpHandler=true Description Replace YourFilePath with the file path of the external configuration file on the WebLogic server that should be used by the Banner Recruiter Integration Manager. This will override the configuration that was specified in the WAR file and is an optional argument. If a proxy server is required for HTTP communications, you must add the following arguments. If you fo not require a proxy server, do not add these arguments. If you are using SSL in an environment other than AIX, you must add the following argument. If you are using SSL in an AIX environment or are not using SSL in your environment, do not add this arguement. 11. Click Save. 12. In the Change Center, click Activate Changes. Create the JNDI Data Source If needed, you can create a JNDI Data Source that allows the Banner Recruiter Integration Manager to connect to your Banner database. About this task All Banner XE applications share the same JNDI Data Source. If you are deploying the Banner Recruiter Integration Manager into a WebLogic managed server that already has a JNDI Data Source defined, you can skip to the next procedure. 1. Log in to your Oracle WebLogic Server Administration Console. 2. In the Domain Structure pane, expand Services, and then click Data Sources. 3. In the Change Center, click Lock & Edit. 4. In the Data Sources table, click New > Generic Data Source. 5. On the JDBC Data Source Properties form, enter the following information, and then click Next. Field Name JNDI Name Description Enter a name for the Data Source, such as BRIM DataSource. Enter jdbc/bannerdatasource Ellucian. Confidential & Proprietary 42

43 Install and configure Banner integration components Field Database Type Description Select Oracle. NOTE: Although the specific name of the Data Source is not important, you must enter the JNDI name as it appears above in order for the Banner Recruiter Integration Manager to function properly. 6. From the Database Driver drop-down list, select the Oracle Driver (Thin) 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, and then click Next. Field Database Name Host Name Port Database User Name Password Confirm Password Description Enter the ORACLE_SID of your Banner database. Enter the host name of your Banner database server. Enter the port number of your Banner database server. Enter banproxy. Enter the password for the banproxy account. Re-enter the password for the banproxy account. 10. On the Test Database Connection form, review the information, and then click Test Configuration. 11. If the test was successful, click Next. If the test was unsuccessful, review the connection properties and make any necessary changes. 12. On the Select Targets form, select the Recruiter managed server, and then click Finish. 13. In the Data Sources table, click the Data Source that you created. 14. Click the Connection Pool tab. 15. Specify the following information, and then click Save. Field Description Maximum Capacity Enter 60. Statement Cache Type Select FIXED. Statement Cache Size Enter At the bottom of the page, click the Advanced link to display additional fields Ellucian. Confidential & Proprietary 43

44 Install and configure Banner integration components 17. In the Inactive Connection Timeout field, enter 0, and then click Save. 18. In the Change Center, click Activate Changes. Deploy the Banner Recruiter Integration Manager to the WebLogic server You must deploy the Banner Recruiter Integration Manager to the WebLogic server. 1. Log in to your Oracle WebLogic Server Administration Console. 2. In the Domain Structure pane, click Deployments. 3. In the Change Center, click Lock & Edit. 4. In the Deployments table, click Install. 5. In the Path field on the Install Application Assistant form, enter the location of the WAR file, and then click Next. By default, this is PRODUCT_HOME/current/dist/brim war. 6. On the Choose targeting style form, select Install this deployment as an application, and then click Next. 7. On the Select deployment targets form, select the Recruiter managed server, and then click Next. 8. In the Security section of the Optional Settings form, select DD Only: Use only roles and policies that are defined in the deployment descriptors. 9. In the Source accessibility section, select Copy this application onto every target for me, and then click Next. 10. 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. 11. In the Change Center, click Activate Changes. Restart the Recruiter managed server You must restart the Recruiter managed server. 1. Log in to 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 (or name of the server). 4. On the Settings for Recruiter form, click the Control tab. 5. In the Server Status table on the Control tab, select Recruiter, click Shutdown > Force Shutdown Now, and then click Yes Ellucian. Confidential & Proprietary 44

45 Install and configure Banner integration components 6. After the Recruiter server shuts down, select Recruiter (or name of the server), click Start, and then click Yes. 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 Banner Recruiter Integration Manager is "Active". If the State is "Prepared", perform the following steps to start the deployment: a) In the Deployments table, select the BannerRecruiterIntegrationManager application. b) Click Start > Servicing all requests, and then click Yes. Results You can now access the Banner Recruiter Integration Manager. The URL for the Banner Recruiter Integration Manager consists 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, Enable Cross Domain Security for BEP and BRIM To deploy the Banner Event Publisher and Banner Recruiter Integration Manager on separate WebLogic server domains, you must first enable Cross Domain Security. About this task Cross Domain Security establishes trusted relationship between the two domains by creating matching credentials for each domain. NOTE: This task is only necessary if you are deploying BEP and the Banner Recruiter Integration Manager on separate WebLogic server domains. 1. Log into your Oracle WebLogic Server Administration Console that contains your Banner Recruiter Integration Manager deployment. 2. In Domain Structure pane, click the name of the domain that contains your Banner Recruiter Integration Manager deployment. 3. In the Change Center, click Lock & Edit. 4. In the Settings section, click the Security tab. 5. On the General tab, select the Cross Domain Security Enabled option. 6. Click Save. 7. Click the Advanced link to display the Advanced section. 8. In the Credntial field, enter a password to be used by both the Banner Recruiter Integration Manager and BEP WebLogic server domains Ellucian. Confidential & Proprietary 45

46 Install and configure Banner integration components 9. In the Confirm Credential field, reenter the password. 10. Click Save. 11. In the Change Center, click Activate Changes. 12. In the Domain Structure pane, expand Environment, and then click Servers. 13. For each of the servers in the Servers table, perform the following steps. a) Click the name of the server. b) In the Settings section, click the Control tab. c) In the Server Status table, select the server, and then click Shutdown > Force Shutdown Now. NOTE: Shut down the AdminServer last. 14. After all of the servers in the Servers table have been shutdown, perform the following steps. a) Click the name of the server. b) In the Settings section, click the Control tab. c) In the Server Status table, select the server, and then click Start. NOTE: Shut down the AdminServer first. 15. Log into your Oracle WebLogic Server Administration Console that contains your BEP deployment. 16. In Domain Structure pane, click the name of the domain that contains your BEP deployment. 17. Repeat step 3 through step Log into the WebLogic server that contains your Banner Recruiter Integration Manager deployment. 19. Navigate to the application configuration directory. By default, PRODUCT_HOME\current\instance\config. 20. Open the brim_configuration.groovy file, and then add the following properties. Property jms.jndi.environment. principal="userid" jms.jndi.environment. credentials="yourpassword" Replacement Value In this property, replace UserID with the user ID used to log into the WebLogic Administration Console that contains your BEP deployment. In this property, replace YourPassword with password used to log into the WebLogic Administration Console that contains your BEP deployment. 21. Log into your Oracle WebLogic Server Administration Console that contains your Banner Recruiter Integration Manager deployment. 22. In the Domain Structure pane, expand Environment, and then click Servers Ellucian. Confidential & Proprietary 46

47 Install and configure Banner integration components 23. In the Servers table, click the name of the managed server that contains your Banner Recruiter Integration Manager deployment. By default, Recruiter. 24. In the settings for Recruiter, click the Control tab. 25. In the Server Status table, select Recruiter, and then click Shutdown > Force Shutdown Now. 26. After the Recruiter server shuts down, select Recruiter, and then click Start. 27. After the Recruiter server restarts, verify that the State of the Recruiter server in the Server Status table is "Running." 2015 Ellucian. Confidential & Proprietary 47

48 Install and configure the Colleague integration components Install and configure the Colleague integration components Install and configure the Colleague integration components This section provides instructions for preparing your Colleague ERP system to integrate with Recruiter. If you are using Banner or PowerCampus as your ERP system, you do not need to perform the steps in this section. Set up a Recruiter administrator in Colleague If you are integrating Colleague with Recruiter, you must set up a Recruiter administrative user role in Colleague. Create an Operator record for the administrative user Perform the following steps to create an Operator record for the administrative user. 1. In Colleague UI, create a Person record for the user on the Name and Address Entry (NAE) form. 2. In the Search window, enter UT-SOD to access the Operator Definition (SOD) form. 3. At the Operator ID LookUp prompt, create an Operator ID for the user (for example, RECRUITER). Click OK, and then click Add. 4. In the Name field, enter a name (for example, RECRUITER). 5. In the Security Classes field, enter ST-RECRUITER.IMPORTS. RECRUITER.IMPORTS is an Ellucian-delivered security class that contains the Envision processes needed by the administrative user. 6. Save your changes on the SOD form. Create a user record for the administrative user Perform the following steps to create a user record for the administrative user 1. Access the DMI Registry User Setup (DRUS) form. 2. At the Person LookUp prompt, enter the ID of the person that you created in Step 1. Click OK. 3. In the Person User ID field, enter the desired user ID (for example, recadmin). 4. In the New User Password field, create a temporary default password for the user Ellucian. Confidential & Proprietary 48

49 Install and configure the Colleague integration components 5. In the Env Operator Equivalent field, enter the Operator ID that you created on the SOD form for this user. 6. Save your changes on the DRUS form. Change the default password Perform the following steps to change the default password. 1. Access the Colleague System Credentials Def (CCDF) form. 2. In the Credential ID column of the Colleague Systems Credentials table, enter the ID of the person that you created previously. 3. On the Colleague System Credential Setup (CCSU) form, change the value in the Credential Password field. NOTE: Record the new password. You will need to enter the user ID and this password during the Recruiter installation. 4. Save your changes on the CCSU form. 5. If not already set, set up an notification on the CCDF form to notify you when the password is going to expire. You can use the following fields to set up the notification. For more information, see the Colleague help. Days Before Expiration to Notify Address to Notify Days Between Notifications 6. Save your changes on the CCDF form. Create a staff record for the administrative user Perform the following steps to create a staff record for the administrative user. 1. Access the Staff and Volunteers (SVM) form. 2. At the Staff LookUp prompt, enter the ID of the person that you created in Step 1. Click OK. 3. At the Record not on STAFF file prompt, click Y to create the staff record. 4. In the Staff Code field, enter a code for this user (for example, RECADMIN). 5. In the Operator ID field, enter the Operator ID that you created on the SOD form for this user. 6. In the Staff Type field, select Staff. 7. Save your changes on the SVM form Ellucian. Confidential & Proprietary 49

50 Install and configure the Colleague integration components Retrieve the Colleague integration components If you are integrating Colleague with Recruiter, you must retrieve the following software components or updates using SA Valet. You must also be using Colleague Release 18. About this task See the Updating Colleague Software manual for detailed procedures for retrieving the SA Valet software components and installing the software updates. 1. From SA Valet, retrieve the software components that are listed in the following table. Any software updates that are defined as prerequisites to the listed software updates will be automatically installed if they are not already installed. Software Component Product Description SU DMI DMI update in support of Recruiter 3.6 and higher. SU Colleague Colleague update in support of Recruiter 3.6 and higher. SU Envision Envision update in support of Colleague Web API 1.9. SU Colleague Colleague update in support of Colleague Web API 1.9. IN Installer Colleague Web API From Colleague UI, install the Envision and Colleague software updates. For information about installing the Colleague Web API, see Install and configure the Colleague Web API on page 50 Install and configure the Colleague Web API If you are integrating Colleague with Recruiter, you must install and configure the Colleague Web API. About this task We recommend that the Colleague Web API be installed on a separate server. This server can be shared by all applications that use the Colleague Web API, such as Pilot, Recruiter, and Colleague Self-Service. This web server must be able to communicate with both the Colleague application server and the Recruiter application server Ellucian. Confidential & Proprietary 50

51 Install and configure the Colleague integration components 1. Create a new IIS website, and install the Colleague Web API to the website. See the Installing Colleague Web API section of the Setting Up Colleague Web API manual for information about running the Colleague Web API InstallShield. 2. Configure the web services parameters, Colleague Web API settings, and security settings. See the Configuring and Administering Colleague Web API section of the Setting Up Colleague Web API manual Ellucian. Confidential & Proprietary 51

52 Install and configure PowerCampus integration components Install and configure PowerCampus integration components Install and configure PowerCampus integration components This section provides instructions for preparing your PowerCampus ERP system to integrate with Recruiter. If you are using Banner or Colleague as your ERP system, you do not need to perform the steps in this section. Retrieve PowerCampus integration components If you are integrating PowerCampus 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 PowerCampus or higher Description Contains the version of PowerCampus that integrates with Recruiter 4.1. See the appropriate PowerCampus Installation Guide for more information. This is a required component for Recruiter integration. Configure PowerCampus for integration You must configure PowerCampus before you any additional integration steps. Review and perform the steps in the PowerCampus Integration with Recruiter - Installation and Configuration Guide Ellucian. Confidential & Proprietary 52

53 Install the Recruiter software Install the Recruiter software Install the Recruiter software This section contains steps for installing the Recruiter software. Locate CRM connection details Before you can install Recruiter, you must locate your Microsoft Dynamics CRM connection settings. This information will be required during the Recruiter CRM installation. 1. Access your CRM application server as an administrator. 2. Do the following to determine the CRM organization name and server URL: a) In a browser, open CRM. From the URL, you will need the CRM server URL and the CRM organizations name. These values are the URL of the server, including the port number, and the organization to which you are installing Recruiter. b) Record the values. Where the address components are: CRM Server URL = recruiter.mycollege.edu:5555 CRM Organization Name = Recruiter 3. Do the following to determine the CRM administrator domain and username. a) Access the CRM Deployment Manager. b) In the left pane, click Deployment Administration. c) From the right pane, obtain the CRM administrator domain and username. These values are the domain and the username of the CRM system user who is set up as an administrator for Recruiter. d) Record the values. crm\crmadmin Where the account components are: Account Domain: crm Account Username: crmadmin 2015 Ellucian. Confidential & Proprietary 53

54 Install the Recruiter software Recruiter pre-installation verification Before you install Recruiter, we recommend verifying the following items to ensure that you do not experience issues during the installation. Verify that the CRM administrator has a primary address Before you install Recruiter, we recommend verifying the following items to ensure that you do not experience issues during the installation. 1. Open CRM at 2. Go to System Administration > Security. 3. Click Users. 4. Open the CRM administrator account, and enter an address in the Primary field. Verify bulk components Make sure that you have installed and configured the bulk components. For bulk installation information, see Install bulk on page 20. Verify ERP integration components Make sure that you have installed and configured the appropriate ERP integration components. For ERP integration information, see Install and configure Banner integration components on page 21 or Install and configure the Colleague integration components on page 48. Start the required Windows service You must start the required Windows server for the Recruiter installation. 1. On your CRM asynchronous server, access Windows Services (Start > Administrative Tools > Services) Ellucian. Confidential & Proprietary 54

55 Install the Recruiter software 2. In the Services window, locate Microsoft Dynamics CRM Asynchronous Processing Service. 3. If "Running" is not displayed in the Status column, right-click the service name, and then click Start. Deploy Recruiter assemblies to the GAC The Recruiter assemblies must be added to the GAC on your CRM servers. About this task You must deploy the Recruiter assemblies to the GAC before you install Recruiter into your CRM organization. If you installed Microsoft Dynamics CRM on multiple servers to provide load balancing, you must perform this procedure on each server before you install Recruiter into your CRM organization 1. From the Ellucian Download Center, locate the Recruiter installer for Recruiter 4.1, and save the file on the CRM application server on which you are installing Recruiter. NOTE: You must run the Recruiter installer on the server where you have Microsoft Dynamics CRM installed. 2. Right-click on the installer, and then click Run as administrator. 3. Click Deploy Recruiter Assemblies to the GAC. 4. On the Welcome window, click Next. 5. On the License Agreement window, read the license agreement, select I accept the terms of the license agreement, and then click Next. 6. On the Server Information window, enter your connection information. Server connection setting Description Example Server URL Domain Username Password The URL of your CRM application server, including the port number. Domain of the user set up as a system administrator on the server. Username of the user set up as a system administrator on the server. System administrator account password edu:5555 mycollege crmadmin 2015 Ellucian. Confidential & Proprietary 55

56 Install the Recruiter software Server connection setting Description Example Is IFD Indicates whether the CRM server is set up as an Internet- Facing Deployment. To view your IFD setting, access the Microsoft Dynamics CRM Deployment Manager and view the Deployment Summary section of the page. 7. Click Add Info to add another server, or click Next. 8. On the Additional Configurations window, select the assemblies to be deployed to the GAC, and then click Next. NOTE: Your selections will be applied to all of the remote servers you entered. If any of the servers you entered on the previous window are remote, you will have the option to restart the asynchronous services on those servers and to recycle the CRM application pools on those servers after the assemblies have been deployed to the GAC. 9. After each assembly has been successfully deployed, click Next. Results The Recruiter assemblies have been deployed to the GAC. You can now install Recruiter into your CRM organization. Install the Recruiter CRM components The Recruiter CRM application installs the CRM components for Recruiter on the CRM application server. Before you begin You must deploy the Recruiter assemblies to the GAC. For more information, see Deploy Recruiter assemblies to the GAC on page From the Ellucian Download Center, locate the Recruiter installer for Recruiter 4.1, and save the file on the CRM application server on which you are installing Recruiter. NOTE: You must run the Recruiter installer on the server where you have Microsoft Dynamics CRM installed. 2. Right-click on the installer, and then click Run as administrator Ellucian. Confidential & Proprietary 56

57 Install the Recruiter software 3. Click Install Ellucian Recruiter into a CRM Organization. 4. On the Welcome window, click Next. 5. On the License Agreement window, read the license agreement, select I accept the terms of the license agreement, and then click Next. 6. On the Customer Information window, enter your organization name, code, and password provided to you by Ellucian. 7. Click Next. 8. On the CRM Connection window, enter your connection information, and then click Next. CRM connection setting Description Example Select Connection Internet Facing Deployment CRM Server URL Deployment Server URL Organization Name Admin Account Domain Admin Account Username Select the connection information from a previously entered CRM organization. Indicates whether the CRM server is set up as an Internet- Facing Deployment. To view your IFD setting, access the Microsoft Dynamics CRM Deployment Manager and view the Deployment Summary section of the page. The URL of the machine, including the CRM port number, to which you are installing Recruiter. The URL of the deployment service if the deployment service is located on a separate server. For typical installations, this field should be the same as the CRM Server URL field. Name of the CRM organization to which you are installing Recruiter. Domain of the CRM system user set up as a system administrator. Username of the CRM system user set up as a system administrator. edu: edu:5555 Recruiter mycollege crmadmin 2015 Ellucian. Confidential & Proprietary 57

58 Install the Recruiter software CRM connection setting Description Example Admin Account Password Use Executing User For SQL Authentication SQL Username SQL Password Password for the CRM admin user. Indicates whether you want to use the admin account credentials when connecting to the SQL database. Username of the SQL account to use when connecting to the SQL database. Password for the SQL user account. sqladmin The installer will test the connection information. If the test is not successful, you will receive an error message with additional details. 9. To save the connection information for future use, enter a name, and then click Save. Otherwise, click Skip Saving. 10. On the Recruiter Locale Configuration window, select your locale, and then click Next. 11. On the time zone window, select the time zone where your institution is located, and then click Next. 12. On the Select Language To Install window, click Next. The language is automatically selected based on the organization you are installing Recruiter into and should not be changed. 13. On the list of servers and organizations window, add additional servers and organizations or install Recruiter to the listed servers and organizations. Option Add an additional server and organization to which you want to install Recruiter. Install Recruiter to the listed servers and organizations. Description 1. Click Yes. 2. Repeat steps 8 on page 57 and 9 on page 58. Click No. 14. On the Install Recruiter Help window, create a new website or use an existing website. Option Description Create Website 1. Select the Create Website option. 2. In the New Site Name field, enter a name for the Recruiter help website. 3. In the New Site Port field, enter a unique port number for the Recruiter help website Ellucian. Confidential & Proprietary 58

59 Install the Recruiter software Option Description 4. Click Next. Use Existing Website 1. Select the Use Existing Website option. 2. From the Select Existing Site drop-down list, select the website to which you want to install the Recruiter help website. 3. In the Virtual Directory Name field, enter a name for the virtual directory that will contain the Recruiter help website. If no name is entered, the default directory, Recruiter4_1_0_0, is used. 4. Click Next. 15. On the Install Recruiter Help window, make any changes necessary to the URL for the Recruiter help, and then click Set Setting. 16. On the ready to install window, click Next. 17. After the installation has completed successfully, click Done. Install the Recruiter external website You must install the Recruiter external website to allow prospective students to create accounts, register for events, and submit applications. Before you begin You must run the installer on the server that you want to host the Recruiter external website. The installer cannot be run remotely. NOTE: You must have already install the Recruiter CRM components into an organization before you can install the external website. For more information, see Install the Recruiter CRM components on page From the Ellucian Download Center, locate the Recruiter installer for Recruiter Right-click on the installer, and then click Run as administrator. 3. Click Install Recruiter External Website. 4. On the Welcome window, click Next. 5. On the License Agreement window, read the license agreement, select I accept the terms of the license agreement, and then click Next. 6. On the Customer Information window, enter your organization name, code, and password provided to you by Ellucian Ellucian. Confidential & Proprietary 59

60 Install the Recruiter software 7. Click Next. 8. On the CRM Connection window, enter your connection information, and then click Next. CRM connection setting Description Example Select Connection Internet Facing Deployment CRM Server URL Deployment Server URL Organization Name Admin Account Domain Admin Account Username Admin Account Password Select the connection information from a previously entered CRM organization. Indicates whether the CRM server is set up as an Internet- Facing Deployment. To view your IFD setting, access the Microsoft Dynamics CRM Deployment Manager and view the Deployment Summary section of the page. The URL of the machine, including the CRM port number, to which you are installing Recruiter. The URL of the deployment service if the deployment service is located on a separate server. For typical installations, this field should be the same as the CRM Server URL field. Name of the CRM organization to which you installed Recruiter. Domain of the CRM system user set up as a system administrator. Username of the CRM system user set up as a system administrator. Password for the CRM admin user. edu: edu:5555 Recruiter crm crmadmin 9. On the Choose Install Location window, select the folder to which you want to install the external website, and then click Next. 10. On the Install Recruiter External Website window, create a new website or use an existing website Ellucian. Confidential & Proprietary 60

61 Install the Recruiter software Option Description Create Website 1. Select the Create Website option. 2. In the New Site Name field, enter a name for the Recruiter external website. 3. In the New Site Port field, enter a unique port number for the Recruiter external website. 4. Click Next. Use Existing Website 1. Select the Use Existing Website option. 11. On the ready to install window, click Next. 12. After the site has been created or updated, click Next. 2. From the Select Existing Site drop-down list, select the website to which you want to install the Recruiter external website. 3. In the Virtual Directory Name field, enter a name for the virtual directory that will contain the Recruiter external website. If no name is entered, the default directory, Ellucian.ERecruiting. Web.External, is used. 4. Click Next. 13. On the Recruiter External Site Configuration window, enter the locations of the external application form and the client external CSS file if different from the default values, and then click Next. 14. After the installation has completed successfully, click Done. Update the external website timezone If your external website is deployed on a server that is in a different time zone than that of your institution, you must update the web.config of the external website in order to prevent times, such as event times, from being displayed incorrectly. 1. Log into the server that hosts your Recruiter external website. 2. Open Windows Explorer, and then navigate to the folder containing your external website. By default, C:\intepub\wwwroot\Ellucian.ERecruiting.Web.External\. 3. Open the web.config file in a text editor. 4. Locate the <connectionstrings> section Ellucian. Confidential & Proprietary 61

62 Install the Recruiter software 5. Below the <connectionstrings> section, add the following entry: <appsettings> <add key="clienttimezone" value="yourinstitutiontimezone"> </appsettings> Replace YourInstitutionTimeZone with the name of the time zone where your institution is located, such as "Eastern Standard Time". See ms aspx for a list of time zones. 6. Save the web.config file. Prevent cross frame scripting Placing external website forms in iframes can create a security vulnerability. About this task If your institution displays forms from the external website in iframes, they can be vulnerable to cross frame scripting. To prevent this, you can create a whitelist of websites that are allowed to display the external website forms in an iframe. 1. On your external website server, open Internet Information Services (IIS) Manager. 2. In the Connections pane, expand the server node, expand Sites, and then select your Recruiter external website. 3. In the Features View, open HTTP Response Headers. 4. In the Actions pane, click Add. 5. In the Name field of the Add Custom HTTP Response Header dialog box, enter Content- Security-Policy. 6. In the Value field, enter frame-ancestors Replace with the URL of the website that will frame the external website. 7. Click OK. 8. In the Actions pane, click Add. 9. In the Name field of the Add Custom HTTP Response Header dialog box, enter X-Frame- Options. 10. In the Value field, enter ALLOW FROM Replace with the URL of the website that will frame the external website. 11. Click OK. 12. Restart IIS Ellucian. Confidential & Proprietary 62

63 Install the Recruiter software Install the Recruiter ERP response services You must install the Recruiter ERP response services to integrate Recruiter with your ERP system. Before you begin You must have already install the Recruiter CRM components into an organization before you can install the ERP response services. For more information, see Install the Recruiter CRM components on page From the Ellucian Download Center, locate the Recruiter installer for Recruiter Right-click on the installer, and then click Run as administrator. 3. Click Install Recruiter ERP Response Services. 4. On the Welcome window, click Next. 5. On the License Agreement window, read the license agreement, select I accept the terms of the license agreement, and then click Next. 6. On the Customer Information window, enter your organization name, code, and password provided to you by Ellucian. 7. Click Next. 8. On the CRM Connection window, enter your connection information, and then click Next. CRM connection setting Description Example Select Connection Internet Facing Deployment CRM Server URL Deployment Server URL Select the connection information from a previously entered CRM organization. Indicates whether the CRM server is set up as an Internet- Facing Deployment. To view your IFD setting, access the Microsoft Dynamics CRM Deployment Manager and view the Deployment Summary section of the page. The URL of the machine, including the CRM port number, to which you are installing Recruiter. The URL of the deployment service if the deployment edu: edu: Ellucian. Confidential & Proprietary 63

64 Install the Recruiter software CRM connection setting Description Example Organization Name Admin Account Domain Admin Account Username Admin Account Password service is located on a separate server. For typical installations, this field should be the same as the CRM Server URL field. Name of the CRM organization to which you installed Recruiter. Domain of the CRM system user set up as a system administrator. Username of the CRM system user set up as a system administrator. Password for the CRM admin user. Recruiter mycollege crmadmin 9. On the Choose Install Location window, select the folder to which you want to install the response service, and then click Next. 10. On the Install Recruiter ERP Response Services window, create a new website or use an existing website. Option Description Create Website 1. Select the Create Website option. 2. In the New Site Name field, enter a name for the ERP response service website. 3. In the New Site Port field, enter a unique port number for the ERP response service website. 4. Click Next. Use Existing Website 1. Select the Use Existing Website option. 11. On the ready to install window, click Next. 2. From the Select Existing Site dropdown list, select the website to which you want to install the ERP response service website. 3. In the Virtual Directory Name field, enter a name for the virtual directory that will contain the ERP response service website. 4. Click Next Ellucian. Confidential & Proprietary 64

65 Install the Recruiter software 12. After the site has been created or updated, click Next. 13. On the Recruiter API and ERP Configurations window, enter the configuration information, and then click Next. API and ERP setting Description Example ERP Settings ERP System Endpoint URL The Enterprise Resource Planning system that you are using for this installation The URL of the ERP service endpoint that supports the integration with Recruiter. This is either the URL of the Banner Recruiter Integration Manager, the Colleague Web API, or the PowerCampus Web API. NOTE: If the Banner Recruiter Integration Manager, the Colleague Web API, or PowerCampus Web API were set up on a secured port, you must use "https" and the secured port number when you enter the URL. Colleague com:8090/colleagueapi Username Password Recruiter Settings Endpoint URL The user login for the ERP administrative user. The user password for the ERP The URL of the Recruiter Reponse Service REST endpoints. NOTE: The URL is generated from the values entered on the previous window. admin edu:5555/ Ellucian.ERecruiting. Erp.Response.Services/ DatatelRecruiterResponse.svc/ RESTService Username The user login for the Recruiter Response Service administrative user. admin 2015 Ellucian. Confidential & Proprietary 65

66 Install the Recruiter software API and ERP setting Description Example NOTE: Typically, this is an administrator account on the server, or credentials for the Recruiter Response Service website if authentication has been configured. Password The user password for the Recruiter Response Service administrative user. 14. On the ready to install window, click Next. 15. After the installation has completed successfully, click Done. Set up the ECommerce Website You must install the Ellucian Payment Gateway to be able to collect application fees through your Recruiter external website. Before you begin You must have installed the Ellucian Payment Gateway. For more information about installing the Payment Gateway, see the Payment Gateway Installation s (1.3) manual. 1. From the Ellucian Download Center, locate the Recruiter installer for Recruiter Right-click on the installer, and then click Run as administrator. 3. Click Set Up ECommerce Web Site. 4. On the Welcome window, click Next. 5. On the License Agreement window, read the license agreement, select I accept the terms of the license agreement, and then click Next. 6. On the Customer Information window, enter your organization name, code, and password provided to you by Ellucian. 7. Click Next. 8. On the CRM Connection window, enter your connection information, and then click Next. CRM connection setting Description Example Select Connection Select the connection information from a previously entered CRM organization Ellucian. Confidential & Proprietary 66

67 Install the Recruiter software CRM connection setting Description Example Internet Facing Deployment CRM Server URL Deployment Server URL Organization Name Admin Account Domain Admin Account Username Admin Account Password Indicates whether the CRM server is set up as an Internet- Facing Deployment. To view your IFD setting, access the Microsoft Dynamics CRM Deployment Manager and view the Deployment Summary section of the page. The URL of the machine, including the CRM port number, to which you are installing Recruiter. The URL of the deployment service if the deployment service is located on a separate server. For typical installations, this field should be the same as the CRM Server URL field. Name of the CRM organization to which you installed Recruiter. Domain of the CRM system user set up as a system administrator. Username of the CRM system user set up as a system administrator. Password for the CRM admin user. edu: edu:5555 Recruiter mycollege crmadmin 9. On the Choose Install Location window, select the folder to which you want to install the Payment Gateway, and then click Next. 10. On the Install Recruiter Ecommerce Services Website window, create a new website or use an existing website. Option Description Create Website 1. Select the Create Website option. 2. In the New Site Name field, enter a name for the ecommerce services website Ellucian. Confidential & Proprietary 67

68 Install the Recruiter software Option Description 3. In the New Site Port field, enter a unique port number for the ecommerce services website. 4. Click Next. Use Existing Website 1. Select the Use Existing Website option. 11. On the ready to install window, click Next. 12. After the site has been created or updated, click Next. 2. From the Select Existing Site drop-down list, select the website to which you want to install the ecommerce services website. 3. In the Virtual Directory Name field, enter a name for the virtual directory that will contain the ecommerce services website. 4. Click Next. 13. In the Payment Gateway Server URL field on the Payment Gateway Configuration window, enter the URL, including the.svc extension, of the server that hosts the Payment Gateway service. 14. In the Payment Gateway Provider Key field, enter the Payment Provider Account ID from the Payment Gateway MMC snap-in. 15. Click Next. 16. After the installation has completed successfully, click Done Ellucian. Confidential & Proprietary 68

69 Perform post-installation tasks on the servers Perform post-installation tasks on the servers Perform post-installation tasks on the servers After you install Recruiter and before you log into the software, we recommend that you perform the tasks in this section. Before you begin, you must have completed the installation of all prerequisite software and Recruiter software. Change Internet Information Services (IIS) settings to improve performance We recommend that you change certain settings in IIS to improve Recruiter performance. Change the IIS application pool refresh cycle You can change the refresh cycle of the IIS application pools to reduce page load times in certain instances. About this task By default, IIS is configured to refresh the cache that contains the external website pages every 29 hours. The first user to access each page on the external website after cache has been refreshed may experience longer load times as the cache is recreated. Changing the refresh cycle to a monthly cycle will greatly reduce the number of users affected by the cache recreation. 1. Log into the server that hosts your Recruiter external website 2. Open the Internet Information Services (IIS) Manager. 3. In the IIS Manager folder tree, expand the server node, and then select the Application Pools node. 4. Right-click the Ellucian.ERecruiting.Web.External application pool, and then select Recycling. 5. In the Regular time intervals field, enter 43200, which equals the Ellucian recommended 30 day cycle. 6. Click Next, and then click Finish. 7. Repeat steps 4 on page 69 through 6 on page 69 for the DefaultAppPool application pool Ellucian. Confidential & Proprietary 69

70 Perform post-installation tasks on the servers Change the IIS application pool timeout settings You can change the timeout settings for the IIS application pool using this task. About this task IIS stops application pools after they have been idle for a set amount of time. When the application pool is restarted, IIS recycles the application pool, which clears the cache. The first user to access each page on the external website after the cache has been cleared might experience longer page load times as the cache is recreated. Turning off the application pool timeout setting will reduce the number of users affected by the cache recreation. 1. Log into the server that hosts your Recruiter external website 2. Open the Internet Information Services (IIS) Manager. 3. In the IIS Manager folder tree, expand the server node, and then select the Application Pools node. 4. Right-click the Ellucian.ERecruiting.Web.External application pool, and then select Advanced Settings. 5. In the Idle Time-out field, enter 0, which turns off the idle time-out feature. 6. Click OK. 7. Repeat steps 4 on page 70 through 6 on page 70 for the CRMAppPool and the DefaultAppPool Ellucian. Confidential & Proprietary 70

71 Perform optional Recruiter diagnostics Perform optional Recruiter diagnostics Perform optional Recruiter diagnostics Using the Recruiter installer, you can perform optional diagnostic tests to aid in your application deployment. Verify the CRM installation You can run this diagnostic test on the CRM application server to determine if your CRM connection is working and that the correct software version is installed. 1. On the CRM application server on which you are installed Recruiter, locate the Recruiter installer. 2. Right-click on the installer, and then click Run as administrator. 3. Click CRM Version Diagnostics. Green indicators show whether the installed versions of Microsoft Dynamics CRM and CRM Update are supported by Recruiter. If either indicator is red, you must update to a versions supported by Recruiter. 4. Click Done. Verify the integration settings You can run this diagnostic test on the CRM application server to determine if your integration settings are set and enabled. This diagnostic test checks for existing integration settings and performs basic connection testing. 1. On the CRM application server on which you are installed Recruiter, locate the Recruiter installer. 2. Right-click on the installer, and then click Run as administrator. 3. Click Integration Settings Diagnostics. 4. On the CRM Connection window, enter your connection information, and then click Next. CRM connection setting Description Example Select Connection Select the connection information from a previously entered CRM organization Ellucian. Confidential & Proprietary 71

72 Perform optional Recruiter diagnostics CRM connection setting Description Example Internet Facing Deployment CRM Server URL Deployment Server URL Organization Name Admin Account Domain Admin Account Username Admin Account Password Indicates whether the CRM server is set up as an Internet- Facing Deployment. To view your IFD setting, access the Microsoft Dynamics CRM Deployment Manager and view the Deployment Summary section of the page. The URL of the machine, including the CRM port number, to which you are installing Recruiter. The URL of the deployment service if the deployment service is located on a separate server. For typical installations, this field should be the same as the CRM Server URL field. Name of the CRM organization to which you installed Recruiter. Domain of the CRM system user set up as a system administrator. Username of the CRM system user set up as a system administrator. Password for the CRM admin user. edu: edu:5555 Recruiter mycollege crmadmin A green indicator shows whether the connection test was successful. If the indicator is red, you must review the error log and correct any issues. After you have correct the issues, perform this task again. 5. Click Done Ellucian. Confidential & Proprietary 72

73 Configure and use the Recruiter software Configure and use the Recruiter software Configure and use the Recruiter software 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. Supported browsers for Recruiter You can use any of the supported browsers to access Recruiter The following table provides information about which browsers are supported for Recruiter 4.1. Internet Browser Microsoft Internet Explorer 10 1 Microsoft Internet Explorer 11 Windows 8.1 Windows 7 Windows Vista Mac 10.9 Mac 10.8 Supported Supported Supported Not supported Not supported Supported Supported Supported Not supported Not supported Mozilla Firefox Supported Supported Supported Supported Supported Google Chrome Apple Safari 6.2 Apple Safari 7.1 Not supported Not supported Not supported Not supported Not supported Not supported Not supported Not supported Not supported Supported Not supported Not supported Not supported Supported Not supported NOTE: If you are using Microsoft Internet Explorer, you must disable Compatibility View on intranet sites. To do this, go to Tools > Compatibility View Settings, and clear the Display intranet sites in Compatibility View check box. 1 Internet Explorer 10 that has the new Windows UI optimized for touch devices is only supported for use with the areas of Microsoft Dynamics CRM that have the modern user interface. For more information about Internet Explorer 10 browser experience modes, see Internet Explorer 10 on Windows Ellucian. Confidential & Proprietary 73

74 Configure and use the Recruiter software Supported browsers for the Recruiter external website You can use any of the supported browsers to access the Recruiter external website. The following table provides information about which browsers are supported for the Recruiter 4.1 external website. Internet Browser Microsoft Internet Explorer 10 2 Microsoft Internet Explorer 11 Windows 8.1 Windows 7 Windows Vista Mac 10.9 Mac 10.8 Supported Supported Supported Not supported Not supported Supported Supported Supported Not supported Not supported Mozilla Firefox Supported Supported Supported Supported Supported Google Chrome Apple Safari 6.2 Apple Safari 7.1 Supported Supported Supported Supported Supported Not supported Not supported Not supported Not supported Supported Not supported Not supported Not supported Supported Not supported NOTE: If you are using Microsoft Internet Explorer, you must disable Compatibility View on intranet sites. To do this, go to Tools > Compatibility View Settings, and clear the Display intranet sites in Compatibility View check box. 2 Internet Explorer 10 that has the new Windows UI optimized for touch devices is only supported for use with the areas of Microsoft Dynamics CRM that have the modern user interface. For more information about Internet Explorer 10 browser experience modes, see Internet Explorer 10 on Windows Ellucian. Confidential & Proprietary 74