Append Fields Tool
One Tool Example
Append Fields has a One Tool Example. Visit Sample Workflows to learn how to access this and many other examples directly in Alteryx Designer.
Use Append Fields to append the fields of one small input (Source) to every record of another larger input (Target). The result is a Cartesian join. In a Cartesian join, every row from one table is joined to every row of another table. For example, if table A has 100 rows, and table B has 1,000 rows, the Cartesian join of these two tables results in 100,000 rows.
The Append Fields tool accepts 2 inputs:
- T anchor (Target): The larger data stream that records are appended to.
- S anchor (Source): The smaller data stream that provides the records that are added to the Target stream.
For example, Target (T) input contains 16 records with 5 data fields, and Source (S) contains 5 records with 3 fields. The output generated from the Append Fields contains 80 records with 8 fields.
Configure the Tool
Use the table in the Configuration window to modify the incoming data stream. Each row in the table represents a column in your data. The Field column in the table identifies the name of each column in the data and auto-sizes to fit column (field) names without cutting off any text (up to 40 characters).
Before you start updating your fields (columns), you might want to limit your list so that you can perform updates on only a subset of the fields. This is also really helpful if your dataset contains many fields.
To do this, you can use the Search box at the top of the Configuration window. Enter a keyword and the Append Fields tool searches the Field, Rename, and Description columns to return matches. The search is not case-sensitive.
You can then perform various actions (like select, deselect, rename, etc.) on only the fields that were returned via your search. Think of the Search box as a way to filter your list of fields so that you can update only a subset of your data columns.
To view your entire list of fields again, use the "x" icon to clear out the Search box.
After you perform a search, only a subset of your data fields (columns) display. Please note that depending on what action you chose in the Options menu...
- Some actions might apply to only fields shown.
- Some actions might apply to all fields, regardless of which ones are shown
- Some actions might only apply to the specific fields that are selected (highlighted) in the list of fields.
Because of this, please use caution when you perform actions on a subset of fields and double-check the results to make sure they are what you're expecting.
Select, Deselect, Sort, and Reorder Columns
Select and Deselect Fields/Columns
To include a column in the dataset, check the check box to the left of the column name. Uncheck the check box to exclude the column. You can also use the select and deselect all check box at the top of the table to quickly select and deselect all visible fields.
To sort the columns of data based on the column name...
- Click on the column name to sort in ascending order.
- Click on the column name a second time to sort in descending order.
Depending on the language of your Designer instance, a different default sort order might be used. Consult the Localization User Settings to read more about the default Sort Method.
To reorder the columns of data...
- Select to highlight a row, or select and drag to highlight multiple rows.
- Use the Move Up or Move Down arrows, or right-click and drag, to move the rows to a new location.
The Unknown column is selected by default. It allows new columns in the data. Move the column to the location where you want a new column to be.
Modify Data Type and Size
Use the Type dropdown to change the data type of a column in your dataset.
To change the supported length (characters for string and numeric fixed decimal types) or measurement (bytes for other numeric types) of data in a column, select Size and enter a number. Size varies by data type and you can edit it for fixed decimal numeric types and all string types.
Use the [data type]: Forced option to ensure a column always contains the expected data type. This is helpful when creating macros.
Rename a Column or Add a Description
- To change the name of a column, select the Rename field and enter the new name.
- To add a description, select the Description field and enter a description.
View More Options
After you select or highlight rows (columns of data) in the table, select the Options dropdown above the table to view more configuration options:
- Save/Load: Save Field Configuration as a .yxft file. The Alteryx Field Type File is a text file that can be used in other workflows using the Load Field Names or Load Field Names & Types options.
- Select: Select or deselect all or highlight columns. Options include Select All and Deselect All.
- Change Field Type of Highlighted Fields: Change the data type of all highlighted columns at once.
- Sort: Sort the column order in ascending or descending order. Options include Sort on Original Field Name, Sort on New Field Name, and Sort on Field Type, or Revert to Incoming Field Order. Depending on the language of your Designer instance, a different default sort order might be used. Consult the Localization User Settings to read more about the default Sort Method.
- Move: Move highlighted columns to the top or bottom of the list.
- Add Prefix to Field Names: Add a prefix to the selected or highlighted column name.
- Add Suffix to Field Names: Add a suffix to the selected or highlighted column name.
- Remove Prefix or Suffix: Remove the prefix or suffix from the selected or highlighted column name.
- Clear All Renames: Remove the new name for all columns.
- Clear Highlighted Renames: Remove the new name for all highlighted columns.
- Revert All to Original Type & Size: Undo all changes to type and size in all columns and use the original values.
- Revert Highlighted to Original Type & Size: Undo changes to type and size in the selected or highlighted columns and use the original values.
- Forget All Missing Fields: Remove all columns that are no longer included in the data.
- Forget Highlighted Missing Fields: Remove all highlighted columns that are no longer included in the data.
- Deselect Duplicate Fields: Deselect the second column when duplicate column names exist. This option is only available with multiple inputs.
Warn/Error on Too Many Records Being Generated
Since the Append Fields tool performs a Cartesian join, you can unintentionally produce an excessive amount of records. You can configure warnings or errors to be reported to ensure that too many records are not produced.
- Allow All Appends: All records will be appended to all records with no error or warning.
- Warn on appends of more than 16 Records: If more than 16 records are in the Source file (S input) a warning is reported and the workflow continues processing.
- Error on appends of more than 16 Records: If more than 16 records are in the Source file (S input) an error is reported and the workflow stops processing.