|
|
Dataset - Rename column |
Declaration
<AMDATASET ACTIVITY="rename_column" DATASET="text" COLUMNBY="text (options)" COLUMN="text" NEWCOLUMNNAME="text" />
Description
Renames a column in a dataset.
Practical Usage
Used to rename a column in a dataset.
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 |
|
Specifies how to identify the column to rename. The options are:
|
| 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 drop-down combo 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. |
Examples
NOTE:
- The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
- Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.
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" />