# Integration via Ellucian Tables

We suggest utilizing Ellucian Ethos as the API connection layer for Ellucian Banner; however, it is not unusual for Ellucian Ethos to be unavailable. In this case, we can directly integrate with Ellucian Banner tables. 

The following sections detail the database tables and fields that ProcessMaker TCE will need access to. This information will help your organization create a customized database user profile to restrict access, enhance security, and meet any IT security compliance requirements that may apply to your organization.

### Authentication

The following settings/credentials are required to access and utilize the Banner API. These credentials ensure secure and authorized interaction with the API, enabling seamless data exchange and integration with third-party systems (here, ProcessMaker TCE).

<table data-header-hidden><thead><tr><th width="201"></th><th></th></tr></thead><tbody><tr><td>Database Host</td><td>The Ellucian Banner database hostname, URL, or IP address.</td></tr><tr><td>Database Port</td><td>The Ellucian Database listener port — If not modified, this port typically follows the Oracle standard setting (Port: 1521).</td></tr><tr><td>Listener/Service Name</td><td>The Ellucian Database listener/service name.</td></tr><tr><td>Username</td><td>The username created for ProcessMaker TCE.</td></tr><tr><td>Password</td><td>The password created for ProcessMaker TCE.</td></tr></tbody></table>

### Required Tables and Fields

#### **Student Management**

<table><thead><tr><th width="124">Table</th><th>Description</th><th>Purpose</th></tr></thead><tbody><tr><td>SPRIDEN</td><td>List of Person entities registered in Ellucian Banner</td><td>Used to retrieve information (e.g., first name, last name, Banner ID)</td></tr><tr><td>SGBSTDN</td><td>List of Student entities registered in Ellucian Banner</td><td>Used to validate if a given person is a student</td></tr><tr><td>GOREMAL</td><td>Email addresses by person</td><td>Used to retrieve the email address for a person/student</td></tr><tr><td>STVTERM</td><td>Administrative periods Associated with a student</td><td>Used to query associated administrative periods for students</td></tr><tr><td>STVSTYP</td><td>Student types</td><td>Used to resolve the student type for a given student.</td></tr></tbody></table>

#### Query — Retrieve student by Banner ID

<div align="left"><figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXcwBeJQzyc9wyt7Wuq-8xhKggj9ZSO1l7-d-0qf2D0mdWI9PjOj2vgrwx04Izo0zC1nqnFL5yWUHrukQHdbqq93HVrOt7l28n6vj2bzcjOkWzFSarVKTEtazOjeTIHEwJZtHK0dQQ?key=Dyb55TJ9e6ksR11hmeDuiVtj" alt=""><figcaption></figcaption></figure></div>

#### Query — Retrieve student email

<div align="left"><figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdF-9kG49jcqfHNwnsb8TAAj80VXN5O-s5slbWiyXDQlLb0TsfwDviOkb2yJ4cWDLoP2N_2pg-oMJExkzUsyqFokh2r3GlqTFBsemt1fAzkrZWI_yW_L36ItWYhczDp7M1wASH4cw?key=Dyb55TJ9e6ksR11hmeDuiVtj" alt="" width="375"><figcaption></figcaption></figure></div>

#### Query — Retrieve student by email address

<div align="left"><figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdW-5_C6O3VcPhdBHat2s3819uTIMLMf2hxOE_9wjneQfv9g8anT2OTPLqjMWbX3mtx0EwN-G7ZKtbJLlHAByzTCOo4lKYO-eNZ_k0F_r0ETRT1uJ2T0eL-UpwQrqRkxnoKsfwq?key=Dyb55TJ9e6ksR11hmeDuiVtj" alt="" width="375"><figcaption></figcaption></figure></div>

#### Query — Retrieve student by name

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXcPNdRgUykyj50GDwjkByJmQ1lItnUiBloPC8bRtAevagfe2HRyJCwQdAbUTlRr9PibWc7l2C4Aqxu1wgzCkNuul6Dtk5ikGsSlWg5ZFC6TU_YwQcaXRuvHAki37pH2LvXvQqlh9w?key=Dyb55TJ9e6ksR11hmeDuiVtj" alt=""><figcaption></figcaption></figure>

#### Query — Retrieve attached administrative periods

<div align="left"><figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdkCI39yCBQGRM6DsMIRErM1xY5_EA2oDk5WGWAr03yEwdUCAiiJ1-LEPkcHIAvBEdap5rI8bXzr9XRAhWEZ2UQ3UGnx0a3q8bip1rAMyiFpSi3uHo00Xg6qDKEkN_MWfC2i2WbWg?key=Dyb55TJ9e6ksR11hmeDuiVtj" alt="" width="563"><figcaption></figcaption></figure></div>

#### **Course Management**

<table><thead><tr><th width="121">Table</th><th>Description</th><th>Purpose</th></tr></thead><tbody><tr><td>SCBCGID</td><td>UUIDs associated with a course</td><td>Used to retrieve the UUID for a given course</td></tr><tr><td>SCBCRSE</td><td>Courses registered in Ellucian Banner</td><td>Used to retrieve the list of existing courses</td></tr><tr><td>SCBDESC</td><td>Course descriptions</td><td>Used to get a detailed description of a given course</td></tr><tr><td>STVTERM</td><td>Administrative periods Associated with a course</td><td>Used to query the administrative period(s) associated with a course</td></tr></tbody></table>

#### Query — Retrieve the list of courses

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXcdBs3Y4Ny_c90WR_xtVAIq15gCxnf4GOWXE2py5rbzq9P3UqHIdmKjA2dfWmPrPeDsb-NiyvXcjLpBobQTuL2ALEANB8GwHzCL3ZbbupOxCVnW_52EV-duA7gD6l24YHSfE-YnEQ?key=Dyb55TJ9e6ksR11hmeDuiVtj" alt=""><figcaption></figcaption></figure>

#### Query — Retrieve course description

<div align="left"><figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXcex-qQGNk6ZZ4nHTyv4ndfsFVSP0JZpWdjSlI82BiYwPzTJxxJb3an6_y4q77Wv7ywohqxU92n_ZsbvfQHbRq1WC6OK9MY8yiDbfciYKJZRVPNoM07O1eDCbhIxwXZkNofuQC0?key=Dyb55TJ9e6ksR11hmeDuiVtj" alt="" width="563"><figcaption></figcaption></figure></div>

#### Query — Retrieve administrative periods per course

<div align="left"><figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXfcX4AhT6gF8gvcluKXhVOdn5I1TAEK4YnbVVYHapzM5WlsFwKMxO_n3yLhgin0alDWBDCADARbtw98Pbxtk2LSojZ7Wbht3PiG3KkxHPEQsK9nCXg_OCvIoFg6PKEif1nV2WAu?key=Dyb55TJ9e6ksR11hmeDuiVtj" alt="" width="375"><figcaption></figcaption></figure></div>

#### **Administrative Periods**

| Table   | Description                                          | Purpose                                             |
| ------- | ---------------------------------------------------- | --------------------------------------------------- |
| STVTERM | Administrative periods registered in Ellucian Banner | Used to retrieve the list of administrative periods |

#### Query — Retrieve administrative periods

![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXcWP1sJV3b60yH6fydBiGmfcMx76kAOxz0-JKwX7abpMhJ1JvtJfCUJ3aKdPaRsbLxg8ryEaubpYj_tnAt_sCqbsj4NHnQ8qroq8B_JQAxYJezfce3a7T7DHWyTr3mooma5s7s4?key=Dyb55TJ9e6ksR11hmeDuiVtj)

#### **External Institutions**

| Table   | Description                                         | Purpose                                            |
| ------- | --------------------------------------------------- | -------------------------------------------------- |
| STVSBGI | External institutions registered in Ellucian Banner | Used to retrieve the list of external institutions |

#### Query — Retrieve external institutions

![](https://lh7-rt.googleusercontent.com/docsz/AD_4nXe35fHpWpUS6MfNYQuzqlQVKTe2XRJXXCtzjiz0ldu3pDgQuwbTzLjmNwRHPhaa0X1uG8c88HTHMn1qTPO29OqocQ6D_C44NUWgXTi3U_27CFop5qeCNGLxfDWrOLwU3lXMEandyA?key=Dyb55TJ9e6ksR11hmeDuiVtj)

#### **Course Equivalency**

| Table   | Description                                    | Purpose                                       |
| ------- | ---------------------------------------------- | --------------------------------------------- |
| SHBTATC | External courses registered in Ellucian Banner | Used to retrieve the list of external courses |
| SHRTATC | Internal courses registered in Ellucian Banner | Used to retrieve the list of internal courses |

#### Query — Retrieve courses

<div align="left"><figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdScGZXuH7UDH2sdct-mfxG57dc5azaRWwTkkFXFqbjmZWaqf2Y_punlYN3owSj6_K3EXx2HnKi7UarVEQv8Eh6VdnOUMbcG7uM6wEC-uQQXrtSnWbh7B7XVHCJFhDTkocP_Urw?key=Dyb55TJ9e6ksR11hmeDuiVtj" alt="" width="563"><figcaption></figcaption></figure></div>

#### **Course Articulation**

<table><thead><tr><th width="111">Table</th><th width="246">Description</th><th>Purpose</th></tr></thead><tbody><tr><td>SHRTRIT</td><td>Transfer Institution Number</td><td>Used to retrieve Transfer Institution Number By Student PIDM and Sequence Number </td></tr><tr><td>SHRTRAM</td><td>Attendance Periods </td><td>Retrieve Attendance Period By Student PIDM and Sequence Number</td></tr><tr><td>SHRTRAM</td><td>Transfer Maintenance</td><td>Used to create Transfer Maintenance when needed<br>Write access is required!</td></tr><tr><td>SHRTRIT</td><td>Transfer Maintenance</td><td>Used to create an external institution record when needed<br>Write access is required!</td></tr><tr><td>SHRTRCR</td><td>External course articulations</td><td>Used to retrieve previous articulations of external courses</td></tr><tr><td>SHRTRCE</td><td>Internal course articulations</td><td>Used to retrieve previous articulations of internal courses</td></tr><tr><td>SHRTRCR</td><td>Register external course articulations</td><td>Used to register an articulation for a particular external course and student<br>Write access is required!</td></tr><tr><td>SHRTRCE</td><td>Register internal course articulations</td><td>Used to register an articulation for a particular internal course and student<br>Write access is required!</td></tr></tbody></table>

#### Query — Transfer Institution Number By Student PIDM and Sequence Number

<div align="left"><figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXc8dUg78RMKplXCXG7IGvDF4FS2Lv97jC4JGdgqe6KoEVWQJshZL4JLWhI8vCsYb9DQMVMPh-uvYEkNy-mFtmkf3V7HkWiFzUqBh0dLbph_b5AvVg6fx1SUUNGMm99i3KviyinryQ?key=Dyb55TJ9e6ksR11hmeDuiVtj" alt="" width="375"><figcaption></figcaption></figure></div>

#### Query — Attendance Period By Student PIDM and Sequence Number

<div align="left"><figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXcyRmIzjG5fTdhQGrHbAdRKSpBzBLZUMyjeH1VmH75EQpqU-pTPK4mAEi9h-l0jqWJzUi9hEcmcW30I3PolrksNP9ztXIp1Jhj5MVFJvrjx3s5IpYcYfDS-psC8nWhQfafeHpqT?key=Dyb55TJ9e6ksR11hmeDuiVtj" alt="" width="563"><figcaption></figcaption></figure></div>

#### Query — Create Transfer Maintenance

<div align="left"><figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdVU0ifoAeqzpnV4DiO_9dgwYTxPcpPWadBtAFnxrYbvE_FO3bd2T_vHydSmROTI_qPAibj65nyLeBZjBRXoH_O6ysZDOHq45oRFv59NkdMc5VtQ4Y3PLwVVNBtw9va9vxM6s3R?key=Dyb55TJ9e6ksR11hmeDuiVtj" alt="" width="563"><figcaption></figcaption></figure></div>

#### Query — Create an external institution record

<div align="left"><figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdLHItmXl3A-FVtWqCaOjZtFw4XloeoAO7X-Y8PEqHERSPXFBsrwGMUdKiSLdcInI5_QYuTCwO5lfDWLIesR8qO2DvmeksxOnyDzgKrAqEM5riR36hbbkhVqqIgrNvtiAAtbqcfPA?key=Dyb55TJ9e6ksR11hmeDuiVtj" alt="" width="563"><figcaption></figcaption></figure></div>

#### Query — Get previous articulations (external)

<div align="left"><figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdAqoTb141PnoThK6EUouzt8zKhLk5J5K8Fygk-n_snrgdE1MsRI6LciVYFcPL5hg5vfgWOhePnRnjPdHY4LMhfkO8Rn5B5FenA9sobCDiGvdlXyxJbXK7Sq3n0FA2VwCBiyN-0?key=Dyb55TJ9e6ksR11hmeDuiVtj" alt="" width="563"><figcaption></figcaption></figure></div>

#### Query — Get previous articulations (internal)

<div align="left"><figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdh1tlAPuOLJnB2GjdVu0hbHoHIINbYFR5hwS4D0P1TCaxafh0YenglZJ9MfXuQwGC-oh7IygABiqnNo7zc2IkdbKCLlSGQpsoFyESWgUyxETqfnJvthsXVEEBulXcNA36f0x_m_A?key=Dyb55TJ9e6ksR11hmeDuiVtj" alt="" width="563"><figcaption></figcaption></figure></div>

#### Query — Save external course articulation

<div align="left"><figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXeeASsEcnoZ0RDAklRrqNsehoV7BCgXmBfp7iL1EVqSfmlS2kyQeo5KodjXAxJ9uAmZjgMGvN_Nalbh--SvY-JGRGGDTGzjKeYcdiJGCW2YCdE-_gZrqnHXgcjjwVYeongpWEIU1Q?key=Dyb55TJ9e6ksR11hmeDuiVtj" alt="" width="563"><figcaption></figcaption></figure></div>

#### Query — Save internal course articulation

<div align="left"><figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdd0R_1kxZahUqkOSKkApMVEeMisFuAZwoa-No1ZfaQOTowAEmHkB_luqqDFj4wAYtX80_D1l7HXjYvSNfqRAcUo0jIm9Ldr9R8Obnsrmg2y2VJfwKLfWNcRYjaHBHP39cjEbXK?key=Dyb55TJ9e6ksR11hmeDuiVtj" alt="" width="563"><figcaption></figcaption></figure></div>

## Checklist

The following checklist includes all the information required and actions to be taken to set up the ProcessMaker TCE/Ellucian Banner integration.

### Ellucian Banner without Ethos

* [ ] Provide the Ellucian Banner database hostname, URL, or IP address.
* [ ] Provide the Ellucian Database listener port — If not modified, this port typically follows the Oracle standard setting (Port: 1521).
* [ ] Provide the Ellucian Database listener/service name.
* [ ] Perform Firewall/Database security modifications —&#x20;
  * [ ] Whitelist the ProcessMaker development and production environment addresses for incoming database requests.&#x20;
* [ ] Create a ProcessMaker-specific database user with a username and password.
* [ ] Assign the required user rights to access required tables. Required tables are described herein above.
* [ ] Provide the database username and password.