The following are examples of how to configure the Transformer mapping element to modify the value of an existing attribute and fit the target system's requirements.
Base64 Encode
The Base64 Encode transformer type allows you to convert binary data, such as images or PDFs, into a text format using a set of 64 ASCII characters (A-Z, a-z, 0-9, and /). The Base64 string can be then easily transferred and the target system can decode it back to its original binary format, reducing the chances of data loss during the migration. This is mostly useful when migrating data between systems with different character encoding requirements, or when migrating to systems that do not support binary data.
In the following example, any binary data that is included in the source_file_path attribute is transformed to a text format before migration.
For more information on this function, see Class Base64 in the Apache Commons documentation at https://commons.apache.org/.
Burst Repeating Attribute
The Burst Repeating Attribute transformer type allows you to split a single-value attribute, using a specified delimiter, to create a multi-value attribute with a list or array of strings, enabling filtering and searching based on individual values.
In the following example, the single-value file_name attribute, which stores multiple values in a single string, is split on the _ delimiter and converted into a multi-value attribute. For example, if the attribute's single string value is AP_vendor_claim123, then it is transformed to three separate values: AP, vendor, and claim123.
Capitalize Fully with Delimiters
The Capitalize Fully with Delimiters transformer type allows you to capitalize the first character of each word of an attribute, with delimiters provided as parameters.
In the following example, the first character of each word within the >>DocTypeName attribute's value is capitalized and the underscore character is used to separate the words. For example, if the Document Type's name is ap_veNDOR_inVOice, then it is transformed to Ap_Vendor_Invoice.
For more information on this function, see capitalizeFully in the Class WordUtils section of the Apache Commons documentation at https://commons.apache.org/.
Characters from Beginning
The Characters from Beginning transformer type allows you to retrieve a specified number of characters from the beginning of the attribute's value.
In the following example, the first five characters of the >>DocTypeName attribute are returned. For example, if the Document Type's name is AP VendorInvoice, then it is transformed to AP Ve.
For more information on this function, see left in the Class StringUtils section of the Apache Commons documentation at https://commons.apache.org/.
Characters from End
The Characters from End transformer type allows you to retrieve a specified number of characters from the end of an attribute.
In the following example, the last seven characters of the >>DocTypeName attribute are returned. For example, if the Document Type's name is AP VendorInvoice, then it is transformed to Invoice.
For more information on this function, see right in the Class StringUtils section of the Apache Commons documentation at https://commons.apache.org/.
Combine Attributes
The Combine Attributes transformer type allows you to combine the values from two attributes into a single multi-value attribute.
In the following example, the values of First Name and Last Name are combined into a single Name attribute. For example, if the First Name is Bob and the Last Name is Lowes, then the Name attribute is set to Bob Lowes.
Date to String
The Date to String transformer type allows you to format a date attribute according to a specified date format pattern.
In the following example, the date values of the >>DocDate attribute, regardless of their original format, are converted to the yyyy-MM-dd pattern specified in the Date Format field. For example, if the attribute's value is 21.09.2025, then it is transformed to 2025-09-21.
For more information on date patterns, see the Class SimpleDateFormat section of the Oracle documentation at https://docs.oracle.com/en/.
For more information on this function, see format in the Class DateFormatUtils section of the Apache Commons documentation at https://commons.apache.org/.
Default If Null
The Default If Null transformer type allows you to specify a default value if the attribute's value is not set, set to null, or set to an empty string.
In the following example, if the value of the >>DocTypeName attribute is not set, set to null, or set to an empty string, then it is transformed to the Unknown value.
File Path Parser
The File Path Parser transformer type allows you to parse a file path using the forward slash (/) delimiter and retrieve a specific path segment based on its index. In other words, a file's location is divided into its individual parts and only a specific part of that location is retrieved.
In the following example, the third part of a file path is returned. For example, if the file path in the >>FullPath attribute's value is xx/yy/zz/aa.log, then it is transformed to aa.log.
To return the xx path, set the Index to 0.
To return the yy path, set the Index to 1.
To return the zz path, set the Index to 2.
If Null Switch
The If Null Switch transformer type allows you to use the secondary attribute's value if the primary attribute's value is not set, set to null, or set to an empty string.
In the following example, if the value of Mobile Phone Number is not set, set to null, or set to an empty string, then it is set to the value of Home Phone Number. If both attributes are set to null, then an empty string is returned.
If With Eval
The If with Eval transformer type allows you to perform if/else logic using expressions. An expression can be an attribute value, a static value, or a combination of both delimited by the semicolon (;) and each attribute must be prefixed with the bang character (!), for example ;!username;.
Increment
The Increment transformer type allows you to increase the numerical value of an attribute by one. If the attribute's type is not an integer, then it is parsed into an integer.
In the following example, the value of the starting_number attribute is updated to a higher number. For example, when assigning a new number to each processed file, if the value of starting_number is 100, then the first processed file is assigned 100, the second 101, the third 102, and so on.
Left Pad
The Left Pad transformer type allows you to extend the attribute's value (in characters) to a desired length by adding padding characters on the left.
In the following example, the claim_no attribute's value is set to be eight characters long. For example, if the claim number is 1234567, then it is transformed to 01234567.
For more information on this function, see leftPad in the Class StringUtils section of the Apache Commons documentation at https://commons.apache.org/.
Normalize File Name
The Normalize File Name transformer type allows you to replace all characters of an attribute's value that are invalid in a file name. The invalid characters include but are not limited to the following:
- less than (<)
- greater than (>)
- colon (:)
- forward slash (/)
- backward slash (\)
- double quote (")
- vertical bar (|)
- question mark (?)
- asterisk (*)
In the following example, all invalid characters in the file_name attribute's value are replaced with underscores (_). For example, if the file name is <legacy*data>.log, then it is transformed to _legacy_data_.log.
Remove Duplicate Repeating Values
The Remove Duplicate Repeating Values transformer type allows you to remove duplicates from a multi-value attribute.
In the following example, duplicate values are removed from the Phone Numbers attribute. For example, if the attribute's value is an array of following strings ["555-555-5555", "666-666-6666", "555-555-5555"], then the list is transformed to ["555-555-5555", "666-666-6666"].
Remove Repeating Values
The Remove Repeating Values transformer type allows you to remove a specific value from a multi-value attribute.
In the following example, the 555-555-5555 value is removed from the Phone Numbers attribute. For example, if the attribute's value is an array of following strings ["555-555-5555", "666-666-6666", "777-777-7777"], then it is transformed to ["666-666-6666", "777-777-7777"].
Remove String
The Remove String transformer type allows you to remove a specific string from an attribute's value.
In the following example, the \\source-file-server01\c$\ string is removed from the source_file_path attribute. For example, if the source file path is \\source-file-server01\c$\hyland_migrate_demo\test.txt, then it is transformed to hyland_migrate_demo\test.txt.
If you want the search to be case insensitive, switch on the Case Insensitive Search toggle.
For more information on this function, see remove in the Class StringUtils section of the Apache Commons documentation at https://commons.apache.org/.
Remove Trailing Whitespace
The Remove Trailing Whitespace transformer type allows you to remove trailing whitespaces from an attribute.
In the following example, any space characters that appear at the end of the >>DocTypeName attribute's value are removed. For example, if the attribute's value is APVendorInvoice<space><space>, then it is transformed to APVendorInvoice.
Replace
The Replace transformer type allows you to replace a string in an attribute's value.
In the following example, forward slashes (/) are replaced with backward slashes (\) in the S3_key. For example, if the S3 key's value is \\source-file-server01\c$\hyland_migrate_demo\test.txt, then it is transformed to //source-file-server01/c$/hyland_migrate_demo/test.txt.
If you want the search to be case insensitive, switch on the Case Insensitive Search toggle.
For more information on this function, see replace in the Class StringUtils section of the Apache Commons documentation at https://commons.apache.org/.
Replace Regex
The Replace Regex transformer type allows you to replace a string of characters within the attribute's value that matches a defined regular expression (Regex) with a new string.
In the following example, the VendorInvoice string within the >>DocTypeName attribute's value is replaced with Invoice. For example, if the Document Type's name is APVendorInvoice, then it is transformed to APInvoice.
For more information on this function, see replaceAll in the Class String section of the Oracle documentation at https://docs.oracle.com/en/.
Right Pad
The Right Pad transformer type allows you to extend the attribute's value (in characters) to a desired length by adding padding characters on the right.
In the following example, the Legacy ID number is set to be eight characters long. For example, if the legacy ID number is 1234567, then it is transformed to 12345670.
For more information on this function, see rightPad in the Class StringUtils section of the Apache Commons documentation at https://commons.apache.org/.
Static Sequence
The Static Sequence transformer type allows you to generate sequential values, such as auto-incremented IDs or row numbers, as this transformer type returns an automatically incrementing integer, starting from one and increasing by one with each subsequent call.
For example, when migrating documents, each document that is processed by Hyland Migrate, receives a new number starting with 1. The first document is assigned 1, the second 2, the third 3, and so on.
String to Date
The String to Date transformer allows you to convert a date/time string within the attribute's value into a defined date/time format pattern.
In the following example, any date/time string in the value of Document Date is transformed to the yyyy.MM.dd date/time format pattern, for example 2025.04.07.
For more information on date/time patterns, see in the Class SimpleDateFormat section of the Oracle documentation at https://docs.oracle.com/en/.
Substring After First
The Substring After First transformer type allows you to extract the part of a string within the attribute's value that appears after the first occurrence of a specified string of characters.
In the following example, a file path in the source_file_path attribute's value is transformed to a relative path. For example, if the file path is \\my-server\c$\document.txt, then it is transformed to document.txt as it appears right after the first occurrence of \\my-server\c$\.
If you want the search to be case insensitive, switch on the Case Insensitive Search toggle.
For more information on this function, see substringAfter in the Class StringUtils section of the Apache Commons documentation at https://commons.apache.org/.
Substring After First Attribute Value
The Substring After First Attribute Value transformer type allows you to extract the part of a string within the attribute's value that appears after the first occurrence of a specified string of characters stored in another attribute's value.
In the following example, if the s3_key attribute's value is \\source-file-server01\c$\hyland_migrate_demo\document.txt and the source_file_path attributes contains the \\source-file-server01\c$\ string, then it is transformed to hyland_migrate_demo\document.txt, as it appears right after the first occurrence of \\source-file-server01\c$\.
For more information on this function, see substringAfter in the Class StringUtils section of the Apache Commons documentation at https://commons.apache.org/.
Substring After Last
The Substring After Last transformer type allows you to extract the part of a string within the attribute's value that appears after the last occurrence of a specified string of characters.
In the following example, a full file path is transformed to the file name. For example, if the file path is \\source-file-server01\c$\hyland_migrate_demo\document.txt, then it is transformed to document.txt as it appears right after the last occurrence of \.
If you want the search to be case insensitive, switch on the Case Insensitive Search toggle.
For more information on this transformer type, see substringAfterLast in the Class StringUtils section of the Apache Commons documentation at https://commons.apache.org/.
Substring Before First
The Substring Before First transformer type allows you to extract the part of a string within the attribute's value that appears before the first occurrence of a specified string of characters.
In the following example, a full file path is transformed to the base directory of a file. For example, if the full file path is \\source-file-server01\c$\hyland_migrate_demo\Documents.txt, then it is transformed to the \\source-file-server01\c$\hyland_migrate_demo\ base directory as it appears right before the first occurrence of Documents.
If you want the search to be case insensitive, switch on the Case Insensitive Search toggle.
For more information on this function, see substringBefore in the Class StringUtils section of the Apache Commons documentation at https://commons.apache.org/.
Substring Before Last
The Substring Before Last transformer type allows you to extract the part of a string within the attribute's value that appears before the last occurrence of a specified string of characters.
In the following example, a full file path is transformed to the subdirectory of a file. For example, if the full file path is \\source-file-server01\c$\hyland_migrate_demo\Documents.txt, then it is transformed to the \\source-file-server01\c$\hyland_migrate_demo subdirectory as it appears right before the last occurrence of \.
If you want the search to be case insensitive, switch on the Case Insensitive Search toggle.
For more information on this function, see substringBeforeLast in the Class StringUtils section of the Apache Commons documentation at https://commons.apache.org/.
Substring Start End
The Substring Start End transformer type allows you to extract the part of a string within the attribute's value that starts at the defined start index and ends one character before the defined end index.
In the following example, the Document Type's name is shortened. For example, if the >>DocTypeNameattribute's value is ApVendorInvoice, the Start Index is 8, and the End Index is 15, then the Document Type's name is transformed to Invoice.
For more information on this function, see substring in the Class StringUtils section of the Apache Commons documentation at https://commons.apache.org/.
To Lowercase
The To Lowercase transformer type allows you to change characters within the attribute's value to lowercase.
In the following example, all characters within the >>DocTypeName attribute's value are changed to lowercase. For example, if the Document Type's name is AP_VendorInVoiCe, then it is transformed to ap_vendorinvoice.
For more information on this function, see lowerCase in the Class StringUtils section of the Apache Commons documentation at https://commons.apache.org/.
To Uppercase
The To Uppercase transformer type allows you to change characters within the attribute's value to uppercase.
In the following example, all characters within the >>DocTypeName attribute's value are changed to uppercase. For example, if the Document Type's name is AP_VendorInVoiCe, then it is transformed to AP_VENDORINVOICE.
For more information on this function, see upperCase in the Class StringUtils section of the Apache Commons documentation at https://commons.apache.org/.
Trim
The Trim transformer type allows you to remove whitespaces from the beginning and end of the attribute's value.
In the following example, whitespaces from the beginning and end of the >>DocTypeName attribute's value are removed. For example, if the Document Type's name is <space>AP<space>VendorInvoice<space>, then it is transformed to AP<space>VendorInvoice.
For more information on this operation, see trim in the Class StringUtils section of the Apache Commons documentation at https://commons.apache.org/.
US Dollar Currency Format
The US Dollar Currency Format transformer type allows you to format the attribute's value as US currency, including a preceding dollar sign, a decimal point, and two digits after the decimal.
In the following example, the total_amount attribute's value is formatted as US currency. For example, if the value is 1234.5, then it is transformed to $1,234.50.
For more information on this operation, see format in the Class NumberFormat section of the Oracle documentation at https://docs.oracle.com/en/.
Year Adder
The Year Adder transformer type allows you to add a specified number of years to the date attribute's value.
In the following example, 4 years are added to the date value of the original_date attribute. For example, if the date is 1950-09-09, then it is transformed to 2000-09-09.