Ellucian CRM Recruit Installation and Integration. Release

Transcription

1 Ellucian CRM Recruit Installation and Integration Release

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 CRM Recruit, 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 Ellucian CRM Recruit installation and integration...6 Who should read this content...6 What this content covers... 6 Microsoft Dynamics CRM 2016 documentation... 7 Download Microsoft Dynamics CRM 2016 documentation...7 Plan your deployment... 8 Plan your Microsoft Dynamics CRM security and server deployment...8 Recruit software requirements... 8 Installation checklists Install the Microsoft software checklist Install supporting software checklist Install and configure ERP integration checklist Install Recruit software checklist...15 Perform administrative tasks checklist...17 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)...20 Install the Microsoft Dynamics CRM 2016 Reporting Extensions Create a CRM organization Install the supporting software Install bulk Install and configure Banner integration components...25 Retrieve Banner integration components Upgrade the Banner database...26 Perform the Banner DB upgrade steps Update login.sql Verify that the required products are installed Migrate staged files to permanent directory...28 Migrate staged files on Unix Migrate staged files on Windows...29 Provide necessary grants to the BANPROXY user Update the version number Ellucian. Confidential & Proprietary 3

4 Contents Verify the banproxy database account Set up a Recruit integration user in Banner...30 Banner Recruiter Integration Manager security Security access...32 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...36 Application-specific configuration...36 Centralized Applications configuration JMX bean names...39 Logging configuration...40 Output logging file location Central Authentication Service SSO Regenerate the WAR file Configure Banner Event Publisher (BEP) for Recruit...43 Install BEP Verify the BEP installation...43 Configure BEP for Recruit...44 Create event metadata Enable and disable BEP events Configure BEP events...46 Configure the confirmed date decision code...46 Configure the confirmed date deposit code Configure the enrolled date decision code...48 Create durable subscribers...48 Deploy the Banner Recruiter Integration Manager...49 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...57 Restart the Recruit managed server Verify deployment of the Banner Recruiter Integration Manager APIs Enable Cross Domain Security for BEP and BRIM...59 Install and configure the Colleague integration components Set up a Recruit administrator in Colleague...62 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...64 Install and configure the Colleague Web API...64 Install and configure PowerCampus integration components...66 Retrieve PowerCampus integration components...66 Configure PowerCampus for integration Ellucian. Confidential & Proprietary 4

5 Contents Install the Recruit software...67 Locate CRM connection details...67 Recruit pre-installation verification Verify that the CRM administrator has a primary address...67 Verify bulk components Verify ERP integration components Start the required Windows service...68 Deploy Recruit assemblies to the GAC...68 Install the Recruit CRM components...70 Install the Recruit external website...74 Update the external website timezone...77 Prevent cross frame scripting...78 Install the Recruit ERP response services Set up the ECommerce Website Perform post-installation tasks on the servers...85 Change Internet Information Services (IIS) settings to improve performance Change the IIS application pool refresh cycle Change the IIS application pool timeout settings...86 Perform optional Recruit diagnostics...87 Verify the CRM installation Verify the integration settings Configure and use the Recruit software Ellucian. Confidential & Proprietary 5

6 About Ellucian CRM Recruit installation and integration About Ellucian CRM Recruit installation and integration About Ellucian CRM Recruit installation and integration This document includes information about installing and configuring Ellucian CRM Recruit and the Recruit integration components on premises at your institution. Who should read this content Anyone responsible for the installation and initial configuration of Recruit 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 Recruit. Installing and configuring the supporting software that is required for use with Recruit. Installing and setting up the Recruit Enterprise Resource Planning (ERP) integration components if you are using Banner by Ellucian, Colleague by Ellucian, or PowerCampus By Ellucian. Installing the Recruit software. Performing post-installation tasks on the servers. Performing optional Recruit diagnostics. Note: After you have completed the tasks in this document, you must access the Recruit Help within Microsoft Dynamics CRM. The Recruit Help contains required post-installation tasks to perform in Recruit and information about how to initially load data into, configure, and use Recruit Ellucian. Confidential & Proprietary 6

7 Microsoft Dynamics CRM 2016 documentation Microsoft Dynamics CRM 2016 documentation Microsoft Dynamics CRM 2016 documentation Microsoft provides detailed documentation to help you plan and deploy your Microsoft Dynamics CRM 2016 implementation. Download Microsoft Dynamics CRM 2016 documentation The Deploying and administering Microsoft Dynamics CRM Online and Microsoft Dynamics CRM 2016 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 2016 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 2016 guide from the following location: details.aspx?id= Administering CRM 2016 for online and on-premises guide is also available and can be used to help manage and configure features of CRM deployments. Note: This manual includes basic steps for retrieving and installing the Microsoft software that is required before you can install Recruit. For comprehensive requirements and configuration details, refer to the Deploying and administering Microsoft Dynamics CRM Online and Microsoft Dynamics CRM 2016 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 2016 and Recruit 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 2016 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 2016 guide that you downloaded in Microsoft Dynamics CRM 2016 documentation on page 7. Security considerations for Microsoft Dynamics CRM 2016 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 2016 server roles Browser support Microsoft provides a current list of the browsers that are supported by Microsoft Dynamics CRM See for more information. Recruit software requirements The following software is required to support Recruit. The software requirements are listed by server, not by order of installation. To speed up installation time, the Microsoft Dynamics CRM 2016 server setup and ERP system setup can be performed in parallel. Microsoft Dynamics CRM 2016 database server Windows Server 2012 or Windows Server 2012 R2.NET Framework 4.6 SQL Server 2012 SP2 or SQL Server 2014 SQL Server 2012 or 2014 Reporting Services Microsoft Dynamics CRM 2016 Reporting Extensions 2015 Ellucian. Confidential & Proprietary 8

9 Plan your deployment Microsoft Dynamics CRM 2016 asynchronous server Windows Server 2012 or Windows Server 2012 R2.NET Framework 4.6 including Windows Identity Foundation components Back End Server role for Microsoft Dynamics CRM 2016 Microsoft Dynamics CRM 2016 application server Windows Server 2012 or Windows Server 2012 R2.NET Framework 4.6 including Windows Identity Foundation components Front End Server and Deployment Administration Server roles for Microsoft Dynamics CRM 2016 Microsoft Dynamics CRM Router (optional) Internet Information Services (IIS) 8 or 8.5, depending on the Windows Server version Recruit CRM components Recruit external website server Windows Server 2012 or Windows Server 2012 R2.NET Framework 4.6 including Windows Identity Foundation components Internet Information Services (IIS) 8 or 8.5, depending on the Windows Server version Recruit external website components Ellucian Payment Gateway for Recruit payments only Banner. Servers vary. Note: Recruit integrates with Banner, Colleague, or PowerCampus. Banner General or higher Banner Student 8.8 or higher Banner Database Upgrade 9.3 or higher Banner Event Publisher 1.2.3, 1.2.4, , or higher Note: BEP is not supported if you are using XCAS/UCAS or BDM. Banner Financial Aid or higher (if licensed) Banner Document Management 9.1 with AX Web Services and AX Web Access.NET 6.5 SP2 (if licensed) Note: You must first install BDM and then upgrade to 9.1. Banner Recruiter Integration Manager 2.1 WebLogic with Java 7 SDK or with Java 7 SDK or Java 8 SDK 2015 Ellucian. Confidential & Proprietary 9

10 Plan your deployment Colleague. Servers vary. Note: Recruit integrates with Banner, Colleague, or PowerCampus. Colleague Release 18 Colleague software updates Colleague Web API 1.9 or 1.10 PowerCampus. Servers vary. Note: Recruit integrates with Banner, Colleague, or PowerCampus. PowerCampus or higher 2015 Ellucian. Confidential & Proprietary 10

11 Installation checklists Installation checklists Installation checklists We recommend that you install the required software using the sequence of steps in the following tables. Install the Microsoft software checklist The following table lists the steps to upgrade the Microsoft software used by Recruit Task Location Details 1. Install Windows Server 2012 or Windows Server 2012 R2, 64-bit version. CRM database 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 2016 guide. 2. Enable.NET Framework 4.6. CRM database server 3. Set up Active Directory users. CRM database server Recruit requires that you set up two system administrator users. 4. Install SQL Server 2012 SP2 or SQL Server Deploy SQL Server 2012 or 2014 Reporting Services. CRM database server CRM database server See the "SQL Server installation and configuration" section of the Deploying and administering Microsoft Dynamics CRM Online and Microsoft Dynamics CRM 2016 guide. See the "SQL Server installation and configuration" section of the Deploying and administering Microsoft Dynamics CRM Online and Microsoft Dynamics CRM 2016 guide Ellucian. Confidential & Proprietary 11

12 Installation checklists Task Location Details 6. Review the Microsoft Dynamics CRM documentation for SQL Server requirements and recommendations. CRM database server 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 2016 guide. 7. Configure security for your SQL Server. CRM database server See Configure security for the SQL Server on page Install Windows Server 2012 or Windows Server 2012 R2, 64-bit version. 9. (Optional) Create an Organization Unit (OU) for security groups created by CRM. CRM asynchronous server CRM asynchronous server See the "Software requirements for Microsoft Dynamics CRM Server 2013" section of the Deploying and administering Microsoft Dynamics CRM Online and Microsoft Dynamics CRM 2016 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 Enable.NET Framework 4.6. CRM asynchronous server 11. Enable Windows Identity Foundation. CRM asynchronous server 12. Install the Back End Server role for Microsoft Dynamics CRM Install Windows Server 2012 or Windows Server 2012 R2, 64-bit version. CRM asynchronous server CRM application server See Install Microsoft Dynamics CRM 2016 on page 19. See the "Software requirements for Microsoft Dynamics CRM Server 2013" section of the Deploying and administering Microsoft 2015 Ellucian. Confidential & Proprietary 12

13 Installation checklists Task Location Details 14. Enable.NET Framework 4.6. CRM application server 15. Enable Windows Identity Foundation. CRM application server Dynamics CRM Online and Microsoft Dynamics CRM 2016 guide. 16. Install the Front End Server and Deployment Administration Server roles for Microsoft Dynamics CRM CRM application server See Install Microsoft Dynamics CRM 2016 on page Install the Microsoft Dynamics CRM Router (optional). 18. Install the Microsoft Dynamics CRM Reporting Extensions. CRM application server See Install the Microsoft Dynamics CRM Router (optional) on page 20. CRM database server See Install the Microsoft Dynamics CRM 2016 Reporting Extensions on page Create an organization in Microsoft Dynamics CRM. CRM application server See Create a CRM organization on page 22. Install supporting software checklist The following table lists the steps to install supporting software required by Recruit Task Location Details Install bulk CRM application server You must install the bulk solution before installing Recruit on your CRM application server Ellucian. Confidential & Proprietary 13

14 Installation checklists Task Location Details See Install bulk on page 23 for more information. Install and configure ERP integration checklist The following table lists the steps to install and configure Recruit to integrate with your ERP system. Task Location Details Install and configure Banner integration with Recruit Install and configure Colleague integration with Recruit Install and configure PowerCampus integration with Recruit Banner servers Colleague servers PowerCampus servers For Banner institutions only. See Install and configure Banner integration components on page 25 for more information. For Colleague institutions only. See Install and configure the Colleague integration components on page 62 for more information. For PowerCampus institutions only. See Install and configure PowerCampus integration components on page 66 for more information Ellucian. Confidential & Proprietary 14

15 Installation checklists Install Recruit software checklist The following table lists the steps to install Recruit Task Location Details 1. Locate the CRM connection details CRM application server Before you can install Recruit, you must locate your Microsoft Dynamics CRM connection settings. This information will be required during the Recruit installation. See Locate CRM connection details on page 67 for more information. 2. Locate the CRM administrator details CRM application server Before you can install Recruit, you must locate your Microsoft Dynamics CRM administrator account domain and username. This information will be required during the Recruit installation. See Locate CRM administrator details for more information. 3. Perform pre-installation steps. CRM application server See Recruit pre-installation verification on page 67 for more information. 4. Start the required Windows service CRM application server See Start the required Windows service on page 68 for more information. 5. Deploy Recruit assemblies to the GAC CRM application server See Deploy Recruit assemblies to the GAC on page 68 for more information Ellucian. Confidential & Proprietary 15

16 Installation checklists Task Location Details 6. Install the Recruit CRM components CRM application server See Install the Recruit CRM components on page 70 for more information. 7. Install the Recruit external website Recruit external website server You must install the Recruit external website to allow prospective students to create accounts, register for events, and submit applications. See Install the Recruit external website on page 74 for more information. 8. Update the external website timezone Recruit external website server See Update the external website timezone on page Prevent cross frame scripting Recruit external website server See Prevent cross frame scripting on page Install the Recruit ERP response services CRM application server You must install the Recruit ERP response services to integrate Recruit with your ERP system. See Install the Recruit ERP response services on page 78 for more information. 11. Install the ECommerce website CRM application server You must install the Ellucian Payment Gateway to be able to collect application fees through your Recruit external website. See Set up the ECommerce Website on page 82 for more information Ellucian. Confidential & Proprietary 16

17 Installation checklists Perform administrative tasks checklist The following table lists the steps to perform after you have completed the installation of Recruit Task Location Details 1. Perform post-installation tasks. CRM application server See Perform post-installation tasks on the servers on page Perform optional diagnostics. CRM application server See Perform optional Recruit diagnostics on page Perform post-installation tasks in Recruit. CRM application server See the Recruit Help within Microsoft Dynamics CRM for more information Ellucian. Confidential & Proprietary 17

18 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 Recruit. 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.6, SQL Server 2012 SP2 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.6, and Windows Identity Foundation. For additional details and recommended order of installation components, see Installation checklist. Configure security for the SQL Server All CRM data, Recruit 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 SP2 or SQL Server 2014 Security and Protection (Database Engine): technet.microsoft.com/en-us/library/bb510589%28v=sql.110%29.aspx SQL Server 2012 SP2 or SQL Server 2014 Best Practices Analyzer: technet.microsoft.com/en-us/library/dn aspx 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 2016 installation, security groups are created and updated in your Active Directory infrastructure. You can choose to create an OU in your 2015 Ellucian. Confidential & Proprietary 18

19 Install the Microsoft software 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). Install Microsoft Dynamics CRM 2016 Recruit 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 2016 components must be installed on both the Recruit CRM asynchronous server and the Recruit CRM application server. Note: For Recruit, the Microsoft Dynamics CRM 2016 "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 Ellucian. Confidential & Proprietary 19

20 Install the Microsoft software 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 2016 installer, select No for the option to use the Microsoft 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 2016, 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 2016 installer, select No for the option to use the Microsoft 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 2016, not the temporary license key provided by Microsoft when you downloaded Microsoft Dynamics CRM What to do next If you are using for Microsoft Office Outlook, you must also install the appropriate 32-bit or 64-bit Microsoft Outlook connector client on each 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.8).aspx. For information about supported service configurations for server-side synchronization, which is the preferred option, see Ellucian. Confidential & Proprietary 20

21 Install the Microsoft software 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 Recruit 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 Implementation Guide for CRM Online and CRM 2016 at download/details.aspx?id= Install the Microsoft Dynamics CRM 2016 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 Recruit 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 Ellucian. Confidential & Proprietary 21

22 Install the Microsoft software Create a CRM organization Recruit requires that you create at least one organization in Microsoft Dynamics CRM 2016 to make the deployment available for users. Before you begin You must have already installed Microsoft Dynamics CRM 2016 on the CRM asynchronous and CRM application servers and the Microsoft Dynamics CRM 2016 Reporting Extensions on the CRM database server. For more information, see Install Microsoft Dynamics CRM 2016 on page 19 and Install the Microsoft Dynamics CRM 2016 Reporting Extensions on page 21. On the CRM application server, create a CRM organization. For instructions on creating an organization in CRM, see library/dn aspx. Warning! To prevent Recruit 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 22

23 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 Recruit Install bulk You must install the bulk solution before installing Recruit on your CRM application server. Before you begin If you are using the Recruit Spanish translation, you must install bulk with CRM configured for the Spanish language. Note: You must disable your browser s pop-up blocker to complete this task. 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 from the Ellucian Download Center. 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 Settings > 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. Note: During the import, you may receive a warning stating that hierarchical relationships for entities will change. This warning is normal and can be ignored. Microsoft Dynamics CRM uploads the bulk solution. You can view details about the installation by clicking View solution package details. 7. Click Next Ellucian. Confidential & Proprietary 23

24 Install the supporting software 8. In the Post Import Actions section, verify that the Enable any SDK message processing steps included in the solution option is selected. 9. Click Import. Microsoft Dynamics CRM imports the bulk solution. 10. On the Importing Solution dialog box, click Close Ellucian. Confidential & Proprietary 24

25 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 Recruit. 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 Recruit, 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 General or higher Banner Student 8.8 or higher Banner Financial Aid or higher (if licensed) Banner Database Upgrade 9.3 or higher Description Contains the version of Banner General that integrates with Recruit See the appropriate Banner General Release Guide for more information. This is a required component for Recruit integration. Contains the version of Banner Student that integrates with Recruit See the appropriate Banner Student Release Guide for more information. This is a required component for Recruit integration. Contains the version of Banner Financial Aid that integrates with Recruit See the appropriate Banner Financial Aid Release Guide for more information. This is an optional component for Recruit integration. Contains the database components and security classes that support the Banner integration 2015 Ellucian. Confidential & Proprietary 25

26 Install and configure Banner integration components Software Banner Document Management 9.1 with AX Web Services and AX Web Access.NET 6.5 SP2 (if licensed) Note: You must first install BDM and then upgrade to 9.1. Banner Event Publisher 1.2.3, 1.2.4, , or higher Description with Recruit See Upgrade the Banner database on page 26 for more information. This is a required component for Recruit integration. Contains the version of Banner Document Management that integrates with Recruit See the appropriate Banner Document Management Release Guide for more information. This is an optional component for Recruit integration. Enables events in Banner to be sent to Recruit through the Banner Recruiter Integration Manager.See Configure Banner Event Publisher (BEP) for Recruit on page 43 for more information. This is a required component for Recruit integration. Note: BEP is not supported if you are using XCAS/UCAS or BDM. Banner Recruiter Integration Manager 2.1 Enables communication between Banner and Recruit. See Prepare the Banner Recruiter Integration Manager release package on page 32 manual for more information. This is a required component for Recruit integration. Upgrade the Banner database You must upgrade the Banner database before you perform any additional integration steps. Warning! if you have Banner Operational Data Store (ODS) installed, you must run the Banner ODS Preprocessor for Banner XE (ODSPREBXE) solution before you upgrade the Banner database. The ODSPREBXE reduces the impact that a Banner XE installation or upgrade can have on ODS refresh times. For more information, see the Banner ODS Preprocessor for Banner XE manual and Ellucian Support Center article Ellucian. Confidential & Proprietary 26

27 Install and configure Banner integration components Perform the Banner DB upgrade steps Common database upgrade steps for all Banner 9.x applications must be performed before you upgrade the database for the Banner Recruiter Integration Manager application. About this task Banner Recruiter Integration Manager requires Banner Database Upgrade 9.3 or higher to be installed before starting the installation of this release. Note: If you have already installed the 9.3 release, you can skip to the next procedure. Refer to the instructions in the Banner Database Upgrade Guide manual for the database upgrade steps. Update login.sql You must edit login.sql to update the schema owner s default password and to specify the path to create log files. 1. Replace the #UPDATEME# string with the value of a particular schema owner's password in your environment. Make this update in your environment for each Banner schema owner. 2. Set the value that gets assigned to splpref. The value can be set to the ORACLE_SID or to a directory name. Your options depend on your operating system. The splpref variable defines the file prefix that the installation process uses to generate listings or intermediate SQL routines. This feature allows you to segregate the generated output when the stage must be applied to more than one instance. Verify that the required products are installed You must check to ensure that all prerequisite products are installed in the environment. 1. Run SQL*Plus, and run the following procedure: sqlplus 2. Review the ruappready listing Ellucian. Confidential & Proprietary 27

28 Install and configure Banner integration components Migrate staged files to permanent directory Migration scripts are provided for the Unix and Windows platforms. These scripts expect your directory structure to match the directory structure created by the Banner isntallation process. If you choose a different directory structure, you must modify the scripts. Note: The release does not include migration scripts for other platforms due to their highlight customized structures. You can, however, use the file STUMIGR.TXT as a starting point for writing your own migration scripts. Migrate staged files on Unix The file STUMIGR.TXT lists all files that must be deleted from your permanent directories, and all files that should be copied from the staging directory to your permanent directories. About this task The file stumigr.shl does the appropriate removes, copies, and links. The local LN variable at the top of stumigr.shl determines the type of links that are used in the migration. Note: If you want to use symbolic links, set LN='ln -s' so that the command ${LN} file $BANNER_HOME/links is translated to ln -s file$banner_home/links. Note: If you want to force the removal of any existing targets before linking files, set LN='ln -f'. 1. Ensure that the directory path names in stumigr.shl are correct. 2. Ensure that the environment variable $BANNER_HOME in stumigr.shl is set to the appropriate directory. 3. Sign on to an operating system account that has write permission into the targetbanner directories. If you are a cshell user (your operating system prompt is a percent sign), enter sh and press Enter to enter the Bourne shell. 4. Navigate to the staging directory for the product. 5. Run the migration script as follows: sh stumigr.shl >stumigr.log 2>&1 & 6. If you were a cshell user and want to return to that mode, press CTRL-D or enter exit. Then press Enter. 7. Review stumigr.log. This file contains the results of the migration Ellucian. Confidential & Proprietary 28

29 Install and configure Banner integration components Results Note: Even if your directory structure matches the baseline perfectly, some link commands will fail (that is, where the link currently exists). Other link errors might indicate that you had two copies of an object when the migration script was executed. This condition must be corrected. The duplication is probably between links and the product subdirectory. Migrate staged files on Windows You must run the stumigr.pl migration script if you are using a Windows platform. 1. Check the value of the BANENV environment variable by executing the SET command from the DOS prompt. If the value of BANENV is REG, the value used for BANNER_HOME will be taken from the HKEY_LOCAL_MACHINE\SOFTWARE\BANNER\BANNER_HOME registry entry. If the value of BANENV is ENV, the value used for BANNER_HOME will be taken from the environment variable BANNER_HOME. 2. Ensure that the directory path names in stumigr.pl are correct. 3. Sign on to an operating system account that has write permission into the targetbanner directories. 4. Navigate to the staging directory for the product. 5. Run the migration script as follows: perl stumigr.pl >stumigr.log 2>&1 6. Review stumigr.log. This file contains the results of the migration. Provide necessary grants to the BANPROXY user You must provide grants to the BANPROXY user. Before you begin You will need the password for the BANINST1 user. About this task Note: Some grants may be provided for non-existent objects, and these grants may generate errors. These errors can be ignored Ellucian. Confidential & Proprietary 29

30 Install and configure Banner integration components 1. Run SQL*Plus, and then run the following procedure: sqlplus 2. Review the brim_baninst1_grants listing. Update the version number You must insert the release version number into the Web Application (GURWAPP) table. Before you begin You will need the password for the GENERAL user. 1. Run SQL*Plus, and then run the following procedure: sqlplus 2. Review the sudv2brim0100 listing. 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 Recruit integration user in Banner You must set up a Recruit user in Banner. About this task The Banner Recruiter Integration Manager requires this user to be able to pull data from Banner into Recruit. 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 Recruit Ellucian. Confidential & Proprietary 30

31 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 31

32 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 Recruit Integration objects in order for the user to use Banner Recruit 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 7 SDK or the Java 8 SDK installed on the WebLogic server, and you must make sure that the Java bin directory is defined in the PATH system properly. WebLogic is required if you are using the Java 8 SDK Ellucian. Confidential & Proprietary 32

33 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 33

34 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 35. 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 34

35 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 35