| TransferTransferIdentity Method |
This method will create a context assignment for the old context when an identity is being transferred to a new context
The method will also create an Identity transfer object that can be used for reporting, auditing, and to retrieve the old managers of an identity in the Transfer identity assignments survey.
If the Identity transfer object is created, the Transfer identity assignments survey will be launched.
Properties on the *previous* version of the identity data object will be copied to the new Identity transfer object using the provided copyrule.
The method will use the configured Grace days on the context type data object to set the validity of the context assignment for the old context
The method cannot be used for personal context types e.g.Employments, and for context membership based on direct context assignments.Only membership-based contexts are supported.
Namespace:
Omada.OE.Solution.OIM.Assembly.PackagedSolution
Assembly:
Omada.OE.Solution.OIM.Assembly (in Omada.OE.Solution.OIM.Assembly.dll) Version: 15.0.0.0
Syntaxpublic void TransferIdentity(
CodeMethodInvokeContext context,
string contextTypeSystemName,
string copyRuleUId,
string surveyScheduleUId,
string scopeVariables,
string surveySettings,
int deadlineDays
)
Parameters
- context
- Type: Omada.OE.ModelCodeMethodInvokeContext
- contextTypeSystemName
- Type: SystemString
System name of a (context) data object type - copyRuleUId
- Type: SystemString
UId of a Copy rule object. Property values from the *previous* version of the identity data object will be copied to the new Identity transfer object using this Copy rule (optional)
- surveyScheduleUId
- Type: SystemString
UId of a predefined Survey Schedule data object which defines the survey to be launched - scopeVariables
- Type: SystemString
Maps values from the Action object to the scope variables in the Transfer identity assignments survey.
The mapping string has the following format:
[Scope variable name as defined in Survey template starting with @]=[System name of property or fixed field on identity data object];
The following Fixed fields are supported:
Id
Type
Number
DisplayName
CreateTime
CreatedBy
ChangeTime
ChangedBy
DeleteTime
DeletedBy
Locked
Example of a mapping string: @Identity=Id;@firstName=FirstName.
If empty, the values for the scope variables of the survey will be retrieved from the Survey Schedule object.
If not empty and the Survey Schedule contains values for the scope variables as well, the scope variable mapping will override the predefined values in the Survey Schedule
- surveySettings
- Type: SystemString
Maps values from the Action object to the survey settings in the Transfer identity assignments survey.
The mapping string has the following format:
[Survey setting name as defined in Survey template]=[System name of property or fixed field on identity data object];
The following Fixed fields are supported:
Id
Type
Number
DisplayName
CreateTime
CreatedBy
ChangeTime
ChangedBy
DeleteTime
DeletedBy
Locked
Example of mapping string: identity=Id;firstName=FirstName
If empty, the values for the survey settings of the survey will be retrieved from the Survey Schedule object.
If not empty and the Survey Schedule contains values for the survey settings as well, the survey settings mapping will override the predefined values on the Survey Schedule
- deadlineDays
- Type: SystemInt32
The deadline of the survey will be set from the day the survey is launched plus the number of days provided in this parameter
If a value is provided, the deadline on the Survey schedule object will not be used.
Leave empty to use the value of the Grace days property on the context type.
See Also