Ping Identity Data Sync Server - Direct Attribute Mapping

Data Sync Server Documentation Index
Configuration Reference Home

Direct Attribute Mapping

A Direct Attribute Mapping is used when an attribute receives its values directly from another attribute.

↓Parent Component
↓Properties
↓dsconfig Usage

Parent Component

The Direct Attribute Mapping component inherits from the Attribute Mapping

Properties

The properties supported by this managed object are as follows:

Basic Properties:	Advanced Properties:
↓ to-attribute	↓ also-depends-on-src-attribute
↓ description	↓ sync-on-every-update
↓ exclude-value	↓ scramble-value
↓ from-attribute	↓ base64-encode-value
	↓ base64-decode-value

Basic Properties

to-attribute (Read-Only)

Description	Specifies the name of the attribute whose values are constructed by this attribute mapping.
Default Value	None
Allowed Values	The name of the destination attribute
Multi-Valued	No
Required	Yes
Admin Action Required	None. Modification requires no further action

description

Description	A description for this Attribute Mapping
Default Value	None
Allowed Values	A string
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

exclude-value

Description	Specifies a list of values that will be excluded from the destination attribute after applying any other mapping or transformation.
Default Value	None
Allowed Values	A string
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

from-attribute

Description	Specifies the name of the source attribute whose values are used to directly provide the values of the destination attribute.
Default Value	None
Allowed Values	The name of the source attribute
Multi-Valued	No
Required	Yes
Admin Action Required	None. Modification requires no further action

Advanced Properties

also-depends-on-src-attribute (Advanced Property)

Description	Changes to the specified source attribute will trigger an update to the destination attribute independent of any changes to the attributes that this mapping directly depends on. This property is very rarely needed. Any change detected at the source to the specified attribute will force the attribute value to be recomputed and updated at the destination (if it was out-of-sync). This property is only needed when the Data Sync Server cannot directly detect changes to an attribute. For instance in some environments, a Directory Server plugin might introduce attribute changes that do not show up in the LDAP change log, so a separate attribute is watched for changes even though its value does not directly contribute to the synchronized value. This property does not need to be set except in very unusual situations.
Default Value	None
Allowed Values	A string
Multi-Valued	Yes
Required	No
Admin Action Required	None. Modification requires no further action

sync-on-every-update (Advanced Property)

Description	This property will cause the attribute specified in this mapping (the 'to-attribute') to get synchronized on any detected change of any attribute. This is useful when an attribute may change without any indication in the changelog. This property is very rarely needed. Any change detected at the source to any attribute will force this attribute value to be recomputed and updated at the destination (if it was out-of-sync). This property is only needed when the Data Sync Server cannot directly detect changes to an attribute. For instance in some environments, a Directory Server plugin might introduce attribute changes that do not show up in the LDAP change log. This property does not need to be set except in very unusual situations.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

scramble-value (Advanced Property)

Description	Scrambles the source attribute value before synchronizing it to the destination. WARNING: this option must only be used in test environments. This option allows sensitive information from a production environment to be obscured when synchronizing to a test environment. When set to true, attribute values are scrambled in a manner that is intended to obscure the original values in a way that is not trivial to reverse but that preserves the syntax and schema characteristics for the values. Uppercase ASCII alphabetic characters will be replaced with randomly-chosen uppercase characters, lowercase ASCII alphabetic characters will be replaced with randomly-chosen lowercase characters, and ASCII numeric digits will be replaced with randomly-chosen digits. All characters that are not ASCII alphanumeric characters will be left untouched, and value lengths will be preserved.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	Yes
Admin Action Required	None. Modification requires no further action

base64-encode-value (Advanced Property)

Description	Encodes the source attribute with base-64 before synchronizing it to the destination.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

base64-decode-value (Advanced Property)

Description	Decodes the source attribute from base-64 before synchronizing it to the destination.
Default Value	false
Allowed Values	true false
Multi-Valued	No
Required	No
Admin Action Required	None. Modification requires no further action

dsconfig Usage

To list the configured Attribute Mappings:

dsconfig list-attribute-mappings
     [--property {propertyName}] ...

To view the configuration for an existing Attribute Mapping:

dsconfig get-attribute-mapping-prop
     --mapping-name {name}
     --map-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Attribute Mapping:

dsconfig set-attribute-mapping-prop
     --mapping-name {name}
     --map-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Direct Attribute Mapping:

dsconfig create-attribute-mapping
     --mapping-name {name}
     --map-name {name}
     --type direct
     --set from-attribute:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Attribute Mapping:

dsconfig delete-attribute-mapping
     --mapping-name {name}
     --map-name {name}