From 4d16789f799560ed3276543290b8f6db48fc2cd6 Mon Sep 17 00:00:00 2001 From: Tristan Huet Date: Thu, 28 Sep 2023 18:56:03 +0200 Subject: [PATCH] docs: add documentation of new parameter option shouldRenameFileOnUpload --- doc/scenarioParametersConfiguration.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/doc/scenarioParametersConfiguration.md b/doc/scenarioParametersConfiguration.md index 5673b7e0a..f25ef5ea0 100644 --- a/doc/scenarioParametersConfiguration.md +++ b/doc/scenarioParametersConfiguration.md @@ -123,7 +123,14 @@ information about it in the `options` field of the parameter description: - `connectorId`: the connector id to use in the dataset object that will be created with the Cosmo Tech API - `description`: the description to use in the dataset object that will be created with the Cosmo Tech API -Also, if you want to have a default file present when creating a new scenario, you can provide the id of an existing +When files uploaded by webapp users are sent to the back-end to be stored (for example in Azure Storage), the original +file name is preserved. This behavior can be inconvenient when writing the parameters handler of your solution. If you +want to have more predictable names for the files uploaded with the webapp, you can enable the option +`options.shouldRenameFileOnUpload` to force the renaming of files uploaded by users before they are sent to the +back-end. When this option is enabled, a new file name is generated by concatenating the parameter id with the extension +of the uploaded file (e.g._initial_stock_dataset.csv_) + +Finally, if you want to have a default file present when creating a new scenario, you can provide the id of an existing dataset in the `defaultValue` property. Example: @@ -140,6 +147,7 @@ parameters: connectorId: 'c-d7e5p9o0kjn9' description: 'Initial stock dataset part' defaultFileTypeFilter: '.zip,.csv,.json,.xls,.xlsx' + shouldRenameFileOnUpload: true ``` ### Table parameters