Dataset - Rename column

Declaration

<AMDATASET ACTIVITY="rename_column" DATASET="text" COLUMNBY="text (options)" COLUMN="text" NEWCOLUMNNAME="text" />

Related Topics   

Description

Renames a column in a dataset.

Practical usage

Used to rename a column in a dataset.

IMPORTANT: Some column names may contain special characters (for example, !-()@#). In this scenario, you must manually add a bracket notation to the column name for the Task Builder to interpret it correctly. For example, %DatasetName.[File_Size_(MB)]%.

Parameters

General

Property Type Required Default Markup Description
Dataset name Text Yes (Empty) DATASET="Customers" Specifies the dataset to rename the column in.
Select by Text (options) Yes Column name
  • COLUMNBY="name"
  • COLUMNBY="index"
 Specifies how to identify the column to rename. The options are:
  • Column name (default) - Identifies the column to rename by column name.
  • Column index - Identifies the column to rename by column index number.
Column name Text Yes, if Select by is set to Column name (Empty) COLUMN="Status" The name of the column to rename. This parameter is required if the Select by parameter is set to Column name.
NOTE: All available columns stored in the dataset will automatically appear in the Column name box after the selected dataset has been run at least once in the Task Builder.
Column index Text Yes, if Select by is set to Column index (Empty) COLUMN="5" The column index number of the column to rename. This parameter is required if the Select by parameter is set to Column index.
NOTE: The column index number entered must be greater than 0.
New column name Text Yes (Empty) NEWCOLUMNNAME="Product Status" The new name for the column.

Description

Error Causes

On Error

Examples

NOTE:
  • Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
  • To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.

Example 1

This task uses the Create and Insert Row Dataset activities to create a dataset with three columns and three rows, and then renames the heading1 column as Column1.

Copy 
<AMDATASET RESULTDATASET="myDataset" COLUMNS="heading1;heading2;heading3" DELIMITER="semi_colon" DESCRIPTION="This is user input description showing in variables panel of Task Builder" />
<AMDATASET ACTIVITY="insert_row" DATASET="myDataset" ROWLOCATION="end"><COLUMNSETTER COLUMNNAME="heading1" VALUE="Row 1" /><COLUMNSETTER COLUMNNAME="heading2" VALUE="value2" /><COLUMNSETTER COLUMNNAME="heading3" VALUE="value3" /></AMDATASET>
<AMDATASET ACTIVITY="insert_row" DATASET="myDataset" ROWLOCATION="end"><COLUMNSETTER COLUMNNAME="heading1" VALUE="Row2" /><COLUMNSETTER COLUMNNAME="heading2" VALUE="value2" /><COLUMNSETTER COLUMNNAME="heading3" VALUE="value3" /></AMDATASET>
<AMDATASET ACTIVITY="insert_row" DATASET="myDataset" ROWLOCATION="end"><COLUMNSETTER COLUMNNAME="heading1" VALUE="Row3" /><COLUMNSETTER COLUMNNAME="heading2" VALUE="value2" /><COLUMNSETTER COLUMNNAME="heading3" VALUE="value3" /></AMDATASET>
<AMDATASET ACTIVITY="rename_column" DATASET="myDataset" COLUMNBY="name" COLUMN="heading1" NEWCOLUMNNAME="Column1" />

Example 2

This task uses the Create and Insert Row Dataset activities to create a dataset with three columns and three rows, and then renames the first column as Column1.

Copy 
<AMDATASET RESULTDATASET="myDataset" COLUMNS="heading1;heading2;heading3" DELIMITER="semi_colon" DESCRIPTION="This is user input description showing in variables panel of Task Builder" />
<AMDATASET ACTIVITY="insert_row" DATASET="myDataset" ROWLOCATION="end"><COLUMNSETTER COLUMNNAME="heading1" VALUE="Row 1" /><COLUMNSETTER COLUMNNAME="heading2" VALUE="value2" /><COLUMNSETTER COLUMNNAME="heading3" VALUE="value3" /></AMDATASET>
<AMDATASET ACTIVITY="insert_row" DATASET="myDataset" ROWLOCATION="end"><COLUMNSETTER COLUMNNAME="heading1" VALUE="Row2" /><COLUMNSETTER COLUMNNAME="heading2" VALUE="value2" /><COLUMNSETTER COLUMNNAME="heading3" VALUE="value3" /></AMDATASET>
<AMDATASET ACTIVITY="insert_row" DATASET="myDataset" ROWLOCATION="end"><COLUMNSETTER COLUMNNAME="heading1" VALUE="Row3" /><COLUMNSETTER COLUMNNAME="heading2" VALUE="value2" /><COLUMNSETTER COLUMNNAME="heading3" VALUE="value3" /></AMDATASET>
<AMDATASET ACTIVITY="rename_column" DATASET="myDataset" COLUMNBY="index" COLUMN="1" NEWCOLUMNNAME="Column1" />