Integration via Ellucian Tables

Prev Next

While Ellucian Ethos is the recommended integration approach for Ellucian Banner, it is not uncommon for Ethos to be unavailable. In these situations, ProcessMaker TCE can integrate directly with Ellucian Banner database tables.

The following sections describe the database tables and fields that ProcessMaker TCE requires access to. This information can be used to create a dedicated database user profile with restricted permissions that align with organizational security and compliance requirements.

Authentication

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

ParameterDescription
Database HostThe Ellucian Banner database hostname, URL, or IP address.
Database PortThe Ellucian Database listener port. If not modified, this typically uses the Oracle default port of 1521.
Listener/Service NameThe Ellucian Database listener or service name.
UsernameThe username created for ProcessMaker TCE.
PasswordThe password created for ProcessMaker TCE.

Required Tables and Fields

Student Management

TableDescriptionPurpose
SPRIDENPerson records registered in Ellucian BannerRetrieve person information such as first name, last name, and Banner ID
SGBSTDNStudent records registered in Ellucian BannerValidate whether a person is a student
GOREMALEmail addresses by personRetrieve student email addresses
STVTERMAdministrative periods associated with studentsQuery administrative periods for students
STVSTYPStudent typesResolve student type information

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

TableDescriptionPurpose
SCBCGIDCourse UUIDsRetrieve UUID information for courses
SCBCRSECourses registered in Ellucian BannerRetrieve course records
SCBDESCCourse descriptionsRetrieve detailed course descriptions
STVTERMCourse administrative periodsQuery course administrative periods

Query — Retrieve the List of Courses

Query — Retrieve Course Description

Query — Retrieve Administrative Periods per Course

Administrative Periods

TableDescriptionPurpose
STVTERMAdministrative periods registered in Ellucian BannerRetrieve administrative periods

Query — Retrieve Administrative Periods

External Institutions

TableDescriptionPurpose
STVSBGIExternal institutions registered in Ellucian BannerRetrieve external institution records

Query — Retrieve External Institutions

Course Equivalency

TableDescriptionPurpose
SHBTATCExternal coursesRetrieve external course records
SHRTATCInternal coursesRetrieve internal course records

Query — Retrieve Courses

Course Articulation

TableDescriptionPurpose
SHRTRITTransfer Institution NumberRetrieve transfer institution information
SHRTRAMAttendance PeriodRetrieve attendance period information
SHRTRAMTransfer MaintenanceCreate transfer maintenance records (write access required)
SHRTRITExternal Institution RecordsCreate external institution records (write access required)
SHRTRCRExternal Course ArticulationsRetrieve and save external articulations (write access required)
SHRTRCEInternal Course ArticulationsRetrieve and save internal articulations (write access 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 information and actions required to set up the ProcessMaker TCE and Ellucian Banner integration.

Ellucian Banner without Ethos

☐ Provide the Ellucian Banner database hostname, URL, or IP address.

☐ Provide the Ellucian Database listener port.

☐ Provide the Ellucian Database listener/service name.

☐ Perform firewall and database security modifications-

☐ Whitelist the ProcessMaker development and production environment IP addresses.

☐ Create a ProcessMaker-specific database user.

☐ Assign permissions to all required tables listed above.

☐ Provide the database username and password.