Workday

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. 

  1. Navigate to the "Data Sources" report
  2. Filter to "Student Course Registrations" data source
  3. From the related actions menu select Custom Report -> Create
  4. Name the report "Student Registrations"
  5. Select "Advanced" for the report type
  6. Check the "Enable As Web Service" box
  7. Check the "Optimized for Performance" box
  8. 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
       
    * Student ID is a calculated field. Use the following configuration:
         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

  9. Select the Filter tab
    1. In Filter on Instances
      1. Add Starting Academic Period Field
      2. Set Operator to "in the selection list"
      3. Set Comparison Type to "Prompt the user for the value"
      4. Set Comparison Value to "Default Prompt"
  10. Select the Prompts tab
    1. Add Starting Academic Period Field
    2. Set Prompt Qualifier to Default Prompt
    3. Set Label For Prompt XML Alias to "academicPeriod"
    4. Set Default Type to "No default value"
    5. Uncheck Required, Do Not Prompt at Runtime, and Do Not Include in Subtitle boxes
  11. Select the Share tab
    1. Select "Share with specific authorized groups and users"
    2. Add the "Student Integration System" group to "Authorized Groups"
  12. Select OK
  13. 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.

  1. Navigate to the "Data Sources" report and select "Academic Periods"
  2. From the related actions menu select Custom Report -> Create
  3. Name the report "Academic Period Types
  4. Select "Advanced" for the report type
  5. Check the "Enable As Web Service" box
  6. 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)
  7. Select the Share tab
    • Select "Share with specific authorized groups and users"
    • Add the "Student Integration System" group to "Authorized Groups"
  8. Select OK
  9. 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

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.