Directory Services › Get Object Operator › Input Parameters

Input Parameters

Get Criteria

Start Search Path

Specifies the start location for the search, such as Like CN=Users,dc=domainpart,dc=company-name,dc=top-level-domain-name

Retrieve Scope

Select one of the following options:

Subtree Scope

Search the entire subtree (including the object at the search path).

One Level Scope

Search the objects directly under the object at the search path.

Object Scope

Search the object at the search path only.

Results Limit Count

Maximum number of entries to return.

• If you enter 0 or nothing in this field, CA Process Automation uses the value set in the Max Number of Search Results field (from the Directory Services category configuration).
• If you enter a value in this field, CA Process Automation uses the smaller value between this field's value and the value set in the Max Number of Search Results field (from the Directory Services category configuration).

Time Limit for Retrieve

Time in seconds to wait before timing out of this search. If this limit is 0 (or nothing is entered), there is no time limit set on the search.

Retrieve Object Type

Select one of the following options:

• User
• Computer
• Group
• Organizational Unit
• Role
• Other

This field controls the filter value displayed in the Retrieve Filter field.

Retrieve Filter

Choose the search filter to use for this search.

You can:

Use a generic filter by selecting User, Group, Organizational Unit, Role, or Computer in the Retrieve Object Type field, which displays the associated filter value in the Retrieve Filter field and makes this field read-only.

or

Enter your own filter by selecting Other in the Retrieve Object Type field, which displays "objectclass=" in the Retrieve Filter field and makes this field writable so you can fill out your own filter value. The expression must be syntactically correct otherwise the search can fail. See LDAP Search Filter Basics for a primer on LDAP search filters syntax.

Note that you can use different filters for User, Group, Organizational Unit, Role, or Computer by selecting Other in the Retrieve Object Type field and entering his/her filter value in the Retrieve Filter field. The provided generic search filters may not work with some LDAP servers, especially if the LDAP server does not support some of the object classes listed in the filters.

Retrieve Attributes specified as an Array Variable?

If checked, you can supply a dataset variable that contains an array of attributes to retrieve.

Retrieve Attributes Array Variable

The dataset variable that supplies an array of attributes to retrieve. This field is enabled when the Retrieve Attributes specified as an Array Variable? field is checked.

Retrieve Attributes List

Specifies a list of attributes to retrieve for this search filter. This list is enabled when the Retrieve Attributes specified as an Array Variable? field is unchecked.

Sort Criteria

Sort Fields specified as an Array Variable?

If checked, you can supply a dataset variable that contains an array of attributes used for sorting the retrieved data.

Sort List Fields Array Variable

The dataset variable that supplies an array of attributes to use for the sort order. This field is enabled when Sort Fields specified as an Array Variable? is checked.

Sort List Order

List of attributes to use for the sort order. This list is enabled when the Sort Fields specified as an Array Variable?: field is unchecked.

If nothing is entered in the Sort Criteria section, the retrieved objects are not sorted.

Note that some LDAP servers (for instance OpenLdap) do not support "Sorting" of data. In this case, the operator might fail with the following reason: [LDAP: error code 12 - critical extension is not recognized]. Do not provide any sorting criteria in this case. This is a limitation in the LDAP server, not CA Process Automation.