SearchEx (IDirectorySearch)
Returns an array of directory resources for a given search string, with the ability to filter results based on whether the value specified for the resource name or description parameter partially or exactly matches the actual value for the given parameter.
Inputs | Data Type | Description |
---|---|---|
Description Filter | 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. |
Exclude Clause | 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:
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.
|
Filter Matching Option | Search Filter Options | Specifies the algorithm applied to match the Name Filter and
Description Filter text to candidate resources found by the search. Options are:
In the Inputs section of the activity configuration panel, click the ellipsis button, and then select the option you want to use. |
Include Clause | 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:
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.
|
Name Filter | 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. |
Starting Resource | 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 | |
---|---|---|
Directory Resource[] |
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. |