Debugging

Send detailed information from Ellucian Mobile to the log file to support troubleshooting.

About this task

By default, the Mobile Integration Server has error level debugging turned on; that is, only error information is sent from Ellucian Mobile to the log file. This level of debugging is defined in the Ellucian Mobile WAR file.

For initial setup or troubleshooting, you can specify that detailed Ellucian Mobile activity (not only errors) is sent to the log file. This is done by using the log4j section in the <sis>-mobileserver-config.groovy file. The debugging specified in the <sis>-mobileserver-config.groovy file overrides the debugging specified in the WAR file.

Procedure

  1. Open your <sis>-mobileserver-config.groovy file in an editor.
  2. Locate the log4j section in the file, and uncomment that section.
  3. Change the file entry under rollingFile to match the path for your mobileserver.
  4. If you want to limit the detailed debugging to specific types of activity, to limit the growth of the log file, replace the last line of that code section ('com.ellucian') with the specific package for the activity that you want to investigate, using the information in the table below. For example, to investigate grades activity, change the end of the log4j section to look like this: 
    
    debug 'grails.app.services.com.ellucian',
          'grails.app.controllers.com.ellucian',
          'grails.app',
          'com.ellucian.mobile.grade'
}
    Package Logs data for this type of activity... Notes
    com.ellucian.mobile.banner Banner Student Api Used only by Banner
    com.ellucian.mobile.colleague Colleague Web API Used only by Colleague
    com.ellucian.mobile.​powercampus PowerCampus WebAPI Used only by PowerCampus
    com.ellucian.mobile.ilp ILP Platform API Used only by Colleague and Banner
    com.ellucian.mobile.beacons Mobile beacons
    com.ellucian.mobile.​configuration Management of mobileserver configuration data
    com.ellucian.mobile.core Core mobileserver functionality
    com.ellucian.mobile.course Course and registration
    com.ellucian.mobile.directory Directory, both database and LDAP versions
    com.ellucian.mobile.events Event calendar
    com.ellucian.mobile.events.​parser Event calendar parsing
    com.ellucian.mobile.feed News feeds
    com.ellucian.mobile.finance Student finance
    com.ellucian.mobile.grade Grades
    com.ellucian.mobile.maps Maps
    com.ellucian.mobile.​notification Retrieval of notifications from the SIS
    com.ellucian.mobile.​notifications General notifications functionality
    com.ellucian.mobile.numbers Important numbers
    com.ellucian.mobile.security Login and authentication (SIS, LDAP, CAS, or SAML)
    com.ellucian.mobile.system Core functionality
    com.ellucian.mobile.​verification Verification of configuration entries (database and server URLs and credentials)
  5. Save your changes to the <sis>-mobileserver-config.groovy file.
  6. Restart Tomcat to apply the changes.
    Note: To turn off detailed debugging, comment out the <log4j> section.