Element451Integrations Guide

Banner Configuration

Updated 1 page in this section

Please follow all of the steps below in order to ensure that the integration will work correctly.  Skipping any step will cause delays in testing (and possibly development) which can negatively impact your overall progress in using Element successfully.

Configuration Steps#

1. Add E451 as an Alternative ID Type#

On GTVADID make sure to add an alternative ID (we recommend naming it E451) that will allow Element to write the Element ID of a record, onto the Banner record for ease of troubleshooting/reporting

2. Create a Proxy User (in Banner) that will be used by the Ethos Application.#

Ethos will require a user account in Banner in order to access data.

3. Set up Banner Permissions#

Set up Banner GSACECR Permissions

4. Complete Additional Banner Configurations#

In order for the integration to work successfully, the following configurations should be reviewed and completed.  If they are not, errors will occur during testing and you will be referred back to this step (make sure you do them both in Banner Prod and Pre-Prod/Test).

  1. Due to an Ellucian defect (PD0018084), set default value of ‘0000’ on STVDEGC.
  2. Set all state ISO codes on STVSTAT (https://en.wikipedia.org/wiki/ISO_3166-2:US).
  3. Configure county code validation on STVCNTY.
  4. On STVLANG, make sure to populate the ISO codes (https://iso639-3.sil.org/code_tables/639/data).
  5. Set Default Values on GORICCR for HEDM process (https://resources.elluciancloud.com/r/bundle/banner_ethos_api_acn_use/page/r_goriccr_d.html).
    Common defaults include:
    1. Update PERSON.MATCHRULE (rather than default “UPDATE_ME”)
    2. For ORGANIZATIONS API, set PHONES.COUNTRY. DEFAULT to the 2 or 3 character nation ISO code from STVNATN. (Enter US if using ISO 3166-1 alpha-2 country code OR enter USA if using ISO 3166-1 alpha-3 country code.)
    3. For ADMISSION-APPLICATIONS-SUBMISSIONS API,
      1. Set “ADM.APPL.RESD.TYPE.DEFAULT” to a default value (rather than the default “UPDATE_ME”)
      2. Set “ADM.APPL.STU.TYPE.DEFAULT” to a default value (rather than the default “UPDATE_ME”)
    4. For “CEEB.CODE.SOURCE.FIELD”, set value as “STVSBGICODE” (Element451 uses CEEB codes to translate educational institutions into your Banner/Ethos’s institution values (Ethos GUIDs/IDs)
  6. On GORDMSK, for the API_PERSONS and API_PERSON_CREDENTIALS objects, make sure the “Visible” box is checked for all pages, including SSN.
  7. On SOACTRL, in the Institutional Defaults tab, make sure to set a starting priority (we recommend 1).
  8. If you want to integrate more than 1 name type, you will need to make sure name types are configured (especially Legal Name). Skip this step otherwise.
  9. On the Ethos Integration site (https://integrate.elluciancloud.com), configure PERSON.MATCHRULE setting with the matching source code (GTVCMSC_CODE)

5. Build out the Ethos Application in the Ethos Integration site#

  • Select the Applications tab, click “Create New App: Manually”
  • Check “Configure REST API proxy”, click Continue
  • Application name: Element451
  • Description: Element451 Integration Application
  • Click Next
  • Click Add Source Application
  • Select your primary Banner Web API application (name will vary from school to school)
  • Enter the Banner username and password from the proxy account created in step 2 above.
  • Click Blue “Add API Key” Button to create a new API Key.
    • For IP address restrictions, select “Set API key to have no IP address restrictions”. (We will leave this for testing, but add before go-live to Prod)
  • For subscriptions, the minimum Element451 recommend are persons, person-holds, admission-application, and addresses (do not add Student, Courses, or other types of current student based subscriptions to this specific Ethos/Element451 application).
    • If you have the Success module and want Enrolled Program data to sync, you will also want to add student-academic-programs, student-academic-periods, and student-grade-point-averages.

6. Test the Permissions of the API Key#

Use our Ethos API Key Checker to validate that the API key has the necessary permissions to Ellucian endpoints.  NOTE, this does not check for valid Ethos configuration, simply if the API key has the necessary permissions

7. Provide the API Key to Element451#

It is essential to send API credentials securely. Sending over plain text email is not secure and if done, we will request a new API key to be generated and sent in an encrypted fashion. If you do not have a way of transmitting the key in a secure fashion, please let the Integration staff assigned to your project know and they will send you an encrypted email that you can reply to with the API key.

8. Fill out the Ethos Configuration Form#

a related page

Fill out the form linked to help Element451 understand how the integration should behave.  This let us know what address, email, phone types, etc to map to and how the integration should be work in certain scenarios.