SaveStudentCourse (V2)

The SaveStudentCourse activity enables you to Register or Unregister a Student Course. You can also transfer students who have been registered for a course from one class section to another class section using the TransferClassSection action in the SaveStudentCourse activity.

SaveStudentCourse is used after a CreateStudentCourse (V2) activity has created a Student Course instance. SaveStudentCourse will persist a Student Course instance in the database.

SaveStudentCourse

Properties

SaveStudentCourse Properties
Property Value Required Notes
Action InArgument
<CourseAction>
Yes Select one of the following options:
  • Register
  • Unregister
  • TransferClassSection

When the action TransferClassSection is selected, the StudentCourseId and TransferToClassSectionId are required.

DisplayName String No Specify a name for the activity or accept the default.
ParentTermId InArgument<Int32> No Use this value when a Parent/Child relationship has been defined for the terms at your institution and you want to register a student into a Child term. The ParentTermId value is the AdTermId of the Parent term in Anthology Student.

You can use LookupTerms (V2) to pass the Id into the SaveStudentCourse activity.

Note: This value is used only with the Register Action when registering a student into a child term.

StudentCourse InArgument
<StudentCourseEntity>
Conditional The Student Course created by this workflow activity. This is a variable that can be used as input for subsequent activities in the workflow. Specify the variable's name, type, and scope (and default if applicable) in the Variables pane of the Designer window.

Note: This value is used only with the Register and Unregister Actions.

To identify the variable type, in the Variable type field of the Variables pane, select Browse for Types.... In the 'Browse and Select a .NET Type' window, navigate to Cmc.Nexus.Academics.Contracts > Cmc.Nexus.Academics.Entities, select StudentCourseEntity, and click OK.

variable type

See StudentCourseEntity Class in the Anthology Student Object Library.

StudentCourseId InArgument<Int32> Conditional The StudentCourseId is the StudentCourse.Id (which is AdEnrollSched.AdEnrollSchedID in Anthology Student for the current class).

This value is used only with the TransferClassSection Action.

TransferToClassSectionId InArgument<Int32> Conditional The TransferToClassSectionId is the ClassSection.Id of the class into which you want to transfer students (mapped to AdClassSched.AdClassSchedId in Anthology Student).

Note: This value is used only with the TransferClassSection Action.

ValidationMessages OutArgument
<ValidationMessageCollection>
No Specify a variable that can be used to capture validation messages. For more information, see Capture Validation Errors.