Supported Features

Export of new and existing Sections

Export of SectionMeetings and instructor assignments for new Sections

Building of Crosslist associations for new Sections.

Setup

The majority of work needed to be done to support via the API pertains to properly configuring the System Settings for your CampusVue setup.  Though there are several settings that need to be added.  Fortunately, they need to be configured only once:

 

System Settings to Configure

 

PrimarySisConnectionString

The database connection string for your CampusVue database.

CampusVueAuthenticationServiceUrl

The URL to the CampusVue API’s Authentication Service.

CampusVueCourseSectionServiceUrl

The URL to the CampusVue API’s CourseSection Service.

CampusVuePeriodServiceUrl

The URL to the CampusVue API’s PeriodService.

CampusVueUserName

The CampusVue user that will be used to make all export changes through the API.

CampusVuePassword

The password for the selected CampusVue user.

CampusVueDummyInstructorId

If your organization uses a ‘dummy’ or ‘placeholder’ CampusVue instructor used to represent a CourseSection without an instructor assignment, or an assignment that has yet to be made, then this setting should hold the SyStaffId of that instructor.

 

Otherwise, this parameter’s value should be set to ‘0’ (zero) to indicate no such instructor exists.

 

When this parameter is not configured, Astra will be unable to export Sections that have no instructor assignments.

Running Jobs

Running an API export job is similar to running any other import or export job.  For more specific on creating and running jobs, see "Jobs".

 

1.Create a new Batch Export job using the "CampusVueSectionExport.xml" file.

 

2.In the job configuration form, select the desired Campuses and Terms from which to export.

 

3.Under ‘CampusVue Database Settings’, enter a SQL database username and password of a user for your CampusVue database.  The database will need to be referenced during the export, which will be done as this user.

 

4.Enter a name for the job, save, and run.

Detailed Results – Section Export

The following table illustrates how information contained in a CampusVue CourseSection is configured from Astra Schedule:

 

CampusVue Values

 

Active

IsActive flag from Section

AllowWaitList

Always set to true

ApplyBookList

Always set to default

ApplyFee

Always set to default

AttendanceType

Always set to TimeAbsent

ClassMeetsAtVariousTimesAndDays

IsArranged flag from Section

Description

Title of Section

EndDate

EndDate of SectionMeetings.

MaximumNumberOfStudents

SISMaxEnrollment from Section

PassFailSettings

Defaults to CampusVue’s Course setting

PrimaryInstructor

First instructor

Section

SectionCode from Section

SectionDeliveryMethod

Taken from Section’s configured DeliveryMethod

StartDate

StartDate of SectionMeetings.

Detailed Results – Section Meeting Export

Astra Schedule will associate one AdPeriod to a corresponding CourseSection for every SectionMeeting exported.  If necessary, a new AdPeriod will be created in CampusVue to properly describe the meeting pattern of the export SectionMeeting.

 

New Periods can be found in the AdPeriod table.

Associations of Periods to CourseSections can be found in the AdClassSchedPeriod table.

Instructor assignments for the meeting can be found in the AdClassAttend table.

 

The following table illustrates how information from a SectionMeeting is mapped to an AdPeriod:

 

CampusVue Values

 

Active

Always set to true

CampusIds

SyCampusID(s) of the institution campus(es)

Days

SectionMeeting’s DaysMet

Description

SectionMeeting’s DaysMet and Time description

Frequency

Always set to 1

PatternType

Always set to ‘W’

PeriodEndTime

SectionMeeting’s end time

PeriodStartTime

SectionMeeting’s start time

ReOccuranceEndAfter

Always set to 1

ReOccuranceUptoClassEnd

Always set to true

ReOccurrenceStart

Always set to 0

Detailed Results – Cross-list Export

Astra Schedule will associate cross-listed SectionMeetings at the CourseSection level in CampusVue.

 

Exported Crosslists can be found in the AdCrossListSection table

Current Section Export Limitations

Unsupported Use Cases:

 

Export Section Meetings with no times (cannot make room/instructor assignments w/o times in CampusVue)

 

Export a section associated with a course not imported from CampusVue (We cannot export courses created in Astra Schedule)

 

Export a section associated with a campus not in CampusVue

 

Export a section associated with a term not in CampusVue

 

Export a section wherein the meetings do not all agree on the instructor assignments (primary and secondary).  The API export requires this information in the Course Section

 

Export a section wherein the meetings do not all agree on the start dates

 

Removing a section from a cross-list group

 

Updating cross-list membership for non-new sections (We only know about cross-list additions when we are dealing with a new section.)

 

Exporting a section with a Delivery Method not in CampusVue.

Page url: ?campusvuesectionexporttesting.htm