ConvertApplicantToEnrollment (V2)

The ConvertApplicantToEnrollment activity enables you to promote an Applicant record to an Enrollment and invoke the enrollment business logic.

If you use the ConvertApplicantToEnrollment (V2) activity with Anthology Student Activities and Contracts (V1) (instead of V2), the EnrollmentWebServiceUrl key needs to be set.

To verify this in the Desktop client, navigate to Setup > System > File Server & Services, click Configure Web Service Locations, and select the Other tab. Closed

Use Case

When an online application is submitted through Forms Builder, an Applicant record is created that leverages the student statuses associated with the configured Applicant Category statuses. Once the student is approved for enrollment, typically the Anthology Student user would use the Enrollment Wizard and populate the enrollment with the existing information. Instead of having a user go through the Enrollment Wizard, a workflow can detect an approval from a Contact Manager activity, Document Status event, or Group Membership event and then, using the ConvertApplicantToEnrollment activity promote the applicant record to a full enrollment.

Convert Applicant To Enrollment

Convert Applicant To Enrollment

Properties

ConvertApplicantToEnrollment Properties
Property Value Required Notes
AcademicAdvisorId InArgument<Nullable><Int32>> No* Specify the Academic Advisor Id using a VB expression or variable.
  • The Academic Advisor Id is optional when 'Advisor Selection' is cleared under Setup > Academic Records > Enrollment.

  • The Academic Advisor Id is required when 'Advisor Selection' is selected under Setup > Academic Records > Enrollment.

ApplicationReceivedDate InArgument<DateTime> Yes Specify the date when the student’s application was received using a VB expression or variable.
BillingMethodId InArgument<Int32> Yes Specify the database identifier for the Billing Method using a VB expression or variable.
CampusId InArgument<Int32> Yes Specify the database identifier for the Campus in which the student is enrolled using a VB expression or variable.
CatalogYearId InArgument<Nullable><Int32>

No

Specify the catalog year identifier using a VB expression or variable.

Note: This property is available only in the V2 version of the activity, i.e., in the Cmc.Nexus.Academics.Workflow namespace.

DisplayName String No Specify a name for the activity or accept the default.
EnrollDate InArgument<DateTime> Yes Specify date when the student is enrolled into the Program using a VB expression or variable.
EnrollId InArgument<Int32> Yes Specify the Student Enrollment Period Id using a VB expression or variable.
ExpectedStartDate InArgument<DateTime> Yes Specify the date that the student is expected to start using a VB expression or variable.
GradeLevelId InArgument<Int32> Yes Specify the database identifier for Grade Level for this enrollment using a VB expression or variable.
GraduationDate InArgument<DateTime> No Specify the Graduation Date using a VB expression or variable.
MidpointDate InArgument<DateTime> No Specify the Midpoint Date using a VB expression or variable.
ProgramVersionId InArgument<Int32> Yes Specify the database identifier for Program Version for this enrollment using a VB expression or variable.
ShiftId InArgument<Int32> Yes Specify the database identifier for the Shift from the AdShift table (Day, Night, etc.) using a VB expression or variable.
StartDateId InArgument<Nullable><Int32>> No* Specify the database identifier for the Start Date using a VB expression or variable.

Required:

  • If ''Require Start Date' is selected under Setup > Academic Records > Settings.

  • If MidpointDate/GraduationDate are not specified.

Optional:

  • If 'Require Start Date' is set to 'Not Required' under Setup > Academic Records > Settings.

  • If MidpointDate/GraduationDate are specified.

StartTermId InArgument<Nullable><Int32>

No

Specify the start term year identifier using a VB expression or variable.

Note: This property is available only in the V2 version of the activity, i.e., in the Cmc.Nexus.Academics.Workflow namespace.

StudentId InArgument<Int32> Yes Specify a Student Id using a VB expression or variable.
StudentStatusId InArgument<Int32> Yes Specify the Student Status Id using a VB expression or variable.
ValidationMessages InOutArgument
<ValidationMessageCollection>
No Specify a variable that can be used to capture validation messages. For more information, see Capture Validation Errors.