DeleteEntity<>
The DeleteEntity<> activity invokes the Delete method of an entity service to delete an instance of an entity.
Note: The DeleteEntity<> activity does not support the deletion of CampusNexus CRM entities.
When you drag the DeleteEntity<> activity into the Designer window, you are prompted to select the entity type.
When you select the 'Browse for Type' option, the list of assemblies and associated entities is displayed. Find and select the entity and click OK.
After you have selected an entity, the name of the entity is inserted into the DisplayName field, e.g., DeleteEntity<StudentGroupEntity>. Proceed to specify the entity to be deleted and, optionally, a validation message.
Properties
Property | Value | Required | Notes |
---|---|---|---|
DisplayName | String
|
No | Specify a name for the activity or accept the default. |
Entity | InOutArgument<Entity>
|
Yes | Specify the entity previously retrieved with a GetEntity<> activity using a VB expression or variable. |
Messages | InArgument
|
No | Specify the validation message to be displayed when the entity is deleted. Specify a variable that can be used to capture validation messages. For more information, see Capture Validation Errors. |