...
Followings are the available user scaler properties:scalar properties:
OrgLoginId: is optional, doesn’t update if empty. This is unique within an Organization. It can be removed depending on the configuration after user deactivation (System.Customer.PreserveOrgLoginIdOnDeactivate). Default Value: '' (String)
EmailAddress: will not be updated if empty. This is unique across different organizations. It can be removed depending on the configuration after user deactivation. Default Value: '' (String)(System.Customer.PreserveLoginEmailOnDeactivate).
ExternalUserId: is optional, doesn’t update if empty. This is unique within an Organization. (Doesn’t get erased after user deactivation). Default Value: '' (String)
Deactivate (X): If the column DeactivateX (aka ‘Deactivate (X)’) exists, leaving the value empty (‘’) would reactivate a user. Use ANY value for DeactivateX there to deactivate a user..
OrgLoginId: is optional, Don't update if empty. This is unique within an Organization. Default Value: '' (String)Password: if the user already exists and left empty - the password is not updated. Default Value:'' (String)
FirstName: will not be updated if empty. Default Value: '' (String)
LastName: will not be updated if empty
EmailAddress: will not be updated if empty. Default Value: '' (String)ContactEmail: will not be updated if empty. Default Value: '' (String)
ForcePasswordChange: ‘True' True' or 'False'. Anything not 'True' (e.g. empty) for new users will be interpreted as 'False'. For updates, will not be updated if not 'True' or 'False'. Default Value: 'false’ (Boolean)
CanViewReports: 'True' or 'False'. Anything not 'True' (e.g. empty) for new users will be interpreted as 'False'. For updates, will not be updated if not 'True' or 'False'new users will be interpreted as 'False'. For updates, will not be updated if not 'True' or 'False'. Default Value: 'false’ (Boolean)
PasswordChangesAllowed: ‘True’ or ‘False’. Setting to false blocks users from changing their own passwords. If this is false,
ForcePasswordChangeCANNOT be ‘true’.
*Along with these scaler scalar properties all active OPF fields can be used in translation.
Sample CsvTranslations:
"OrgLoginId=UniqueUserID,FirstName=FirstName,LastName=LastName,Password=DateOfBirth,ContactEmail=PersonalEmailAddress,Deactivate (X)=Deactivate (X)"
Here Left side of '=' sign is the MLS user property and right side is the csv column name.
[MLS user property]=[csv column name]
...
Supported data types:
String
Integer
EmailAddress
DateTime
NumberBoolean
Data Assembler Configuration (Optional)
...
From V4.9, It is possible to use any fields to assemble other field even those fields are not part of OPFthose fields are not part of OPF.
Check For Existing User Configuration (No Configuration Required)
This activity checks for existing users using Identifier fields configured in Data Validation Configuration. Currently this activity doesn’t have it’s own configuration.
Reset Fields To Default If Empty Configuration (Mandatory)
...
If we want to set null/empty value to any field, those fields must be included in ResetFieldsToDefaultIfEmptyConfiguration. That means, if any organization uses deactivation field (Deactivate (X)) that needs to included in this configuration.
| Info |
|---|
The user property must be part of the |
Default values for different user property types:
User scalar property (string): empty string (except any Primary Identifying Field)
OPF (single-choice-string): first choice
OPF (string): empty string
OPF (int): not supported yet (we don’t have a default value for int yet)
...
Every field must have a Name and Type. If any field is configured as “DateTime“ type then Format must be specified (example above) otherwise it will be considered as configuration error.Also
If UserImporterConfiguration contains DataFormattingConfiguration and it formats any datetime field, then the Format in DataValidationConfiguration for the datetime type field must match the output format of FieldFormatting.
| Code Block | ||
|---|---|---|
| ||
"DataFormattingConfiguration" : {
"FieldFormatting" : [
{
"FieldName" : "EmbarkmentDate",
"Type" : "DateTime",
"InputFormat" : "dd-MMM-yy",
"OutputFormat" : "yyyy-MM-dd"
}
]
} |
List of all exact names for user scalar properties which can be used:
...
All the values inside the PasswordFormat will be concatenated for password creating for new user only. If IsField=true, that means it will get the value provided in the csv (Also can be modified in previous activities), Otherwise whatever the value provided in the configuration value property it will consider that.
| Info |
|---|
|
Auto User Deactivation Configuration (Optional)
...
| Code Block | ||
|---|---|---|
| ||
"AutoUserDeactivationConfiguration": {
"MaxUsersToDeactivate": "500",
"UserFilterFieldNames": [
"Rank"
]
} |
UserFilterFieldNames array takes the field name to filter the users on which auto deactivation will be applied if filtered users are not part of the csv import, where field must be a Single Choice String (ScS).
...
Sample Configuration:
| Code Block | ||
|---|---|---|
| ||
"ThresholdConfiguration" : {
"Thresholds" : [
{
"Name" : "MaxUsersPerImport",
"Value" : 1,
"Action" : "StopImport"
},
{
"Name" : "MaxDeactivateUsers",
"Value" : 1,
"Action" : "GenerateWarning"
},
{
"Name" : "MaxNewUsers",
"Value" : 4,
"Action" : "StopImport"
},
{
"Name" : "MaxOrgProfileValueUpdates",
"Value" : 1,
"Action" : "GenerateWarning"
},
{
"Name" : "MaxReactivateUsers",
"Value" : 1,
"Action" : "GenerateWarning"
},
{
"Name" : "MaxInvalidUsers",
"Value" : 1,
"Action" : "None"
}
]
} |
...