Ad Astra integrates with Workday's APIs for ingesting and publishing the necessary data for Essential Scheduling, Student Centered Scheduling, and Integrated Planning. Below are the instructions for configuring Workday.
Workday Integration User
Create an integration user and change default settings in order to not require a password reset after 90 days. Assign the integration user access to the APIs via the "View Security for Securable Item" task in Workday.
APIs Required for Base Data: Essential Scheduling
Functional Area | API |
Student Records | Get_Instructor_Eligibility |
Student Records | Get_Instructor_Loads |
Student Records | Get_Meeting_Day_Patterns |
Student Records | Get_Meeting_Patterns |
Student Records | Get_Course_Equivalency_Groups |
Student Records | Get_Course_Section_Colocations |
Student Records |
Get_Course_Section_Relationship (later versions call it Get_Course_Section_Clusters) |
Student Records | Get_Course_Sections |
Student Records | Get_Course_Subjects |
Student Records | Get_Student_Course |
Human Resources | Get_Academic_Appointee |
Human Resources | Get_Academic_Unit_Hierarchies |
Human Resources | Get_Academic_Units |
Human Resources | Get_Location_Attributes |
Human Resources | Get_Locations |
Academic Foundation | Get_Maintained_Academic_Periods |
Academic Foundation | Get_Programs_of_Study |
Academic Foundation | Get_Student_Grading_Schemes |
Academic Foundation | Get_Student_Tag_Categories |
Academic Foundation | Get_Student_Tags |
Additional APIs Required for Base Data: Essential Scheduling - Publish
Functional Area | API |
Student Records | Submit_Course_Section |
Student Records | Submit_Cancel_Course_Section |
Student Records | Submit_Published_Course_Section |
Student Records | Put_Course_Section_with_Preliminary_Status |
Student Records | Put_Publish_Course_Section |
Endpoints for Extended Data: Student Centered Scheduling and Integrated Planning
Functional Area | Endpoint |
Academic Advising | academicProgressForStudent |
Academic Foundation | educationTestResults |
Academic Foundation | programsOfStudy |
Academic Foundation | student |
Financial Aid | isirTransactions |
Student Records | programOfStudyAssignmentSnapshots |
Student Records | studentTransferCredit |
Student Registrations Report
Create a Student Registrations custom report (required) to allow access to historical student registrations.
- Navigate to the "Data Sources" report
- Filter to "Student Course Registrations" data source
- From the related actions menu select Custom Report -> Create
- Name the report "Student Registrations"
- Select "Advanced" for the report type
- Check the "Enable As Web Service" box
- Check the "Optimized for Performance" box
- Add the following columns to the report
- Workday ID
- Course
- Course Sections
- Unit Type
- Start Date
- In-Progress Registration Units
- Units
- Replaced Registration
- Academic Level
- Student ID *
- Repeated Registration
- Academic Period
- Student
- Overall Registration Status
- Academic Unit
- Attempted Units
- Earned Units
- Transcript Grade
- Earned Grade Points
1. Add calculated
2. Name: Student ID
3. Calculation
1. Lookup Field: Student Record
2. Related Business Object: Academic Record
3. Return Value: Student ID
- Select the Filter tab
- In Filter on Instances
- Add Starting Academic Period Field
- Set Operator to "in the selection list"
- Set Comparison Type to "Prompt the user for the value"
- Set Comparison Value to "Default Prompt"
- In Filter on Instances
- Select the Prompts tab
- Add Starting Academic Period Field
- Set Prompt Qualifier to Default Prompt
- Set Label For Prompt XML Alias to "academicPeriod"
- Set Default Type to "No default value"
- Uncheck Required, Do Not Prompt at Runtime, and Do Not Include in Subtitle boxes
- Select the Share tab
- Select "Share with specific authorized groups and users"
- Add the "Student Integration System" group to "Authorized Groups"
- Select OK
- Select Test to test the report
Academic Period Types Report
Create an Academic Period Types custom report (required) to allow access to partial terms and term types.
- Navigate to the "Data Sources" report and select "Academic Periods"
- From the related actions menu select Custom Report -> Create
- Name the report "Academic Period Types
- Select "Advanced" for the report type
- Check the "Enable As Web Service" box
- Add the following columns to the report all from the Academic Periods business object
- Academic Period
- Academic Year (the non-prompt option)
- Period Type
- Standard Academic Period (boolean)
- Select the Share tab
- Select "Share with specific authorized groups and users"
- Add the "Student Integration System" group to "Authorized Groups"
- Select OK
- Select Test to test the report
Provide Information
Provide Ad Astra the following:
Integration Username and Password
SIS Institution ID *
Base SOAP URL
Workday WSDL file location for Student Registration report
Workday WSDL file location for Academic Period Type report
* Note: The SIS Institution ID can be derived from the Workday Instance URL (E.g. "CUSTOMER_SIS_ID" from https://impl.workday.com/CUSTOMER_SIS_ID/d/home.htmld)
Initial Import
After successful configuration, the terms will be populated per the pending scheduled import.
Article Version History
Version: Updates Made | Date: |
1: Added table with indicators of requirement for Ingest or Publish for APIs. Started Article Version History table to capture changes moving forward. | 8/19/24 (Current View) |
2. Added the following fields to the Student Registrations Report: Attempted Units, Earned Units, Transcript Grade, Earned Grade | 9/6/24 |
3. Reformatting for clarity – separated into 3 sections for: Base data, Publish, and Extended Data. Added note for integration user to not require password reset after 90 days. | 9/17/24 |
Comments
Please sign in to leave a comment.