From 90691a2f03e1d3126f0b1ebdefac17da47802b09 Mon Sep 17 00:00:00 2001 From: Satvik Patil Date: Wed, 5 Aug 2026 15:06:08 +0530 Subject: [PATCH 01/12] Mandatory configuration.json --- examples/quickstart/configuration_form/configuration.json | 1 + 1 file changed, 1 insertion(+) create mode 100644 examples/quickstart/configuration_form/configuration.json diff --git a/examples/quickstart/configuration_form/configuration.json b/examples/quickstart/configuration_form/configuration.json new file mode 100644 index 000000000..9e26dfeeb --- /dev/null +++ b/examples/quickstart/configuration_form/configuration.json @@ -0,0 +1 @@ +{} \ No newline at end of file From eb52a6b8026a166fecb35a5b14c54648a51dcb12 Mon Sep 17 00:00:00 2001 From: Satvik Patil Date: Thu, 13 Aug 2026 16:52:28 +0530 Subject: [PATCH 02/12] README change --- examples/quickstart/configuration_form/README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/examples/quickstart/configuration_form/README.md b/examples/quickstart/configuration_form/README.md index b3108d505..10cbca195 100644 --- a/examples/quickstart/configuration_form/README.md +++ b/examples/quickstart/configuration_form/README.md @@ -4,7 +4,7 @@ This example demonstrates how to define a connector setup form using `ConfigurationForm`, `form_field`, and `Test` from the Fivetran Connector SDK. It covers plain text, password, dropdown, and toggle fields, including dropdown options with labels and descriptions. It also shows how to register a connection test that Fivetran runs when the user clicks **Test Connection** during setup. -The API fields (`api_base_url`, `api_key`) in the configuration form illustrate how a real connector would collect connection details. The `configuration.json` file provided contains sample values for running the connector locally. +The API fields (`api_base_url`, `api_key`) in the configuration form illustrate how a real connector would collect connection details. An empty `configuration.json` file is included as a placeholder — you can populate it by running `fivetran configuration` or by providing values through the Fivetran UI after deployment. Refer to `def configuration_form()` and `def connection_test()` in `connector.py` for the main setup form and test implementation. @@ -50,6 +50,11 @@ For available CLI commands, refer to the [Connector SDK Commands](https://fivetr fivetran debug --configuration configuration.json ``` +> **Note**: The `configuration.json` file is **mandatory** when deploying the connector using `fivetran deploy`. You have two options: +> +> - **Option 1**: If you don't have credentials yet, include an empty `configuration.json` file (or one with placeholder values) in your deployment. You can then provide the actual values through the Fivetran UI setup form after deployment. +> - **Option 2**: If you have credentials, run `fivetran configuration` to interactively populate the `configuration.json` file with real values, then deploy using `fivetran deploy`. + ## Features - Demonstrates form field types: `TextField` (plain text and password variants), `DropdownField`, and `ToggleField` From 6c80bea6df4ecc4a79ea204495bf1901499b0018 Mon Sep 17 00:00:00 2001 From: Satvik Patil Date: Thu, 13 Aug 2026 17:22:36 +0530 Subject: [PATCH 03/12] Tweak statement --- examples/quickstart/configuration_form/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/examples/quickstart/configuration_form/README.md b/examples/quickstart/configuration_form/README.md index 10cbca195..7760ac647 100644 --- a/examples/quickstart/configuration_form/README.md +++ b/examples/quickstart/configuration_form/README.md @@ -50,10 +50,10 @@ For available CLI commands, refer to the [Connector SDK Commands](https://fivetr fivetran debug --configuration configuration.json ``` -> **Note**: The `configuration.json` file is **mandatory** when deploying the connector using `fivetran deploy`. You have two options: +> **Note**: A `configuration.json` file is required when deploying the connector using `fivetran deploy`. See the [configuration resolution order](https://fivetran.com/docs/connector-sdk/connector-development-and-configuration/configuration-json#configurationresolutionorder) documentation for details. You have two options: > -> - **Option 1**: If you don't have credentials yet, include an empty `configuration.json` file (or one with placeholder values) in your deployment. You can then provide the actual values through the Fivetran UI setup form after deployment. -> - **Option 2**: If you have credentials, run `fivetran configuration` to interactively populate the `configuration.json` file with real values, then deploy using `fivetran deploy`. +> - **Option 1**: Deploy with an empty `configuration.json` file and provide values through the Fivetran UI setup form after deployment. +> - **Option 2**: Run `fivetran configuration` to populate the `configuration.json` file with values, then deploy using `fivetran deploy`. ## Features From 2713980849c43941d19656bb0634ca0616acc06d Mon Sep 17 00:00:00 2001 From: SatvikPatil <54502802+fivetran-satvikpatil@users.noreply.github.com> Date: Fri, 14 Aug 2026 17:20:21 +0530 Subject: [PATCH 04/12] Update examples/quickstart/configuration_form/README.md Co-authored-by: fivetran-chinmayichandrasekar --- examples/quickstart/configuration_form/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/examples/quickstart/configuration_form/README.md b/examples/quickstart/configuration_form/README.md index 7760ac647..870caceba 100644 --- a/examples/quickstart/configuration_form/README.md +++ b/examples/quickstart/configuration_form/README.md @@ -50,7 +50,11 @@ For available CLI commands, refer to the [Connector SDK Commands](https://fivetr fivetran debug --configuration configuration.json ``` -> **Note**: A `configuration.json` file is required when deploying the connector using `fivetran deploy`. See the [configuration resolution order](https://fivetran.com/docs/connector-sdk/connector-development-and-configuration/configuration-json#configurationresolutionorder) documentation for details. You have two options: +{% note %} +You can deploy this connector with: +- An empty `configuration.json` file. Configuration values are then provided through the Fivetran UI setup form after deployment. +- A pre-populated `configuration.json` file from running `fivetran configuration`. The setup form displays the values already filled in. +{% /note %} > > - **Option 1**: Deploy with an empty `configuration.json` file and provide values through the Fivetran UI setup form after deployment. > - **Option 2**: Run `fivetran configuration` to populate the `configuration.json` file with values, then deploy using `fivetran deploy`. From fa64d5ae7906e4946640892ebe00174a43bb0717 Mon Sep 17 00:00:00 2001 From: Satvik Patil Date: Fri, 14 Aug 2026 17:28:58 +0530 Subject: [PATCH 05/12] Requested changes --- examples/quickstart/configuration_form/README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/examples/quickstart/configuration_form/README.md b/examples/quickstart/configuration_form/README.md index 870caceba..20c93bc3c 100644 --- a/examples/quickstart/configuration_form/README.md +++ b/examples/quickstart/configuration_form/README.md @@ -4,7 +4,11 @@ This example demonstrates how to define a connector setup form using `ConfigurationForm`, `form_field`, and `Test` from the Fivetran Connector SDK. It covers plain text, password, dropdown, and toggle fields, including dropdown options with labels and descriptions. It also shows how to register a connection test that Fivetran runs when the user clicks **Test Connection** during setup. -The API fields (`api_base_url`, `api_key`) in the configuration form illustrate how a real connector would collect connection details. An empty `configuration.json` file is included as a placeholder — you can populate it by running `fivetran configuration` or by providing values through the Fivetran UI after deployment. +The API fields (`api_base_url`, `api_key`) in the configuration form illustrate how a real connector would collect connection details. + +{% note %} +This project includes an empty `configuration.json` because it is required during deployment. You can optionally populate it to test the setup form fields, then deploy with the pre-populated file so the values appear pre-filled in the setup form. +{% /note %} Refer to `def configuration_form()` and `def connection_test()` in `connector.py` for the main setup form and test implementation. @@ -32,7 +36,7 @@ Refer to the [Connector SDK Setup Guide](https://fivetran.com/docs/connector-sdk For available CLI commands, refer to the [Connector SDK Commands](https://fivetran.com/docs/connector-sdk/connector-development-and-configuration/connector-sdk-commands) reference. -1. Run the `fivetran configuration` command to interactively provide values for each form field. This generates (or overrides) a `configuration.json` file in the project directory. +1. Run the `fivetran configuration` command to interactively provide values for each form field. This overrides the `configuration.json` file in the project directory. ```bash fivetran configuration @@ -55,9 +59,6 @@ You can deploy this connector with: - An empty `configuration.json` file. Configuration values are then provided through the Fivetran UI setup form after deployment. - A pre-populated `configuration.json` file from running `fivetran configuration`. The setup form displays the values already filled in. {% /note %} -> -> - **Option 1**: Deploy with an empty `configuration.json` file and provide values through the Fivetran UI setup form after deployment. -> - **Option 2**: Run `fivetran configuration` to populate the `configuration.json` file with values, then deploy using `fivetran deploy`. ## Features From 5a0313fe4587dea79536bd9f895b9637845d4ee2 Mon Sep 17 00:00:00 2001 From: Satvik Patil Date: Mon, 17 Aug 2026 10:18:52 +0530 Subject: [PATCH 06/12] Doc change --- examples/quickstart/configuration_form/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/quickstart/configuration_form/README.md b/examples/quickstart/configuration_form/README.md index 20c93bc3c..9a9662621 100644 --- a/examples/quickstart/configuration_form/README.md +++ b/examples/quickstart/configuration_form/README.md @@ -7,7 +7,7 @@ This example demonstrates how to define a connector setup form using `Configurat The API fields (`api_base_url`, `api_key`) in the configuration form illustrate how a real connector would collect connection details. {% note %} -This project includes an empty `configuration.json` because it is required during deployment. You can optionally populate it to test the setup form fields, then deploy with the pre-populated file so the values appear pre-filled in the setup form. +This project includes an empty `configuration.json` because it is required during deployment. You can optionally populate it, then deploy with the pre-populated file so the values appear pre-filled in the setup form. {% /note %} Refer to `def configuration_form()` and `def connection_test()` in `connector.py` for the main setup form and test implementation. From 9030569421f96b939143fa53e6a70855c79d5aab Mon Sep 17 00:00:00 2001 From: Satvik Patil Date: Mon, 17 Aug 2026 10:22:50 +0530 Subject: [PATCH 07/12] NIT comment --- examples/quickstart/configuration_form/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/quickstart/configuration_form/README.md b/examples/quickstart/configuration_form/README.md index 9a9662621..844782cc4 100644 --- a/examples/quickstart/configuration_form/README.md +++ b/examples/quickstart/configuration_form/README.md @@ -7,7 +7,7 @@ This example demonstrates how to define a connector setup form using `Configurat The API fields (`api_base_url`, `api_key`) in the configuration form illustrate how a real connector would collect connection details. {% note %} -This project includes an empty `configuration.json` because it is required during deployment. You can optionally populate it, then deploy with the pre-populated file so the values appear pre-filled in the setup form. +This project includes an empty `configuration.json` because it is required during deployment. You can optionally populate it and then deploy with the pre-populated file so the values appear pre-filled in the setup form. {% /note %} Refer to `def configuration_form()` and `def connection_test()` in `connector.py` for the main setup form and test implementation. From 74c119e6998364bfed063f1b14d6a3c856b4f693 Mon Sep 17 00:00:00 2001 From: Satvik Patil Date: Mon, 17 Aug 2026 10:30:06 +0530 Subject: [PATCH 08/12] Doc change --- examples/quickstart/configuration_form/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/quickstart/configuration_form/README.md b/examples/quickstart/configuration_form/README.md index 844782cc4..b5d61af5e 100644 --- a/examples/quickstart/configuration_form/README.md +++ b/examples/quickstart/configuration_form/README.md @@ -55,7 +55,7 @@ For available CLI commands, refer to the [Connector SDK Commands](https://fivetr ``` {% note %} -You can deploy this connector with: +You can deploy this connector using one of these options: - An empty `configuration.json` file. Configuration values are then provided through the Fivetran UI setup form after deployment. - A pre-populated `configuration.json` file from running `fivetran configuration`. The setup form displays the values already filled in. {% /note %} From 38831a22b09bfaed356c29fd136fba6a5190a621 Mon Sep 17 00:00:00 2001 From: Satvik Patil Date: Mon, 17 Aug 2026 11:22:29 +0530 Subject: [PATCH 09/12] Review comment --- examples/quickstart/configuration_form/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/examples/quickstart/configuration_form/README.md b/examples/quickstart/configuration_form/README.md index b5d61af5e..a89358b32 100644 --- a/examples/quickstart/configuration_form/README.md +++ b/examples/quickstart/configuration_form/README.md @@ -6,6 +6,8 @@ This example demonstrates how to define a connector setup form using `Configurat The API fields (`api_base_url`, `api_key`) in the configuration form illustrate how a real connector would collect connection details. +For more details on creating configuration forms, refer to the [Setup Form](https://fivetran.com/docs/connector-sdk/technical-reference/connector-sdk-setup-form) documentation. + {% note %} This project includes an empty `configuration.json` because it is required during deployment. You can optionally populate it and then deploy with the pre-populated file so the values appear pre-filled in the setup form. {% /note %} @@ -57,7 +59,7 @@ For available CLI commands, refer to the [Connector SDK Commands](https://fivetr {% note %} You can deploy this connector using one of these options: - An empty `configuration.json` file. Configuration values are then provided through the Fivetran UI setup form after deployment. -- A pre-populated `configuration.json` file from running `fivetran configuration`. The setup form displays the values already filled in. +- A pre-populated `configuration.json` file (created either by running `fivetran configuration` or manually editing the file). The setup form displays the values already filled in. {% /note %} ## Features From 3c056a3fc002f6e2b653ffcb03e91a23abd87f2c Mon Sep 17 00:00:00 2001 From: Satvik Patil Date: Mon, 17 Aug 2026 12:43:31 +0530 Subject: [PATCH 10/12] Requested change --- examples/quickstart/configuration_form/README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/examples/quickstart/configuration_form/README.md b/examples/quickstart/configuration_form/README.md index a89358b32..c1386b9df 100644 --- a/examples/quickstart/configuration_form/README.md +++ b/examples/quickstart/configuration_form/README.md @@ -6,10 +6,8 @@ This example demonstrates how to define a connector setup form using `Configurat The API fields (`api_base_url`, `api_key`) in the configuration form illustrate how a real connector would collect connection details. -For more details on creating configuration forms, refer to the [Setup Form](https://fivetran.com/docs/connector-sdk/technical-reference/connector-sdk-setup-form) documentation. - {% note %} -This project includes an empty `configuration.json` because it is required during deployment. You can optionally populate it and then deploy with the pre-populated file so the values appear pre-filled in the setup form. +This project includes an empty `configuration.json` because it is required during deployment. You can optionally populate it and then deploy with the pre-populated file so the values appear pre-filled in the [setup form](https://fivetran.com/docs/connector-sdk/technical-reference/connector-sdk-setup-form). {% /note %} Refer to `def configuration_form()` and `def connection_test()` in `connector.py` for the main setup form and test implementation. From 8eedc2e5987b420865352f07f4c516b47293d81a Mon Sep 17 00:00:00 2001 From: Satvik Patil Date: Mon, 17 Aug 2026 12:57:16 +0530 Subject: [PATCH 11/12] Doc change --- examples/quickstart/configuration_form/README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/examples/quickstart/configuration_form/README.md b/examples/quickstart/configuration_form/README.md index c1386b9df..cc53cc022 100644 --- a/examples/quickstart/configuration_form/README.md +++ b/examples/quickstart/configuration_form/README.md @@ -6,9 +6,7 @@ This example demonstrates how to define a connector setup form using `Configurat The API fields (`api_base_url`, `api_key`) in the configuration form illustrate how a real connector would collect connection details. -{% note %} -This project includes an empty `configuration.json` because it is required during deployment. You can optionally populate it and then deploy with the pre-populated file so the values appear pre-filled in the [setup form](https://fivetran.com/docs/connector-sdk/technical-reference/connector-sdk-setup-form). -{% /note %} +>Note: This project includes an empty `configuration.json` because it is required during deployment. You can optionally populate it and then deploy with the pre-populated file so the values appear pre-filled in the [setup form](https://fivetran.com/docs/connector-sdk/technical-reference/connector-sdk-setup-form). Refer to `def configuration_form()` and `def connection_test()` in `connector.py` for the main setup form and test implementation. @@ -54,11 +52,10 @@ For available CLI commands, refer to the [Connector SDK Commands](https://fivetr fivetran debug --configuration configuration.json ``` -{% note %} -You can deploy this connector using one of these options: -- An empty `configuration.json` file. Configuration values are then provided through the Fivetran UI setup form after deployment. -- A pre-populated `configuration.json` file (created either by running `fivetran configuration` or manually editing the file). The setup form displays the values already filled in. -{% /note %} +> Note: You can deploy this connector using one of these options: +> - An empty `configuration.json` file. Configuration values are then provided through the Fivetran UI setup form after deployment. +> - A pre-populated `configuration.json` file (created either by running `fivetran configuration` or manually editing the file). The setup form displays the values already filled in. + ## Features From f81673b94d097ec2e0713b23394d7c4c87457271 Mon Sep 17 00:00:00 2001 From: Satvik Patil Date: Mon, 17 Aug 2026 12:59:33 +0530 Subject: [PATCH 12/12] NIT Comment --- examples/quickstart/configuration_form/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/quickstart/configuration_form/README.md b/examples/quickstart/configuration_form/README.md index cc53cc022..f57a1a1d2 100644 --- a/examples/quickstart/configuration_form/README.md +++ b/examples/quickstart/configuration_form/README.md @@ -6,7 +6,7 @@ This example demonstrates how to define a connector setup form using `Configurat The API fields (`api_base_url`, `api_key`) in the configuration form illustrate how a real connector would collect connection details. ->Note: This project includes an empty `configuration.json` because it is required during deployment. You can optionally populate it and then deploy with the pre-populated file so the values appear pre-filled in the [setup form](https://fivetran.com/docs/connector-sdk/technical-reference/connector-sdk-setup-form). +> Note: This project includes an empty `configuration.json` because it is required during deployment. You can optionally populate it and then deploy with the pre-populated file so the values appear pre-filled in the [setup form](https://fivetran.com/docs/connector-sdk/technical-reference/connector-sdk-setup-form). Refer to `def configuration_form()` and `def connection_test()` in `connector.py` for the main setup form and test implementation.