CAML Query activity

Configure the CAML Query activity

To configure the CAML Query activity, do the procedure in this topic.

Examples

(Example) Create a SharePoint Access Token

Good to Know

In most text fields, you can use process data variables as an alternative to literal data values.
You can configure whether this activity waits for other activities before it runs.
For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?
This section shows the configuration settings on the configuration screens for this activity. Other configuration settings apply to system activities. For more information, refer to:
Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

How to Start

Open Process Builder.
For information about how to open this screen, refer to Process Builder.
In Process Builder, in the Activity Library, and open the SharePoint tab.
On the SharePoint tab, drag the CAML Query activity onto your process.

Procedure

Complete the fields on the General Configuration screen.
Click CAML Query Builder .
Complete the fields on these screens.
(Optional) Click Advanced > Email Notifications .
For more information, refer to Email Notifications screen (Process Activities).

General Configuration

Specifies the basic settings for the CAML Query activity.

Good to Know

Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field Name	Definition
Display Name	Description: Specifies the activity name that shows in your process. Allowed Values: One line of text (a string). Accepted: Letters Numbers Spaces Default Value: None Accepts Variables: No Example: This is a common configuration field that is used in many examples. Refer to: Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.
Description	Description: Specifies an optional text description for your activity. Allowed Values: More than one line of text. Default Value: None Accepts Variables: No

Field Name

Definition

Display Name

Description:

Specifies the activity name that shows in your process.

Allowed Values:

One line of text (a string).

Accepted:

Letters
Numbers
Spaces

Default Value:

None

Accepts Variables:

No

Example:

This is a common configuration field that is used in many examples. Refer to:

Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Description:: Specifies an optional text description for your activity.
Allowed Values:: More than one line of text.
Default Value:: None
Accepts Variables:: No

Configure CAML Query > List and View Fields tab

Creates a view from the available fields, or columns, in a SharePoint list.

Fields

Field Name	Definition
SharePoint	Description: Specifies the access token that connects to your SharePoint site. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No Example: Refer to: (Example) Configure a Create List Item Activity to Put the Leave Information in the SharePoint List (External) Form Based Apps – SharePoint Data Source (Example) Create a SharePoint Access Token
Create	Opens this Screen: Access Token for SharePoint Function of this Screen: Configure an access token to connect to SharePoint. Example: Refer to: (Example) Create a SharePoint Access Token
Site URL	Description: Specifies the URL for your SharePoint site. Allowed Values: A valid SharePoint site URL. Default Value: None Accepts Variables: Yes Example: http://[machine name]:[port]/sites/[site name] Note: You must include the /sites in the Site URL for the site to be created successfully. (External) Form Based Apps – SharePoint Data Source
List	Description: Specifies the name of your SharePoint list . Allowed Values: The name of your SharePoint list. Default Value: None Accepts Variables: Yes
Show Hidden Fields	Description: Specifies if you can use hidden columns in SharePoint for your CAML query. Allowed Values: Deselected - The SharePoint hidden columns are not available for your CAML query. Selected - The SharePoint hidden columns are displayed in the Possible View Fields box, so you can use them for your CAML query. Default Value: Deselected
Possible View Fields	Description: Shows all the columns of the specified SharePoint list. Allowed Values: A SharePoint column selected from the list. Default Value: None Accepts Variables: No Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?
Left Arrow	Function: Moves the selected fields from the Possible View Fields box to the Configured View Fields box.
Right Arrow	Function: Moves the selected fields from the Configured View Fields box to the Possible View Fields box.
Configured View Fields	Description: Specifies the SharePoint columns that are included in the CAML query. Allowed Values: A list of columns moved from the Possible View Fields box using the Left Arrow button. To remove a column from the list, select the column, and then click the Right Arrow button. Default Value: None Accepts Variables: No Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Configure CAML Query > Where Clause tab

Configures a Where clause to filter the results of a CAML query.

Fields

Field Name	Definition
SharePoint	Description: Specifies the access token that connects to your SharePoint site. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No Example: Refer to: (Example) Configure a Create List Item Activity to Put the Leave Information in the SharePoint List (External) Form Based Apps – SharePoint Data Source (Example) Create a SharePoint Access Token
Create	Opens this Screen: Access Token for SharePoint Function of this Screen: Configure an access token to connect to SharePoint. Example: Refer to: (Example) Create a SharePoint Access Token
Site URL	Description: Specifies the URL for your SharePoint site. Allowed Values: A valid SharePoint site URL. Default Value: None Accepts Variables: Yes Example: http://[machine name]:[port]/sites/[site name] Note: You must include the /sites in the Site URL for the site to be created successfully. (External) Form Based Apps – SharePoint Data Source
Fields	Description: Specifies the name of the SharePoint column. Allowed Values: Read only. Default Value: A list of names in the specified list. Accepts Variables: No
Add Condition	Function: Creates a condition row.
Select Nest Type	Function: Specifies the use of logical AND and OR operators to nest conditions for the WHERE clause. And - Specifies the logical AND operator. Or - Specifies the logical OR operator. You must set the nest type first before defining the condition for the where clause.
Column	Description: Specifies the name of the SharePoint column. Allowed Values: A valid SharePoint column name. Drag the name the column from the Fields field and drop it into the Column Name field to build a condition. Default Value: None Accepts Variables: No Example: Title
Comparer	Description: Specifies the operator to use in your WHERE clause. Allowed Values: = != Contains Begins with Is Not Null Is Null Default Value: =
Value	Description: Specifies the value for the column. Allowed Values: A valid column value. Default Value: None Accepts Variables: Yes Limitations: Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?
Delete	Function: Deletes the row.

Configure CAML Query > Grouping tab

Groups SharePoint list data by a specified column name, either in ascending or descending order.

Fields

Field Name	Definition
SharePoint	Description: Specifies the access token that connects to your SharePoint site. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No Example: Refer to: (Example) Configure a Create List Item Activity to Put the Leave Information in the SharePoint List (External) Form Based Apps – SharePoint Data Source (Example) Create a SharePoint Access Token
Create	Opens this Screen: Access Token for SharePoint Function of this Screen: Configure an access token to connect to SharePoint. Example: Refer to: (Example) Create a SharePoint Access Token
Site URL	Description: Specifies the URL for your SharePoint site. Allowed Values: A valid SharePoint site URL. Default Value: None Accepts Variables: Yes Example: http://[machine name]:[port]/sites/[site name] Note: You must include the /sites in the Site URL for the site to be created successfully. (External) Form Based Apps – SharePoint Data Source
Group By - Columns	Description: Specifies the name of the SharePoint column to group the SharePoint records to get the required result set. Allowed Values: The name of your SharePoint list column. Default Value: None Accepts Variables: No
Order By - Columns	Description: Specifies the name of the SharePoint column that organizes the CAML query result set. Allowed Values: The name of your SharePoint list column. Default Value: None Accepts Variables: No
Sort By	Description: Specifies the sort order for the result set. Allowed Values: Ascending Descending Default Value: Ascending

Configure CAML Query > Code Snippet tab

Shows the code snippet that is generated from the WHERE clause.

Fields

Field Name	Definition
SharePoint	Description: Specifies the access token that connects to your SharePoint site. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No Example: Refer to: (Example) Configure a Create List Item Activity to Put the Leave Information in the SharePoint List (External) Form Based Apps – SharePoint Data Source (Example) Create a SharePoint Access Token
Create	Opens this Screen: Access Token for SharePoint Function of this Screen: Configure an access token to connect to SharePoint. Example: Refer to: (Example) Create a SharePoint Access Token
Site URL	Description: Specifies the URL for your SharePoint site. Allowed Values: A valid SharePoint site URL. Default Value: None Accepts Variables: Yes Example: http://[machine name]:[port]/sites/[site name] Note: You must include the /sites in the Site URL for the site to be created successfully. (External) Form Based Apps – SharePoint Data Source
Code Snippet	Description: Shows the code snippet the system creates for the CAML WHERE clause. Allowed Values: Read only. Default Value: None

Configure CAML Query > Query Options tab

Specifies how and where CAML query operations are performed in the SharePoint list.

Fields

Field Name	Definition
SharePoint	Description: Specifies the access token that connects to your SharePoint site. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No Example: Refer to: (Example) Configure a Create List Item Activity to Put the Leave Information in the SharePoint List (External) Form Based Apps – SharePoint Data Source (Example) Create a SharePoint Access Token
Create	Opens this Screen: Access Token for SharePoint Function of this Screen: Configure an access token to connect to SharePoint. Example: Refer to: (Example) Create a SharePoint Access Token
Site URL	Description: Specifies the URL for your SharePoint site. Allowed Values: A valid SharePoint site URL. Default Value: None Accepts Variables: Yes Example: http://[machine name]:[port]/sites/[site name] Note: You must include the /sites in the Site URL for the site to be created successfully. (External) Form Based Apps – SharePoint Data Source
Row Limit	Description: Specifies the maximum number of rows to get with the CAML query. Allowed Values: Deselected - Specifies to get 10,000 maximum from the CAML query. Selected - Gets the specified number of records. Default Value: Deselected
Include Mandatory Columns	Description: Specifies that mandatory columns are in the CAML query results. Allowed Values: Selected - The mandatory columns are in the CAML query results. Deselected - The mandatory columns are not in the CAML query results. Default Value: Selected
Specify A Folder	Description: Specifies the location of a folder in which to execute the CAML query. Allowed Values: Selected - The activity runs the CAML query at the folder location. Look in All Folders and Subfolders - The CAML query is run in all the folders and their subfolders. Specify a Folder Relative URL like Folder/SubFolder - The CAML query runs only in the specified folder. Deselected - The activity runs the CAML query in the entire SharePoint database. Default Value: Selected Accepts Variables: No
Fetch Recursively	Description: Specifies if the CAML query runs only in the specified folder and its subfolders. To Open this Field: Select Specify a Folder Relative URL like Folder/Subfolder. Allowed Values: Selected - The CAML query runs only in the specified folder and its subfolders. Deselected - The CAML query runs only in the specified folder. Default Value: Selected Accepts Variables: No

Configure CAML Query > Schema tab

Connects the SharePoint columns in a CAML query response to the nodes in an AgilePoint schema.

Fields

Field Name	Definition
SharePoint	Description: Specifies the access token that connects to your SharePoint site. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No Example: Refer to: (Example) Configure a Create List Item Activity to Put the Leave Information in the SharePoint List (External) Form Based Apps – SharePoint Data Source (Example) Create a SharePoint Access Token
Create	Opens this Screen: Access Token for SharePoint Function of this Screen: Configure an access token to connect to SharePoint. Example: Refer to: (Example) Create a SharePoint Access Token
Site URL	Description: Specifies the URL for your SharePoint site. Allowed Values: A valid SharePoint site URL. Default Value: None Accepts Variables: Yes Example: http://[machine name]:[port]/sites/[site name] Note: You must include the /sites in the Site URL for the site to be created successfully. (External) Form Based Apps – SharePoint Data Source
Map CAML Query Response to AgilePoint Schema	Description: Connects the SharePoint columns returned from the CAML query to the AgilePoint process schema. Allowed Values: Click the Schema Mapping button to open the Schema Mapper. Use this screen to connect the response to the data model for your process. Default Value: None Example: Refer to: (Example) Schema Mapper

Configure CAML Query > Test Query tab

Makes sure the specified CAML query is correct.

Fields

Field Name	Definition
SharePoint	Description: Specifies the access token that connects to your SharePoint site. Allowed Values: A list of access tokens configured for your environment. Default Value: None Accepts Variables: No Example: Refer to: (Example) Configure a Create List Item Activity to Put the Leave Information in the SharePoint List (External) Form Based Apps – SharePoint Data Source (Example) Create a SharePoint Access Token
Create	Opens this Screen: Access Token for SharePoint Function of this Screen: Configure an access token to connect to SharePoint. Example: Refer to: (Example) Create a SharePoint Access Token
Site URL	Description: Specifies the URL for your SharePoint site. Allowed Values: A valid SharePoint site URL. Default Value: None Accepts Variables: Yes Example: http://[machine name]:[port]/sites/[site name] Note: You must include the /sites in the Site URL for the site to be created successfully. (External) Form Based Apps – SharePoint Data Source
Test Query	Function: Examines the CAML query, and shows a message if an error occurs. If the CAML query runs successfully, the result shows in the box.