Steps

Assign Success Plan to Student

This step consumes a Student Id and SuccessPlanTemplate Id as input values and it then returns a success plan ID that is associated with the selected student.

Properties

Name	Description	Property Value Type
StudentId	The ID of the Student with which the success plan will be associated.	InArgument<EntityReference>
SuccessPlanTemplateId	The ID of the Success Plan Template with which the Contact will be associated.	InArgument<EntityReference>
SuccessPlanId	The ID of the resultant success plan record.	OutArgument<EntityReference>

Attach Appointment in Email

This step attaches the appointment in an email that is sent to the student / user.

Properties

Name	Description	Property Value Type
Email	The ID of the email that is sent to the student.	InArgument<EntityReference>
Appointment	The ID of the appointment scheduled for the selected user and/or the student.	InArgument<EntityReference>

Attach Trip Schedule in Email

This step attaches details of the retrieved trip schedule in an email to corresponding staff members and volunteers.

Properties

Name	Description	Property Value Type
Email	The ID of the email that is drafted.	InArgument<EntityReference>
TripActivity	The Trip Activity that is associated with volunteers/staff members.	InArgument<EntityReference>
StartDateTime	The start date and time of the Trip Activity that is associated with volunteers/staff members.	InArgument<DateTime>
EndDateTime	The end date and time of the Trip Activity that is associated with volunteers/staff members.	InArgument<DateTime>
Location	The location of the Trip Activity that is associated with volunteers/staff members.	InArgument<String>
FileName	The file name of the Trip Activity that is associated with volunteers/staff members.	InArgument<String>
Subject	The subject of the Trip Activity that is associated with volunteers/staff members.	InArgument<String>
Description	The description of the Trip Activity that is associated with Volunteers / staff members.	InArgument<String>

Copy Application

This action copies the specified application record and related requirements and recommendations.

Properties

Name	Description	Property Value Type
Application	The ID of the source application record.	<Input>EnitityReference
RecordId	The ID of the copied application record.	<Output>String

Note: The Program and Application Period fields are configured not to be copied while copying an application. This setting can be changed in the Copy Application action.

Copy Application Definition Version

This action copies the specified application definition version record and related application definition version detail including related application period programs.

Properties

Name	Description	Property Value Type
ApplicationDefinitionVersion	The ID of the source application definition version record.	<Input>EnitityReference
RecordId	The ID of the copied application definition version record.	<Output>String

Copy Application Registration

This action copies the specified application registration record and related applications including related requirements and recommendations.

Properties

Name	Description	Property Value Type
ApplicationRegistration	The ID of the source application registration record.	<Input>EnitityReference
RecordId	The ID of the copied application registration record.	<Output>String

Copy Records

This action makes a copy of the specified source record. The name of the copied record will be prefixed with the text specified in the “Prefix” parameter. Prefix is not valid for entities that have an auto-naming convention. Fields that must not be copied can be configured in the FieldsToIgnore parameter.

Properties

Name	Description	Property Value Type
SourceRecordUrl	Record Url of the source record.	<Input>String
Prefix	Prefix string that will be added to the record name.	<Input>String
FieldsToIgnore	Semi colon separated list of fields that must not be copied.	<Input>String
CopyAttachments	Determines if attachments should be copied or not.	<Input>Boolean
RecordId	Return the record id of the newly copied record.	<Output>String

Copy Related Records

This action copies child records of the source parent record to the newly copied parent record based on the specified relationship name.

Properties

Name	Description	Property Value Type
RelationshipName	One to many relationship name	<Input>String
SourceParentRecordUrl	The URL of the source parent record.	<Input>String
TargetParentId	The ID of the newly copied parent records	<Input>String
FiledsToIgnore	Semi colon separated list of fields of the child entity that must not be copied.	<Input>String
RelatedRelationships	Semi colon separated list of one to many relationship names of child entity that should not be copied.	<Input>String
RelatedFieldsToIgnore	Semi colon separated list of fields of the child of child entity that must not be copied. For child of child fields, provide <EntityName>.<FieldName> as there could be multiple child of child relationships configured in the RelatedRelationships parameter.	<Input>String
CopyAttachments	Determines if attachments must be copied.	<Input>Boolean

Copy Review Bundle

This action copies the specified review bundle record. Associated applications and reviewers will not be copied.

Properties

Name	Description	Property Value Type
Review Bundle	Review bundle Id of the source review bundle record.	<Input>EnitityReference
RecordId	Review bundle Id of the copied review bundle record.	<Output>String

Copy Trip

This action copies the specified trip record and related trip activities.

Properties

Name	Description	Property Value Type
Trip	The ID of the source trip record.	<Input>EnitityReference
RecordId	The ID of the copied trip record.	<Output>String

Notes: The following fields are configured not to be copied while copying a trip. This setting can be changed in the Copy Trip action.

Trip : Trip Status, Review Date
The Trip BPF stage will be set to Create Trip.
Trip Activity : Associated Appointment/Event, Start Time, End Time, Activity Status, Ratings, Rating Comments, Actual Expenses.
The Trip Activity Type will be set to Other.

Create History on Status Change

This step creates a lifecycle history record when the status of the lifecycle record is changed.

Property

Name	Description	Property Value Type
Lifecycle	Lifecycle for which history needs to be generated as the status is changed.	InArgument<EntityReference>

Execute Process of Child Records

This step executes the specified process/workflow on all child records of a parent record based on the relationship specified.

Properties

Name	Description	Property Value Type
ParentRecordUrl	Record Url of the parent record.	<Input>String
RelationshipName	One to many relationship name.	<Input>String
ProcessId	Process to be executed on child records	<Input>EntityReference

Get Active Lifecycle

This step returns an Open Lifecycle of a given Contact and its input filter parameters.

Properties

Name	Description	Property Value Type
Contact	The ID of the Contact.	InArgument<EntityReference>
Campus	The ID of the Campus to match with the Lifecycle.	InArgument<EntityReference>
Complete App Received Contains Data	Set “Yes” to check if the “Complete App Received” field in the Lifecycle has a value set. Set “No” to skip this check.	InArgument<Boolean>
Deposit Received Contains Data	Set “Yes” to check if the “Deposit Received” field in Lifecycle has a value set. Select “No” to skip this check.	InArgument<Boolean>
Expected Start Date	The ID of the Expected Start Date which should match with the Lifecycle’s “Expected Start Date”.	InArgument<EntityReference>
Lifecycle Type	The Lifecycle Type which should match with the Lifecycle.	InArgument<String>
Program	The ID of Program which should match with the Lifecycle.	InArgument<EntityReference>
Program Level	The ID of the Program Level that should match with the Lifecycle.	InArgument<EntityReference>
Source Campus	The ID of Source Campus that is associated with the contact.	InArgument<EntityReference>
Source Category	The ID of the Source Category that is associated with the contact.	InArgument<EntityReference>
Source Method	The ID of the source Method that is associated with the contact.	InArgument<EntityReference>
Source Program	The ID of the source Program that is associated with the contact.	InArgument<EntityReference>
Source Program Level	The ID of the source Program Level that is associated with the contact.	InArgument<EntityReference>
Source Referring Contact	The ID of the source Referring Contact that is associated with the contact.	InArgument<EntityReference>
Source Referring Organization	The ID of the source Referring Organization that is associated with the contact.	InArgument<EntityReference>
Source Referring Staff	The ID of the source Referring Staff that is associated with the contact.	InArgument<EntityReference>
Source Campaign	The ID of the source Campaign that is associated with the contact.	InArgument<EntityReference>
Source Sub Category	The ID of the source Sub Category that is associated with the contact.	InArgument<EntityReference>
Lifecycleid	The Lifecycle of the given Contact which matched with the conditions passed.	OutArgument<EntityReference>

Get ChildEntity RecordsCount

Returns the count of child entity records based on the lookup field of the parent entity.

Properties

Name	Description	Property Value Type
Child Entity Schema Name	Name of child entity.	InArgument<String>
Parent Lookup Field Name on Child	Field name of the lookup field in parent entity.	InArgument<String>
Record URL (Parent)	Associated parent record for which child record count must be determined.	InArgument<String>
Result	Count of child records.	OutArgument<String>

Get Configuration

This step retrieves the default Configuration entity.

Property

Name	Description	Property Value Type
ConfigurationValue	The active configuration.	OutArgument<EntityReference>

Get Current Date

Returns the current date, date part only or date with time based on the parameter sent.

Properties

Name	Description	Property Value Type
Date Only	"True" returns only the date, and "False" returns the current date and time.	InArgument<bool>
Current Date	Current date based on Date Only parameter.	OutArgument<DateTime>

Get Lifecycle Type of Application's Application Definition Version

This step retrieves the Lifecycle type defined in the Application Version associated with the Application.

Properties

Name	Description	Property Value Type
ApplicationId	The application that is being added or modified.	InArgument<EntityReference>
LifecycleType	The Lifecycle type associated with the application.	OutArgument<OptionSetValue>

Get Multi-Select Options

In a record, this step retrieves comma separated selected values of the multi-select field sent as parameter.

Properties

Name	Description	Property Value Type
Source Record URL	Record for which multi-select option set values needs to be fetched.	InArgument<string>
Attribute Name	Attribute name of the multi-select field.	InArgument<string>
Selected Values	Comma separated selected values of the multi-select field.	OutArgument<string>

Get OptionSet Values

In a record, this step retrieves selected values of the optionset field sent as parameter.

Properties

Name	Description	Property Value Type
Source Record URL	Record for which optionset values need to be fetched.	InArgument<string>
Attribute Name	Attribute name of the optionset field.	InArgument<string>
Selected Values	Selected values of the optionset field.	OutArgument<string>

Get current Academic Period of Inbound Interest's Contact

This step retrieves the current Academic Period of an Inbound Interest's Contact.

Property

Name	Description	Property Value Type
CurrentAcademicPeriodId Property	The current Academic Period of the Inbound Interest's Contact.	OutArgument<EntityReference>

Get Current Campus of Inbound Interest's Contact

This step retrieves the current Campus of an Inbound Interest's Contact.

Property

Name	Description	Property Value Type
CurrentCampusId	The current campus of an Inbound Interest's Contact.	OutArgument<EntityReference>

Get current Program Level of Inbound Interest's Contact

This step retrieves the current Program Level of the Inbound Interest's Contact.

Property

Name	Description	Property Value Type
CurrentProgramLevelId	The current Program Level of the Inbound Interest's Contact.	OutArgument<EntityReference>

Get current Program of Inbound Interest's Contact

This step retrieves the current Program of the Inbound Interest's Contact.

Property

Name	Description	Property Value Type
CurrentProgramId	The current Program of the Inbound Interest's Contact.	OutArgument<EntityReference>

Get current School Status of Inbound Interest's Contact

This step retrieves the School Status of the Inbound Interest's Contact.

Property

Name	Description	Property Value Type
SchoolStatusId	The School Status of the Inbound Interest's Contact.	OutArgument<EntityReference>

Get source Campaign of Inbound Interest's Contact

This step retrieves the source campaign of the Inbound Interest's Contact.

Property

Name	Description	Property Value Type
SourceCampaignId	The source campaign of the Inbound Interest's contact.	OutArgument<EntityReference>

Get source Campus of Inbound Interest's Contact

This step retrieves the source Campus of the Inbound Interest's Contact

Property

Name	Description	Property Value Type
SourceCampusId	The source campus of the Inbound Interest's Contact.	OutArgument<EntityReference>

Get source Category of Inbound Interest's Contact

This step retrieves the source Category of the Inbound Interest's Contact.

Property

Name	Description	Property Value Type
SourceCategoryId	The source category of the Inbound Interest's Contact.	OutArgument<EntityReference>

Get source Expected Start of Inbound Interest's Contact

This step retrieves the source Expected Start of the Inbound Interest's Contact.

Property

Name	Description	Property Value Type
ExpectedStartId	The source Expected Start of the Inbound Interest's Contact.	OutArgument<EntityReference>

Get source Method of Inbound Interest's Contact

This step retrieves the source Method of the Inbound Interest's contact.

Property

Name	Description	Property Value Type
SourceMethodId	The source Method of the Inbound Interest's contact.	OutArgument<EntityReference>

Get source Program Level of Inbound Interest's Contact

This step retrieves the source Program Level of the Inbound Interest's contact.

Property

Name	Description	Property Value Type
SourceProgramLevelId	The source Program Level of the Inbound Interest's contact.	OutArgument<EntityReference>

Get source Program of Inbound Interest's Contact

This step retrieves the source Program of the Inbound Interest's contact.

Property

Name	Description	Property Value Type
SourceProgramId	The source Program of the Inbound Interest's contact.	OutArgument<EntityReference>

Get source Referring Organization of Inbound Interest's Contact

This step retrieves the source Referring Organization of the Inbound Interest's contact.

Property

Name	Description	Property Value Type
SourceReferringOrganizationId	The source Referring Organization of the Inbound Interest's contact.	OutArgument<EntityReference>

Get source Referring Staff of Inbound Interest's Contact

This step retrieves the source Referring Staff of the Inbound Interest's contact.

Property

Name	Description	Property Value Type
SourceReferringStaffId	The source Referring Staff of the Inbound Interest's contact.	OutArgument<EntityReference>

Get source Sub-category of Inbound Interest's Contact

This step retrieves the source Sub-category of the Inbound Interest's contact.

Property

Name	Description	Property Value Type
SourceSubcategoryId	The source Sub-category of the Inbound Interest's contact.	OutArgument<EntityReference>

Grant and Revoke Permissions

This step grants or revokes permissions to a user or team for an entity.

Properties

Name	Description	Property Value Type
Target User	The target user for whom the permissions must be granted or revoked.	InArgument<EntityReference>
Target Team	The target team for which the permissions must be granted or revoked.	InArgument<EntityReference>
Actor	The actor for whom the permissions must be granted or revoked.	InArgument<EntityReference>
Read Access	The Read permission for an entity. It can have one of the following values: True - Indicates permission is granted. False - Indicates permission is revoked.	InArgument<Boolean>
Write Access	The Write permission for an entity. It can have one of the following values: True - Indicates permission is granted. False - Indicates permission is revoked.	InArgument<Boolean>
Append Access	The Append and Append To permissions for an entity. It can have one of the following values: True - Indicates permission is granted. False - Indicates permission is revoked.	InArgument<Boolean>
Share Access	The Share permission for an entity. It can have one of the following values: True - Indicates permission is granted. False - Indicates permission is revoked.	InArgument<Boolean>

Retrieve Reviewer For Bundle

This step retrieves reviewer records for the user in the bundle.

Properties

Name	Description	Property Value Type
Bundle	Review bundle for which reviewer information must be retrieved.	InArgument<EntityReference>
User	User ID of the reviewer.	InArgument<EntityReference>
Reviewer	Retrieved reviewer record for the user in the bundle.	OutArgument<EntityReference>

Retrieve Student Department Phone Number

This step retrieves the student's Department phone number.

Properties

Name	Description	Property Value Type
DepartmentId	The department to which the student belongs.	InArgument<EntityReference>
PhoneNumber	The phone number of the department which is associated with the student.	OutArgument<String>

Retrieves the Time zone of the Trip Activity

This step retrieves a trip activity’s time zone information based on the trip activity type.

It returns:

The logged-in user’s time zone information when the trip activity type that’s selected is “Appointment” or “Other”.
The event’s time zone information when the trip activity type that’s selected is “Event”.

Properties

Name	Description	Property Value Type
TripActivityId	The Trip Activity that is associated with volunteers/staff members.	InArgument<EntityReference>
TimezoneInformation	The Time zone information	OutArgument<String>

Set Lifecycle Process and Stage for Application

This step starts the Lifecycle process and sets the process stage for a given application.

Properties

Name	Description	Property Value Type
ApplicationId	The application that is being added or modified.	InArgument<EntityReference>
Process	The Lifecycle process.	InArgument<EntityReference>
ProcessStage	The stage that needs to be set on the Lifecycle process.	InArgument<string>
Lifecycle Status	The Lifecycle status that will be set in the lifecycle.	InArgument<string>
Result	Returns True if successful and returns False if failed to set process and stage.	OutArgument<bool>

Update Application Definition Version Detail Name

This step calls the step Execute Process of Child Records to execute the ApplicationDefinitionVersionDetailAutoName workflow to update the name field of all Application Definition Version Detail records, when the name of the Application Definition Version record is changed. This process runs simultaneously when Application Definition Version name is updated, hence the changes are reflected immediately on the Application Definition Version page.

Property

Name	Description	Property Value Type
ApplicationDefinitionVersion	Application definition version id of the source application definition version record.	<Input>EnitityReference

Note: While the steps Execute Process of Child Records and Update Application Definition Version Detail Name update Application Definition Version Detail records based on the changed name in the parent Application Definition Version, the Execute Process of Child Records step is generic and can be copied to perform other updates to child records in real time based on updates to a parent record. For instance, if the Status field in a parent record changes, corresponding updates can also happen in the Status field in all child records.