retentionMappings
Field Retention
|
Define here which fields should be kept or deleted
type: array of object
default value: ' '
object attributes: {
field
(required)
: {
display name: Field
type: string
description : The name of the field to operate on.
}
operation
: {
display name: Operation
type: string
default value: 'keep '
description : The type of operation to perform: keep (default) or delete
enum: {
keep
delete
}
}
}
|
translationMappings
Field Translations
|
Define here fields that should be moved or copied to another field. When a field is moved, the values from the source field are moved over to the target field and the source field is removed. When a field is copied, the values from the source field are copied over to the target field and the source field is retained.
type: array of object
default value: '{"operation"=>"move", "source"=>"charSet", "target"=>"charSet_s"}{"operation"=>"move", "source"=>"fetchedDate", "target"=>"fetchedDate_dt"}{"operation"=>"move", "source"=>"lastModified", "target"=>"lastModified_dt"}{"operation"=>"move", "source"=>"signature", "target"=>"dedupeSignature_s"}{"operation"=>"move", "source"=>"length", "target"=>"length_l"}{"operation"=>"move", "source"=>"mimeType", "target"=>"mimeType_s"}{"operation"=>"move", "source"=>"parent", "target"=>"parent_s"}{"operation"=>"move", "source"=>"owner", "target"=>"owner_s"}{"operation"=>"move", "source"=>"group", "target"=>"group_s"} '
object attributes: {
operation
: {
display name: Operation
type: string
default value: 'copy '
description : The type of operation to perform: copy (default) or move.
enum: {
copy
move
}
}
source
(required)
: {
display name: Source Field
type: string
description : The name of the field to operate on.
}
target
(required)
: {
display name: Target Field
type: string
description : The name of the target field.
}
}
|
unmappedRule
Unmapped Fields
|
Define here how fields not mapped by the above rules should be handled. By default, any remaining fields will be kept on the document.
type: object
default value: '{"delete"=>false, "fieldToCopyValuesTo"=>"", "fieldToMoveValuesTo"=>"", "keep"=>true, "valueToAddToUnmappedFields"=>"", "valueToSetOnUnmappedFields"=>""} '
object attributes: {
delete
: {
display name: Delete
type: boolean
default value: 'false '
description : Delete all unmapped fields
}
fieldToCopyValuesTo
: {
display name: Copy
type: string
description : Copy all unmapped field values to this field
}
fieldToMoveValuesTo
: {
display name: Move
type: string
description : Move all unmapped field values to this field
}
keep
: {
display name: Keep
type: boolean
default value: 'true '
description : Keep all unmapped fields
}
valueToAddToUnmappedFields
: {
display name: Add
type: string
description : Add this value to all unmapped fields
}
valueToSetOnUnmappedFields
: {
display name: Set
type: string
description : Set this value on all unmapped fields
}
}
|
updateMappings
Field Value Updates
|
Define here values that should be added to or set on a field. When a value is added, any values previously on the field will be retained. When a value is set, any values previously on the field will be overridden.
type: array of object
default value: ' '
object attributes: {
field
(required)
: {
display name: Field
type: string
description : The name of the field to operate on.
}
operation
: {
display name: Operation
type: string
default value: 'add '
description : The type of operation to perform: add (default) or set.
enum: {
add
set
}
}
value
(required)
: {
display name: Value
type: string
description : The value to add to or set on the field.
}
}
|