Transformation Rules
Transformation rules automatically modify the values of composite fields. Transformation rules are applied to composite fields in the Advanced section of the Properties pane in an Enrollment Design, where you can click the Transformation Rules button to set transformation rules for the composite field.
Note: For more information on composite fields, refer to Configure Composite Fields.
Transformation rules include the following attributes:
-
Transformation: the type of rule applied to a composite field.
-
Scope: the range of characters in a component field to which the rule is applied.
-
Parameter(s): the characters to which the rule will apply, if applicable.
-
Replacement: the characters which will replace those of the parameter(s), if applicable.
Available Transformation options include Remove, Keep, Substitute, Replace, Fill (Pad), or Add. Each option changes the other attributes available to apply in the transformation rule. Refer to the table below for the differences in attributes available for each Transformation.
Remove
| Attribute | Options | Description |
| Scope | Anywhere | Remove the Parameter(s) wherever they appear. |
| Prepended | Remove the Parameter(s) from the beginning of the field. | |
| Trailing | Remove the Parameter(s) from the end of the field. | |
| Parameter(s) | Enter the value to remove. | |
| Replacement | N/A |
Setting the Scope to Anywhere will remove the match if it occurs anywhere within the field value. The matching is case sensitive.
Example: For a component field with a value of "Sample Data", using a Scope of Anywhere and a Parameter of "Sample" will yield a composite field with a value of "Data".
Scopes of Prepend and Trailing will remove an exact match at either the start or end of the field value.
Example: For a component field with a value of "Sample Data", using a Parameter of "Sample" with a Scope of Prepend will yield a composite field with a value of "Data", while a Scope of Trailing would not change the value.
Keep
| Attribute | Options | Description |
| Scope | X-Left-most |
Retains the X-left-most characters; i.e., if the component field has a value of "This is a test", and the Parameter(s) value is "4", the transformation would eliminate all but the 4 left-most characters, resulting in the composite field having a value of "This". |
| X-Right-most | Retains the X-right-most characters; i.e., if the component field has a value of "This is a test", and the Parameter(s) value is 4, the transformation would eliminate all but the 4 right-most characters, resulting in the composite field having a value of "test". | |
| In Positions | Retains one or more positions or ranges of positions, separated by commas; i.e., if the component field has a value of "This is a test", and the Parameter(s) value is "1-5,11-14", the transformation will retain only characters in the positions of 1-5 and 11-14, resulting in the composite field having a value of "This test". | |
| Parameter(s) |
Enter an integer value to preserve the characters according to the selected Scope. |
|
| Replacement | N/A |
Specify the number of characters to keep from the field value. Scopes of X-Left-most and X-Right-most will keep the number of characters at either the start or end of the field value.
Example: For a component field with a value of "Sample Data", using a Parameter of "4" and a Scope of X-Left-most will yield a composite field with a value of "Samp", whereas a Scope of X-Right-most will yield a value of "Data".
Setting the Scope to In Positions will keep the characters in the specified position or range of the field value,
Example: For a component field with a value of "Sample Data", using a Parameter of "1,3,7-9" and a Scope of In Positions will yield a composite field with a value of "Sm Da."
Substitute
| Attribute | Options | Description |
| Scope | In Entirety (Exact match) no case | Applies the rule only when the entirety of the Parameter(s) appear, regardless of the characters' cases. |
| In Entirety (Exact match) case aware | Applies the rule only when the entirety of the Parameter(s) appear in the specific character cases entered. | |
| Any occurrence (no case) | Applies the rule wherever any portion of the Parameter(s) appear, regardless of the characters' cases. | |
| Any occurrence (case aware) | Applies the rule wherever any portion of the Parameter(s) appear in the specific character cases entered. | |
| Parameter(s) | Enter the value to locate. | |
| Replacement | Enter the value to substitute in place of the Parameter(s). |
The Scopes of In Entirety (exact match) no case and In Entirety (exact match) case aware will replace the field value only if the entire value of the component field matches the specified search parameter. You can specify if the search if case sensitive or not.
Example: For a component field with a value of "Sample Data", using a Scope of In Entirety (exact match) no case or In Entirety (exact match) case aware, a Parameter of "Sample Data" and a Replacement of "New Value" a field value of "Sample Data" will yield a composite field with a value of "New Value", while a component field with a value of "Sample Data X" would not be changed.
Using the same Parameter and Replacement, the Scopes of Any occurrence (no case) or Any occurrence (case aware) would transform a component field with a value of "Sample Data" to a composite field with a value of "New Value", or transform a component field with a value of "Sample Data X" to a composite field with a value of "New Data X".
Replace
| Attribute | Options | Description |
| Scope | When no exact matches for any X | Locates an exact match in the component field for the value of the Parameter(s), and is case sensitive. |
| Parameter(s) | Enter the value to locate. | |
| Replacement | Enter the value to replace the Parameter(s). |
Will replace any match of the search parameter that is found in the field value. The matching is case sensitive.
Example : Using a Parameter of "Sample Data" and a Replacement set to "New Value", a component field with a value of "Sample Data X" would yield a composite field with a value of "New Value X".
Fill (Pad)
| Attribute | Options | Description |
| Scope | From left side | Inserts the Replacement character(s) on the left side of the field. |
| From right side | Inserts the Replacement character(s) on the right side of the field. | |
| Parameter(s) | N/A | |
| Replacement | Enter the character(s) to apply according to the selected Scope. |
Scopes of From left side and From right side will pad the value of the component field with the Replacement value if the field value does not fill the entire length. The Replacement value will fill the remaining space one or more times until the remaining space is less than the length of replacement value.
Example: For a component field with a length of 20 characters and a value of "Sample Data", using a Scope of From left side and a Replacement of "123" will yield a composite field with a value of "Sample Data123123123", while a Replacement of "123456" with the same Scope will yield a composite field with a value of "Sample Data123456".
Add
| Attribute | Options | Description |
| Scope | Prepended | Inserts the Replacement character(s) at the beginning of the field. |
| Appended | Inserts the Replacement character(s) at the end of the field. | |
| Parameter(s) | N/A | |
| Replacement | Enter the character(s) to apply according to the selected Scope. |
Scopes of Prepended and Appended will add the specified Parameter to the beginning or end of the field value. The added string occurs independent of the length of the field.
Example: For a component field with a value of "Sample Data", using a Scope of Appended and a Replacement of "(Added Text)"will yield a composite field with a value of "Sample Data(Added Text)".