Copyright © Cloud Software Group, Inc. All Rights Reserved

SharePoint Query

Activity

The SharePoint Query activity supports querying list items across different Microsoft SharePoint lists and websites in a specific site collection.

Configuration

The Configuration tab contains the following fields.

Table 23 SharePoint Query Configuration 

Field	Global Var?	Description
Name	No	(Required) The name of the activity in the process definition. The default value is SharePoint Query.
Description	No	(Optional) A short description of the activity. Click the button to add the description in the Description page.
SharePoint Connection	No	(Required) Specifies a shared connection resource. Click the button to open the Select A Resource page. All usable SharePoint Connection shared resources are listed in the page. Select one to apply to your current activity.
Query Scope	No	(Required) Specifies the scope that the query operation covers. There are two options: • AllWebs—the query operation covers the current site collection. • SubWebs—the query operation only covers a selected website and its sub-website.
List Template	No	(Required) Specifies the list which will be used as a template to generate CAML query. Note: The query scope is not limited to the list you selected in this field.
CAML Source	No	(Required) Specifies the query schema of Collaborative Application Markup Language (CAML).There are two options to input query parameters: • Simple CAML—supports the Contains and Eq queries. After you provide values for the input parameters in the Input tab, the activity uses the non-empty values to do the searching. If the input value is Text, Note, URL, Choice, or MultiChoice data type, the query will be generated as a Contains query. Others will be generated as an Eq query. See Input Guidelines for details about these Microsoft SharePoint data types. • Input CAML—supports inputting a CAML query directly in the CAMLText field in the input tab. The root node of the query must be Where.
Max Size	Yes	(Required) Specifies the maximum numbers of list items that will be returned by the query. The default value is 2000. Note: If there are a large number of records that match the query condition, you can use this property to limit the total numbers of list items that will be returned by the query.
Timeout (sec)	Yes	(Required) Specifies how long the plug-in waits for the process to execute the query operation. The default value is 120 seconds. Note: The query operation will fail if it times out when started at runtime. TIBCO recommends that you provide enough time for the query operation to execute.

Input

The required input of the activity varies with the configuration you have made in the Configuration tab. Table 20 specifies the possible input of the activity.

Table 24 SharePoint Query Input

Input Item	Data Type	Description
FieldValues	N/A	The attributes of the selected item. It varies with different list types. Refer to Input Guidelines for details about how to provide a valid input. This parameter only appears when you select Simple CAML as the CAML source.
CAMLText	string	The CAML query. You can manually type in a query or you can use the generated query from the previous activity in the current process. This parameter only appears when you select Input CAML as the CAML source. Note: The root node of the CAML query must be Where.

Output

The output for the activity is as follows.

Table 25 SharePoint Query Output

Output Item	Data Type	Description
ResultCount	integer	The number of results returned by the query.
QueryScope	string	The scope that the query operation covers.
QueryMode	string	The mode of the query. The possible values are SimpleCAML and InputCAML.
Results—include all the items that match the query condition.
item	N/A	The attributes of the queried item. It varies with different list types. For the meaning of each attribute, refer to the documentation of Microsoft SharePoint.

Error Output

The Error Output tab lists the exceptions that can be thrown by this activity.

Table 26 SharePoint Query Exceptions

Exception	Cause
SharePointPluginException	Occurs when the plug-in has internal errors.
SharePointRemoteException	Occurs when the Microsoft SharePoint server encounters errors with processing a request from the plug-in.
ActivityTimedOutException	Occurs when the query operation times out.

Copyright © Cloud Software Group, Inc. All Rights Reserved