Definition and Usage
Retrieves the subtext of a text value by specifying the start index and length. This command allows you to extract specific portions of text strings based on position or content markers.
Parameter Values
Input parameters
Parameter | Description | Possible Values | Required | Options / Notes |
Original text | Enter text or select a variable containing the text | - | Yes | - |
From | Specify how to find the starting position for text retrieval | The first character, Character position, Specific text | Yes | - |
Start index | The position of the first character to retrieve. This is a zero-based index, counting from zero for the first character | - | Yes | Only required when "Character position" is selected |
Starting text | Enter the starting text of the retrieval. If you want to extract the order number in the text "Purchase Order Number :12345", then the starting text is ":" | - | Yes | Only required when "Specific text" is selected |
Include starting text | Include the starting text in the extracted subtext | - | No | Checkbox option; only available when "Specific text" is selected |
Extraction method | Choose whether to extract subtext up to the end of the string or specify a length for extraction | End of the text, Number of character(s) | Yes | - |
Length | Specify the number of characters to extract from the original text | - | Yes | Only required when "Number of character(s)" is selected |
Error handling
Parameter Name | Description |
Throw error & stop | When an error occurs, the action will trigger an error and stop the execution of the entire app. |
Retry command | If an error occurs, the action will retry the command in an attempt to resolve the issue and continue the process. |
Ignore error & continue | When an error occurs, the action will be ignored, and the workflow will continue without interruption. |
Variables produced
This action produces a variable containing the extracted subtext from the original text based on the specified parameters.
Using Variables in Conditions
You can use the {x} icon to insert variables into parameter fields. This allows you to dynamically specify text to process or positions to extract from. For example, you might use a variable containing user input as your "Original text" or use a calculated value for the "Start index" or "Length" parameters.
Notes
The "Start index" is zero-based, meaning the first character position is 0, not 1.
When using "Specific text" as the starting point, ensure the text exists in the original string to avoid errors.
If the specified starting position or length extends beyond the boundaries of the original text, the command may return an error or a truncated result.
For better performance with large text strings, consider using specific starting points rather than extracting from the beginning.