Astra Schedule Help (7.5)

Banner API Export

Hide Navigation Pane

Banner API Export

Previous topic Next topic  

Banner API Export

Previous topic Next topic JavaScript is required for the print function  

Available starting with version 7.5.13, Astra Schedule will provide an export option that uses the published Banner API to achieve section and meeting data export to the Banner system. The existing, standard import/export infrastructure (ATE) will provide export processing, meaning that Astra Schedule export jobs will still be utilized.  Export “spokes” will in turn call the PL SQL APIs. This export option can be used to insert new sections and meetings in Banner (for example to establish sections in Banner that were created in Astra Schedule), as well as update existing sections and meetings in Banner to reflect changes made in Astra Schedule.

Supported Use Cases

The following export use cases will be initially supported by this feature:

 

Run an export job to perform a batch insert of newly published, production sections and meetings in Banner

Run an export job to perform a batch update of existing sections and meetings to update days/time, instructor assignment, and/or room assignment changes.
 
noteNOTE:  The Banner API will only export section/meeting data from the "production" schedule in Astra Schedule.  It does not export directly from a sandbox.

 

Not Supported:

 

Pushed section or meeting deletes (Astra to Banner)

Real-time updates (Manual or scheduled batch export only)

API Access Required

The system will call the following Banner PL SQL APIs.  To utilize the Banner API export, the system will require access to these packages/tables.  All business logic in Banner will be managed by the APIs.

 

SB_SECTION (Sections)

 

sb_section.p_create
 
Called when exporting any Section with a NULL SISKey value (newly created in Astra)

 

sb_section.p_update
 
Called when exporting any Section with a non-NULL SISKey value

 

GB_CLASSTIMES (Meetings)

 

gb_classtimes.p_create
 
Called when exporting any Section Meeting with a NULL SISKey value

 

gb_classtimes.p_update
 
Called when exporting any Section Meeting with a non-NULL SISKey value

 

SB_FACASSIGNMENT (Instructor)

 

sb_facassignment.p_delete
 
Called when an instructor assignment is removed from a previously exported/imported meeting in Astra

 

sb_facassignment.p_update
 
Called to update an existing instructor assignment already in Astra and Banner

 

sb_facassignment.p_create
 
Called to create a new assignment in Banner that was added in Astra

 

SB_TERM (Term)

 

sb_term.f_query_one
 
Called when creating a new section.

 

sb_term.p_update
 
Called when creating a new section.

 

noteNOTE:  The system also requires read access to SOBTERM for sobptrm_census_date used during section creation.

 

SB_COURSE (Course)

 

sb_course.f_query_one
 
Called when creating a new section.

Logging

Export log file artifacts will be created as follows:

 

Time/date stamps and log messages (errors, warnings) for records that are unable to be exported due to Astra-side issues (e.g. mapping problems – incompatibility of data elements; invalid or missing required elements in Banner)
 

Record level log messaging for records export to Oracle that have export failures (e.g. Banner business logic/rule enforcement rejects the export)
 

Export job status will indicate a success or failure status in the UI

 

Log file artifacts are accessible from the ATE job entry on the job list page.

Banner API Export Job

When setting up a Banner API batch export job, select the BannerApiSectionExport spoke file, as shown below:

 

BannerAPIExportJob

 

The job form includes a number of parameters to define the export behavior.  See below for a description of each of these settings.

 

BannerAPIExportJobDetail