String Substring Documentation

Version: 1.0.0

Retrieved: 2025-10-09 15:16:23

String Substring

Used for extracting a substring from a string.

Settings

Name	Requirements	Purpose	Default
Source Property	String 1 to 64 in length	The property that contains the string to do the substring operation on	data
Target Property	String 1 to 64 in length	The property that will contain the result of the substring operation	data
Start Position	int 0 to Int.Max	The index to start the substring	0
Length	int 0 to Int.Max	How many characters to include from Start Position. If 0 the rest of the string from Start Position will be included	0
Start From End	bool	If true the Start Position will be at the right hand side of the string, and Length is calculated towards the beginning of the string	false

Example Successful Processing

When the Source Property can be found the module will extract a substring from the Source Property and write that substring into the Target Property.

# Settings:
Source Property = "message"
Target Property = "result"
Start Position = 6
Length = 0
Start From End = false

# Incoming message
{
    'data':{
        'message':'Hello Sweden',
        'timestamp': '2019-08-10 16:23:44'
    }
}

# Outgoing message:
{
    'data':{
        'message':'Hello Sweden',
        'result':'Sweden'
        'timestamp': '2019-08-10 16:23:44'
    }
}

Example Missing Source Property

If the Source Property cant be found on the message it will just pass through.

# Settings:
Source Property = "someText"
Target Property = "result"
Start Position = 6
Length = 0
Start From End = false

# Incoming message
{
    'data':{
        'message':'Hello Sweden',
        'timestamp': '2019-08-10 16:23:44'
    }
}

# Outgoing message:
{
    'data':{
        'message':'Hello Sweden',
        'timestamp': '2019-08-10 16:23:44'
    }
}

Array Modules

Transformation

Data Conversions