Note: this is an abstract component that cannot be instantiated.
Attribute Mappings are used to define how the values of a single "destination" attribute are determined. The values might be derived from a direct mapping from another attribute, constructed from a mixture of hard-coded strings and portions of other attributes, or generated using custom Java class code.
↓Direct Subcomponents
↓Relations From this Component
↓Properties
↓dsconfig Usage
The following Attribute Mappings are available in the server :
These Attribute Mappings inherit from the properties described below.
The following components have a direct composition relation to Attribute Mappings:
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 |
| ↓ java-class |
| 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 | 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 |
| Description | Specifies the fully-qualified name of the Java class that provides the attribute mapping implementation. |
| Default Value | None |
| Allowed Values | The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sync.api.AttributeMapping |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
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 Synchronization 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 Synchronization 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 |
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 delete an existing Attribute Mapping:
dsconfig delete-attribute-mapping
--mapping-name {name}
--map-name {name}