Versions Compared

Version Old Version 24 New Version 25
Changes made by

Haider

Haider

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

View file
nameSampleUserImporterConfig.json

DataConsistencyCheckConfigurationData Consistency Check Configuration

Sample Configuration:

Code Block
languagejs
"DataConsistencyCheckConfiguration" : {

}

Currently this configuration section is empty.

ValueMappingConfigurationValue Mapping Configuration

Sample Configuration:

Code Block
languagejs
"ValueMappingConfiguration": {
	"FieldNamesWithMapping": [
	  {
		"FieldName": "Rank",
		"MappingMode": "Complete",
		"MappingFileName": "ValueMapping-Rank.json"
	  }
	]
}

...

Code Block
languagejs
[
    {
   	 "SourceValue": "Capt.",
   	 "TargetValue": "Captain"
    },
    {
   	 "SourceValue": "Captain",
   	 "TargetValue": "Captain"
    },
    {
   	 "SourceValue": "1st Eng.",
   	 "TargetValue": "First Engineer"
    },
    {
   	 "SourceValue": "2nd Eng.",
   	 "TargetValue": "Second Engineer"
    }
]

DataSanitationConfigurationData Sanitation Configuration

Sample Configuration:

Code Block
languagejs
  "DataSanitationConfiguration": {
    "FieldsToSanitize": [
      {
        "FieldName": "DeptCode",
        "ReduceToSingleWhiteSpace": "true",
        "SanitizeValues": [
          {
            "Original": "XT",
            "Replacement": "xt"
          },
          {
            "Original": ",",
            "Replacement": "+"
          }
        ]
      }
    ]
  }

...

SanitizeValues: It contains the original and replacement values for the field.

ResetFieldsToDefaultIfEmptyConfigurationReset Fields To Default If Empty Configuration

Sample Configuration:

Code Block
languagejs
  "ResetFieldsToDefaultIfEmptyConfiguration": {
    "ResetFieldsToDefaultIfEmpty": [
		"Vessel",
		"Rank",
		"EmbarkmentDate"
    ]
  }

...

  • 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)

DataFormattingConfigurationData Formatting Configuration

Sample Configuration:

Code Block
languagejs
"DataFormattingConfiguration" : {
	"FieldFormatting" : [
		{
			"FieldName" : "DateOfBirth",
			"Type" : "DateTime",
			"InputFormat" : "MM-dd-yyyy",
			"OutputFormat" : "dd-MM-yyyy"				
		}
	]
}

Data formatting takes an input value and formats it according to the configuration. For every field which needs formatting the expected input format and output format is needed. The expected input format may be optional and that depends on the data type. Above configuration shows formatting of a date field.

DataAssemblerConfigurationData Assembler Configuration

Sample Configuration:

Code Block
languagejs
"DataAssemblerConfiguration": {
	"FieldConfigurations" : [ 
		{
			"FieldName" : "OrgLoginId",
			"Segments" : [
				{	
					"IsField" : "true", 
					"Value" : "Operating Line"
				},
				{
					"IsField" : "false", 
					"Value" : "-"
				},
				{
					"IsField" : "true",
					"Value" : "OrgLoginId"
				}
			]
		}
	]

...

For example, Above configuration adds a prefix to an user property "OrgLoginId" which consists of 3 different segments, “Operation Line” “-“ & “OrgLoginId“. If IsField=true, that means it will get the value provided in the csv, Otherwise whatever the value provided in the configuration value property it will consider that.

DataValidationConfigurationData Validation Configuration

Sample Configuration:

Code Block
languagejs
"DataValidationConfiguration": {
	"IdentifierFields": [
		"OrgLoginId"
	],
	"CriticalFields": [
		"Rank",
		"Vessel",
		"FirstName",
		"LastName"
	],
	"RegularFields": [
		"ContactEmail"
	],
	"PasswordFields": [
		"DateOfBirth"  
	],
	"FieldFormattings": [
		{
			"FieldName": "LastName",
			"Type": "String"
		},
		{
			"FieldName": "Vessel",
			"Type": "String"
		},
		{
			"FieldName": "Rank",
			"Type": "String"
		},
		{
			"FieldName": "OrgLoginId",
			"Type": "String"
		},
		{
			"FieldName": "FirstName",
			"Type": "String",
			"Format": "Xn*"
		},
		{
			"FieldName": "DateOfBirth",
			"Type": "DateTime",
			"Format": "dd-MM-yyyy"
		},
		{
			"FieldName": "ContactEmail",
			"Type": "EmailAddress"
		}
	]
}

...

Every field added in any of these field types must present in field formatting sections.

PasswordConfigurationPassword Configuration

Sample Configuration:

Code Block
languagejs
"PasswordConfiguration": {
	"UseRandomPassword": "false",
	"PasswordFormat": [
	{
		"Value": "Password",
		"IsField": "true"
	},
	{
		"Value": "aA!",
		"IsField": "false"
	}
	]
}

...

Also, Deactivation users count must be less than less than MaxUsersToDeactivate

UserImporterConfigurationUser Importer Configuration

Sample Configuration:

Code Block
languagejs
  "UserImporterConfiguration": {
    "BatchSize": "400",
    "MaxJsonLength": "4194304",
    "ExpireInitialPassword": "true",
    "ResetPasswordOnUserReactivation": "false",
	"UserImportMode" : "Partial",
	"Thresholds": [
		{
			"Name" : "MaxUsersPerImport",
			"Value" : 1,
			"Action" : "GenerateWarning"
		},
		{
			"Name" : "MaxDeactivateUsers",
			"Value" : 1,
			"Action" : "GenerateWarning"
		},
		{
			"Name" : "MaxNewUsers",
			"Value" : 1,
			"Action" : "GenerateWarning"
		},
		{
			"Name" : "MaxOrgProfileValueUpdates",
			"Value" : 1,
			"Action" : "GenerateWarning"
		},
		{
			"Name" : "MaxReactivateUsers",
			"Value" : 1,
			"Action" : "GenerateWarning"
		},
		{
			"Name" : "MaxInvalidUsers",
			"Value" : 1,
			"Action" : "None"
		}
	]
  }

...