RPA.Tables

The values can either be a list of values, one for each row, or one single value that is set for all rows.

Examples:

*** Tasks ***
# Add empty column
Add table column    ${table}

# Add empty column with name
Add table column    ${table}    name=Home Address

# Add new column where every every row has the same value
Add table column    ${table}    name=TOS    values=${FALSE}

# Add new column where every row has a unique value
${is_first}=    Create list    ${TRUE}    ${FALSE}    ${FALSE}
Add table column    ${table}    name=IsFirst    values=${is_first}

The values can either be a list of values, or a dictionary where the keys match current column names. Values for unknown keys are discarded.

It can also be a single value that is set for all columns, which is None by default.

Example:s

*** Tasks ***
# Add empty row
Add table row    ${table}

# Add row where every column has the same value
Add table row    ${table}    Unknown

# Add values per column
${values}=    Create dictionary    Username=Mark    Mail=mark@robocorp.com
Add table row    ${table}    ${values}

Data can be a combination of various iterable containers, e.g. list of lists, list of dicts, dict of lists.

See the main library documentation for more information about supported data types.

Examples

*** Tasks ***
${orders}=       Read worksheet as table    orders.xlsx
Sort table by column    ${orders}    CustomerId
${export}=       Export table    ${orders}
# The following keyword expects a dictionary:
Write as JSON    ${export}

Remove all rows from a table which have only None values.

The filtering will be done in-place.

Examples

*** Tasks ***
${table}=    Read worksheet as table    orders.xlsx
Filter empty rows    ${table}

Remove all rows where column values don't match the given condition.

See the keyword Find table rows for all supported operators and their descriptions.

The filtering will be done in-place.

Examples:

*** Tasks ***
# Only accept prices that are non-zero
Filter table by column    ${table}   price  !=  ${0}

# Remove uwnanted product types
@{types}=    Create list    Unknown    Removed
Filter table by column    ${table}   product_type  not in  ${types}

Find all rows in a table which match a condition for a given column.

Supported operators:

Returns the matches as a new Table instance.

Examples:

*** Tasks ***
# Find all rows where price is over 200
@{rows}=    Find table rows    Price  >  ${200}

# Find all rows where the status does not contain "removed"
@{rows}=    Find table rows    Status    not contains    removed

Examples:

*** Tasks ***
# Get the value in the first row and first column
Get table cell    ${table}    0    0

# Get the value in the last row and first column
Get table cell    ${table}   -1    0

# Get the value in the third row and column "Name"
Get table cell    ${table}    2    Name

Examples

*** Tasks ***
${emails}=    Get table column    ${users}    E-Mail Address
FOR    ${email}    IN    @{emails}
    Send promotion    ${email}
END

Examples:

*** Tasks ***
${rows}  ${columns}=    Get table dimensions    ${table}
Log    Table has ${rows} rows and ${columns} columns.

Examples:

*** Tasks ***
${first}=    Get table row    ${orders}
Log     Handling order: ${first}[Order ID]

${row}=      Get table row    ${data}    -1    as_list=${TRUE}
FOR    ${value}    IN    @{row}
    Log    Data point: ${value}
END

If start is not defined, starts from the first row. If end is not defined, stops at the last row.

Examples:

*** Tasks ***
# Get all rows except first five
${slice}=    Get table slice    ${table}    start=5

# Get rows at indexes 5, 6, 7, 8, and 9
${slice}=    Get table slice    ${table}    start=5    end=10

# Get all rows except last five
${slice}=    Get table slice    ${table}    end=-5

Group a table by column and return a list of grouped Tables.

Examples

*** Tasks ***
${orders}=    Read worksheet as table    orders.xlsx
@{groups}=    Group table by column    ${orders}    customer
FOR    ${group}    IN    @{groups}
    # Process all orders for the customer at once
    Process order    ${group}
END

By default rows from all tables are appended one after the other. Optionally a column name can be given with index, which is used to merge rows together.

Examples

For instance, a name column could be used to identify unique rows and the merge operation should overwrite values instead of appending multiple copies of the same name.

*** Tasks ***
${products}=    Merge tables    ${prices}    ${stock}    index=Name
FOR    ${product}    IN    @{products}
    Log many
    ...    Product: ${product}[Name]
    ...    Price: ${product}[Price]
    ...    Stock: ${product}[Stock]
END

Examples:

*** Tasks ***
# Remove column from table and discard it
Pop table column    ${users}   userId

# Remove column from table and iterate over it
${ids}=    Pop table column    ${users}    userId
FOR    ${id}    IN    @{ids}
    Log    User id: ${id}
END

Examples:

*** Tasks ***
${first}=    Pop table row    ${orders}
Log     Handling order: ${first}[Order ID]

${row}=      Pop table row    ${data}    -1    as_list=${TRUE}
FOR    ${value}    IN    @{row}
    Log    Data point: ${value}
END

By default attempts to deduce the CSV format and headers from a sample of the input file. If it's unable to determine the format automatically, the dialect and header will have to be defined manually.

Valid dialect values are excel, excel-tab, and unix, and header is boolean argument (True/False). Optionally a set of valid delimiters can be given as a string.

The columns argument can be used to override the names of columns in the resulting table. The amount of columns must match the input data.

If the source data has a header and rows have more fields than the header defines, the remaining values are put into the column given by column_unknown. By default it has the value "Unknown".

Examples:

*** Tasks ***
# Source dialect is deduced automatically
${table}=    Read table from CSV    export.csv
Log   Found columns: ${table.columns}

# Source dialect is known and given explicitly
${table}=    Read table from CSV    export-excel.csv    dialect=excel
Log   Found columns: ${table.columns}

Renames columns in the Table with given values. Columns with name as None will use the previous value.

The renaming will be done in-place.

Examples:

*** Tasks ***
${columns}=    Create list   First  Second  Third
Rename table columns    ${table}    ${columns}
# First, Second, Third


${columns}=    Create list   Uno  Dos
Rename table columns    ${table}    ${columns}
# Uno, Dos, Third

Examples:

*** Tasks ***
${table}=    Read table from CSV    data.csv
Set row as column names    ${table}    0

Examples:

*** Tasks ***
# Set the value in the first row and first column to "First"
Set table cell    ${table}    0    0       First

# Set the value in the last row and first column to "Last"
Set table cell    ${table}   -1    0       Last

# Set the value in the third row and column "Name" to "Unknown"
Set table cell    ${table}    2    Name    Unknown

The values can either be a list of values, one for each row, or one single value that is set for all rows.

Examples:

*** Tasks ***
# Set different value for each row (sizes must match)
${ids}=    Create list    1  2  3  4  5
Set table column    ${users}    userId    ${ids}

# Set the same value for all rows
Set table column    ${users}    email     ${NONE}

The values can either be a list of values, or a dictionary where the keys match current column names. Values for unknown keys are discarded.

It can also be a single value that is set for all columns.

Examples:

*** Tasks ***
${columns}=  Create list     One  Two  Three
${table}=    Create table    columns=${columns}

${values}=   Create list     1  2  3
Set table row    ${table}    0    ${values}

${values}=   Create dictionary    One=1  Two=2  Three=3
Set table row    ${table}    1    ${values}

Set table row    ${table}    2    ${NONE}

Sort a table in-place according to column.

Examples

*** Tasks ***
${orders}=    Read worksheet as table    orders.xlsx
Sort table by column    ${orders}    order_date

Return first count rows from a table.

Examples:

*** Tasks ***
# Get the first 10 employees
${employees}=    Read worksheet as table    employees.xlsx
${first}=        Table head    ${employees}    10

Return last count rows from a table.

Examples:

*** Tasks ***
# Get the last 10 orders
${orders}=    Read worksheet as table    orders.xlsx
${latest}=    Table tail    ${orders}    10

The filtering will be done in-place.

Examples

*** Tasks ***
${table}=    Read table from CSV    data.csv
Log    ${table.columns}  # "One", "Two ", "  Three "
Trim column names     ${table}
Log    ${table-columns}  # "One", "Two", "Three"

Remove all rows from the end of a table which have only None as values.

The filtering will be done in-place.

Examples

*** Tasks ***
${table}=    Read worksheet as table    orders.xlsx
Trim empty rows    ${table}

Valid dialect values are Excel, ExcelTab, and Unix.

Examples

*** Tasks ***
${sheet}=    Read worksheet as table    orders.xlsx    header=${TRUE}
Write table to CSV    ${sheet}    output.csv