Directory Proxy Server Documentation Index
Configuration Reference Home

Default Value Proxy Transformation

The Default Value Proxy Transformation may be used to include one or more default values for an attribute if it is not present in a search result entry. It may also optionally be used to replace existing values for the attribute if it is already present.

Please note that any joined entries included with the search result entries will not be altered when performing searches with the join request control (OID 1.3.6.1.4.1.30221.2.5.9).

Parent Component
Properties
dsconfig Usage

Parent Component

The Default Value Proxy Transformation component inherits from the Proxy Transformation

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ request-criteria
↓ target-attribute
↓ value
↓ entry-type
↓ base-dn
↓ scope
↓ filter
↓ conflict-behavior

Basic Properties

description

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

enabled

Description
Indicates whether this proxy transformation is enabled for use in the server.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

request-criteria

Description
Criteria indicating the set of operations for which the transformation will be invoked.
Default Value
This Proxy Transformation will be invoked for all operations.
Allowed Values
The DN of any Request Criteria.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

target-attribute

Description
Specifies the name of the attribute for which to generate the value(s).
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

value

Description
The value to use for the target attribute.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
Yes
Admin Action Required
None. Modification requires no further action

entry-type

Description
Indicates the types of entries that should be processed.
Default Value
None
Allowed Values
add-request - Indicates that this proxy transformation should be applied to entries contained in an add request.

search-result-entry - Indicates that this proxy transformation should be applied to entries returned in search results.
Multi-Valued
Yes
Required
Yes
Admin Action Required
None. Modification requires no further action

base-dn

Description
A base DN for entries for which to include the specified values for the target attribute. If no value is defined, then the default values will be used for all search result entries.
Default Value
None
Allowed Values
A valid DN.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

scope

Description
The scope to use in conjunction with the base DN to determine whether to include the default value in search result entries.
Default Value
sub
Allowed Values
base - The default values should be used only in the entry with the specified base DN.

one - The default values should be used only in entries that are immediate children of the base entry, but not the base entry itself.

sub - The default values should be used in the base entry and all subordinate entries.

subordinate-subtree - The default values should be used in entries that are subordinates of the base entry, but not the base entry itself.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

filter

Description
Provides a filter which should be used to identify entries that should be processed. Note that for search result entries, this filter will be applied to the entry in the form that the entry was returned from the backend server, which may not necessarily have all attributes needed to reliably make the determination. As a result, it is recommended that if a filter is provided, it only be used for instances of this Default Value Proxy Transformation which are intended to operate on add requests but not search result entries.
Default Value
None
Allowed Values
A valid LDAP search filter
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

conflict-behavior

Description
Indicates the behavior that should be exhibited for entries that already contain the target attribute.
Default Value
use-existing-values
Allowed Values
use-existing-values - Indicates that the existing values for the entry should be used instead of the default values.

use-default-values - Indicates that the default values specified in this proxy transformation should be used instead of the existing values.

merge-existing-and-default-values - Indicates that the resulting entry should contain both the existing and the default values. The associated attribute type should be declared to allow multiple values in the schema.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Proxy Transformations:

dsconfig list-proxy-transformations
     [--property {propertyName}] ...

To view the configuration for an existing Proxy Transformation:

dsconfig get-proxy-transformation-prop
     --transformation-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Proxy Transformation:

dsconfig set-proxy-transformation-prop
     --transformation-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Default Value Proxy Transformation:

dsconfig create-proxy-transformation
     --transformation-name {name}
     --type default-value
     --set enabled:{propertyValue}
     --set target-attribute:{propertyValue}
     --set value:{propertyValue}
     --set entry-type:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Proxy Transformation:

dsconfig delete-proxy-transformation
     --transformation-name {name}