Configuration Reference Home
Oracle Unified Directory - Hide Entries By Filter Workflow Element

Hide Entries By Filter Workflow Element

The Hide Entries By Filter Workflow Element provides the hide entries by filter functionality.

This workflowElement allows to filter entries returned by search operations.

Parent Component

The Hide Entries By Filter Workflow Element component inherits from the Simple Workflow Element

Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ apply-for-admin ↓ java-class
↓ enabled
↓ excluded-ldap-url
↓ ldap-filter
↓ ldap-url
↓ next-workflow-element

Basic Properties

apply-for-admin

Description
Control whether the filtering is applicable to root users. If this parameter is set to false, and the bound user is a root user, the search results are returned as is, without being further filtered by the workflow element.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

enabled

Description
Indicates whether the Workflow Element is enabled for use in the server. If a Workflow Element is not enabled, then its contents are not accessible when processing operations.
Default Value
None
Allowed Values
true
false
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

excluded-ldap-url

Description
Specifies a list of the LDAP URL used for the excluded filtering. Used to further restrict the search results based on the entry DN. If an entry that is returned as part of search result is a descendent of the URL base or the entry that corresponds to the URL base DN and if the entry satisfies the URL filter, then the entry is not returned.
Default Value
None
Allowed Values
A String
Multi-valued
Yes
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

ldap-filter

Description
Specifies the LDAP filter used for the filtering. if the LDAP filter is static, only entries which match this filter will be returned. If it's a dynamic filter, the dynamic values will be set according to the bound user entry. A a static LDAP filter looks like (department=sales), while a dynamic filter is (department=%department%). The %department% will be interpreted as a variable. For example, if you set the ldap Filter to (department=%department%), the workflowElement replaces %department% with the actual department value associated with the bound user. If the bound user attribute is multi-valued, then the filter is created by ORing all the values. If the bound user doesn't have the filtered attribute, then the dynamic filter will not be modified and entries are filtered according to it (e.g. 'department=%department%' ).
Default Value
None
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

ldap-url

Description
Specifies a list of the LDAP URL used for the filtering. Used to further restrict the search results based on the entry DN. If an entry that is returned as part of search result satisfies the URL filter, then the entry is returned to the client only if it is a descendent of the URL base. If the entry does not satisfy the URL filter, then the entry is returned as is.
Default Value
None
Allowed Values
A String
Multi-valued
Yes
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

next-workflow-element

Description
Defines the next workflow element in the chain of workflow elements.
Default Value
None
Allowed Values
The DN of any Workflow Element.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No


Advanced Properties

java-class

Description
Specifies the fully-qualified name of the Java class that provides the Hide Entries By Filter Workflow Element implementation.
Default Value
org.opends.server.workflowelement.ovdplugin.hideentriesbyfilter.HideEntriesByFilterWorkflowElement
Allowed Values
A java class that implements or extends the class(es) :
org.opends.server.workflowelement.WorkflowElement
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
Yes
Read-only
No


Copyright © 2017, 2020, Oracle and/or its affiliates. All rights reserved.