# ConvertToJSON Required Frends version: 5.5+ Required .NET version: 6.0 Compatible Agents: Crossplatform Source code: {% tabs %} {% tab title="Parameter: Input" %} | Name | Description | | --------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | Path : `String` |

Path to the Excel file.


Default: C:\tmp\ExcelFile.xlsx
Example: C:\tmp\ExcelFile.xlsx

| | {% endtab %} | | {% tab title="Parameter: Options" %} | Name | Description | | ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ReadOnlyWorkSheetWithName : `String` |

If empty, all work sheets are read.


Default: -
Example: Sheet1

| | UseNumbersAsColumnHeaders : `Boolean` |

If set to true, numbers will be used as column headers instead of letters (A = 1, B = 2...).


Default: false
Example: true

| | ThrowErrorOnFailure : `Boolean` |

Choose if exception should be thrown when conversion fails.


Default: true
Example: true

| | DateFormat : `DateFormats` |

Date format selection.

Possible values:

Date format selection.

Date format selection.

Date format selection.

Date format selection.


Default: 0
Example: DDMMYYYY

| | ShortDatePattern : `Boolean` |

If set to true, dates will exclude timestamps from dates.

Default false


Default: false
Example: true

| | {% endtab %} | | {% tab title="Result: Result" %} | Name | Description | | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Success : `Boolean` |

Indicates if the conversion was successful.
Example: true

| | ErrorMessage : `String` |

Exception message.
Example: An error occurred...

| | JSON : `String` |

Excel-conversion to JSON.
Example: "{"workbook":{"workbook\_name":"ExcelTestInput2.xls","worksheet":{"name":"Sheet1","rows":\[{"RowNumber":1,"Cells":\[{"ColumnName":"A","ColumnIndex":1,"ColumnValue":"Foo"},{"ColumnName":"B","ColumnIndex":2,"ColumnValue":"Bar"},{"ColumnName":"C","ColumnIndex":3,"ColumnValue":"Kanjiċƒ"},{"ColumnName":"D","ColumnIndex":4,"ColumnValue":"Summa"}]}]}}}"

| | {% endtab %} | | {% tab title="Changelog" %} ## Changelog ### \[2.2.0] - 2026-01-22 #### Changed * Open Excel files with FileAccess.Read to support read-only files ### \[2.1.0] - 2024-08-21 #### Changed * Updated the Newtonsoft.Json package to the latest version. ### \[2.0.0] - 2023-03-21 #### Changed * Change how the Json is constructed. * Added CancellationToken to the Task. * Refactored code to be more simple. * Added two helper classes Row and Cell. ### \[1.0.1] - 2022-08-02 #### Changed * Updated the documentation with better descriptions and examples. #### Fixed * Nuget package should not contain the FrendsTasksMetadata.json files. ### \[1.0.0] - 2022-03-03 #### Added * Initial implementation {% endtab %} {% endtabs %}