Skip to main content
ExLibris
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    Registration Status

    Overview

    The Registration Status product integration allows students to view their registration status for a particular term.

    Vendors

    The Registration Status product integration is currently supported by the Ellucian Banner (XE) vendor.

    User Experience

    The following section describes information relating to the user experience for the Registration Status product integration.

    User Activities

    Students can view their registration status for a particular term.

    User Workflow

    A single page application (SPA) with no redirects out of the page (or app).

    Authentication

    The Account Info product integration requires the user's identifier from the vendor's system. This is obtained with the token based authentication attributes.
    The connection to the vendor is handled as part of the generic API Configuration component (in App Manager, in the product instance). This is found under the Vendor section on the configuration page.

    Offline Support

    No offline support is provided, since the data would not be current and no data is preferable to inaccurate data.

    Screenshots

    The following are examples of screenshots of the Registration Status product integration user interface for a reference when configuring it:
    registration_status_1.png registration_status_2.png registration_status_3.png
    registration_status_4.png registration_status_5.png  

    Technical Overview

    The following section describes technical information for the Registration Status product integration.

    Supported Vendors

    Only Ellucian BannerXE is supported. The numbered release is Banner 9.
    • Banner 9 is the latest release of Banner.
    • XE is an add-on to Banner that allows customers to extend it.
    • For all integrations done prior to this product integration, Banner 9 and XE are interchangeable.

    Prerequisites

    The following prerequisities are required for the Registration Status product integration.
    • User identifier mapping
      • If you have CMAuth configured, map the relevant vendor ID in the integration profile (Additional Mapping). For example: bannerId=employeeID, where employeeID is the relevant user attribute on the vendor’s backend system.
      • If you have LDAP configured, verify that the relevant attribute is returned as an attribute from the LDAP response.
    • Map the relevant vendor ID in the integration profile for the app profile.

    Configuration

    To configure the Registration Status product integration, select Add Product Integration from the Product Integrations main menu option.
    Select Registration Status and the following configuration page appears:
    registartion_status_configuration.png
    Registration Status Configuration
    The following table describes the configuration options available on this page.
    Non-mandatory fields are displayed with their default values unless otherwise noted.
    Configuration Option Description Mandatory Data Type Default Example
    Manage Integration
    Enable Product Integration Select to enable the product integration on the user's campusM app. No Checkbox Unselected  
    Product Integration Description A description of the product integration for internal use Yes String    
    Screen Title The title that appears in the top header of the service No String Registration Status  
    Look and Feel No      
    Primary Theme Color Select a color for the main elements on the page No Color Picker #444444  
    Secondary Theme Color Select a color for the secondary elements on the page No Color Picker #6f8ea4  

    Past Terms (in days)

    Display past terms for the last number of days

    No

    String

    0

     

    Next Terms (in days)

    Display future terms for the next number of days

    No

    String 

     0

     

    General Configuration
    Show the Credits Earned section Enables or disables whether or not the user can see the Credits Earned block. No Boolean true  
    Show the Curriculum Information section Enables or disables whether or not the user can see the Curriculum Information block. No Boolean true  
    Text / Labels Enter replacement text for the default titles and labels No String    
    Terms Page Header Displayed at the top of the Terms landing page, if enabled. No String Select a Term  
    No Terms Message Displayed when the terms service returns a valid response, but there are no valid terms in it. No String No terms found.  
    Unknown Terms Text Displayed any time a term is to be displayed, but there is no valid description for that term. No String Unknown Term  
    Registration Status Page Header Displayed at the top of the selected Registration Status page, followed by the term description. No String Status for Term  
    Registration Status Disclaimer Custom text to outline a student's registration and academic status. No String Displayed below are the various items which may affect your registration. Your Time Ticket, Holds, Academic Standing, Student Status, Classes and Curriculum may prevent registration or restrict the courses you will be permitted to select.  
    No Status Information Message Displayed when the status service returns a valid response, but there are no valid items in it. No String No status information found for this term.  
    Credits Earned "Hours" Text The suffix for displaying any value in hours. No String    
    Terms Service Failure Message This message will appear when the integration is unable to reach or process the terms API correctly. No String    
    Service Failure Message This message will appear when the integration is unable to reach or process the registration status API correctly. No String The page is having trouble fetching your status - please Service Failure Message
    Vendor – This section defines the structure of the APIs used in this product integration.
    Vendor Name Defines to which vendor the integration connects. The Account Info product integration is currently supported by the Ellucian Banner XE vendor. Yes Drop-down list   API
    API Configuration
    This section contains the API details  to define the API structure. You can test the API configuration. See Testing API Product Integration Configuration.
    Base URL to retrieve the information The URL for the API Yes URL   https://{HOST}
    Parameter Input Option The parameter input option for Banner ID. Possible values: Username, Token Property, and Constant. It is sent as the path parameter.   Yes Drop-Down list Token Property
    Authentication Type Authentication type against the web service. The options are the following:
    • No Auth
    • Basic - username and password for Base64 basic authentication.
    Yes Drop-down list    
    Import/ Export Configuration
    You can configure product integration and then export it to another campusM environment, for example, from sandbox to production or from preview to production.  
    Export Create a JSON file with all product integration configuration. No      
    Import Use this option in order to load configuration from JSON of an exported product integration. No      
    • Was this article helpful?