Versions Compared

Key

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

...

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.

...

Data Formatting Configuration (

...

Optional)

Sample Configuration:

Code Block
languagejs
  "ResetFieldsToDefaultIfEmptyConfigurationDataFormattingConfiguration" : {
	"FieldFormatting" : [
		{
			"ResetFieldsToDefaultIfEmptyFieldName" : ["DateOfBirth",
		"Vessel	"Type" : "DateTime",
			"Rank"InputFormat" : "MM-dd-yyyy",
			"EmbarkmentDateOutputFormat"     ]
  }

If no value (null/empty) is provided for a user property AND that property is part of the ResetFieldsToDefaultIfEmpty array, it resets any existing value to its default value (dependent on the data type - see below).

Info

The user property must be part of the DataValidationConfiguration except except for any Primary Identifying Field)

Default value for different user property types is as follows:

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

Info

If ResetFieldsToDefaultIfEmptyConfiguration is not required ResetFieldsToDefaultIfEmptyarray can be left empty like this. But configuration section must exists.

Code Block
  "ResetFieldsToDefaultIfEmptyConfiguration": {
    "ResetFieldsToDefaultIfEmpty": [
    ]
  }

Data Formatting Configuration (Optional)

Sample Configuration:

Code Block
languagejs
"DataFormattingConfiguration" : {
	"FieldFormatting" : [
: "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.

Supported data types:

  • String

  • DateTime

  • Number

Data Assembler Configuration (Optional)

Sample Configuration:

Code Block
languagejs
"DataAssemblerConfiguration": {
	"FieldConfigurations" : [ 
		{
			"FieldName" : "OrgLoginId",
			"Segments" : [
				{	
					"IsField" : "true", 
					"Value" : "Operating Line"
				},
				{
					"FieldNameIsField" : "DateOfBirthfalse", 
					"TypeValue" : "DateTime"-"
				},
				"InputFormat" {
					"IsField" : "MM-dd-yyyytrue",
					"OutputFormatValue" : "dd-MM-yyyyOrgLoginId"
				}
			]
		}
	]
}

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.

Supported data types:

  • String

  • DateTime

  • Number

Data Assembler Configuration (Optional)

Sample Configuration:

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

The data assembler activity is able to modify user property fields dynamically or create values using other user property fields. Every user property can be used to aggregate data for another or the same field.

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.The data assembler activity is able to modify user property fields dynamically or create values using other user property fields. Every user property can be used to aggregate data for another or the same field.

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.

Reset Fields To Default If Empty Configuration (Mandatory)

Sample Configuration:

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

If no value (null/empty) is provided for a user field listed in the ResetFieldsToDefaultIfEmpty array, it resets the user property (from no value) to the field’s default value (dependent on the data type - see below).

Any field not included in ResetFieldsToDefaultIfEmpty and no value was provided (null/empty), will not be updated (ignored).

 

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 DataValidationConfiguration except for any Primary Identifying Field)

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)

Data Validation Configuration (Mandatory)

...