Use the Search Files activity to search files in MS SharePoint.
About this task
Use this task to search files in MS SharePoint instance. The call to this activity is a
synchronous call where the input data is sent to the activity for processing and the response is
sent back to the orchestration.
Procedure
- Right click the Orchestrations section and select new orchestration.
- Drag the newly created MS SharePoint endpoint to the orchestration and select Search
Files activity. The Search Files activity will be added to the orchestration.
Double click the activity. MS SharePoint Search Files Checklist is
displayed.
- In the Checklist, click Retry. Review the default settings and make the
required changes.
- Select the Map Inputs in the Checklist. The XML
Schemas generated from that operation are displayed as nodes under the request input parameter in
the To Activity panel.
- Create a map between the orchestration variables and the input parameter of the activity.
Mandatory Fields:
- queryText (text consisting of the filename user wants to search)
- fileExtension (extension of the file user wants to search)
Sample input request:
<Search xmlns="http://www.IBM.com/xmlns/prod/websphere/j2ca/Sharepoint/search">
<SearchRequestDetails xmlns="">
<querytext>test</querytext>
<fileExtension>txt</fileExtension>
</SearchRequestDetails>
</Search>
Note: Values must be provided at run time for the mandatory elements of the input structure. A
value can be provided by specifying a default value for element or by linking the element with an
input node. During run time if no value is provided for a mandatory element, the activity throws an
exception, which is reported by the Web Management Console. If a value is not provided at run time
for an optional input parameter, no exception is thrown during run time.
- Select the Map Outputs in the Checklist. The XML
Schema generated to hold the response of the activity is displayed as nodes under the response
output parameter in the From Activity panel.
- Create a map between the output parameters and orchestration variables.
Results
You have configured the MS SharePoint Search Files activity.
Note: You can search multiple files at one go using this activity since the input variable is unbounded
Limitation:
Search Files Activity is not giving desired results for On Premise. It is working fine for On
Cloud. This is the known API behaviour for SharePoint On Premise setup.