Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleCreate a Connection Inside IntelliBoard
  1. Log in to IntelliBoard using the primary account holder information.

  2. Click the “Integrations” tab

    image-20241112-195529.png
  3. Click the “+ Connect” button on the Ellucian Banner tile.

    image-20241112-195835.png
  4. A Connection Information Box will appear. Completed the fields as needed.

    image-20241112-200937.png

    Connection: Select your primary LMS connection from the dropdown menu
    Ellucian Banner API Key: Add the Ellucian Banner API Key. (See Ellucian documentation or open a support ticket with Ellucian for more information.)
    Ellucian Column for Relation Mapping: Specify how data from Ellucian’s system should be mapped or linked to corresponding fields in IntelliBoard. Select “Map Ellucian Data to Email” or “Map Ellucian Data to SIS ID.”
    Ellucian Banner Processing Frequency: Select how frequently you want the Ellucian data to sync: Daily, Weekly, Monthly, or Every 90 Days.
    Ellucian Banner Processing Time: Set the time you want processing to occur. We recommended setting for an overnight hour

  5. Click “Save”

Expand
titleFAQ: API Key Access

When creating an API key to connect to Ellucian, you have the option to set the key as Restricted or Unrestricted:

  • Unrestricted: An unrestricted API key grants full access, allowing all available data to transfer between systems without any restrictions. This key provides open access to every dataset and table within Ellucian's environment.

  • Restricted: A restricted API key applies specific access rules, limiting the data transfer to only certain tables. This key unlocks access only to the tables you specify, based on your data needs.

We recommend creating a Restricted API key and configuring it to access specific tables such as person, and other essential data tables. By doing so, you ensure that only necessary data is available, supporting data security and compliance best practices.

Expand
titleList of API Endpoints

List of endpoints:

  • /api/persons

  • /api/persons?criteria={"emails":[{"address":"%s"}]}

  • /api/persons/%s/

  • /api/religions

  • /api/ethnicities

  • /api/races

  • /api/marital-statuses

  • /api/privacy-statuses

  • /api/citizenship-statuses

  • /api/veteran-statuses

  • /api/interests

  • /api/interest-areas

  • /api/addresses

  • /api/academic-programs

  • /api/academic-disciplines

  • /api/educational-institutions

  • /api/admission-applications

  • /api/person-holds

  • /api/sections

  • /api/section-instructors

  • /api/instructional-methods

  • /api/instructional-delivery-methods

  • /api/instructional-events

  • /api/instructional-platforms

  • /api/cip-codes

  • /api/course-categories

  • /api/course-levels

  • /api/course-title-types

  • /api/courses

  • /api/grade-schemes

  • /api/educational-institution-units

  • /api/section-title-types

  • /api/subjects

  • /api/course-statuses

  • /api/students

  • /api/students?criteria={"person": {"id":"%s"}}

  • /api/students?person=%s

  • /api/student-types

  • /api/residency-types

  • /api/academic-levels

  • /api/student-academic-programs

  • /api/student-classifications

  • /api/academic-periods

  • /api/student-grade-point-averages

  • /api/student-academic-credentials

  • /api/student-transcript-grades

  • /api/student-advisor-relationships

  • /api/advisor-types

  • /api/student-cohort-assignments

  • /api/student-cohorts

  • /api/student-financial-aid-awards

  • /api/financial-aid-application-outcomes

  • /api/student-course-transfers

  • /api/student-charges

Expand
titleFAQ: Will personalized tables be included in the data import?

Currently, personalized or custom tables will not be included in the data import. If needed, personalized tables may be added through InForm.

Expand
titleHow does the selection of tables affect the data import?

The tables you choose and the permissions you set will impact the volume of data imported. As of now, there are no restrictions on the historical range of data, so all available records in the selected tables will be included.

Ellucian Colleague

Expand
titleCreate a Connection Inside IntelliBoard
  1. Log in to IntelliBoard using the primary account holder information.

  2. Click the “Integrations” tab

    image-20241112-195529.png
  3. Click the “+ Connect” button on the Ellucian Colleague tile.

    image-20241112-203030.png
  4. A Connection Information Box will appear. Completed the fields as needed.

    image-20241112-200937.png

    Connection: Select your primary LMS connection from the dropdown menu
    Ellucian Banner API Key: Add the Ellucian Banner API Key. (See Ellucian documentation or open a support ticket with Ellucian for more information.)
    Ellucian Column for Relation Mapping: Specify how data from Ellucian’s system should be mapped or linked to corresponding fields in IntelliBoard. Select “Map Ellucian Data to Email” or “Map Ellucian Data to SIS ID.”
    Ellucian Banner Processing Frequency: Select how frequently you want the Ellucian data to sync: Daily, Weekly, Monthly, or Every 90 Days.
    Ellucian Banner Processing Time: Set the time you want processing to occur. We recommended setting for an overnight hour

  5. Click “Save”

Expand
titleFAQ: API Key Access

When creating an API key to connect to Ellucian, you have the option to set the key as Restricted or Unrestricted:

  • Unrestricted: An unrestricted API key grants full access, allowing all available data to transfer between systems without any restrictions. This key provides open access to every dataset and table within Ellucian's environment.

  • Restricted: A restricted API key applies specific access rules, limiting the data transfer to only certain tables. This key unlocks access only to the tables you specify, based on your data needs.

We recommend creating a Restricted API key and configuring it to access specific tables such as person, and other essential data tables. By doing so, you ensure that only necessary data is available, supporting data security and compliance best practices.

Expand
titleList of API Endpoints

List of endpoints:

  • /api/persons

  • /api/persons?criteria={"emails":[{"address":"%s"}]}

  • /api/persons/%s/

  • /api/religions

  • /api/ethnicities

  • /api/races

  • /api/marital-statuses

  • /api/privacy-statuses

  • /api/citizenship-statuses

  • /api/veteran-statuses

  • /api/interests

  • /api/interest-areas

  • /api/addresses

  • /api/academic-programs

  • /api/academic-disciplines

  • /api/educational-institutions

  • /api/admission-applications

  • /api/person-holds

  • /api/sections

  • /api/section-instructors

  • /api/instructional-methods

  • /api/instructional-delivery-methods

  • /api/instructional-events

  • /api/instructional-platforms

  • /api/cip-codes

  • /api/course-categories

  • /api/course-levels

  • /api/course-title-types

  • /api/courses

  • /api/grade-schemes

  • /api/educational-institution-units

  • /api/section-title-types

  • /api/subjects

  • /api/course-statuses

  • /api/students

  • /api/students?criteria={"person": {"id":"%s"}}

  • /api/students?person=%s

  • /api/student-types

  • /api/residency-types

  • /api/academic-levels

  • /api/student-academic-programs

  • /api/student-classifications

  • /api/academic-periods

  • /api/student-grade-point-averages

  • /api/student-academic-credentials

  • /api/student-transcript-grades

  • /api/student-advisor-relationships

  • /api/advisor-types

  • /api/student-cohort-assignments

  • /api/student-cohorts

  • /api/student-financial-aid-awards

  • /api/financial-aid-application-outcomes

  • /api/student-course-transfers

  • /api/student-charges

Expand
titleFAQ: Will personalized tables be included in the data import?

Currently, personalized or custom tables will not be included in the data import. If needed, personalized tables may be added through InForm.

Expand
titleHow does the selection of tables affect the data import?

The tables you choose and the permissions you set will impact the volume of data imported. As of now, there are no restrictions on the historical range of data, so all available records in the selected tables will be included.

Qwickly Attendance

Expand
titleCreate a Connection Inside IntelliBoard
  1. Log in to IntelliBoard using the primary account holder information.

  2. Click the “Integrations” tab

  3. Click the “+ Connect” button on the Ellucian Colleague tile.

    image-20241112-204358.png
  4. A Connection Information box with appear. Complete the fields as needed.

    image-20241112-204504.png

    Connection: Select your primary LMS connection from the dropdown menu
    Qwickly Data feed URL: Paste the Data feed URL here. (See Data feed URL instructions below.)
    Qwickly API Key: Paste the API Key here. (See Key instructions below.)
    Qwickly Secret Key: Past the Secret Key here. (See Key instructions below.)
    Qwickly Processing Frequency: Select how frequently you want Qwickly data to sync: Daily, Weekly, Monthly, or Every 90 Days.
    Qwickly Processing Time: Set the time you want processing to occur. We recommended setting for an overnight hour.

  5. Click “Save.”

...