Versions Compared

Key

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

...

  • Original = "(", Replacement = "["

  • Original = ")", Replacement = "]"

  • Original = ",", Replacement = "-"

  • Original = "\\", Replacement = "/"

  • Original = ":", Replacement = "-"

  • Original = "|", Replacement = "/"

Reduce To One Email Address Configuration (

...

Mandatory)

Sample Configuration:

Code Block
languagejs
"ReduceToOneEmailAddressConfiguration": {
    "MultipleEmailsDelimiter": ","
  }

If there are multiple email address provided for one user AND those are separated by the MultipleEmailsDelimiter only the first email is imported if this configuration is present.

Reset Fields To Default If Empty Configuration (

...

Mandatory)

Sample Configuration:

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

...

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. Please consider that any previous data manipulation will have taken effect (i.e. DataSanitization). It may not be the original value from the CSV anymore.

Data Validation Configuration (Mandatory)

Sample Configuration:

Code Block
languagejs
  "DataValidationConfiguration": {
    "IdentifierFields": [
      {
        "Name": "OrgLoginId",
        "Type": "String"
      }
    ],
    "CriticalFields": [
      {
        "Name": "Vessel",
        "Type": "String"
      },
      {
        "Name": "FirstName",
        "Type": "String"
      },
      {
        "Name": "LastName",
        "Type": "String"
      },
      {
        "Name": "Rank",
        "Type": "String"
      }
    ],
    "RegularFields": [
      {
        "Name": "EmailAddress",
        "Type": "EmailAddress"
      },
      {
        "Name": "DeptCode",
        "Type": "String"
      },
      {
        "Name": "Password",
        "Type": "String"
      }
    ]
  }

...

  • IdentifierFields": "OrgLoginId"

  • CriticalFields": "Rank", "Vessel", "FirstName", "LastName"

  • RegularFields: "EmailAddress", "ContactEmail", “Deactivate (X)”, “UserLanguage”, “CanViewReports”, “ForcePasswordChange”, “Password“

Password Configuration (

...

Mandatory)

Sample Configuration:

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

...

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

Threshold Configuration (Mandatory)

Sample Configuration:

Code Block
languagejs
  "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"
		}
	]
  }

...