Specify Banner registration messages

Specify the types of course section registration error messages displayed to the mobile user.

About this task

Note: You can skip this procedure if you want to accept the default: Only course section registration error messages with an errorFlag of F (Fatal) are displayed to mobile users.

If a mobile user attempts to register for a Banner course section and there is an issue with the registration, the Banner Student API will return a message to Ellucian Mobile. This could indicate an error that would prevent registration or an issue that would not prevent registration but that might make registration inadvisable.

Each message (crnError) includes an errorFlag attribute which could be F (Fatal) or W (Warning). By default, only fatal error messages are sent from the mobile server to the mobile device. Warnings are generally intended for an administrator who is registering a student. However, you might want to display both fatal errors and warnings to mobile users. To change the types of error messages sent to mobile users, edit your banner-mobileserver-config.groovy file as described below.

Procedure

  1. Open your banner-mobileserver-config.groovy file in an editor.
  2. Add the following section anywhere in the file.

    /*Registration options*/

    ellucian.student.registration.banner.crnErrorFlagsToEmit = "F"

    Note: The default value of "F" provides the same behavior as if this section was not in the banner-mobileserver-config.groovy file.
  3. To change the course section registration error messages displayed to the mobile user, change ellucian.student.registration.banner.crnErrorFlagsToEmit to include all desired values, separated by commas.
    For example, if you want mobile users to see error messages (crnErrors) with errorFlag values of both F (Fatal) and W (Warning), set ellucian.student.registration.banner.crnErrorFlagsToEmit to "F,W".
  4. Save your changes to the banner-mobileserver-config.groovy file.
  5. Restart Tomcat to apply the changes.