Find Groups operation

Filter properties
Result properties
Exceptions

Retrieves information about one or more groups from User Manager based on search filters that you provide. The search returns all users that are found that meet the search criteria.

Note: The maximum number of groups that is returned is 1000.

To retrieve only one group that meets the search criteria, use the Find Group operation operation.

For information about the General and Route Evaluation property groups, see Common operation properties.

Filter properties

Properties for specifying search criteria. You must specify at least one filter. You can specify more than one filter to narrow the search results.

Domain Name

A string value that represents the User Management domain that the groups belong to. To specify a literal value, select a domain from the list.

For information about domains, see Setting up and managing domains in LiveCycle Administration Help.

Universal ID

A string value that represents the unique identification of the group. This value searches the Unique Identifier property that is configured in the Directory Groups properties of the domains that are created in User Management.

You must provide the entire identification, for example 56e04201-1dd211b2-80cafe29-7dd5631b.

Name

A string value that represents the name of the groups. This value searches the Full Name property that is configured in the Directory Groups properties of the domains that are created in User Management.

You can specify all or part of the name for the groups that you want to retrieve.

Result properties

Properties for specifying where to store operation results.

List of Groups

The location to store the returned list value that contains Group values. Each Group value represents a group that matches the search filters. For example, to save the list in a variable, select a list variable from the list.

For information about retrieving values from a list, see Accessing data in data collections.

Output XML Document

The location in the process data model to store a returned document value that represents an XML document that contains the search results. The XML represents a list of Group values. For example, the following XML is the result of a search that returns the default All Principals group:

<?xml version="1.0" encoding="UTF-8"?> 
<groups> 
    <group> 
        <principalOid>B98E6F7F-5DC7-102C-A430-00000A24CA8A</principalOid> 
        <domainName>DefaultDom</domainName> 
        <commonName>All Principals</commonName> 
        <canonicalName>GROUP_ALLPRINCIPALS</canonicalName> 
    </group> 
</groups>

Exceptions

The exception event attached to this operation can receive UMException exceptions.