Luminis Platform Banner Document Management Suite Portal Guide. Release November 2011

Transcription

1 Luminis Platform Banner Document Management Suite Portal Guide Release November 2011

2 Banner, Colleague, PowerCAMPUS, Luminis and Datatel are trademarks of Ellucian or its affiliates and are registered in the U.S. and other countries. Ellucian, Advance, DegreeWorks, fsaatlas, Course Signals, SmartCall, Recruiter, MOX, ILP, and WCMS are trademarks of Ellucian or its affiliates. Other names may be trademarks of their respective owners Ellucian. All rights reserved. The unauthorized possession, use, reproduction, distribution, display or disclosure of this material or the information contained herein is prohibited. Contains confidential and proprietary information of Ellucian and its subsidiaries. Use of these materials is limited to Ellucian licensees, and is subject to the terms and conditions of one or more written license agreements between Ellucian and the licensee in question. In preparing and providing this publication, Ellucian is not rendering legal, accounting, or other similar professional services. Ellucian makes no claims that an institution's use of this publication or the software for which it is provided will guarantee compliance with applicable federal or state laws, rules, or regulations. Each organization should seek legal, accounting and other similar professional services from competent providers of the organization s own choosing. Prepared by: Ellucian 4375 Fair Lakes Court Fairfax, Virginia United States of America Revision History Publication Date November 2011 Summary New version that supports Luminis Platform software.

3 Contents Introduction Prerequisites Software Files and additional documentation Setup Installation steps Step 1 Install and configure BDMS Web services to integrate with Luminis Platform Step 2 Configure CAS for the ApplicationXtender Web Access server in Luminis Step 3 Install the portlet on a Luminis server Step 4 Add the portlet in the Luminis portal Step 5 Configure the ApplicationXtender Web Access tab in the Luminis portal Manage the BDMS portlet Search for Documents Add a Document November 2011 Luminis Platform Contents

4 4 Luminis Platform November 2011

5 Introduction Banner Document Management Suite (BDMS) is the baseline Banner module for imaging and document management. Ellucian and EMC Documentum, a division of EMC Corporation, have formed a partnership to provide an integrated document management and imaging solution for Banner, based on the ApplicationXtender Content Management platform. Banner Document Management Suite integrates the ApplicationXtender suite with Banner administrative solutions to make imaging, document management, enterprise workflow, output management, portable document collections, and storage management options available for both Banner and non-banner users. The Banner Document Management Suite (BDMS) portlet provides a quick, easy tool to search for and add documents and images to your institution's database. If you implement both Luminis Platform and BDMS, you can use the BDMS portlet to display BDMS data in the Luminis portal. This document describes how to install and use the BDMS portlet within Luminis Platform November 2011 Luminis Platform Introduction

6 6 Luminis Platform November 2011 Introduction

7 This section describes how to install the BDMS portlet so that it functions within Luminis Platform. Prerequisites The databases, files and documents, and setup requirements described in the following sections must be completed prior to installing BDMS within Luminis Platform. Software At minimum, the following requirements should be observed when installing and setting up BDMS within Luminis Platform: Banner Document Management Suite ApplicationXtender 6.50 SP1, or higher with ApplicationXtender Web Access.NET Version (.NET Framework Version ) Luminis Portal release or higher Banner Enterprise Identity Services or higher Files and additional documentation The following files and documentation must be obtained prior to installing and setting up BDMS: BDMS WAR file: luminis-bdms.war BDMS Web Services file BDMS_WebServices_AX<n.nn.nnn>.zip Note The value <n.nn.nnn> represents the ApplicationXtender version, for example, if you are using ApplicationXtender , use the BDMS_WebServices_AX zip file. EMC ApplicationXtender Web Services Administration Guide Banner Enterprise Identity Services Handbook November 2011 Luminis Platform

8 To access these files and documents, see the Customer Support Center. Setup The following must be completed before you install the BDMS portlet on Luminis Platform. Integrate BDMS and the Luminis Portal with Banner Enterprise Identity Services. Configure BDMS and the Luminis Portal to participate as clients in a Central Authentication Service single sign-on session (CAS SSO). For details on these configurations, see the Banner Enterprise Identity Services Handbook, available on the Customer Support Center. Installation steps To install the BDMS portlet on Luminis, complete the following procedures: 1. Install and configure BDMS Web Services to integrate with Luminis. 2. Configure CAS for the ApplicationXtender Web Access Server in Luminis. 3. Install the portlet on a Luminis server. 4. Add the portlet in the Luminis portal. 5. Configure the ApplicationXtender Web Access tab in the Luminis portal. Note In all of the procedures, text between < > symbols indicate variables. Replace the variable name with the value applicable to your setup. For example, replace <axserver> with the name of your ApplicationXtender Web Access Server. Step 1 Install and configure BDMS Web services to integrate with Luminis Platform To use the BDMS portlet, BDMS Web Services must be installed and the Luminis server must be able to access BDMS Web Services. Complete the following procedures to install and configure BDMS Web Services: 8 Luminis Platform November 2011

9 Install BDMS Web services To install BDMS Web Services on the ApplicationXtender Web Access server, complete the following steps: 1. Extract the contents of the BDMS_WebServices_AX<n.nn.nnn>.zip file to a temporary directory on the ApplicationXtender Web Access server. 2. Check the location where ApplicationXtender Web Services is installed. Depending on the location, complete one of the following options: If ApplicationXtender Web Services is installed in the default c:\inetpub\wwwroot\appxtenderservices directory, complete the following steps: Navigate to the directory where you extracted the contents of the BDMS_WebServices_AX<n.nn.nnn>.zip file Run the install.bat file. If ApplicationXtender Web Services is installed in another directory, complete the following steps: Note It is recommended that you install the Web Services in the default directory, if possible, to avoid potential upgrade issues Navigate to the directory where you extracted the contents of the BDMS_WebServices_AX<n.nn.nnn>.zip file Edit the install.bat file using an editor such as Edit Plus or vi editor, to set the INSTALLFOLDER variable to point to the ApplicationXtender Web Services installation folder Run the install.bat file. Configure BDMS Web services To configure BDMS Web services to allow the Luminis Platform server access to the services, complete the following steps: 1. Navigate to the directory where BDMS Web services is installed. The default directory is c:\inetpub\wwwroot\appxtenderservices 2. Locate the web.config file and open it using an editor such as Edit Plus or vi editor. 3. Locate the IPSecuritySettings section. This section is located at the end of the file. November 2011 Luminis Platform

10 4. Modify this section to include the IP addresses of the Luminis servers that require access to BDMS Web Services. For example, to grant access to BDMS Web Services to two servers and , modify this section as follows: <IPSecuritySettings IPSecurityType="IPFiltering" > <IPFilters> <clear /> <add name="server1" address=" " /> <add name="server2" address=" " /> </IPFilters> </IPSecuritySettings> Step 2 Configure CAS for the ApplicationXtender Web Access server in Luminis To configure CAS on the Luminis server, complete the following steps: 1. Access the following URL on the Luminis server: 2. Log in as an Administrator. 3. Click Add New Service. 4. Enter the following values: Name: BDMS-AX Web Access Service URL: Description: BDMS-AX Web Access 5. Mark the Enabled, Allowed to proxy, and SSO Participant check boxes: 6. Select UDC_IDENTIFIER under Attributes: 7. Save your changes. 8. Clear your Web browser's cache. 10 Luminis Platform November 2011

11 Step 3 Install the portlet on a Luminis server To install the portlet on a Luminis server, complete the following steps. If Luminis Platform is already set up and running, continue to Step 4, Add the portlet in the Luminis portal : Note The commands listed in the procedures are for a Linux environment. Install the portlet on a new Luminis portal server instance To install the portlet on a new Luminis portal server instance, complete the following steps: 1. Copy the BDMS WAR file -- luminis-bdms.war -- to the <LP5 install directory>/install/temp directory. 2. Run the $JAVA_HOME/bin/jar -xvf luminis-bdms.war command in the temp directory. Note The environmental variable JAVA_HOME should point to the location where JAVA is installed. This will extract the luminis-bdms.war file to the temp directory. 3. Change the directory by running the following command: cd WEB-INF/classes/resources 4. Edit the luminis.bdms.config file using an editor, as follows: Set the value of the <axurl> tag to point to your ApplicationXtender Web Access server. Example: <axurl> Set the value of the <UrlAxServices> tag to point to your ApplicationXtender Web Services URL. Example: <UrlAxServices> AxServicesInterface.asmx </UrlAxServices> November 2011 Luminis Platform

12 Set the value of the <UrlBdmsServices> tag to point to your BDMS wrapper web services URL. Example: <UrlBdmsServices> BDMSServicesInterface.asmx</UrlBdmsServices> Note If you change any of the three values later, you must restart the server so that the ApplicationXtender Web Services client code can pick up the updates. The <datasource>, appdefinitionrefreshrate, and hidden field details can be changed anytime and the portlet will pick up the updated values without a server restart. 5. Change the directory by running the following command: cd <LP5 install directory>/install/temp 6. Recreate the luminis-bdms.war file in the temp folder by running the following command: $JAVA_HOME/bin/jar -cvf luminis-bdms.war WEB-INF/* META-INF/* 7. Run the following command in the temp directory: chmod 777 luminis-bdms.war 8. Run the following commands to copy the BDMS WAR to the deploy location: cp luminis-bdms.war <LP5 install directory>/products/liferay/ liferay-admin/deploy cp luminis-bdms.war <LP5 install directory>/products/liferay/ liferay-portal/deploy 9. Wait for a minute while the updates take effect, and then change the directory by running the following command: cd <LP5 install directory>/products/tomcat/tomcat-admin/webapps 10. Check that the webapps directory has a luminis-bdms sub directory. 11. Change the directory by running the following command: cd <LP5 install directory>/products/tomcat/tomcat-admin/common/ classes 12. Open the log4j.properties file located in this directory, using an editor such as Edit Plus or vi editor, and add the following entry at the end of the file: log4j.category.com.sghe.luminis.bdms=info 13. Change the directory by running the following command: cd <LP5 install directory>/products/tomcat/tomcat-portal/ common/classes 12 Luminis Platform November 2011

13 14. Repeat step Login as a super-user and run the following command to start the Luminis Platform server: cd <LP5 install directory>/bin./lpstart Install the Portlet on an already running Luminis portal server instance To install the BDMS portlet on an already running Luminis portal server instance, complete the following steps: 1. Copy the BDMS WAR file- luminis-bdms.war to the <LP5 install directory>/install/temp directory. 2. Run the following command in the temp directory: chmod 777 luminis-bdms.war 3. Run the following commands to copy the BDMS WAR to the deploy location: cp luminis-bdms.war <LP5 install directory>/products/liferay/ liferay-admin/deploy cp luminis-bdms.war <LP5 install directory>/products/liferay/ liferay-portal/deploy 4. Wait for a minute while the updates take effect, and then change the directory by running the following command: cd <LP5 install directory>/products/tomcat/tomcat-admin/webapps 5. Check that the webapps directory has a luminis-bdms sub directory. 6. Change the directory by running the following command: cd luminis-bdms/web-inf/classes/resources 7. Edit the luminis.bdms.config file using an editor such as Edit Plus or vi editor, as follows: Set the value of the <axurl> tag to point to your ApplicationXtender Web Access server. For example: <axurl> Set the value of the <UrlAxServices> tag to point to your ApplicationXtender Web Services URL. For example: <UrlAxServices> AppXtenderServices/AxServicesInterface.asmx </UrlAxServices> November 2011 Luminis Platform

14 Set the value of the <UrlBdmsServices> tag to point to your BDMS wrapper web services URL. For example: <UrlBdmsServices> AppXtenderServices/ BDMSServicesInterface.asmx</ UrlBdmsServices> Note If you change any of the three values later, you must restart the server so that the ApplicationXtender Web Services client code can pick up the updates. The <datasource>, appdefinitionrefreshrate, and hidden field details can be changed anytime and the portlet will pick up the updated values without a server restart. 8. Change the directory by running the following command: cd <LP5 install directory>/products/tomcat/tomcat-portal/ webapps 9. Check that the webapps directory has a luminis-bdms sub directory. 10. Repeat steps 6 and Change the directory by running the following command: cd <LP5 install directory>/products/tomcat/tomcat-admin/common/ classes 12. Open the log4j.properties file located in this directory, using an editor such as Edit Plus or vi editor, and add the following entry at the end of the file: log4j.category.com.sghe.luminis.bdms=info Note If you want more detailed log information, change INFO to DEBUG. 13. Change the directory by running the following command: cd <LP5 install directory>/products/tomcat/tomcat-admin/common/ classes 14. Repeat step Login as a super-user and run the following command to stop the Luminis Platform server: cd <LP5 install directory>/bin./lpstop 16. From the same directory, run the following command to start the Luminis Platform server:./lpstart 14 Luminis Platform November 2011

15 Step 4 Add the portlet in the Luminis portal Complete the following procedure to add the BDMS portlet to the Luminis Platform portal: 1. Log in to the Luminis Platform portal. If you have logged in as a Luminis Administrator, proceed to step Select either the My Public Pages tab or the My Private Pages tab. 3. Click Welcome. 4. Click Options. 5. Click Add Application. The Add Application window is displayed. 6. Type bdms in the Search applications text box. The search results display the BDMS portlet-luminis-bdms. 7. Click Add. The Banner Document Management portlet is displayed on the Luminis portal page. Step 5 Configure the ApplicationXtender Web Access tab in the Luminis portal Complete the following steps to configure the ApplicationXtender Web Access tab for each user who needs to access ApplicationXtender Web Access functionality: 1. Log in to the Luminis Platform portal. If you have logged in as a Luminis Administrator, proceed to step Select either the My Public Pages tab or the My Private Pages tab. November 2011 Luminis Platform

16 3. Click Welcome. 4. Click Options. 5. Click Manage Pages. The Manage Pages window is displayed. 6. Select the Pages tab. 7. Click on your username. The Add Page section is displayed. 8. Type AX Web Access in the Name box. 9. Select Embedded from the Type drop-down list. 10. Click Add Page. An AX Web Access tab is added and a corresponding link is displayed under your username on the page. 11. Click the AX Web Access link under your username. The edit private page section is displayed. 12. Type the following URL in the URL box: Click Save. You can now use the AX Web Access tab on the Luminis Portal to access ApplicationXtender and BDMS functionality. 16 Luminis Platform November 2011

17 Manage the BDMS portlet The Banner Document Management Suite (BDMS) portlet provides a quick, easy tool to search for and add documents and images to your institution s database. If you have implemented both Luminis Platform and BDMS, you can use the BDMS portlet to display BDMS data in the Luminis portal. For instructions on installing the BDMS portlet for Luminis Platform, see the Luminis Platform Installation Guide. You can access ApplicationXtender Web Access directly through the portlet by clicking the Launch AX Web Access link on the portlet. Search for Documents To search for documents within the BDMS portlet, complete the following steps: 1. Click the Search for documents link in the Advanced Search section of the portlet. The ApplicationXtender search form is displayed. 2. Select the required application from the Application drop-down list. The fields for that application are displayed. 3. Specify the required search criteria in the fields. 4. Click Search. The search results are displayed in the ApplicationXtender Web Access window. November 2011 Luminis Platform Manage the BDMS portlet

18 Add a Document To add a document, complete the following steps: 1. Click the Add Document section of the portlet. The Add Document section expands. 2. Select the required application from the Application drop-down list. 3. Click the Add a document link. The Import New Page window of ApplicationXtender Web Access is displayed. 4. Click Browse to navigate to the document that you want to add, and select the document. 5. Click Upload. 18 Luminis Platform November 2011 Manage the BDMS portlet