LookupIsir
The LookupIsir activity returns all fields in the Institutional Student Information Records (ISIR) entity. This activity enables you to create workflows around ISIR specific events.
The optional input values of the LookupIsir activity can be used as follows:
-
LookupIsir based on ISIR Match Id (Conditionally required input value marked C1 in the table below)
-
LookupIsir based on ISIR Main Id (IsirSummaryId property) (Conditionally required input value marked C2 in the table below)
-
LookupIsir based on Award Year, SSN, and ISIR Transaction Id (Conditionally required input values marked C3 in the table below)
Properties
Property | Value | Required | Notes |
---|---|---|---|
AwardYear | InArgument<String>
|
Conditional C3 | Specify the Award Year using a string, for example, "2015-16". |
DisplayName | String
|
No | Specify a name for the activity or accept the default. |
Isir | OutArgument<IsirMessage>
|
Yes | The ISIR 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 Browse for Types.... In the 'Browse and Select a .NET Type' window, navigate to Cmc.Nexus.FinancialAid.Contracts > Cmc.Nexus.FinancialAid.Services, and select IsirMessage. |
IsirMatchId | InArgument<Int32>
|
Conditional C1 | Specify the Id used to match ISIRs to Anthology Student Master records |
IsirSsn | InArgument<String>
|
Conditional C3 | Specify the SSN associated with ISIR records. |
IsirSummaryId | InArgument<Int32>
|
Conditional C2 | Specify the ISIR Main Id. |
IsirTransactionIdentifier | InArgument<String>
|
Conditional C3 | Specify the ISIR Transaction Id. |
ValidationMessages | InOutArgument
|
No | Specify a variable that can be used to capture validation messages. For more information, see Capture Validation Errors. |