Mappers - Alumio Documentation

This page will explain what mappers are and how they translate values from one system to another. The following mappers are available:

Name	Description
Apply operator to value	Maps a value based on the supplied operator.
Apply operator with prepared values	Applies the operator on every item of the left and right array values.
Array or object: Count items	Returns the number of items in an array or the number of keys in an object.
Array or object: Diff values	Returns the values present in the input but not in the supplied data.
Array or object: Flip keys and values	Swaps the keys and values of an array or object.
Array or object: Get values	Returns the values of an array or object as an indexed array.
Array or object: Inherit from data	Fills missing keys in the array or object from the supplied data.
Array or object: Join into string (implode)	Joins array items or object values into a single string using a separator.
Array or object: Keep matching values	Returns only the values that exist in both the input and the supplied data.
Array or object: Merge	Merges the supplied data into the array or object. Existing keys are overwritten.
Array or object: Reverse	Reverses the order of items in an array or keys in an object.
Array or object: Split into chunks	Splits an array or object into chunks of the specified size.
Array: Extract field	Gets the values for a single key from each item in an array.
Array: Fill with value	Creates an array filled with a repeated value at the specified length.
Array: Join into string	Joins array items into a single string using a separator.
Cast: Boolean	Converts a value into a boolean (true/false).
Cast: Float	Converts a value into a float (1.00, 2.05, 10.50, etc).
Cast: Integer	Converts a value into an integer (1, 2, 3, 10, 25, etc).
Cast: String	Converts a value into a string (“abc”, “example”).
Chain mappers	Executes a list of mappers in sequence.
Filesystem: Resolve destination filename conflict	Ensures a destination path is available on the filesystem. If a file already exists at the path, applies a conflict resolution strategy (for example, appending a counter: foo.json becomes foo-2.json).
Filter: Allow only digits	Takes the input and makes sure all non numeric characters are removed.
Filter: Allow only letters	Takes the input and makes sure all characters other than letters are removed. It means it will also remove spaces.
Filter: Allow only letters and digits	Allows only letters and digits; removes all other characters.
Format date value	Converts a date value to another format based on the given criteria.
Format number value	Applies number formatting to the input. Several arguments can be used to get the desired result.
Format to Form URL encoded	Converts a data object or array into a Form URL encoded string.
Format to JSON	Converts a data object or array into a JSON formatted string.
Format to URL encoded	Converts a data object or array into a URL encoded string.
Format to XLSX	Converts a data object or array into a binary XLSX file.
Format to XML	Converts a data object or array into an XML formatted string.
Format to YAML	Converts a data object or array into a YAML formatted string.
Format to cXML	Converts a data object or array into a cXML formatted string.
Format to selected format	Converts a data object into the desired output format.
Locale: Display region	Gets the region for the locale string in the supplied language.
Map value using comparator	Maps a value to the ‘to’ value based on the comparator.
Map value using dictionary	Converts input from one value into another using a lookup dictionary. For example, the value “1” into “One”, “Yes” into “Si”, etc.
Map when a condition applies	Applies mappers when the conditions apply.
Math: absolute value	Gets the absolute value for an integer or float.
Math: ceil	Rounds to the next highest integer.
Math: floor	Rounds to the next lowest integer.
Math: round	Rounds a number to the provided precision.
Object: Diff keys	Returns the keys present in the object but not in the supplied data.
Object: Get keys	Returns the keys of an object as an array.
Object: Keep matching keys	Returns only the keys that exist in both the object and the supplied data.
Object: Sort keys	Sorts the keys of an object based on the provided sort method and direction.
Parse from Form URL encoded	Converts a Form URL encoded string into a data object.
Parse from JSON	Parses a JSON string into a data object.
Parse from URL encoded	Decodes a URL encoded string into plain text.
Parse from XML	Parses an XML string into a data object.
Parse from YAML	Converts a YAML string into a data object.
Parse from cXML	Parses a cXML string into a data object.
Parse from selected format	Converts a string in XML, JSON, CSV, or other formats into a data object.
String: Append	Appends a string to the data.
String: Base64 decode	Decodes a base64 encoded string back to its original value.
String: Base64 encode	Takes the input string and converts it to a base64 encoded value. It can be used for example to create an identifier based on certain values in the data.
String: Capitalize first word	Takes the given input string and converts the first letter to a capital. This only works when en phrase starts with a lowercase letter.
String: Convert character set of string	Converts a string from one encoding to another.
String: Convert encoding	Converts a string to the specified encoding. The from encoding must be known.
String: Convert to lowercase	Takes the given input and casts all letters to a lower case. The given input must be a valid string.
String: Convert to uppercase	Converts all letters in the input to uppercase.
String: Cut	Cuts a string at the provided length value starting the count at the start value.
String: Decode HTML entities	HTML decodes a string to human-readable text.
String: Encode HTML entities	Encodes all HTML entities in a string.
String: Explode to an array	Takes the given input string and converts it to an array/list based on a specified split character.
String: Explode to an array using a regular expression	Explodes a string based on a supplied regex.
String: Extract directory from path	Extracts the directory portion from a file path. For example, ‘/uploads/image.jpg’ returns ‘/uploads’.
String: Extract filename from path	Extracts the filename from a file path. For example, ‘/uploads/image.jpg’ returns ‘image.jpg’.
String: Generate dispersed file path	Generates a nested directory path from a string, distributing files across subdirectories to avoid large flat directories.
String: Hash	Hashes a string with the provided algorithm, the output can be a string or binary.
String: Parse file path into parts	Parses a file path into its components (directory, filename, and extension).
String: Prepend	Prepends a value onto a string.
String: Replace	Replaces within a string based on a string comparison.
String: Replace using regular expression	Replaces part of a string based on the supplied regex.
String: Slugify	Removes all non-alphanumeric characters and replaces them with hyphens (-).
String: Strip HTML tags	Removes the HTML tags from a string. A set of tags can be supplied to be excluded.
String: Transliterate	Transliterates a string based on the supplied transliterator. Can be used to change UTF-16 code units into single characters.
String: Trim characters	Trims characters from the left or right side of a string.