# String
## Introduction
The String library in Autom Mate provides a set of actions for performing operations on textual data. These actions enable users to manipulate, format, and extract information from text strings efficiently.
The purpose of the String component is to offer a range of functionalities for handling and processing textual data within automated workflows. It allows users to modify, transform, and analyze text strings as needed.
## What is String?
The String component encompasses various actions designed to work with text data. These actions facilitate tasks such as appending, assigning values, capitalizing, converting to date or number formats, finding and replacing text, and more.
#### Key Features
* **Text Manipulation**:
* Perform operations to modify and manipulate text strings.
* **Conversion**:
* Convert text values to different formats such as dates or numbers.
* **Search and Replace**:
* Find specific text patterns and replace them with new values.
* **Text Length**:
* Retrieve the length of text strings for analysis.
## How To Use Action
### Append
**Description:** The **Append** action is used to add new data to an existing text or data structure.
**Usage:**
* **Value to Assign**:
* Enter the textual data value to be added.
* **Source to be Appended**:
* Add the data at the end of the existing content.
### Assign
**Description:** The **Assign** action defines a textual value to be assigned to a variable.
**Usage:**
* **Value to Assign**:
* Enter the textual data value to be assigned.
* **Source to be Assigned**:
* Specify the variable to which the data will be assigned.
### Capitalize
**Description:** The **Capitalize** action converts the first letter of a text string to uppercase.
**Usage:**
* **Source String**:
* Enter the text value to be capitalized.
* **Capitalize**:
* Choose to capitalize only the first letter or multiple letters.
* **Assign the output to variable**:
* Determine the variable for the capitalized data.
### Convert String to Date
**Description:** The **Convert (Date)** action transforms a text value into a date type.
**Usage:**
* **Source String**:
* Enter the text value to be converted.
* **Source Date Format**:
* Specify the format of the source text.
* **New Date Format**:
* Select the desired date format after conversion.
* **Assign the output to the variable**:
* Determine the variable for the converted date.
### Convert to Number
**Description:** The **Convert (Number)** action changes a text value to a number type.
**Usage:**
* **Source String**:
* Enter the text value to be converted.
* **Assign the output to variable**:
* Determine the variable for the converted number.
* **Round Number**:
* Specify the number of digits after the decimal point.
### Length
**Description:** The **Length** action retrieves the length of a text value.
**Usage:**
* **Source String**:
* Enter the text value to calculate its length.
* **Assign the output to variable**:
* Determine the variable for the length information.
### Lowercase
**Description:** The **Lowercase** action converts text data from uppercase to lowercase.
**Usage:**
* **Source String**:
* Enter the text value to be converted.
* **Assign the output to variable**:
* Determine the variable for the converted lowercase data.
### Prepend
**Description:** The **Prepend** action adds data to the beginning of an existing text.
**Usage:**
* **Value to Assign**:
* Enter the textual data value to be added.
* **Source to be Prepended**:
* Add the data at the beginning of the existing content.
### Replace
**Description:** The **Replace** action substitutes new textual data for specified text in a string.
**Usage:**
* **Source String**:
* Enter the text value to search for replacements.
* **Find String**:
* Specify the text to be replaced.
* **When Finding**:
* Choose options for matching case sensitivity.
* **Replace With**:
* Enter the new text to replace the found string.
* **Assign the output to the variable**:
* Determine the variable for the replaced data.
### **Regex**
#### **Description and Purpose**
The **String - Regex** action allows Autom Mate users to extract all matching substrings from a given source string based on a user-defined regular expression pattern. This is useful for dynamic text parsing, validation, and data extraction within workflows.
By defining the regex pattern and source text, users can obtain an array of matches to guide downstream logic and processing.
***
#### **Usage Instructions**
{% stepper %}
{% step %}
**Provide Source String**
**Source String (Required):**\
Enter or map the full text where you want to search using the regex.
{% endstep %}
{% step %}
**Define Regex Pattern**
**Regex (Required):**\
Enter the regular expression pattern to be applied on the source string.
Example:
```
\bentity\b
```
This pattern searches for exact occurrences of the word "entity".
{% endstep %}
{% step %}
**Assign Output Variable**
**Assign the output to variable (Required):**\
Select an array-type variable (e.g., `arr`) to store all matched results.
{% endstep %}
{% step %}
**Execute and Review**
Run the action and verify the output variable to confirm extracted substrings.
{% endstep %}
{% endstepper %}
***
#### **Inputs**
| Field | Description |
| ------------------- | ---------------------------------------------- |
| **Source String** | Text to apply the regex search on. |
| **Regex** | The regex pattern for matching substrings. |
| **Output Variable** | Array variable to hold all matched substrings. |
***
#### **Outputs**
| Field | Description |
| ------------------- | -------------------------------------------- |
| **Output Variable** | Array of strings matching the regex pattern. |
***
### **Example Output**
```json
["entity", "entity", "entity", "entity"]
```
***
### Search
**Description:** The **Search** action finds specific text patterns within a string.
**Usage:**
* **Source String**:
* Enter the text value to search within.
* **Find String**:
* Specify the text pattern to search for.
* **When Finding**:
* Choose options for matching case sensitivity.
* **Assign the output to the variable**:
* Determine the variable for the search results.
### Split
**Description:** The **Split** action divides a text value into parts based on a specified delimiter.
**Usage:**
* **Source String**:
* Enter the text value to be split.
* **Delimiter**:
* Specify the separator for splitting the text.
* **Delimiter is**:
* Choose options for matching case sensitivity.
* **Assign the output to the variable**:
* Determine the variable for the split data.
### Substring
**Description:** The **Substring** action extracts a portion of a text value based on specified positions.
**Usage:**
* **Source String**:
* Enter the text value to extract from.
* **Start From**:
* Specify the starting position for extraction.
* **Length (Optional)**:
* Specify the length of the extracted substring (optional).
* **Assign the output to the variable**:
* Determine the variable for the extracted data.
### Trim
**Description:** The **Trim** action removes specified characters from the beginning or end of a text value.
**Usage:**
* **Source String**:
* Enter the text value to be trimmed.
* **Trim from the beginning**:
* Specify characters to remove from the start.
* **Trim from the end**:
* Specify characters to remove from the end.
* **Assign the output to the variable**:
* Determine the variable for the trimmed data.
### Uppercase
**Description:** The **Uppercase** action converts text data from lowercase to uppercase.
**Usage:**
* **Source String**:
* Enter the text value to be converted.
* **Assign the output to variable**:
* Determine the variable for the converted uppercase data.
***
## Additional Tips
### [**Use Cases**](/userguide/use-cases.md)
### [FAQ](/userguide/faq.md)
---
# 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.autommate.com/userguide/libraries/transform/string.md?ask=
```
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.