Search (IDirectorySearch)

Returns an array of directory resources for a given search string.

This method provides the ability to filter results to include resources with names or descriptions that contain but do not exactly match the specified filter text. For exact-match filtering, use the SearchEx (IdirectorySearch) call method instead.

In the Configure Method dialog box, click Next to select a resource. Otherwise, in the Inputs section of the activity configuration panel, click the ellipsis button to select a resource.

Note: To test your search strings, click Next in the Configure Method dialog box. Any values entered here are used as values in the Inputs section of the activity configuration panel. For more information, see Advanced Search.

Inputs	Data Type	Description
DescriptionFilter	String	Specifies text contained in resource descriptions. Resource descriptions containing this text are included in the search results. If you leave this parameter empty, description filtering is NOT done.
ExcludeClause	String	Specifies the classifications that you want to exclude from the search. In the Configure Method dialog box, click Next, and then click Advanced Search. Finally, from the Classifications pane, select the applicable option, and then click Add under Excluded Classifications area. Valid values include any classification available in the Directory of Resources, such as: Equipment Resource Type - Enterprise Type - Work Request Category - <category name> Note: This is not a comprehensive list. If you want to exclude just a single Class classification, you can configure a CreateClassQueryExpression call method and bind this parameter to the output of that method instead.
IncludeClause	String	Specifies the classifications that you want to include in the search. In the Configure Method dialog box, click Next, and then click Advanced Search. Finally, from the Classifications pane, select the applicable option, and then click Add under Included Classifications area. Valid values include any classification available in the Directory of Resources, such as: Equipment Resource Type - Enterprise Type - Work Request Category - <category name> Note: This is not a comprehensive list. If you want to exclude just a single Class classification, you can configure a CreateClassQueryExpression call method and bind this parameter to the output of that method instead.
NameFilter	String	Specifies text contained in resource names. Resource names containing this text are included in the search results. If you leave this parameter empty, name filtering is NOT done.
StartingResource	String	Specifies the model to start your search at. The default is Publications. Valid values are any models that appear in the Models list in the navigator, such as Production, Personnel, Workflow, and so on. In the Inputs section of the activity configuration panel, click the ellipsis button to open the Universal Browser to select the resource you want to use.

Outputs	Description
DirectoryResource[]		Returns all of the resources that match the defined search criteria. Results are limited to 5,000. A search returning more than the limit generates an exception. Use a For Each Activity to loop though all resources or use an Index Activity with an integer value. Indexing is supported only by the integer value; it does not support string values.

Outputs

Description

DirectoryResource[]

Returns all of the resources that match the defined search criteria.

Results are limited to 5,000. A search returning more than the limit generates an exception.

Use a For Each Activity to loop though all resources or use an Index Activity with an integer value. Indexing is supported only by the integer value; it does not support string values.