> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.itential.com/itential-platform/6/studio/tasks/reference/includes/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itential.com/_mcp/server.

# includes

> Reference for the includes workflow task, which searches a string for a specified value and returns true or false.

The `includes` task searches an input variable for a predefined value and returns `true` if the value is found, or `false` if it is not.

The `includes` task is case sensitive.

## Potential use case

Use this task if you need to scan an email list for the word "unsubscribe" and execute a process to remove that email address from a database.

## Properties

| Incoming       | Type   | Description                                                                                                                                                                                                                                            |
| -------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `str`          | String | Required. The string to search.                                                                                                                                                                                                                        |
| `searchString` | String | Required. The string to search for within `str`. Case sensitive.                                                                                                                                                                                       |
| `position`     | Number | Optional. The character position within `str` at which to begin the search. The count begins at `0` (default). Useful when `searchString` is known to appear more than once in `str` and you only need to verify the existence of a specific instance. |

| Outgoing | Type    | Description                                                                                                      |
| -------- | ------- | ---------------------------------------------------------------------------------------------------------------- |
| `result` | Boolean | Returns `true` if `searchString` is found anywhere within `str` from the given position; returns `false` if not. |

## Examples

### Example 1

In this example:

* The `str` variable is statically set to `12 Dollars And 43 Cents`.
* The `searchString` is `Cents`.
* The `position` is statically set to `19`.
* The `result` is `false` — starting at position 19, the `str` value reads `"ents"`, so no complete match of `Cents` is found from that position onward.

![](/_fern-img/c3c23b75e95fdfdf4ec2b79254c4af01645a92df87b680dacd94b3e6d718aab4.webp)

### Example 2

In this example:

* The `str` variable is statically set to `12 Dollars And 43 Cents`.
* The `searchString` is `cents` (lowercase).
* The `position` is statically set to `18`.
* The `result` is `false` — the task is case sensitive, so `"cents"` does not match `"Cents"`.

![](/_fern-img/fb7c55775d72dace52f2a81ef03deef8b0d34d27ea018f9e6a8e46a6a5127952.webp)

### Example 3

In this example:

* The `str` variable is statically set to `12 Dollars And 43 Cents`.
* The `searchString` is `Cents`.
* The `position` is left blank, defaulting to `0`.
* The `result` is `true` — `"Cents"` does appear within the `str` variable.

![](/_fern-img/5b4d30d4ee6abac2849af61ce220a8a45df8ef8ed031cd14406d74538d256f27.webp)

> Reference for the includes workflow task, which searches a string for a specified value and returns true or false.