LookupStudentDocuments
The LookupStudentDocuments activity returns the documents associated with a particular student. You can use this activity to modify the attributes of a Student Document using a workflow.
For example, you can look up a Document Type using a LookupReferenceItem activity and then use a LookupStudentDocuments activity to look up the students to whom the document has been associated via a Contact Manager activity. Based on an event, you can then change the document status or perform other activities, e.g., close a Contact Manager activity.
Properties
| Property | Value | Required | Notes |
|---|---|---|---|
| DisplayName | String
|
No | Specify a name for the activity or accept the default. |
| Document Type Id | InArgument<Int32>
|
Yes | The DocumentTypeId captured from an event. |
| Documents List | OutArgument<DocumentEntity[]>
|
Yes | The Document returned by the lookup function. 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. To identify the variable type, in the Variable type field of the Variables pane, select Array of [T]. In the 'Select Types' window, select Browse for Types, and click OK. In the 'Browse and Select a .NET Type' window, navigate to Cmc.Nexus.Crm.Contract > Cmc.Nexus.Crm.Entities, select DocumentEntity, and click OK.
See DocumentEntity Class in the Anthology Student Object Library. |
| Student Id | InArgument<Int32>
|
Yes | The Student Id captured from an event. |
| ValidationMessages | OutArgument
|
No | Specify a variable that can be used to capture validation messages. For more information, see Capture Validation Errors. |
