Skip to content

UpdateCell.md

Latest commit

 

History

History
68 lines (48 loc) · 2.25 KB

UpdateCell.md

File metadata and controls

68 lines (48 loc) · 2.25 KB
Raw

Update Cell

Update Cell

Overview

Creates an independent copy of the record with the specified cell updated. The original record remains unchanged. The target cell can be identified either by its column header name or by its zero-based column index.

Parameters

1. inputRecord (VARIABLE)

  • Label: Base record
  • Description: The source record to copy and update.
  • Required: Yes
  • Default: None
  • Constraints: Variable type: Record

2. selectMethod (SELECT)

  • Label: Select column by
  • Description: Column whose value is to be updated.
  • Required: Yes
  • Default: name
  • Constraints: None
  • Options:
    • name (label "Header"): Identify the column by its header name.
    • index (label "Index"): Identify the column by its zero-based numeric index.

2.1.1 colName (TEXT) (applicable when selectMethod is name)

  • Label: Column header
  • Description: The header name of the column whose cell value is to be updated.
  • Required: Yes
  • Default: None
  • Constraints: None

2.1.2 caseSensitive (BOOLEAN) (applicable when selectMethod 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 colIndex (NUMBER) (applicable when selectMethod 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. newValue (VARIABLE)

  • Label: New value of cell
  • Description: The new value to place in the identified cell.
  • Required: Yes
  • Default: None
  • Constraints: None

Output

Returns a RECORD containing an independent copy of the record with the updated cell value.

Exceptions

Throws BotCommandException when the specified column cannot be found by name or index, or on any other internal failure.