Transformations

Transformations are supported in multiple parts of the configuration. Transformations do not affect data sources, they are applied on-the-fly as part of the encoding. Filter expressions do not take transformations into account, they have to be based on the source values.

NameDefaultDescriptionTypeSince
rename
Rename a property.
string
v2.0
remove
IN_COLLECTION (until version 3.0: OVERVIEW) skips the property only for the Features resource, ALWAYS always skips it, NEVER never skips it.
string
v2.0
flatten
Flattens object or array properties using the given separator. For arrays the property name is formed by the original property name followed by pairs of separator and array position. For objects the property name is formed by concatenating the original property separated by the given separator. Can only be applied on the feature level in the provider or using the wildcard property name * otherwise.
string
v2.0
objectReduceFormat
Reduces an object to a string using the same syntax as stringFormat but with additional replacements for the object property names.
string
v2.0
reduceStringFormat
Deprecated See objectReduceFormat.
string
v2.0
objectReduceSelect
Reduces an object to one of its properties, the value is the desired property name.
string
v2.0
objectRemoveSelect
Removes an object, if the property with the name in the value is null.
string
v2.0
objectMapFormat
Maps an object to another object, the value is map where the keys are the new property names. The values use the same syntax as stringFormat but with additional replacements for the source object property names.
object
v2.0
arrayReduceFormat
Reduces a value array to a string using the same syntax as stringFormat but with additional replacements for the array indexes.
string
v2.0
stringFormat
Format a value, where {{value}} is replaced with the actual value and {{serviceUrl}} is replaced with the API landing page URI. Additonal operations can be applied to {{value}} by chaining them with `
`, see the examples below.
string
dateFormat
Format date(-time) values with the given patternopen in new window, e.g. dd.MM.yyyy for German notation.
string
v2.0
codelist
Maps the value according to the given codelist. If the value is not found in the codelist or the codelist does not exist, the original value is passed through. Falls der Wert nicht in der Codelist enthalten ist oder die Codelist nicht gefunden wird, bleibt der Wert unverändert. Not applicable for properties containing objects.
string
v2.0
nullify
Maps all values matching the list of regular expressions to null. Not applicable for properties containing objects.
array
v2.0
null
Deprecated See nullify.
string
v2.0

Examples for stringFormat

https://example.com/id/kinder/kita/{{value}} inserts the value into the URI template.

{{value | replace:'\\s*[0-9].*$':''}} removes all white space and numbers at the end (e.g. to remove a street number)

{{value | replace:'^[^0-9]*':''}} removes everything before the first digit

{{value | toUpper}} transforms the value to upper case

{{value | toLower}} transforms the value to lower case

{{value | urlEncode}} encodes special characters in the text for usage as aprt of an URI

[{{value}}](https://de.wikipedia.org/wiki/{{value | replace:' ':'_' | urlencode}}) transforms a value into a markdown link to a Wikipedia entry