The TextReplace Add-In can be used to replace certain strings in a text file. The file is read in line by line and the character strings to be replaced can be defined using regular expressions. The character set of a text file can also be converted.
features | |
Add-in type | Logic |
Interfaces | In/Out: file (“file” parameter) |
Transactions | 1 if successful |
Events | n/a |
parameter | |
expression | List of regular expressions (one per line) to be searched for in the input file |
replacement | List of values with which the found strings are replaced (one per line) |
inputEncoding | Character encoding of the input file (e.g. ‘UTF-8’, ‘ISO-8859-1’) (optional, default = “UTF-8”) |
outputEncoding | Character coding of the output file (e.g. ‘UTF-8’, ‘ISO-8859-1’) (optional, default = “UTF-8”) |
writeBom | Indicates whether a ‘byte order mark’ (BOM) is written if ‘outputEncoding’ is set to ‘UTF-8’ (optional, default = true) |
endpoint | Name of the endpoint that is used in the transaction (optional, default = “”). If “endpoint” starts with *** the value from the calling instance is used. |
The parameters “expression” and “replacement” can contain multiline text. A regular expression must be specified per line in “expression” and a replacement text must be specified in “replacement”. Both parameters must contain the same number of lines.
expression | replacement | |
encoding=”ISO-8859-1” | encoding=”UTF-8” | Replaces the expression encoding=”ISO-8859-1” with encoding=”UTF-8”. |
([^=])(“) | $1" | Replacing all occurrences of “ (group 2), that are not immediately following a = (group 1), with " |
The TextReplace Add-In receives the name of the file to be edited in the subscribed event in the “file” parameter. This parameter is provided by the following add-ins:
If the “inputEncoding” parameter was set to “UTF-8” and the file to be processed is in a different format, the system automatically tries to read the file in the system’s standard character set (usually ISO-8859-1).