Banner Integration Technologies Integration for elearning Learning Management Gateway Installation Guide. Release 4.0, Revision 2 July 2009

Transcription

1 Banner Integration Technologies Integration for elearning Learning Management Gateway Installation Guide Release 4.0, Revision 2 July 2009

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 February 2007 May 2009 July 2009 Summary New version that supports Banner Integration Technologies Integration for elearning 4.0 software. Document revised to reflect current company branding. Document revised to identify special characters that cannot be used in passwords.

3 Banner Integration Technologies 4.0 Learning Management Gateway Installation Guide Contents Chapter 1 Installing LMG: A Summary Installing LMG: The Details Step 1 Install JDK Windows Solaris / Linux Step 2 Create an Installation Directory Step 3 Create a System Environment variable for LMG Directory Step 4 Copy the LMG Distribution Jar File Step 5 Run the Jar-packaged Java Application Processing Notes SCTERPGateway Directory Step 6 Run the mbldisetup Script Step 7 Learn About the LMG Properties Files Event Provider Grade Adapter Step 8 Configure Event Provider Properties Event Property Table Key SSL/TLS Mode Option Step 9 Configure Grade Adapter Properties Grade Adapter Property Table Key SSL/TLS Mode Option Oracle Security Option Step 10 Configure the Log Files July 2009 Banner Integration Technologies 4.0 iii Learning Management Gateway Installation Guide

4 Chapter 2 Administering Learning Management Gateway Start the LMG Start Event Provider Start Grade Adapter Stop the LMG Stop Event Provider Stop Grade Adapter Upgrade to LMG Log Processing Enable Debugging Reconfigure Logging Levels Events Grade Adapter Sample Log File iv Banner Integration Technologies 4.0 July 2009 Learning Management Gateway Installation Guide

5 1 Installing Learning Management Gateway Learning Management Gateway (LMG) is composed of two components: Event Provider and Grade Adapter. LMG distribution is a Java jar file (similar to a zip format) that contains the distributions for Event Provider and Grade Adapter. LMG distribution is not platform dependent, and JDK x or 5.x is all that is required to install, extract, and run the distribution. LMG 4.0 requires: Luminis Platform IV, which incorporates the Smart/Notify event function. Banner Intcomp 7.3 or above. JDK version x or 5.x. Note LMG does not have to be installed on the same server where Luminis Message Broker (LMB) is installed. LMG can communicate with LMB from any server in the LAN. Installing LMG: A Summary 1. Install JDK (1.4.2.x or 5.x) 2. Create an installation directory 3. Create a system environment variable for LMG directory 4. Copy the LMG distribution jar file 5. Run the jar-packaged Java application 6. Run the mbldisetup script 7. Learn about the LMG properties files July 2009 Banner Integration Technologies

6 8. Configure Event Provider properties 9. Configure Grade Adapter properties 10. Configure the log files Installing LMG: The Details Ellucian recommends that you install LMG 4.0 as a full install from the distribution lmg4.0.jar. Warning LMG 4.0 can also process events generated from Banner Intcomp 7.3 or above. If there are events in Banner which are generated from previous versions of Banner Intcomp, then those events must be completely processed by the compatible versions of LMG. If such events are unprocessed when LMG 4.0 processing begins, LMG could impede the event from process completion. Step 1 Install JDK JDK can be downloaded from: Windows 1. Install JDK on the server. 2. If Luminis Platform is not installed on this machine, add the JAVA_HOME environment variable to point to the JDK installation directory. If Luminis Platform is also installed on this machine, do not add the JAVA_HOME environment variable for JDK since doing so may interfere with Luminis Platform. Solaris / Linux If Luminis Platform is not installed on this machine, do the following: 1. Install JDK. 2. Add the JAVA_HOME environment variable. 1-2 Banner Integration Technologies 4.0 July 2009

7 If Luminis Platform is installed on this machine, do the following: 1. Create a separate user account for LMG. This account should not have Luminis Platform installed on it. 2. Install JDK. 3. Create a local JAVA_HOME environment variable for this LMG account. Note Since the value of JAVA_HOME will be overridden by the local value, the JDK used by LMG will not interfere with the working of Luminis, which is installed in another account. Step 2 Create an Installation Directory Create an installation directory to house the LMG. Example: Windows: <drive>:\scterpgateway Solaris / Linux: /export/home/scterpgateway Step 3 Create a System Environment variable for LMG Directory Create a system environment variable SCT_LMG_HOME to point to the directory created in Step 2 Create an Installation Directory on page 1-3. Example: Windows: SCT_LMG_HOME = <drive>:\scterpgateway Solaris / Linux: Create a new environment variable in the log in profile of the account where LMG needs to be installed: SCT_LMG_HOME =/export/home/scterpgateway; export SCT_LMG_HOME July 2009 Banner Integration Technologies

8 Step 4 Copy the LMG Distribution Jar File Copy lmg4.0.jar to the directory created in Step 2 Create an Installation Directory on page 1-3. Note Transfer lmg4.0.jar in binary mode if you are transferring from a different server. Step 5 Run the Jar-packaged Java Application Run the Java application packaged with the jar file as shown below. The illustration Figure 1 on page 1-5 shows the directory structure that is created. java -jar lmgx.x.jar -erp plus/banner -lmbhost lmbserver -dburl dbserver:port:instance -dbpw mydbpasswd -jmspw myjmspasswd -ldi true/false -notification true/false where: X.x. in.jar represents the version number of your LMG (for example: lmg4.0.jar). erp is a switch to indicate either Banner or Plus ERP. lmbhost is the server hosting LMB. dburl is the database server URL (host:port:instance--in that order). dbpw is the database password for user integmgr. jmspw is the JMS password to be assigned to sctlmguser. This password is automatically updated in the mbldisetup script that creates the respective JMS users, topics, and queues and provides access privileges. ldi is a switch to indicate whether the install would process LDI events. Permissible values are true or false. notification is a switch to indicate whether the install would process Smart/ Notify events. Permissible values are true or false. If your are running in a Windows environment and Luminis Platform is installed on the same machine, change startevents.bat under Events/bin by substituting java with the full path of the JDK (not JRE) Java executable. Example Before java -classpath %CP% com.sctcorp.events.messageadapter -configdir %CONFIG_DIR% 1-4 Banner Integration Technologies 4.0 July 2009

9 After D:\java\j2sdk5.x\bin\java.exe -classpath %CP% com.sctcorp.events.messageadapter -configdir %CONFIG_DIR% Executing the installer automatically creates the property settings. Processing Notes For clustered database configuration, you can specify a complete URL format of the database configuration similar to what is found in tnsnames.ora at the command line. If the URL format String is large, provide the value to the dburl switch as a cluster and edit the property files described in Step 7 Learn About the LMG Properties Files on page 1-8 to accommodate the complete URL. Provide the switch of true for at least one of the properties: ldi=true and notification=false. You can also set a value of true for both LDI and Smart events in the same install. SCTERPGateway Directory This illustration shows the directory structure that is created: Figure 1: Gateway Directory Structure Step 6 Run the mbldisetup Script The mbldisetup script is used to create required destinations and channels in LMB. This script uses the mbtool utility provided by LMB to create and modify destinations and provides access privileges to users on those destinations. Access to the mbtool utility is a July 2009 Banner Integration Technologies

10 prerequisite to run this script. Refer to the Luminis Message Broker Installation and Administration Guide for further information on the mbtool utility. Script mbldisetup configures the LMB with the required users and destination objects for Event Provider and Grade Adapter. Defaults in the configuration property files for Event Provider and Grade Adapter are the default values shown in the following table. Ideally, none of these parameters should require editing. The following table describes the parameters for queues, topics, and LDAP users. Parameter Name SCT_LMG_USER Description LDAP user that connects on behalf of LMG. Default: sctlmguser SCT_LMG_PW SCT_GRADE_QUEUE_INBOUND LDAP password for the above user. Autofilled when the mbldisetup script is run. Grade Adapter listens for Grade update requests on this queue in LMB. Default: com_sct_ldi_sis_updaterequest SCT_GRADE_QUEUE_OUTBOUND Grade Adapter provides an UpdateReply message to a Grade update request on this queue in LMB. Default: com_sct_ldi_sis_updatereply SCT_MAIN_DISPATCH_TOPIC Event Provider publishes all Sync events to this topic in LMB. Default: com_sct_ldi_sis_sync SCT_LMS_DISPATCH_TOPIC Event Provider publishes only LMS (Learning Management System) -specific events to this topic in LMB. Default: com_sct_ldi_sis_lmssync SCT_ERROR_TOPIC Topic for SyncError messages and orphaned UpdateReply messages. Default: com_sct_ldi_sis_error SCT_QUEUE_CONNECTION_FACTORY Connection Factory object required by LMG to talk to LMB queues. Default: com_sct_ldi_sis_queueconnfactory 1-6 Banner Integration Technologies 4.0 July 2009

11 Parameter Name SCT_TOPIC_CONNECTION_FACTORY Description Connection Factory object required by LMG to talk to LMB topics. Default: com_sct_ldi_sis_topicconnfactory SCT_TOPIC_CONNECTION_FACTORY_SSL Connection Factory object required by LMG to talk to LMB topics using SSL. Default: com_sct_ldi_sis_ssl_topicconnfactory RE_INITIALIZE true = Delete and recreate the above objects if they already exist in LMB. false (default) = Skip recreating the object, but add the required permissions on those objects to the user. If you require a rerun of this script, set this value to true. The mbldisetup script is used to create required destinations and channels in the LMB and to configure the LMB with user and destination objects for Event Provider and the Grade Adapter. Follow the steps to run this script. 1. Transfer the mbldisetup script to the server where LMB is installed. If using FTP, use ASCII transfer mode. 2. Run mbldisetup Begin by using your operating system instructions below: Windows: Execute the script from a Cygwin command window that is installed with LMB. Solaris: Execute mbldisetup as a shell script The LMG installer script provides the execute permissions. Execute the script as shown:./mbldisetup If topics from previous versions are already present on LMB, running the mbldisetup script verifies that the current LMG user has access to those topics. July 2009 Banner Integration Technologies

12 Step 7 Learn About the LMG Properties Files This step familiarizes you with two files that you must modify for your institution. Event Provider: $SCT_LMG_HOME/Events/config/event_providers.plist Grade Adapter: $SCT_LMG_HOME/GradeAdapter/config/adapter.properties Event Provider The event_providers.plist consists of two sections: SIS section from which the event information is polled JMS transport section to communicate with the JMS broker (LMB) Grade Adapter The adapter.properties consists of two sections: SIS section to transfer the grade exchange information JMS transport section to communicate with the JMS broker (LMB) The property settings for Event Provider and Grade Adapter have been automatically filled from Step 5 Run the Jar-packaged Java Application on page 1-4. Step 8 Configure Event Provider Properties To change the property settings, edit event_providers.plist and configure the Event Provider properties as outlined in Table 1 on page 1-9 and Table 2 on page Event Property Table Key The Events/bin/seteventpw script obfuscates the java.naming.security.credentials/jmspassword, Banner database password (if applicable), and automatically updates the Events/config/event_providers.plist file with respective encrypted passwords. Run this script to accommodate any password changes in the property files. Do not use the following special characters ([ ] { } \ : ; " ' < >? / ~ `) in your password because they are not defined in the encryption algorithm. Using them will generate the following error: 1-8 Banner Integration Technologies 4.0 July 2009

13 java.lang.stringindexoutofboundsexception: String index out of range: -1 error. Note Double asterisks (**) indicate an option to configure and run the LMG in SSL/TLS mode. Configure the following parameters as shown: SSL/TLS Mode Option Property QueueConnectionFactory Value/Description cn=com_sct_ldi_sis_ssl_queueconnfactory, ou=administeredobjects Must match SCT_QUEUE_CONNECTION_FACTORY_SSL in mbldisetup. TopicConnectionFactory cn=com_sct_ldi_sis_ssl_topicconnfactory, ou=administeredobjects Must match SCT_TOPIC_CONNECTION_FACTORY_SSL in mbldisetup. Table 1: Event Provider Properties Property Value/Description Name Banner Event Provider #1 Name for the Event Provider to allow multiple active Event Providers. This is a free-text field. Class com.sctcorp.events.bannerlearnvpdeventpro vider This is the default value. Name of the Java class file for the Event Provider. PollingInterval JDBCDriver 60 (default) Specify the number of seconds between attempts to poll the Banner event queue. oracle.jdbc.driver.oracledriver July 2009 Banner Integration Technologies

14 Table 1: Property Event Provider Properties Value/Description ConnectionUrl The JDBC connection URL Autofilled from Step 5 Run the Jar-packaged Java Application on page 1-4. Example: jdbc:oracle:thin:@banner.sct.com:1521:b40 User Password PersistentConnection integmgr Autofilled from Step 5 Run the Jar-packaged Java Application on page 1-4. true MaxResultSizePerPoll 60 Specify the number of events to fetch from the SIS in every poll. EncryptConnection false Set to true if using Oracle s ASO. EncryptionClient REQUIRED EncryptionTypesClient ( DES40 ) CryptoChecksumClient REQUESTED CryptoChecksumTypesClient ( MD5 ) ValidateXML true Validates XML against DTD before publishing. Set to false to turn DTD validation off. DTDUriBase file:/// Directory that holds the DTDs and other resources. Autofilled from Step 5 Run the Jar-packaged Java Application on page Banner Integration Technologies 4.0 July 2009

15 Table 2: Property Name Event Provider JMS Properties Value/Description LMG EVENT PUBLISHER java.naming.factory.initial java.naming.security. authentication java.naming.security. principal java.naming.security. credenials java.naming.provider.url JMSConnectionFactory QueueConnectionFactory com.sun.jndi.ldap.ldapctxfactory simple cn=sctlmguser,ou=people,o=messaging Must match SCT_LMG_USER in mdldisetup Autofilled from Step 5 Run the Jar-packaged Java Application on page 1-4. ldap://brokerhost:389/o=messaging <brokerhost> is autofilled from Step 5 Run the Jar-packaged Java Application on page 1-4. com.sctcorp.events.jndiconnectionfactory cn=com_sct_ldi_sis_queueconnfactory, ou=administeredobjects Must match SCT_QUEUE_CONNECTION_FACTORY in mbldisetup ** TopicConnectionFactory cn=com_sct_ldi_sis_topicconnfactory,ou=a dministeredobjects Must match SCT_TOPIC_CONNECTION_FACTORY in mbldisetup script ** MainOutboundTopic cn=topic$com_sct_ldi_sis_sync, ou=administeredobjects Must match SCT_MAIN_DISPATCH_TOPIC in mbldisetup OnlineCourseTopic cn=topic$com_sct_ldi_sis_lmssync, ou=administeredobjects Must match SCT_LMS_DISPATCH_TOPIC in mbldisetup JMSUser sctlmguser Must match SCT_LMG_USER in mdldisetup July 2009 Banner Integration Technologies

16 Table 2: Property JMSPassword Event Provider JMS Properties Value/Description Autofilled from Step 5 Run the Jar-packaged Java Application on page 1-4. Note: Destination names provided in mbldisetup do not start with topic$ and queue$, but they are stored in LDAP with topic$ and queue$ prefixed to destination names. LDAP browser query reveals that queues and topics are stored with the queue$ and topic$ respectively prefixed to the JMS objects. Step 9 Configure Grade Adapter Properties To change the property settings, edit the adapter.properties file and configure the properties in Table 3 on page 1-13 and Table 4 on page Grade Adapter Property Table Key GradeAdapter/bin/setgradepw script obfuscates the java.naming.security.credentials/jmspassword, Banner database password (if applicable), and automatically updates the GradeAdapter/config/adapter.properties file with respective encrypted passwords. Run this script to accommodate any changes to passwords in the property files. Do not use the following special characters ([ ] { } \ : ; " ' < >? / ~ `) in your password, because they are not defined in the encryption algorithm. Using them will generate the following error: java.lang.stringindexoutofboundsexception: String index out of range: -1 error. Note Double asterisks (**) indicate a configuration option to set up and run the LMG in SSL/TLS mode Banner Integration Technologies 4.0 July 2009

17 Configure the following parameters as shown: SSL/TLS Mode Option Property QueueConnectionFactory TopicConnectionFactory Value/Description cn=com_sct_ldi_sis_ssl_queueconnfactory,o u=administeredobjects Must match SCT_QUEUE_CONNECTION_FACTORY_SSL in mbldisetup cn=com_sct_ldi_sis_ssl_topicconnfactory,o u=administeredobjects Must match SCT_TOPIC_CONNECTION_FACTORY_SSL in mbldisetup Table 3: Property Name Grade Adapter Properties Value/Description SCT GRADE ADAPTER ProcessorFactory com.sctcorp.adapter.messaging.processo.ba nnerprocessorfactory This is the default. Class to handle Grades for Banner SIS. JDBCDriver ConnectionUrl oracle.jdbc.driver.oracledriver JDBC connection URL. Example: User Password EncryptConnection integmgr Autofilled from Step 5 Run the Jar-packaged Java Application on page 1-4. false Set to true if using Oracle s ASO. EncryptionClient REQUIRED July 2009 Banner Integration Technologies

18 Table 3: Property Grade Adapter Properties Value/Description EncryptionTypesClient ( DES40 ) CryptoChecksumClient REQUESTED CryptoChecksumTypes-Client ( MD5 ) MaxConnections 2 ValidateXML DTDUriBase true Validate XML against DTD. Set to false to turn DTD validation off. file:/// Directory that holds the DTDs and other resources. Auto filled from Step 5 Run the Jar-packaged Java Application on page 1-4. Table 4: Property Name Grade Adapter JMS Properties Value/Description LMG GRADE ADAPTER java.naming.factory.initial java.naming.security.authentication java.naming.security.principal com.sun.jndi.ldap.ldapctxfactory simple cn=sctlmguser,ou=people,o=messaging Must match SCT_LMG_USER in mdldisetup java.naming.security.credentials java.naming.provider.url Autofilled from Step 5 Run the Jar-packaged Java Application on page 1-4. ldap://brokerhost:389/o=messaging <brokerhost> autofilled from Step 5 Run the Jarpackaged Java Application on page 1-4. JMSConnectionFactory com.sctcorp.events.jndiconnectionfactory 1-14 Banner Integration Technologies 4.0 July 2009

19 Table 4: Property Grade Adapter JMS Properties Value/Description QueueConnectionFactory cn=com_sct_ldi_sis_queueconnfactory,ou=ad ministeredobjects Must match SCT_QUEUE_CONNECTION_FACTORY in mbldisetup ** TopicConnectionFactory InboundGradesQueue cn=com_sct_ldi_sis_topicconnfactory,ou=ad ministeredobjects Must match SCT_TOPIC_CONNECTION_FACTORY in mbldisetup ** cn=queue$com_sct_ldi_sis_updaterequest,ou =AdministeredObjects Must match SCT_GRADE_QUEUE_INBOUND in mbldisetup ErrorTopic cn=topic$com_sct_ldi_sis_error,ou=adminis teredobjects Must match SCT_ERROR_TOPIC in mbldisetup JMSUser sctlmguser Must match SCT_LMG_USER in mdldisetup JMSPassword Autofilled from Step 5 Run the Jar-packaged Java Application on page 1-4. Note: Destination names provided in mbldisetup do not have topic$ and queue$ prefixed. An LDAP browser query reveals that queues and topics are stored with the queue$ and topic$ respectively prefixed to the JMS objects and are therefore needed in configurations here. Oracle Security Option Oracle's "Advanced Security Option" (ASO) includes features to support data encryption, data integrity, third-party authentication, and authorizations. LMG takes advantage of these encryption features through the Oracle JDBC drivers. The following security parameters for encryption and integrity are set in the event_providers.plist.banner and adapter.properties files: EncryptionConnections EncryptionClient false required; July 2009 Banner Integration Technologies

20 EncryptionTypesClient CryptoChecksumClient CryptoChecksumTypesClient (RC4_40,DES40C); required; (MD5) If your Oracle database is configured for ASO, set EncryptConnection to true, to use the security features. Step 10 Configure the Log Files Refer to Log Processing on page 2-3 in this document to configure logging properties for the Event Provider and Grade Adapter so that you can tailor them for your institution. You are ready to start the LMG and begin event and grade processing. Review the following chapter for operating instructions Banner Integration Technologies 4.0 July 2009

21 2 Administering Learning Management Gateway This chapter assumes that you have followed the procedures in the preceding chapter. This chapter contains information about how to : Start the LMG Stop the LMG Upgrade the LMG Log processing of the messages Start the LMG You are now ready to start event and grade processing. Use the following instructions to start the LMG. Start Event Provider Change directory to Events/bin and execute the following script: Windows - startevents.bat Solaris - runevents The script creates four log files in the logs directory: adapter.log shows adapter log information. dispatch.log shows event IDs of published events. ldi_event_data.log shows the XML of LDI events being published to LMB. Smart_event_data.log shows the XML of Smart events being published. July 2009 Banner Integration Technologies Administering Learning Management Gateway

22 Start Grade Adapter Change directory to GradeAdapter/bin and execute the following script: Windows - startgradeadapter.bat Solaris - rungradeadapter The script creates two log files in the logs directory: adapter.log shows adapter log information. perf.log shows performance timings of each Grade update request message. Refer to Log Processing on page 2-3 for related information about log management. Stop the LMG You must stop the LMG before modifying the configuration. Use the following instructions to stop the LMG. Stop Event Provider In a Windows environment, give a Ctl+c command on the command window that was opened when you ran startevents.bat, or simply close the command window that was opened when you ran startevents.bat. In a Solaris environment, execute the stopevents script. Stop Grade Adapter In a Windows environment, give a Ctl+c command on the command window that was opened when you ran startgradeadapter.bat, or simply close the command window that was opened when you ran startgradeadapter.bat. In a Solaris environment, execute the stopgradeadapter script. 2-2 Banner Integration Technologies 4.0 July 2009 Administering Learning Management Gateway

23 Upgrade to LMG Stop LMG and clear all contents in the $SCT_LMG_HOME folder. 2. Copy lmg4.0.jar into the existing $SCT_LMG_HOME directory. 3. Execute steps Step 5 Run the Jar-packaged Java Application on page 1-4 and Step 6 Run the mbldisetup Script on page 1-5. Log Processing The LMG application logs runtime information about messages being processed using an open source Log4j package. Logging behavior is controlled by editing configuration files (logging.properties) without modifying the application binary. The configuration files are distributed with the lmg4.0.jar file and reside in the configuration directories of Events and Grade Adapter. Log4j recommends using any of the following logging levels: FATAL ERROR WARN INFO DEBUG The DEBUG level denotes fine-grained information that is most useful to debug an application. The FATAL level denotes very severe error events that often make applications abort. Enable Debugging Modify the logging level in logging.properties. Reconfigure Logging Levels The following are the properties to Modify Events and Grade Adapter: Events 1. Locate the following lines in Events/config/logging.properties: log4j.rootcategory=info log4j.category.com=info, out log4j.category.com.sctcorp.events.messageadapter=info July 2009 Banner Integration Technologies Administering Learning Management Gateway

24 2. Replace the properties as indicated below: log4j.rootcategory=debug log4j.category.com=debug, out log4j.category.com.sctcorp.events.messageadapter=debug LMG Release 4.0 s smart_event_data.log file holds the pertinent logs for Smart events. The file previously named as event_data.log file has been renamed ldi_event_data.log file. You can reconfigure the new log files, ldi_event_data.log and smart_event_data.log, in the same manner as those existing properties above. Note This file is delivered with a default log level of INFO. You can turn off the logging by changing the log level to WARN like this: log4j.category.events=warn, events log4j.category.smevents=warn, smevents The contents of the ldi_event_data.log and smart_event_data.log files are set with the property of: log4j.appender.events.layout.conversionpattern=%d [%t] %-5p %c - %m%n If you prefer to have minimal data in these two log files, you can modify the above property as follows: log4j.appender.events.layout.conversionpattern=%d %x - %m%n For more information on setting logging patterns, please refer to the log4j guides. Grade Adapter 1. Locate the following lines in Edit GradeAdapter/config/logging.properties: log4j.rootcategory=info log4j.category.com=info, out log4j.category.com.sctcorp.messaging.messageadapter=info 2. Replace the properties as indicated below: log4j.rootcategory=debug log4j.category.com=debug, out log4j.category.com.sctcorp.messaging.messageadapter=debug 2-4 Banner Integration Technologies 4.0 July 2009 Administering Learning Management Gateway

25 LMG applications do not need to be restarted after modifying the logging configuration. LMG automatically picks up these changes. A daemon thread polls the logging.properties every 60 seconds for changes. Rollover logging appender features of Log4j are used to back up the log file when it reaches 1 MB. When rollover occurs, the old version of adapter.log automatically moves to adapter.log.1. The number of such rollovers is configurable and is set to 10 in the logging.properties file. Sample Log File The following log file represents sample data from an ldi_event_data.log. July 2009 Banner Integration Technologies Administering Learning Management Gateway

26 :06:33,337 - EventID: EventCode = LDITERM. EventDate = T09:57: :06:33,347 - classifyparameters: EVENTTYPE=SYNC;DATATYPE=TERM;SOURCEDID1=200601;RECSTATUS=1;PARA METER1=CREATE; :06:33,828 - EVENTTYPE / SYNC :06:33,828 - DATATYPE / TERM :06:33,828 - SOURCE / BANNER System Test SCT Banner :06:33,828 - ONLINETOPIC / Y :06:33,828 - G.SOURCEDID.ID / :06:33,828 - G.GROUPTYPE.SCHEME / Luminis :06:33,828 - G.GROUPTYPE.TYPEVALUE / Term :06:33,828 - G.GROUPTYPE.TYPEVALUE.ATT.LEVEL / :06:33,838 - G.DESCRIPTION.SHORT / :06:33,838 - G.DESCRIPTION.LONG / INTCOMP 7.3 NEW :06:33,838 - G.TIMEFRAME.BEGIN / :06:33,838 - G.TIMEFRAME.BEGIN.ATT.RESTRICT / :06:33,838 - G.TIMEFRAME.END / :06:33,838 - G.TIMEFRAME.END.ATT.RESTRICT / :06:33,838 - G.ENROLLCONTROL.ENROLLACCEPT / :06:33,838 - G.ENROLLCONTROL.ENROLLALLOWED / :06:33,838 - G.EXTENSION.LUMINISGROUP.SORT / :06:33,868 - ************************* GENERATED XML - BEGIN***************************** <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE enterprise SYSTEM "ldisp- 2.0.dtd"><enterprise><properties><datasource>BANNER System Test SCT Banner</ datasource><datetime> t09:57:04</datetime></ properties><group><sourcedid><source>banner System Test SCT Banner</ source><id>200601</id></sourcedid><grouptype><scheme>luminis</scheme><typevalue level="1">term</typevalue></grouptype><description><short>200601</ short><long> INTCOMP 7.3 NEW</long></description><timeframe><begin restrict="0"> </begin><end restrict="0"> </end></ timeframe><enrollcontrol><enrollaccept>1</enrollaccept><enrollallowed>0</ enrollallowed></enrollcontrol><extension><luminisgroup><sort>200601</sort></ luminisgroup></extension></group></enterprise> ************************* GENERATED XML - END***************************** :06:34,529 - XML for is a valid document :06:35,730 - Message published to Luminis Message Broker. 2-6 Banner Integration Technologies 4.0 July 2009 Administering Learning Management Gateway