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).

Database Host	The Ellucian Banner database hostname, URL, or IP address.
Database Port	The Ellucian Database listener port — If not modified, this port typically follows the Oracle standard setting (Port: 1521).
Listener/Service Name	The Ellucian Database listener/service name.
Username	The username created for ProcessMaker TCE.
Password	The password created for ProcessMaker TCE.

Required Tables and Fields

Student Management

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

Query — Retrieve student by Banner ID

Query — Retrieve student email

Query — Retrieve student by email address

Query — Retrieve student by name

Query — Retrieve attached administrative periods

Course Management

Table	Description	Purpose
SCBCGID	UUIDs associated with a course	Used to retrieve the UUID for a given course
SCBCRSE	Courses registered in Ellucian Banner	Used to retrieve the list of existing courses
SCBDESC	Course descriptions	Used to get a detailed description of a given course
STVTERM	Administrative periods Associated with a course	Used to query the administrative period(s) associated with a course

Query — Retrieve the list of courses

Query — Retrieve course description

Query — Retrieve administrative periods per course

Administrative Periods

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

Query — Retrieve administrative periods

External Institutions

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

Query — Retrieve external institutions

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

Course Articulation

Table	Description	Purpose
SHRTRIT	Transfer Institution Number	Used to retrieve Transfer Institution Number By Student PIDM and Sequence Number
SHRTRAM	Attendance Periods	Retrieve Attendance Period By Student PIDM and Sequence Number
SHRTRAM	Transfer Maintenance	Used to create Transfer Maintenance when needed Write access is required!
SHRTRIT	Transfer Maintenance	Used to create an external institution record when needed Write access is required!
SHRTRCR	External course articulations	Used to retrieve previous articulations of external courses
SHRTRCE	Internal course articulations	Used to retrieve previous articulations of internal courses
SHRTRCR	Register external course articulations	Used to register an articulation for a particular external course and student Write access is required!
SHRTRCE	Register internal course articulations	Used to register an articulation for a particular internal course and student Write access is required!

Query — Transfer Institution Number By Student PIDM and Sequence Number

Query — Attendance Period By Student PIDM and Sequence Number

Query — Create Transfer Maintenance

Query — Create an external institution record

Query — Get previous articulations (external)

Query — Get previous articulations (internal)

Query — Save external course articulation

Query — Save internal course articulation

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 —

  • Whitelist the ProcessMaker development and production environment addresses for incoming database requests.

• 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.