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

    My Advisor

    campusM + cmLibrary Logo wh bkg sm1.png

    Overview

    The My Advisor product integration provides users with the ability to view a list of their advisors and their contact information.

    Vendors

    The My Advisor product integration currently supports Ellucian Colleague (custom) ERP systems, Oracle PeopleSoft, and RESTfulAPI.

    User Experience

    The following section describes information relating to the user experience for the My Advisor product integration.

    User Activities

    Students select the My Advisor tile and their advisor information is displayed.

    Offline Support

    No offline support is provided.

    Screenshots

    The following is an overview of the My Advisor product integration user interface for reference when configuring it:

    Technical Overview

    The following section describes technical information for the My Advisor product integration.

    Prerequisites

    The following prerequisites are required to configure the My Advisor product integration:

    • For PeopleSoft, the API needs to be configured to take the user's unique identifier as the prompt_fieldvalue. The unique identifier attribute can be correctly mapped in the Integration Profile.

    Required Format

    Select one of the following links for the required format for that vendor:

    • Ellucian Colleague (custom) ERP systems Vendor
    • Oracle PeopleSoft Vendor

    Ellucian Colleague (custom) ERP systems Vendor

    A direct connection to the Ellucian Colleague (custom) API is required. Any middleware or client-specific implementation causes the API response to deviate from what the cloud platform is expecting.

    GET https://{host}/ColleagueApi/students/(userIdentifier}

    {

        "DegreePlanId": 1234,

        "ProgramIds": [

            "UG.ENGLISH-ED.BA"

        ],

        "StudentRestrictionIds":[

       

        ],

        "HasAdvisor": true,

        "PreferredEmailAddress": "example@example.edu",

        "IsLegacyStudent": false,

        "IsFirstGenerationStudent": null,

        "IsInternationalStudent": false,

        "AdmitTerms":[

           "2021FS"

        ],

        "AcademicLevelCodes": [

           "UG"

        ],

        "ResidencyStatus": null,

        "HighSchoolGpas": [

           {

              "HighSchoolID: "1020333",

              "Gpa": 3.97,

              "LastAttendedYear":"2020"

           }

        ],

        "Advisements":[

           {

              "AdvisorId":"0938333",

              "StartDate":"2019-12-10T00:00:00",

              "EndDate":null,

              "AdvisorType":""

           }

        ],

        "StudentTypeCode":"UG",

        "ClassLevelCodes":[

           "SR"

        ],

        "IsConfidential":false,

        "AdvisorIds":[

           "0938333"

        ],

        "IsTransfer":false,

        "FinancialAidCounselorIf":null,

        "EmailAddresses":[

           {

              "Value":"example@example.edu",

              "TypeCode":"ZZ",

              "IsPreferred":true

           } 

        ],

        "StudentHomeLocations":[

           {

              "Location":"MMM",

              "StartDate":"2020-11-19T00:00:00",

              "EndDate":null,

              "IsPrimary":false

           }

        ],

        "PersonDisplayName":{

           "HierarchyCode":"PREFERRED",

           "FullName":"Doe, Jane",

           "FirstName":"Jane",

           "MiddleName":"",

           "LastName":"Doe"

        ],

        "Id":"1239333",

        "LastName":"Doe",

        "FirstName":"Jane",

        "MiddleName":"",

        "BirthNameLast":"",

        "BirthNameFirst":"",

        "BirthNameMiddle":"",

        "PreferredName":"Doe, Jane",

        "PreferredAddress":[

           "123 University Dr",

           "Portland, ME 12345"

        ],

        "Prefix":"",

        "Suffix":"",

        "Gender":"F",

        "BirthDate":"1995-01-31T00:00:00",

        "GovernmentId":"",

        "RaceCodes":[

           "WH"

        ],

        "EthnicCodes":]

           "NHS"

        ],

        "Ethnicities":[

           "White"

        ],

        "MaritalStatus":null,

        "PrivacyStatusCode":"",

        "PersonalPronounCode":""

    }

    GET https://{host}/ColleagueApi/students/{AdvisorId from the response above}/advisors

    Attribute Mapping

    The following table describes the attribute mapping:

    Field Description Mandatory Data Type Default Example
    Name The advisor's name Yes String   Jane Doe
    Email The advisor's email Yes String   some.email@gmail.com

    Oracle PeopleSoft Vendor

    Create a PeopleSoft query that meets the following requirements:

  • Oracle PeopleSoft returns a JSON response with the following structure:
  •  

     

     

    {

        "status": "success",

        "data": {

            "query": {

                "numrows": 2,

                "queryname=": "EXAMPLE_CM_KEYPEOPLE_TILE",

                "rows": [

                    {

                        "attr:rownumber": 1,

                        "STUDENT_ID": "00000123",

                        "ADVISOR_ID": "04671234",

                        "ADVISOR_NAME": "Jane Doe",

                        "ADVISOR_EMAIL_ADDR": "exampleAdvisor@gmail.com",

                        "ADVISOR_CONTACT_TYPE": "Financial Aid Rep"

                    },

                    {

                        "attr:rownumber": 2,

                        "STUDENT_ID": "00000124",

                        "ADVISOR_ID": "04671235",

                        "ADVISOR_NAME": "John Doe",

                        "ADVISOR_EMAIL_ADDR": "exampleAdvisor2@gmail.com",

                        "ADVISOR_CONTACT_TYPE": "Graduate Services Advisor"

                    }

               ]

           }

       }

    }

     

     

     

    The parameters and headers passed into this API are all set within the configuration page.

     

     

     

    Example request:

     

     

     

    GET https://{host}

     

     

     

    Path: {the required path}, e.g. PSIGW/RESTListeningConnector/ExecuteQuery.v1/PUBLIC/{query name}/JSON/NONFILEQuery

     

     

     

    Required parameters, e.g.:

     

     

     

    • isconnectedquery: N 
    • maxrows: 0 
    • prompt_uniquepromptname: USER_ID
    • prompt_fieldvalue: {USER_ID value}
    • json_resp: true

     

     

     

    Basic authentication

     

     

     

    Attribute Mapping

     

    The following table describes the attribute mapping:

     

    Field Description Mandatory Data Type Default Example
    ADVISOR_NAME The advisor's name Yes String   Jane Doe
    ADVISOR_EMAIL_ADDR The advisor's email Yes String   same.email@gmail.com

     

    RESTful API Vendor

     

    campusM uses an API calls to fetch the advisor data:

     

    The call is: 

     

    • https://{HOST}//getAdvisors?user={userId}

     

    [
      {
      "name": "Advisor One",
      "email": "advisor.one@email.com"
    },
    {
    "name": "Advisor Two",
    "email": "advisor.two@email.com"
      }

     

    Configuration

     

    To configure the My Advisors product integration:

     

    • Select Product Integrations > Add Product Configuration > My Advisor.

     

    Configuration Option Description Mandatory Data Type Default Example
    Manage Integration
    Enable Product Integration Enabled the product integration Yes Checkbox Unselected Jane Doe
    Product Integration Description A description of the product integration for internal use Yes String   My Advisor
    Colleague Vendor
    Vendor Name Sets the vendor to use Yes Dropdown   Colleague
    URL to retrieve the information The URL for the web service Yes URL https://myDomain.com  
    Parameter Input Option

    The parameter input option for Colleague ID

    Possible values: Username, Token Property, and Constant. Typically, this is the user's "username" attribute.

    Yes Dropdown   Username
    Authentication Type Authentication type against the web service No Object    
    Oracle PeopleSoft Vendor
    Vendor Name Sets the vendor to use Yes Dropdown   Oracle PeopleSoft
    URL to retrieve the information The URL for the web service Yes URL http://myDomain.com  
    URL Query Parameters The parameters sent as part of the query No Object    
    URL Path Parameters The parameters sent as part of the path No Object    
    General Headers Add (key, value) for additionally needed headers No Object    
    Authentication Type Authentication type against the web service No  Object    
    RESTful API Vendor
    Vendor Name Sets the vendor to use Yes Dropdown   RESTful API
    Base URL to retrieve the information The URL for the Web service        
    Parameter Input Option

    The parameter input option for the API

    Possible values: Username, Token Property, and Constant. Typically this is the user's "username" attribute.

           
    Authentication Type Authentication type against the web service No  Object    
    Look and Feel
    Primary Theme Color Used for the screen title header and other header elements No Color Picker #444444  
    Secondary Theme Color Used for the labels and other elements No Color Picker #6f8ea4  
    Text/Labels
    Email Status Label The label for the email field No String Email  
    No Data Message The message to display if no advisors are found No String No advisors found  
    Service Failure Message Message to display when there is an error retrieving the data No String The page is having trouble fetching your advisors - please try again shortly.  
    Import/Export Configuration
    Export Creates a JSON file with the product integration configuration No      
    Import Use this option to load configuration from JSON of an exported product integration No      

     

    • Was this article helpful?