Search operation

Searches the SharePoint site for the specified string.

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

Login Settings properties

Login settings for invoking the Connector for Microsoft SharePoint service.

Login Mode

A com.adobe.livecycle.crc.sharepoint.client.types.LoginSettings value that represents how the operation will be authenticated with SharePoint. Valid values are INVOCATION_CONTEXT (Use Credentials from process context) and USER_CREDENTIALS (Use User Credentials).

If you provide a literal value, select one of the following options:

Use Credentials from process context:
Uses the LiveCycle User Management credential from the process context for SharePoint authentication.

Use User Credentials:
Uses the specified User Name and Password properties to authenticate with the SharePoint server.

Hostname

(Optional) A string value that specifies the hostname of the machine which hosts Microsoft SharePoint. You can also use the Hostname field to connect with any web application running on a port number other that 80 by specifying the hostname and port number in the format [hostname]:[port number].

This field is only used when Login Mode is set to 'Use User Credentials'. No default is provided.

User Name

(Optional) A string value that specifies the user name to be used to connect with the SharePoint server. If the user account is of Windows local users or users configured using Forms Authentication on the SharePoint site, only the user name is required. However, domain users for Windows Authentication enabled sites must provide both the domain name and login name in the format domainName\LoginName.

This field is only used when the Login Mode is set to 'Use User Credentials'. No default is provided.

Password

(Optional) A string value that specifies the password to be used to connect with the SharePoint server. This field is only used when Login Mode is set to 'Use User Credentials'. No default is provided.

Domain

(Optional) A string value that specifies the domain in which the SharePoint server is present. This field is only used when Login Mode is set to 'Use User Credentials'.

Context Scope Information properties

Properties to identify the SharePoint site and the document library.

Site URL

A string value that specifies the URL of the SharePoint site. Do not append a forward slash to the path. Click Sites to browse the existing SharePoint sites on the host machine. No default is provided.

Document Library Name

(Optional) A string value that specifies the Document library Name. You can browse to view all existing document libraries at the selected site. If you provide a literal value, type the path or click Document Library to select the folder from the Microsoft SharePoint repository. Do not include the repository name in the folder path.

Parent Folder

(Optional) A string value that specifies the parent folder to search. Do not append a forward slash to the path. If you provide a literal value, type the path or click Parent Folder to view existing folders at the selected document library.

Custom Scope Information properties properties

Properties that specify the scope of the search.

Custom Scope

A string value that specifies a custom scope, such as search all sites.

Query Creation Settings properties

Properties to create the search string.

Keyword

A string value that specifies the keyword to search for.

Maximum Results to Return

(Optional) An int value that specifies the maximum number of results to return.

Result properties

A SearchQueryResultType value that contains the search result including the list of documents searched, number of search results returned, total search count, and the search status.

Each search document represents one document in SharePoint site with the following information about it: author, relative URL of the document, absolute URL path, and title. The absolute URL path is the absolute HTTP location of the document and can be used to retrieve the document.

If the search count is equal to the number of documents available, it indicates that the search operation has returned all the results. The parameter 'total available' indicates the total available results for the search query at SharePoint site. You can increase the value of maximum results if the search count is less than the total available.

Exceptions

This operation can throw a RepositoryException exception.