# Substring

## Description

This operation extracts a portion of a string based on specified start and end positions or lengths. It is a versatile tool for extracting parts of text or binary data.

***

## Data types

These are the input/output expected data types for this operation:

### Input data

![](https://965373739-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkxZeV4nlXcIAjMGZxzLI%2Fuploads%2FExtApHuiMxiHgaNWDLb2%2Fimage.png?alt=media\&token=5f4e1372-a2db-4d7e-b81b-976507cac896) - Input string or data from which you want to extract a portion.

### Output data

![](https://965373739-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FkxZeV4nlXcIAjMGZxzLI%2Fuploads%2FyeZGvHDhYqskHKW5bdnp%2Fimage.png?alt=media\&token=d72665aa-3d46-4572-a463-a62344ee7f88) - Specified substring.

***

## Parameters

These are the parameters you need to configure to use this operation (mandatory parameters are marked with a <mark style="color:red;">**\***</mark>):

<details>

<summary>Start Index<mark style="color:red;"><strong>*</strong></mark></summary>

The starting index from where the substring will be extracted (starting from position 0).

</details>

<details>

<summary>Length</summary>

The length of the substring to extract. If not specified, the extraction will continue to the end of the string.

</details>

***

## Example

Suppose you want to extract a specified substring from your input data:

1. In your Pipeline, open the required [Action](https://docs.onum.com/the-workspace/pipelines/actions) configuration and select the input **Field**.
2. In the **Operation** field, choose **Substring**.
3. Set **Start Index** to `3`.
4. Set **Length** to `9`.
5. Give your **Output field** a name and click **Save**.

For example, with the parameters specified above, you'll get the following substring from this text:

```
+34678987678 -> 678987678
```

{% hint style="info" %}
You can try out operations with specific values using the **Input** field above the operation. You can enter the value in the example above and check the result in the **Output** field.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.onum.com/the-workspace/pipelines/actions/transformation/field-transformation/field-transformation-operations/utils/substring.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.