Skip to content

ConvertTableToDictionary.md

Latest commit

 

History

History
95 lines (69 loc) · 3.44 KB

ConvertTableToDictionary.md

File metadata and controls

95 lines (69 loc) · 3.44 KB
Raw

Convert Table To Dictionary

Convert Table To Dictionary

Overview

Converts table column data to key-value pairs. One column provides the keys and another provides the values; repeated keys will be overwritten.

Parameters

1. inputTable (VARIABLE)

  • Label: Base table
  • Description: Table whose columns are to be saved as key-value pair.
  • Required: Yes
  • Default: None
  • Constraints: Variable type: Table

2. keySelectMethod (SELECT)

  • Label: Select key column by
  • Description: Column whose value is to be saved as keys of dictionary.
  • Required: Yes
  • Default: NAME
  • Constraints: None
  • Options:
    • NAME (label "Header"): Select the key column by its header name.
    • INDEX (label "Index"): Select the key column by its numeric index.

2.1.1 keyColNameInput (TEXT) (applicable when keySelectMethod is NAME)

  • Label: Column header
  • Description: The header name of the column to use as dictionary keys.
  • Required: Yes
  • Default: None
  • Constraints: None

2.1.2 keyColCaseSensitive (BOOLEAN) (applicable when keySelectMethod is NAME)

  • Label: Case-sensitive comparison
  • Description: Controls whether column name comparison should be case-sensitive. When false (default): Case-insensitive (e.g., 'Name' matches 'name', 'NAME'). When true: Case-sensitive (e.g., 'Name' does not match 'name').
  • Required: Yes
  • Default: false
  • Constraints: None

2.2.1 keyColIndexInput (NUMBER) (applicable when keySelectMethod is INDEX)

  • Label: Column index
  • Description: Index numbers start with 0. For example, first column has an index of 0.
  • Required: Yes
  • Default: None
  • Constraints: Must be greater than or equal to 0; must be an integer

3. valueSelectMethod (SELECT)

  • Label: Select value column by
  • Description: Column whose value is to be saved as values of dictionary.
  • Required: Yes
  • Default: NAME
  • Constraints: None
  • Options:
    • NAME (label "Header"): Select the value column by its header name.
    • INDEX (label "Index"): Select the value column by its numeric index.

3.1.1 valueColNameInput (TEXT) (applicable when valueSelectMethod is NAME)

  • Label: Column header
  • Description: The header name of the column to use as dictionary values.
  • Required: Yes
  • Default: None
  • Constraints: None

3.1.2 valueColCaseSensitive (BOOLEAN) (applicable when valueSelectMethod is NAME)

  • Label: Case-sensitive comparison
  • Description: Controls whether column name comparison should be case-sensitive. When false (default): Case-insensitive (e.g., 'Name' matches 'name', 'NAME'). When true: Case-sensitive (e.g., 'Name' does not match 'name').
  • Required: Yes
  • Default: false
  • Constraints: None

3.2.1 valColIndexInput (NUMBER) (applicable when valueSelectMethod is INDEX)

  • Label: Column index
  • Description: Index numbers start with 0. For example, first column has an index of 0.
  • Required: Yes
  • Default: None
  • Constraints: Must be greater than or equal to 0; must be an integer

Output

Returns a DICTIONARY with keys from the key column values and values from the value column values.

Exceptions

Throws BotCommandException when the key or value column is not found, or on any other internal failure.