Overview
Connect data from Element451 to Banner via the Ellucian Ethos API. Managed integrations from Element451 are customized to your institution's specific needs and maintained by the Element451 team.
Integration Mechanism: REST API
Direction: Bi-directional
Sync Delay: 1-5 minutes
Trigger Type: Manual or Automated
Data Format: JSON
Authentication Method: Bearer Auth Token
Element → Banner Sync
The sync from Element to Banner is an independent function within the integration that creates or updates applicant data in Banner when triggered from Element451.
Triggering the Sync
The Element → Banner sync can be triggered manually by default and can also be configured to automatically trigger.
Manual Sync
Manual Sync
Add the "Element451 - Trigger Integration Sync" label to any profile to trigger the sync. The label triggers a "Element451 → Ethos Integration Sync" Rule, which runs an "Execute Webhook" step and initializes the sync.
Automatic Sync
Automatic Sync
To automate the sync, consider adding additional triggers to the "Element451 → Ethos Integration Sync" Rule.
A common example is adding a "Decision Released" trigger that will automatically sync applicants to Banner when their Decision in Element451 is released.
Sync Sequence
Sync Sequence
Webhook initializes the sync
Contact data is exported, including contact information, demographic data, applications, previous education, relationships, emergency contacts, and citizenship data.
Data is transformed to values compatible with Banner.
A person matching request is made to Banner to identify if the contact exists in the System.
If the contact does not exist, a new person is created.
If the contact does exist, the person is identified.
Additional person data is sent to Banner.
Address data is sent to Banner.
Visa/Citizenship data is sent to Banner.
Relative / Family member data is sent to Banner.
If a family contact does not exist, a new person is created.
If a family contact does exist, the person is identified.
A relationship is created between the applicant and the family member.
Application data is sent to Banner.
External education data is sent to Banner.
Emergency contact data is sent to Banner.
Field Mapping
Below, we provide a list of fields exported from Element and their matching field in Banner.
View the List
View the List
Element Slug | Banner Field | Banner Form |
user-elementid | GORADID_ADDITIONAL_ID | SPAIDEN |
user-first-name | SPRIDEN_FIRST_NAME | SPAIDEN |
user-last-name | SPRIDEN_LAST_NAME | SPAIDEN |
user-middle-name | SPRIDEN_MI | SPAIDEN |
user-former-last-name | (name type = BIRTH) | SPAIDEN |
user-preferred-name | (name type = PREFERRED/CHOSEN) | SPAIDEN |
user-prefix-name | SPRIDEN_SURNAME_PREFIX | SPAIDEN |
user-suffix-name | SPBPERS_NAME_SUFFIX | SPAIDEN |
user-email-address | GOREMAL_EMAIL_ADDRESS | GOAEMAL |
user-identities-school-email | GOREMAL_EMAIL_ADDRESS | GOAEMAL |
user-ssn | SPBPERS_SSN | SPBPERS |
user-dob | SPBPERS_BIRTH_DATE | SPRIDEN |
user-gender | SPBPERS_GNDR_CODE | SPBPERS |
user-citizenship-us-statuses | SPBPERS_CITZ_CODE | SPRBPERS |
user-race-hispanic | SPBPERS_ETHN_CODE | SPRBPERS |
user-race-categories | GORPRAC_RACE_CDE | GORPRAC |
user-citizenship-country | GOBINTL_NATN_CODE_LEGAL | SPAIDEN |
user-citizenship-country-of-birth | GOBINTL_NATN_CODE_BIRTH | SPAIDEN |
user-addresses-street1 | SPRADDR_STREET_LINE1 | SPAIDEN |
user-addresses-street2 | SPRADDR_STREET_LINE2 | SPAIDEN |
user-addresses-street3 | SPRADDR_STREET_LINE3 | SPAIDEN |
user-addresses-city | SPRADDR_CITY | SPAIDEN |
user-addresses-state | SPRADDR_STAT_CODE | SPAIDEN |
user-addresses-province | SPRADDR_STAT_CODE | SPAIDEN |
user-addresses-zip | SPRADDR_ZIP | SPAIDEN |
user-addresses-country | SPRADDR_NATN_CODE | SPAIDEN |
user-phone-home-country-code | SPRTELE_PHONE_AREA | SPATELE |
user-phone-home-number | SPRTELE_PHONE_NUMBER | SPATELE |
user-phone-cell-country-code | SPRTELE_PHONE_AREA | SPATELE |
user-phone-cell-number | SPRTELE_PHONE_NUMBER | NAE |
user-family-relationship | SORFOLK_DIR_RELT_ID / SORFOLK_RELT_CODE | SOAFOLK |
user-family-email | GOREMAL_EMAIL_ADDRESS | SOAFOLK / SPAIDEN |
user-family-first-name | SPRIDEN_FIRST_NAME | SOAFOLK / SPAIDEN |
user-family-last-name | SPRIDEN_LAST_NAME | SOAFOLK / SPAIDEN |
user-family-middle-name | SPRIDEN_MI | SOAFOLK / SPAIDEN |
user-family-gender | SPBPERS_GNDR_CODE | SPBPERS |
user-family-phone-number | SPRTELE_PHONE_NUMBER | SPATELE |
user-family-phone-country-code | SPRTELE_PHONE_AREA | SPATELE |
user-family-address-street-1 | SPRADDR_STREET_LINE1 | SPAIDEN |
user-family-address-street-2 | SPRADDR_STREET_LINE2 | SPAIDEN |
user-family-address-city | SPRADDR_CITY | SPAIDEN |
user-family-address-state | SPRADDR_STAT_CODE | SPAIDEN |
user-family-address-zipcode | SPRADDR_ZIP | SPAIDEN |
user-family-address-country | SPRADDR_NATN_CODE | SPAIDEN |
user-family-address-province | SPRADDR_STAT_CODE | SPAIDEN |
user-applications-status | SARAPPD_APDC_CODE | SAADCRV |
user-applications-submitted-time | SARADAP_APPL_DATE | SAAADMS |
user-applications-major | SARADAP_MAJR_CODE_1 | SAAADMS |
user-applications-term | SARADAP_TERM_CODE_ENTRY | SAAADMS |
user-applications-degree | SARADAP_DEGC_CODE | SAAADMS |
user-applications-campus | SORLCUR_CAMP_CODE | SAAADMS |
user-applications-student-type | SARADAP_STYP_CODE | SAAADMS |
user-applications-board-status | SARADAP_ADMT_CODE | SAAADMS |
user-applications-decision-released-at | SARAPPD_APDC_DATE | SAAADMS |
user-education-academic-load | (SARADAP_FULL_PART_IND or SARADAP_FULL_PART_IND) | SAAADMS |
user-education-schools-gpa | SORHSCH_GPA | SORHSCH |
user-education-schools-start | SORDEGR_ATTEND_FROM | SOAPCOL |
user-education-schools-end | SORDEGR_ATTEND_TO | SOAPCOL |
user-education-schools-graduate-date | SORHSCH_GRADUATION_DATE | SOAHSCH |
user-citizenship-visa-type | GORVISA_VTYP_CODE | GOAINTL |
📌 Note: Managed integrations are configurable. Additional custom fields in Element or additional resources in Ethos may be included in your institution's integration. Contact Element451 support for more information.
Banner → Element Sync
The sync from Banner to Element is an independent function within the integration that creates or updates student and application data within Element451 based on data from Banner.
Triggering the Sync
The Banner → Element sync relies on "change notifications" from Ethos, which denote that a change was made to an applicant's data in Banner. The managed integration reads these notifications every five minutes and updates the applicant's data in Element accordingly.
Ensure that the Element451 Ethos "application" is subscribed to notifications from the persons, addresses, and admission-applications resources in order for change notifications to be received. Remove the subscriptions to disable the Banner->Element sync.
Sync Sequence
Sync Sequence
Change notification is added to the consume resource.
The managed integration reads the consume resource every five minutes.
Change notification for an applicant is read.
Applicant data is requested from Banner, including person data, application data, aptitude assessments, addresses, and previous education.
Data is transformed to values compatible with Element451.
Person data is imported to Element.
Application data is imported to Element.
Address data is imported to Element.
Aptitude assessment data (evaluations) is imported into Element.
Previous education data (schools) is imported into Element.
Data Source Sync
Translating data values between Element451 and Banner is essential for the integration. Translations are managed by syncing Banner validation table values to Data Sources in Element. This sync is an independent function within the integration.
Sync Schedule
By default, academic-periods (Terms), academic-programs (Majors), and academic-credentials (Degrees) sync every Saturday.
Refreshes of these or other data sources can be requested via Element live support.
Adding New Data Source Values
New values for data sources should always be added in Banner first.
Update the validation table and then wait for the sync to run.
Once a data source has synced with Banner, it should not be edited in Element (exceptions apply; ask Element support when in doubt).
Translation Tables
In addition to updating data sources within Element451, the managed integration also maintains "translation tables" behind the scenes.
These tables are directly responsible for the translation between Element and Banner data values.
If a value is not in the table, it will not be translated properly.
Translation tables are only accessible to Element451 support and will be updated with the data source sync or upon request.
Additional Information
Additional information about configuring Ethos can be found in the Integration Guide: https://integrations.element451.com/ellucian-ethos-142
Troubleshooting Common Errors
Errors during Element->Banner
Errors during Element->Banner
PERSON record locked for ID ...
PERSON record locked for ID ...
{
"type": "<class 'shared_resources.exceptions.APIException'>",
"status_code": "400",
"content": {
"errors": [
{
"code": "Validation.Exception",
"description": "An error occurred attempting to validate data.",
"message": "PersonExternalEducation.Record.Lock: PERSON record locked for ID xxxxxxx"
}
]
}
}Origin: Banner / Ethos
Description:
This means someone is in the record in Banner.
Resolution Steps:
Close the record in Banner and re-sync
reviewRequired
reviewRequired
{
"outcomes": [
{
"type": "initial",
"status": "reviewRequired",
"date": "2025-01-15T11:27:40"
}
],
"originator": "ETHOS",
"id": "xxx-xxxx-xxxx -xxxx-xxxx"
}Origin: Banner / Ethos
Description:
A potential duplicate was found in the SIS when attempting to sync from Element.
Resolution Steps:
Review the match on GOAMTCH
Resolve the duplicate
Resync from Element
Relative review required
Relative review required
Origin: Banner / Ethos
Description:
A potential duplicate was found when attempting to sync a person’s relatives.
Resolution Steps:
Review the match on SOAFOLK
Resolve the duplicate
Resync from Element
Skipping Invalid Address
Skipping Invalid Address
Skipping invalid address: {
"ethos_id": "",
"type": "home",
"street1": "*** Street Name Ave",
"street2": "",
"street3": "",
"city": "Some City",
"state": "ST",
"province": "",
"zip": "12345",
"country": "",
"is_home_mailing": "",
"county": "" //country is missing in this example
}Origin: Element451
Description:
The student is missing required data on their Element profile. Ensure the following are present:
Street 1
City
State
Zip
Country
Resolution Steps:
Navigate to student’s Element profile.
Edit Address, ensure all data items are present, save
Resync from Element
'{State Name}' is not defined as a state or province.
'{State Name}' is not defined as a state or province.
{
"type": "<class 'shared_resources.exceptions.APIException'>",
"status_code": 400,
"content": {
"errors": [
{
"id": "176684ff-6cce-4473-ac9b-caa912220a9e", //address identifier
"sourceId": "0862595",
"code": "persons.addresses",
"description": "Unknown error code.",
"message": "'North Carolina' is not defined as a state or province. (Parameter 'addressDto.place.region')" //North Carolina example shown, but State Name may vary
}
]
},
"args": [
"Status code: 400\nContent:\n{\n \"errors\": [\n {\n \"id\": \"176684ff-6cce-4473-ac9b-caa912220a9e\",\n \"sourceId\": \"0862595\",\n \"code\": \"persons.addresses\",\n \"description\": \"Unknown error code.\",\n \"message\": \"'North Carolina' is not defined as a state or province. (Parameter 'addressDto.place.region')\"\n }\n ]\n}"
]
}Origin: Banner / Ethos
Description:
The student has bad data on their Element profile. Address has State name instead of State abbreviation. In the case of North Carolina, State should be “NC”.
Resolution Steps:
Navigate to student’s Element profile.
Edit Address, select correct State from dropdown menu, save
Resync from Element
There is no ceeb for the institution
There is no ceeb for the institution
Summary 1: There is no ceeb for the institution. Ensure an institution with CEEB code 1234 is listed on STVSBGI in Banner. If no institution, please create one and notify Element451 support to resync with Banner.
Full Error 1:
{
"institution_id": "",
"ceeb": "1234"
"type": "highschool",
"entry_type": "highschool",
"gpa": "",
"start": "",
"end": "",
"graduate_date": "2017-04-17",
"institution_country": ""
}
Origin: Banner / Ethos
Description:
The student selected a prior education institution in Element451 that does not have a match on STVSBGI in Banner.
Resolution Steps:
Create an entry for the institution on STVSBGI
Notify the Element451 team via live support to resync with the SIS to pick up new institutions.