> ## Documentation Index
> Fetch the complete documentation index at: https://docs.maia.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Dynamics 365 Business Central

export const maia = "Maia";

export const designer = "Designer";

export const ComponentMetadata = ({warehouses, unsupportedWarehouses = [], componentType, connectionInputs, connectionOutputs}) => {
  const allWarehouses = [...warehouses.map(w => ({
    name: w,
    supported: true
  })), ...unsupportedWarehouses.map(w => ({
    name: w,
    supported: false
  }))];
  return <div style={{
    background: 'var(--colors-background-light, #f9fafb)',
    border: '1px solid var(--colors-border-default, #e5e7eb)',
    borderRadius: '12px',
    padding: '20px 28px',
    marginBottom: '28px',
    boxShadow: '0 1px 4px rgba(0,0,0,0.10)'
  }}>
      <table style={{
    width: '100%',
    borderCollapse: 'collapse'
  }}>
        <tbody>
          <tr>
            <td style={{
    fontWeight: '600',
    paddingRight: '32px',
    paddingBottom: '14px',
    whiteSpace: 'nowrap',
    verticalAlign: 'middle',
    width: '180px'
  }}>Project Availability</td>
            <td style={{
    paddingBottom: '14px',
    verticalAlign: 'middle'
  }}>
              <div style={{
    display: 'flex',
    flexWrap: 'wrap',
    gap: '8px'
  }}>
                {allWarehouses.map((w, i) => <span key={i} style={{
    background: w.supported ? '#dcfce7' : '#fee2e2',
    color: w.supported ? '#15803d' : '#b91c1c',
    border: `1px solid ${w.supported ? '#bbf7d0' : '#fca5a5'}`,
    borderRadius: '9999px',
    padding: '3px 12px',
    fontSize: '0.85rem',
    fontWeight: '500',
    whiteSpace: 'nowrap'
  }}>
                    {w.name} {w.supported ? '✅' : '❌'}
                  </span>)}
              </div>
            </td>
          </tr>
          <tr>
            <td style={{
    fontWeight: '600',
    paddingRight: '32px',
    paddingBottom: '14px',
    whiteSpace: 'nowrap',
    verticalAlign: 'middle'
  }}>Component Type</td>
            <td style={{
    paddingBottom: '14px',
    verticalAlign: 'middle'
  }}>{componentType}</td>
          </tr>
          <tr>
            <td style={{
    fontWeight: '600',
    paddingRight: '32px',
    paddingBottom: '14px',
    whiteSpace: 'nowrap',
    verticalAlign: 'middle'
  }}>Connection Inputs</td>
            <td style={{
    paddingBottom: '14px',
    verticalAlign: 'middle'
  }}>{connectionInputs}</td>
          </tr>
          <tr>
            <td style={{
    fontWeight: '600',
    paddingRight: '32px',
    whiteSpace: 'nowrap',
    verticalAlign: 'middle'
  }}>Connection Outputs</td>
            <td style={{
    verticalAlign: 'middle'
  }}>{connectionOutputs}</td>
          </tr>
        </tbody>
      </table>
    </div>;
};

<ComponentMetadata warehouses={["Snowflake", "Databricks", "Amazon Redshift", "Google BigQuery"]} unsupportedWarehouses={[]} componentType="Connector, Orchestration" connectionInputs="One" connectionOutputs="Unlimited" />

This page describes how to configure the Dynamics 365 Business Central connector component as part of a data pipeline within {designer}. The Dynamics 365 Business Central component uses the Connect and Configure parameters to create a table of Dynamics 365 Business Central data, which is then stored in your preferred storage location (Snowflake, Databricks, Amazon Redshift, or cloud storage). You *do not* need to use the Create Table component when using this connector, as the Dynamics 365 Business Central component will create a new table or replace an existing table for you using the Destination parameters you define.

The Dynamics 365 Business Central connector is a Flex connector. In {maia}, Flex connectors let you connect to a curated set of endpoints to load data.

You can use the Dynamics 365 Business Central connector in its preconfigured state, *or* you can edit the connector by adding or amending available Dynamics 365 Business Central endpoints as per your use case. You can edit Flex connectors in the [Custom Connector](/docs/guides/custom-connector-setup) user interface.

For detailed information about authentication, specific endpoints parameters, pagination, and more aspects of the Dynamics 365 Business Central API, read the [Dynamics 365 Business Central API documentation](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/).

***

## Properties

Reference material is provided below for the Connect, Configure, Destination, and Advanced Settings properties.

<ResponseField name="Name" type="string" required>
  A human-readable name for the component.
</ResponseField>

### Connect

<ResponseField name="Data Source" type="drop-down" required>
  The data source to load data from in this pipeline. The drop-down menu lists the Dynamics 365 Business Central API endpoints available in the connector. For detailed information about specific endpoints, read the [Dynamics 365 Business Central API documentation](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/).

  | Endpoint                       | Method | Reference                                                                                                                                                                                                                   |
  | ------------------------------ | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Accounts                       | GET    | [Retrieve the properties and relationships of an account](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_account_get)                                             |
  | Accounting Periods             | GET    | [Retrieve the properties and relationships of an accounting period](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_accountingperiod_get)                          |
  | Aged Accounts Payables         | GET    | [Retrieve the properties and relationships of an aged accounts payable report](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_agedaccountspayable_get)            |
  | Aged Accounts Receivables      | GET    | [Retrieve the properties and relationships of an aged accounts receivable report](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_agedaccountsreceivable_get)      |
  | Balance Sheets                 | GET    | [Retrieve the properties and relationships of a balance sheet report](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_balancesheet_get)                            |
  | Bank Accounts                  | GET    | [Retrieve the properties and relationships of a bank account](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_bankaccount_get)                                     |
  | Cash Flow Statements           | GET    | [Retrieve the properties and relationships of a cash flow statement report](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_cashflowstatement_get)                 |
  | Companies                      | GET    | [Retrieve the properties and relationships of a company](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_company_get)                                              |
  | Company Information            | GET    | [Retrieve the properties and relationships of company information](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_companyinformation_get)                         |
  | Contacts                       | GET    | [Retrieve the properties and relationships of a contact](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_contact_get)                                              |
  | Countries/Regions              | GET    | [Retrieve the properties and relationships of a countries regions object](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_countryregion_get)                       |
  | Currencies                     | GET    | [Retrieve the properties and relationships of a currency](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_currency_get)                                            |
  | Currency Exchange Rates        | GET    | [Retrieve the properties and relationships of a currency exchange rate](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_currencyexchangerate_get)                  |
  | Customers                      | GET    | [Retrieve the properties and relationships of a customer](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_customer_get)                                            |
  | Customer Financial Details     | GET    | [Retrieve the properties and relationships of a customer's financial details](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_customerfinancialdetail_get)         |
  | Customer Payment Journals      | GET    | [Retrieve the properties and relationships of a customer payment journal object](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_customerpaymentjournal_get)       |
  | Customer Sales                 | GET    | [Retrieve the properties and relationships of customer sale details](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_customersale_get)                             |
  | Default Dimensions             | GET    | [Retrieve the default dimensions of an entity](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_defaultdimension_get)                                               |
  | Dimensions                     | GET    | [Retrieve the properties and relationships of a dimensions object](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_dimension_get)                                  |
  | Dimension Values               | GET    | [Retrieve the properties and relationships of a dimension value](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_dimensionvalue_get)                               |
  | Dispute Status                 | GET    | [Retrieve the properties and relationships of a dispute status](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_disputestatus_get)                                 |
  | Employees                      | GET    | [Retrieve the properties and relationships of an employee](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_employee_get)                                           |
  | Fixed Assets                   | GET    | [Retrieve the properties and relationships of a fixed asset](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_fixedasset_get)                                       |
  | Fixed Asset Locations          | GET    | [Retrieve the properties and relationships of a fixed asset location](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_fixedassetlocation_get)                      |
  | General Ledger Entries         | GET    | [Retrieve the properties and relationships of a general ledger entry](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_generalledgerentry_get)                      |
  | General Product Posting Groups | GET    | [Retrieve the properties and relationships of a general product posting group](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_generalproductpostinggroup_get)     |
  | Income Statements              | GET    | [Retrieve the properties and relationships of an income statement report](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_incomestatement_get)                     |
  | Inventory Posting Groups       | GET    | [Retrieve the properties and relationships of an inventory posting group](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_inventorypostinggroup_get)               |
  | Items                          | GET    | [Retrieve the properties and relationships of an item](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_item_get)                                                   |
  | Item Categories                | GET    | [Retrieve the properties and relationships of an item category](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_itemcategory_get)                                  |
  | Item Ledger Entries            | GET    | [Retrieve the properties and relationships of an item ledger entry](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_itemledgerentry_get)                           |
  | Item Variants                  | GET    | [Retrieve the properties and relationships of an item variant](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_itemvariant_get)                                    |
  | Job Queue Entries              | GET    | [Retrieve the properties and relationships of a job queue entry](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_jobqueueentry_get)                                |
  | Job Queue Log Entries          | GET    | [Retrieve the properties and relationships of a job queue log entry](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_jobqueuelogentry_get)                         |
  | Journals                       | GET    | [Retrieve the properties and relationships of a journal](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_journal_get)                                              |
  | Locations                      | GET    | [Retrieve the properties and relationships of a location](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_location_get)                                            |
  | Opportunities                  | GET    | [Retrieve the properties and relationships of an opportunity](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_opportunity_get)                                     |
  | Payment Methods                | GET    | [Retrieve the properties and relationships of a payment method](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_paymentmethod_get)                                 |
  | Payment Terms                  | GET    | [Retrieve the properties and relationships of a payment term](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_paymentterm_get)                                     |
  | Projects                       | GET    | [Retrieve the properties and relationships of a project](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_project_get)                                              |
  | Purchase Invoices              | GET    | [Retrieve the properties and relationships of a purchase invoice](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_purchaseinvoice_get)                             |
  | Purchase Orders                | GET    | [Retrieve the properties and relationships of a purchase order](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_purchaseorder_get)                                 |
  | Purchase Receipts              | GET    | [Retrieve the properties and relationships of a purchase receipt](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_purchasereceipt_get)                             |
  | Retained Earnings Statements   | GET    | [Retrieve the properties and relationships of a retained earnings statement report](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_retainedearningsstatement_get) |
  | Sales Invoices                 | GET    | [Retrieve the properties and relationships of a sales object](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_salesinvoice_get)                                    |
  | Sales Orders                   | GET    | [Retrieve the properties and relationships of a sales order](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_salesorder_get)                                       |
  | Sales Quotes                   | GET    | [Retrieve the properties and relationships of a sales quote](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_salesquote_get)                                       |
  | Sales Shipments                | GET    | [Retrieve the properties and relationships of a sales shipment](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_salesshipment_get)                                 |
  | Shipment Methods               | GET    | [Retrieve the properties and relationships of a shipment method](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_shipmentmethod_get)                               |
  | Tax Areas                      | GET    | [Retrieve the properties and relationships of a tax area](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_taxarea_get)                                             |
  | Tax Groups                     | GET    | [Retrieve the properties and relationships of a tax group](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_taxgroup_get)                                           |
  | Trial Balances                 | GET    | [Retrieve the properties and relationships of a trial balance report](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_trialbalance_get)                            |
  | Units of Measure               | GET    | [Retrieve the properties and relationships of a units of measure object](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_unitofmeasure_get)                        |
  | Vendors                        | GET    | [Retrieve the properties and relationships of a vendor](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_vendor_get)                                                |
  | Vendor Payment Journals        | GET    | [Retrieve the properties and relationships of a vendor payment journal](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_vendorpaymentjournal_get)                  |
  | Vendor Purchases               | GET    | [Retrieve the properties and relationships of a vendor purchase object](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_vendorpurchase_get)                        |
</ResponseField>

{/* <!-- param-start:[api-extract-input-v2.connectionRef.overrides.authType] | warehouses: [snowflake, databricks, redshift] --> */}

<ResponseField name="Authentication Type" type="drop-down" required>
  The authentication method to authorize access to your Dynamics 365 Business Central data. Currently supports OAuth 2.0 Client Credentials.
</ResponseField>

{/* <!-- param-start:[api-extract-input-v2.profile, api-extract-input-v2.connectionRef.overrides.oAuthReferenceId] | warehouses: [snowflake, databricks, redshift] --> */}

<ResponseField name="Authentication" type="string" required>
  Select your authentication profile.

  To create a new profile, read [OAuth client credentials](/docs/guides/oauth-client-credentials). For more information, read [Microsoft identity platform and the OAuth 2.0 client credentials flow](https://learn.microsoft.com/en-us/entra/identity-platform/v2-oauth2-client-creds-grant-flow).
</ResponseField>

### Configure

<ResponseField name="URI Parameters" type="column editor" required>
  * **Parameter Name:** The name of a URI parameter.
  * **Parameter Value:** The value of the corresponding parameter.

  | Required parameter | Endpoints                        | Description                                                                                                                                                                                                                                                                                                                                            |
  | ------------------ | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
  | baseURL            | All endpoints                    | Enter `api.businesscentral.dynamics.com`.                                                                                                                                                                                                                                                                                                              |
  | api\_version       | All endpoints                    | Enter `v2.0`.                                                                                                                                                                                                                                                                                                                                          |
  | userDomainName     | All endpoints                    | Log in to the [Dynamics 365 Business Central admin center](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/administration/tenant-admin-center). Select the **Production** link under the **Environments** tab, and in the **Details** section, the `userDomainName` is the GUID that appears after "dynamics.com" in the URL. |
  | environmentName    | All endpoints                    | Log in to the [Dynamics 365 Business Central admin center](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/administration/tenant-admin-center). Select the **Production** link under the **Environments** tab, and in the **Details** section, locate the `environmentName` at the end of the URL. For example `/Production`. |
  | companyId          | All endpoints except `Companies` | Retrieve your `Company ID` from the [Companies](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_company_get) endpoint.                                                                                                                                                                        |

  <Note>
    To access the **Dynamics 365 Business Central admin center**, you will need the correct admin permissions. For more information, read [Supported Microsoft Entra roles for access](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/administration/tenant-admin-center#supported-microsoft-entra-roles-for-access).
  </Note>
</ResponseField>

{/* <!-- param-start:[api-extract-input-v2.queryParams] | warehouses: [snowflake, databricks, redshift] --> */}

<ResponseField name="Query Parameters" type="column editor" required>
  * **Parameter Name:** The name of a query parameter.
  * **Parameter Value:** The value of the corresponding parameter.
</ResponseField>

{/* <!-- param-start:[api-extract-input-v2.headerParams] | warehouses: [snowflake, databricks, redshift] --> */}

<ResponseField name="Header Parameters" type="column editor" required>
  * **Parameter Name:** The name of a header parameter.
  * **Parameter Value:** The value of the corresponding parameter.

  | Required parameter | Endpoints     | Description                                                                                                                                                                                                                                 |
  | ------------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Prefer             | All endpoints | Set this parameter to include the `odata.maxpagesize` value to specify the maximum number of records to return in a single response. The default is set to 100 records per page. This can be changed. For example, `odata.maxpagesize=100`. |
</ResponseField>

{/* <!-- param-start:[api-extract-input-v2.postBody] | warehouses: [snowflake, databricks, redshift] --> */}

<ResponseField name="Post Body" type="JSON">
  A JSON body as part of a POST request.
</ResponseField>

{/* <!-- param-start:[api-extract-input-v2.pageLimit] | warehouses: [snowflake, databricks, redshift] --> */}

<ResponseField name="Page Limit" type="integer">
  A numeric value to limit the maximum number of records per page.
</ResponseField>

### Destination

Select your cloud data warehouse.

<Tabs>
  <Tab title="Snowflake">
    <ResponseField name="Destination" type="drop-down" required>
      * **Snowflake:** Load your data into Snowflake. You'll need to set a cloud storage location for temporary staging of the data.
      * **Cloud Storage:** Load your data directly into your preferred cloud storage location.

      Click either the **Snowflake** or **Cloud Storage** tab on this page for documentation applicable to that destination type.
    </ResponseField>

    <Tabs>
      <Tab title="Snowflake">
        {/* <!-- param-start:[snowflake-output-connector-v0.warehouse] | warehouses: [snowflake] --> */}

        <ResponseField name="Warehouse" type="drop-down" required>
          The Snowflake warehouse used to run the queries. The special value `[Environment Default]` uses the warehouse defined in the environment. Read [Overview of Warehouses](https://docs.snowflake.com/en/user-guide/warehouses-overview.html) to learn more.
        </ResponseField>

        {/* <!-- param-end:[snowflake-output-connector-v0.warehouse] --> */}

        {/* <!-- param-start:[snowflake-output-connector-v0.database] | warehouses: [snowflake] --> */}

        <ResponseField name="Database" type="drop-down" required>
          The Snowflake database. The special value `[Environment Default]` uses the database defined in the environment. Read [Databases, Tables and Views - Overview](https://docs.snowflake.com/en/guides-overview-db) to learn more.
        </ResponseField>

        {/* <!-- param-end:[snowflake-output-connector-v0.database] --> */}

        {/* <!-- param-start:[snowflake-output-connector-v0.schema] | warehouses: [snowflake] --> */}

        <ResponseField name="Schema" type="drop-down" required>
          The Snowflake schema. The special value `[Environment Default]` uses the schema defined in the environment. Read [Database, Schema, and Share DDL](https://docs.snowflake.com/en/sql-reference/ddl-database.html) to learn more.
        </ResponseField>

        {/* <!-- param-end:[snowflake-output-connector-v0.schema] --> */}

        {/* <!-- param-start:[snowflake-output-connector-v0.tableName] | warehouses: [snowflake] --> */}

        <ResponseField name="Table Name" type="string" required>
          The name of the table to be created.
        </ResponseField>

        {/* <!-- param-end:[snowflake-output-connector-v0.tableName] --> */}

        {/* <!-- param-start:[snowflake-output-connector-v0.createTableMode] | warehouses: [snowflake] --> */}

        <ResponseField name="Load Strategy" type="drop-down" required>
          * **Replace:** If the specified table name already exists, that table will be destroyed and replaced by the table created during this pipeline run.
          * **Truncate and Insert:** Each time the pipeline runs, two operations are performed: first, the table is truncated, meaning all existing rows are deleted. Then, your new rows are inserted. The table itself is never destroyed and recreated.
          * **Fail if Exists:** If the specified table name already exists, this pipeline will fail to run.
          * **Append:** If the specified table name already exists, then the data is inserted without altering or deleting the existing data in the table. It's appended onto the end of the existing data in the table. If the specified table name doesn't exist, then the table will be created, and your data will be inserted into the table.
        </ResponseField>

        {/* <!-- param-end:[snowflake-output-connector-v0.createTableMode] --> */}

        {/* <!-- param-start:[snowflake-output-connector-v0.cleanStagedFiles] | warehouses: [snowflake] --> */}

        <ResponseField name="Clean Staged files" type="boolean" required>
          * **Yes:** Staged files will be destroyed after data is loaded. This is the default setting.
          * **No:** Staged files are retained in the staging area after data is loaded.
        </ResponseField>

        {/* <!-- param-end:[snowflake-output-connector-v0.cleanStagedFiles] --> */}

        {/* <!-- param-start:[snowflake-output-connector-v0.stageAccessStrategyForS3, snowflake-output-connector-v0.stageAccessStrategyForAzure, snowflake-output-connector-v0.stageAccessStrategyForGcs] | warehouses: [snowflake] --> */}

        <ResponseField name="Stage Access Strategy" type="drop-down">
          Select the stage access strategy. The strategies available depend on the cloud platform you select in **Stage Platform**.

          * **Credentials:** Connects to the external stage (AWS, Azure) using your configured [cloud provider credentials](/docs/guides/cloud-credentials). Not available for Google Cloud Storage.
          * **Storage Integration:** Use a Snowflake storage integration to grant access to Snowflake to read data from and write to a cloud storage location. This will reveal the **Storage Integration** property, through which you can select any of your existing Snowflake storage integrations.
        </ResponseField>

        {/* <!-- param-end:[snowflake-output-connector-v0.stageAccessStrategyForS3, snowflake-output-connector-v0.stageAccessStrategyForAzure, snowflake-output-connector-v0.stageAccessStrategyForGcs] --> */}

        {/* <!-- param-start:[snowflake-output-connector-v0.stagePlatform] | warehouses: [snowflake] --> */}

        <ResponseField name="Stage Platform" type="drop-down" required>
          Choose a data staging platform using the drop-down menu.

          * **Amazon S3:** Stage your data on an AWS S3 bucket.
          * **Snowflake:** Stage your data on a Snowflake internal stage.
          * **Azure Storage:** Stage your data in an Azure Blob Storage container.
          * **Google Cloud Storage:** Stage your data in a Google Cloud Storage bucket.

          Click one of the tabs below for documentation applicable to that staging platform.
        </ResponseField>

        {/* <!-- param-end:[snowflake-output-connector-v0.stagePlatform] --> */}

        <Tabs>
          <Tab title="Amazon S3">
            {/* <!-- param-start:[snowflake-output-connector-v0.storageIntegrationForS3] | warehouses: [snowflake] --> */}

            <ResponseField name="Storage Integration" type="drop-down" required>
              Select the storage integration. Storage integrations are required to permit Snowflake to read data from and write to a cloud storage location. Integrations must be set up in advance of selecting them. Storage integrations can be configured to support Amazon S3, Google Cloud Storage, or Microsoft Azure Blob Storage, regardless of the cloud provider that hosts your Snowflake account.
            </ResponseField>

            {/* <!-- param-end:[snowflake-output-connector-v0.storageIntegrationForS3] --> */}

            {/* <!-- param-start:[snowflake-output-connector-v0.s3#bucket, snowflake-output-connector-v0.amazonS3Bucket] | warehouses: [snowflake] --> */}

            <ResponseField name="Amazon S3 Bucket" type="drop-down" required>
              An AWS S3 bucket to stage data into. The drop-down menu will include buckets tied to the [cloud provider credentials](/docs/guides/cloud-credentials) that you have associated with your [environment](/docs/guides/environments).
            </ResponseField>

            {/* <!-- param-end:[snowflake-output-connector-v0.s3#bucket, snowflake-output-connector-v0.amazonS3Bucket] --> */}
          </Tab>

          <Tab title="Snowflake">
            {/* <!-- param-start:[snowflake-output-connector-v0.snowflake#internalStageType] | warehouses: [snowflake] --> */}

            <ResponseField name="Internal Stage Type" type="drop-down" required>
              Select the Snowflake internal stage type. Use the Snowflake links provided to learn more about each type of stage.

              * **User:** Each Snowflake user has a [user stage](https://docs.snowflake.com/en/user-guide/data-load-local-file-system-create-stage#user-stages) allocated to them by default for file storage. You may find the user stage convenient if your files will only be accessed by a single user, but need to be copied into multiple tables.
              * **Named:** A [named stage](https://docs.snowflake.com/en/user-guide/data-load-local-file-system-create-stage#named-stages) provides high flexibility for data loading. Users with the appropriate privileges on the stage can load data into any table. Furthermore, because the stage is a database object, any security or access rules that apply to all objects will apply to the named stage.

              Named stages can be altered and dropped. User stages cannot.
            </ResponseField>

            {/* <!-- param-end:[snowflake-output-connector-v0.snowflake#internalStageType] --> */}

            {/* <!-- param-start:[snowflake-output-connector-v0.snowflake#internalNamedStage] | warehouses: [snowflake] --> */}

            <ResponseField name="Named Stage" type="drop-down" required>
              Select your named stage. Read [Creating a named stage](https://docs.snowflake.com/en/user-guide/data-load-local-file-system-create-stage#creating-a-named-stage) to learn how to create a new named stage.

              <Warning>
                There is a known issue where named stages that include special characters or spaces are not supported.
              </Warning>
            </ResponseField>

            {/* <!-- param-end:[snowflake-output-connector-v0.snowflake#internalNamedStage] --> */}
          </Tab>

          <Tab title="Azure Storage">
            {/* <!-- param-start:[snowflake-output-connector-v0.storageIntegrationForAzure] | warehouses: [snowflake] --> */}

            <ResponseField name="Storage Integration" type="drop-down" required>
              Select the storage integration. Storage integrations are required to permit Snowflake to read data from and write to a cloud storage location. Integrations must be set up in advance of selecting them. Storage integrations can be configured to support Amazon S3, Google Cloud Storage, or Microsoft Azure Blob Storage, regardless of the cloud provider that hosts your Snowflake account.
            </ResponseField>

            {/* <!-- param-end:[snowflake-output-connector-v0.storageIntegrationForAzure] --> */}

            {/* <!-- param-start:[snowflake-output-connector-v0.azure#account, snowflake-output-connector-v0.azureBlobAccount] | warehouses: [snowflake] --> */}

            <ResponseField name="Storage Account" type="drop-down" required>
              Select a storage account linked to your desired blob container to be used for staging the data. For more information, read [Storage account overview](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-overview).
            </ResponseField>

            {/* <!-- param-end:[snowflake-output-connector-v0.azure#account, snowflake-output-connector-v0.azureBlobAccount] --> */}

            {/* <!-- param-start:[snowflake-output-connector-v0.azure#container, snowflake-output-connector-v0.azureBlobContainer] | warehouses: [snowflake] --> */}

            <ResponseField name="Container" type="drop-down" required>
              Select a Blob container to be used for staging the data. For more information, read [Introduction to Azure Blob storage](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction).
            </ResponseField>

            {/* <!-- param-end:[snowflake-output-connector-v0.azure#container, snowflake-output-connector-v0.azureBlobContainer] --> */}
          </Tab>

          <Tab title="Google Cloud Storage">
            {/* <!-- param-start:[snowflake-output-connector-v0.stageAccessStrategyForGcs] | warehouses: [snowflake] --> */}

            <ResponseField name="Stage Access Strategy" type="drop-down">
              Select the stage access strategy. The strategies available depend on the cloud platform you select in **Stage Platform**.

              * **Storage Integration:** Use a Snowflake storage integration to grant access to Snowflake to read data from and write to a cloud storage location. This will reveal the **Storage Integration** property, through which you can select any of your existing Snowflake storage integrations.
            </ResponseField>

            {/* <!-- param-end:[snowflake-output-connector-v0.stageAccessStrategyForGcs] --> */}

            {/* <!-- param-start:[snowflake-output-connector-v0.storageIntegration] | warehouses: [snowflake] --> */}

            <ResponseField name="Storage Integration" type="drop-down" required>
              Select the storage integration. Storage integrations are required to permit Snowflake to read data from and write to a cloud storage location. Integrations must be set up in advance of selecting them. Storage integrations can be configured to support Amazon S3, Google Cloud Storage, or Microsoft Azure Blob Storage, regardless of the cloud provider that hosts your Snowflake account.
            </ResponseField>

            {/* <!-- param-end:[snowflake-output-connector-v0.storageIntegration] --> */}

            {/* <!-- param-start:[snowflake-output-connector-v0.gcs#bucket, snowflake-output-connector-v0.gcsBucket] | warehouses: [snowflake] --> */}

            <ResponseField name="GCS Bucket" type="drop-down" required>
              The drop-down menu will include Google Cloud Storage (GCS) buckets tied to the [cloud provider credentials](/docs/guides/cloud-credentials) that you have associated with your [environment](/docs/guides/environments).
            </ResponseField>

            {/* <!-- param-end:[snowflake-output-connector-v0.gcs#bucket, snowflake-output-connector-v0.gcsBucket] --> */}

            {/* <!-- param-start:[snowflake-output-connector-v0.gcs#overwriteAllowed] | warehouses: [snowflake] --> */}

            <ResponseField name="Overwrite" type="boolean" required>
              Select whether to overwrite files of the same name when this pipeline runs. Default is Yes.
            </ResponseField>

            {/* <!-- param-end:[snowflake-output-connector-v0.gcs#overwriteAllowed] --> */}
          </Tab>
        </Tabs>
      </Tab>

      <Tab title="Cloud Storage">
        {/* <!-- param-start:[storage-only-output-v0.prepareStageStrategy] | warehouses: [snowflake] --> */}

        <ResponseField name="Load Strategy" type="drop-down">
          * **Append Files in Folder:** Appends files to storage folder. This is the default setting.
          * **Overwrite Files in Folder:** Overwrite existing files with matching structure.

          See the configuration table for how this parameter works with the Folder Path and File Prefix parameters:

          | Configuration                                                          | Description                                                                                                                                                         |
          | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
          | Append files in folder with defined folder path and file prefix.       | Files will be stored under the structure `uniqueID/timestamp-partX` where X is the part number, starting from 1.                                                    |
          | Append files in folder without defined folder path and file prefix.    | Files will be stored under the structure `folder/prefix-timestamp-partX` where X is the part number, starting from 1.                                               |
          | Overwrite files in folder with defined folder path and file prefix.    | Files will be stored under the structure `folder/prefix-partX` where X is the part number, starting from 1. All files with matching structures will be overwritten. |
          | Overwrite files in folder without defined folder path and file prefix. | Validation will fail. Folder path and file prefix must be supplied for this load strategy.                                                                          |
        </ResponseField>

        {/* <!-- param-end:[storage-only-output-v0.prepareStageStrategy] --> */}

        {/* <!-- param-start:[snowflake-output-connector-v0.folderPath, storage-only-output-v0.folderPath] | warehouses: [snowflake] --> */}

        <ResponseField name="Folder Path" type="string">
          The folder path of the written files.
        </ResponseField>

        {/* <!-- param-end:[snowflake-output-connector-v0.folderPath, storage-only-output-v0.folderPath] --> */}

        {/* <!-- param-start:[snowflake-output-connector-v0.filePrefix, storage-only-output-v0.filePrefix] | warehouses: [snowflake] --> */}

        <ResponseField name="File Prefix" type="string">
          A string of characters to include at the beginning of the written files. Often used for organizing database objects.
        </ResponseField>

        {/* <!-- param-end:[snowflake-output-connector-v0.filePrefix, storage-only-output-v0.filePrefix] --> */}

        {/* <!-- param-start:[storage-only-output-v0.storage] | warehouses: [snowflake] --> */}

        <ResponseField name="Storage" type="drop-down" required>
          A cloud storage location to load your data into for storage. Choose either Amazon S3, Azure Storage, or Google Cloud Storage.

          Click the tab that corresponds to your chosen cloud storage service.
        </ResponseField>

        {/* <!-- param-end:[storage-only-output-v0.storage] --> */}

        <Tabs>
          <Tab title="Amazon S3">
            {/* <!-- param-start:[storage-only-output-v0.s3#bucket] | warehouses: [snowflake] --> */}

            <ResponseField name="Amazon S3 Bucket" type="drop-down" required>
              An AWS S3 bucket to load data into. The drop-down menu will include buckets tied to the [cloud provider credentials](/docs/guides/cloud-credentials) that you have associated with your [environment](/docs/guides/environments).
            </ResponseField>

            {/* <!-- param-end:[storage-only-output-v0.s3#bucket] --> */}
          </Tab>

          <Tab title="Azure Storage">
            {/* <!-- param-start:[storage-only-output-v0.azure#account] | warehouses: [snowflake] --> */}

            <ResponseField name="Storage Account" type="drop-down" required>
              Select a storage account linked to your desired blob container to be used for staging the data. For more information, read [Storage account overview](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-overview).
            </ResponseField>

            {/* <!-- param-end:[storage-only-output-v0.azure#account] --> */}

            {/* <!-- param-start:[storage-only-output-v0.azure#container] | warehouses: [snowflake] --> */}

            <ResponseField name="Container" type="drop-down" required>
              Select a Blob container to be used for staging the data. For more information, read [Introduction to Azure Blob storage](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction).
            </ResponseField>

            {/* <!-- param-end:[storage-only-output-v0.azure#container] --> */}
          </Tab>

          <Tab title="Google Cloud Storage">
            {/* <!-- param-start:[storage-only-output-v0.gcs#bucket] | warehouses: [snowflake] --> */}

            <ResponseField name="GCS Bucket" type="drop-down" required>
              The drop-down menu will include Google Cloud Storage (GCS) buckets tied to the [cloud provider credentials](/docs/guides/cloud-credentials) that you have associated with your [environment](/docs/guides/environments).
            </ResponseField>

            {/* <!-- param-end:[storage-only-output-v0.gcs#bucket] --> */}

            {/* <!-- param-start:[storage-only-output-v0.gcs#overwriteAllowed] | warehouses: [snowflake] --> */}

            <ResponseField name="Overwrite" type="boolean" required>
              Select whether to overwrite files of the same name when this pipeline runs. Default is Yes.
            </ResponseField>

            {/* <!-- param-end:[storage-only-output-v0.gcs#overwriteAllowed] --> */}
          </Tab>
        </Tabs>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Databricks">
    <ResponseField name="Destination" type="drop-down" required>
      * **Databricks:** Load your data into Databricks. You'll need to set a cloud storage location for temporary staging of the data.
      * **Cloud Storage:** Load your data directly into your preferred cloud storage location.

      Click either the **Databricks** or **Cloud Storage** tab on this page for documentation applicable to that destination type.
    </ResponseField>

    <Tabs>
      <Tab title="Databricks">
        {/* <!-- param-start:[databricks-output-connector-v0.catalog] | warehouses: [databricks] --> */}

        <ResponseField name="Catalog" type="drop-down" required>
          Select a [Databricks Unity Catalog](https://docs.databricks.com/en/data-governance/unity-catalog/index.html). The special value `[Environment Default]` uses the catalog defined in the environment. Selecting a catalog will determine which databases are available in the next parameter.
        </ResponseField>

        {/* <!-- param-end:[databricks-output-connector-v0.catalog] --> */}

        {/* <!-- param-start:[databricks-output-connector-v0.schema] | warehouses: [databricks] --> */}

        <ResponseField name="Schema" type="drop-down" required>
          The Databricks schema. The special value `[Environment Default]` uses the schema defined in the environment. Read [Create and manage schemas](https://docs.databricks.com/en/data-governance/unity-catalog/create-schemas.html) to learn more.
        </ResponseField>

        {/* <!-- param-end:[databricks-output-connector-v0.schema] --> */}

        {/* <!-- param-start:[databricks-output-connector-v0.tableName] | warehouses: [databricks] --> */}

        <ResponseField name="Table Name" type="string" required>
          The name of the table to be created.
        </ResponseField>

        {/* <!-- param-end:[databricks-output-connector-v0.tableName] --> */}

        {/* <!-- param-start:[databricks-output-connector-v0.loadStrategy] | warehouses: [databricks] --> */}

        <ResponseField name="Load Strategy" type="drop-down" required>
          * **Fail if Exists:** If the specified table name already exists, this pipeline will fail to run.
          * **Replace:** If the specified table name already exists, that table will be destroyed and replaced by the table created during this pipeline run.
          * **Truncate and Insert:** Each time the pipeline runs, two operations are performed: first, the table is truncated, meaning all existing rows are deleted. Then, your new rows are inserted. The table itself is never destroyed and recreated.
          * **Append:** If the specified table name already exists, then the data is inserted without altering or deleting the existing data in the table. It's appended onto the end of the existing data in the table. If the specified table name doesn't exist, then the table will be created, and your data will be inserted into the table.
        </ResponseField>

        {/* <!-- param-end:[databricks-output-connector-v0.loadStrategy] --> */}

        {/* <!-- param-start:[databricks-output-connector-v0.cleanStagedFiles] | warehouses: [databricks] --> */}

        <ResponseField name="Clean Staged Files" type="boolean" required>
          * **Yes:** Staged files will be destroyed after data is loaded. This is the default setting.
          * **No:** Staged files are retained in the staging area after data is loaded.
        </ResponseField>

        {/* <!-- param-end:[databricks-output-connector-v0.cleanStagedFiles] --> */}

        {/* <!-- param-start:[databricks-output-connector-v0.stagePlatform] | warehouses: [databricks] --> */}

        <ResponseField name="Stage Platform" type="drop-down" required>
          Choose a data staging platform using the drop-down menu.

          * **Amazon S3:** Stage your data on an AWS S3 bucket.
          * **Azure Storage:** Stage your data in an Azure Blob Storage container.

          Click one of the tabs below for documentation applicable to that staging platform.
        </ResponseField>

        {/* <!-- param-end:[databricks-output-connector-v0.stagePlatform] --> */}

        <Tabs>
          <Tab title="Amazon S3">
            {/* <!-- param-start:[databricks-output-connector-v0.s3#bucket] | warehouses: [databricks] --> */}

            <ResponseField name="Amazon S3 Bucket" type="drop-down" required>
              An AWS S3 bucket to stage data into. The drop-down menu will include buckets tied to the [cloud provider credentials](/docs/guides/cloud-credentials) that you have associated with your [environment](/docs/guides/environments).
            </ResponseField>

            {/* <!-- param-end:[databricks-output-connector-v0.s3#bucket] --> */}
          </Tab>

          <Tab title="Azure Storage">
            {/* <!-- param-start:[databricks-output-connector-v0.azure#account] | warehouses: [databricks] --> */}

            <ResponseField name="Storage Account" type="drop-down" required>
              Select a storage account linked to your desired blob container to be used for staging the data. For more information, read [Storage account overview](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-overview).
            </ResponseField>

            {/* <!-- param-end:[databricks-output-connector-v0.azure#account] --> */}

            {/* <!-- param-start:[databricks-output-connector-v0.azure#container] | warehouses: [databricks] --> */}

            <ResponseField name="Container" type="drop-down" required>
              Select a Blob container to be used for staging the data. For more information, read [Introduction to Azure Blob storage](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction).
            </ResponseField>

            {/* <!-- param-end:[databricks-output-connector-v0.azure#container] --> */}
          </Tab>
        </Tabs>
      </Tab>

      <Tab title="Cloud Storage">
        {/* <!-- param-start:[storage-only-output-v0.prepareStageStrategy] | warehouses: [databricks] --> */}

        <ResponseField name="Load Strategy" type="drop-down">
          * **Append Files in Folder:** Appends files to storage folder. This is the default setting.
          * **Overwrite Files in Folder:** Overwrite existing files with matching structure.

          See the configuration table for how this parameter works with the Folder Path and File Prefix parameters:

          | Configuration                                                          | Description                                                                                                                                                         |
          | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
          | Append files in folder with defined folder path and file prefix.       | Files will be stored under the structure `uniqueID/timestamp-partX` where X is the part number, starting from 1.                                                    |
          | Append files in folder without defined folder path and file prefix.    | Files will be stored under the structure `folder/prefix-timestamp-partX` where X is the part number, starting from 1.                                               |
          | Overwrite files in folder with defined folder path and file prefix.    | Files will be stored under the structure `folder/prefix-partX` where X is the part number, starting from 1. All files with matching structures will be overwritten. |
          | Overwrite files in folder without defined folder path and file prefix. | Validation will fail. Folder path and file prefix must be supplied for this load strategy.                                                                          |
        </ResponseField>

        {/* <!-- param-end:[storage-only-output-v0.prepareStageStrategy] --> */}

        {/* <!-- param-start:[databricks-output-connector-v0.folderPath, storage-only-output-v0.folderPath] | warehouses: [databricks] --> */}

        <ResponseField name="Folder Path" type="string">
          The folder path of the written files.
        </ResponseField>

        {/* <!-- param-end:[databricks-output-connector-v0.folderPath, storage-only-output-v0.folderPath] --> */}

        {/* <!-- param-start:[databricks-output-connector-v0.filePrefix, storage-only-output-v0.filePrefix] | warehouses: [databricks] --> */}

        <ResponseField name="File Prefix" type="string">
          A string of characters to include at the beginning of the written files. Often used for organizing database objects.
        </ResponseField>

        {/* <!-- param-end:[databricks-output-connector-v0.filePrefix, storage-only-output-v0.filePrefix] --> */}

        {/* <!-- param-start:[storage-only-output-v0.storage] | warehouses: [databricks] --> */}

        <ResponseField name="Storage" type="drop-down" required>
          A cloud storage location to load your data into for storage. Choose either Amazon S3, Azure Storage, or Google Cloud Storage.

          Click the tab that corresponds to your chosen cloud storage service.
        </ResponseField>

        {/* <!-- param-end:[storage-only-output-v0.storage] --> */}

        <Tabs>
          <Tab title="Amazon S3">
            {/* <!-- param-start:[storage-only-output-v0.s3#bucket] | warehouses: [databricks] --> */}

            <ResponseField name="Amazon S3 Bucket" type="drop-down" required>
              An AWS S3 bucket to load data into. The drop-down menu will include buckets tied to the [cloud provider credentials](/docs/guides/cloud-credentials) that you have associated with your [environment](/docs/guides/environments).
            </ResponseField>

            {/* <!-- param-end:[storage-only-output-v0.s3#bucket] --> */}
          </Tab>

          <Tab title="Azure Storage">
            {/* <!-- param-start:[storage-only-output-v0.azure#account] | warehouses: [databricks] --> */}

            <ResponseField name="Storage Account" type="drop-down" required>
              Select a storage account linked to your desired blob container to be used for staging the data. For more information, read [Storage account overview](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-overview).
            </ResponseField>

            {/* <!-- param-end:[storage-only-output-v0.azure#account] --> */}

            {/* <!-- param-start:[storage-only-output-v0.azure#container] | warehouses: [databricks] --> */}

            <ResponseField name="Container" type="drop-down" required>
              Select a Blob container to be used for staging the data. For more information, read [Introduction to Azure Blob storage](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction).
            </ResponseField>

            {/* <!-- param-end:[storage-only-output-v0.azure#container] --> */}
          </Tab>

          <Tab title="Google Cloud Storage">
            {/* <!-- param-start:[storage-only-output-v0.gcs#bucket] | warehouses: [databricks] --> */}

            <ResponseField name="GCS Bucket" type="drop-down" required>
              The drop-down menu will include Google Cloud Storage (GCS) buckets tied to the [cloud provider credentials](/docs/guides/cloud-credentials) that you have associated with your [environment](/docs/guides/environments).
            </ResponseField>

            {/* <!-- param-end:[storage-only-output-v0.gcs#bucket] --> */}

            {/* <!-- param-start:[storage-only-output-v0.gcs#overwriteAllowed] | warehouses: [databricks] --> */}

            <ResponseField name="Overwrite" type="boolean" required>
              Select whether to overwrite files of the same name when this pipeline runs. Default is Yes.
            </ResponseField>

            {/* <!-- param-end:[storage-only-output-v0.gcs#overwriteAllowed] --> */}
          </Tab>
        </Tabs>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Amazon Redshift">
    <ResponseField name="Destination" type="drop-down" required>
      * **Redshift:** Load your data into Amazon Redshift. You'll need to set a cloud storage location for temporary staging of the data.
      * **Cloud Storage:** Load your data directly into your preferred cloud storage location.

      Click either the **Amazon Redshift** or **Cloud Storage** tab on this page for documentation applicable to that destination type.
    </ResponseField>

    <Tabs>
      <Tab title="Amazon Redshift">
        {/* <!-- param-start:[redshift-output-connector-v0.schema] | warehouses: [redshift] --> */}

        <ResponseField name="Schema" type="drop-down" required>
          The Amazon Redshift schema. The special value `[Environment Default]` uses the schema defined in the environment. Read [Schemas](https://docs.aws.amazon.com/redshift/latest/dg/r_Schemas_and_tables.html) to learn more.

          For more information on using multiple schemas, read [Schemas](https://docs.aws.amazon.com/redshift/latest/dg/r_Schemas_and_tables.html).
        </ResponseField>

        {/* <!-- param-end:[redshift-output-connector-v0.schema] --> */}

        {/* <!-- param-start:[redshift-output-connector-v0.table] | warehouses: [redshift] --> */}

        <ResponseField name="Table Name" type="string" required>
          The name of the table to be created.
        </ResponseField>

        {/* <!-- param-end:[redshift-output-connector-v0.table] --> */}

        {/* <!-- param-start:[redshift-output-connector-v0.createTableMode] | warehouses: [redshift] --> */}

        <ResponseField name="Load Strategy" type="drop-down" required>
          * **Replace:** If the specified table name already exists, that table will be destroyed and replaced by the table created during this pipeline run.
          * **Fail if Exists:** If the specified table name already exists, this pipeline will fail to run.
          * **Truncate and Insert:** Each time the pipeline runs, two operations are performed: first, the table is truncated, meaning all existing rows are deleted. Then, your new rows are inserted. The table itself is never destroyed and recreated.
          * **Append:** If the specified table name already exists, then the data is inserted without altering or deleting the existing data in the table. It's appended onto the end of the existing data in the table. If the specified table name doesn't exist, then the table will be created, and your data will be inserted into the table.
        </ResponseField>

        {/* <!-- param-end:[redshift-output-connector-v0.createTableMode] --> */}

        {/* <!-- param-start:[redshift-output-connector-v0.cleanStagedFiles] | warehouses: [redshift] --> */}

        <ResponseField name="Clean Staged Files" type="boolean" required>
          * **Yes:** Staged files will be destroyed after data is loaded. This is the default setting.
          * **No:** Staged files are retained in the staging area after data is loaded.
        </ResponseField>

        {/* <!-- param-end:[redshift-output-connector-v0.cleanStagedFiles] --> */}

        {/* <!-- param-start:[redshift-output-connector-v0.s3#bucket] | warehouses: [redshift] --> */}

        <ResponseField name="Amazon S3 Bucket" type="drop-down" required>
          An AWS S3 bucket to stage data into. The drop-down menu will include buckets tied to the [cloud provider credentials](/docs/guides/cloud-credentials) that you have associated with your [environment](/docs/guides/environments).
        </ResponseField>

        {/* <!-- param-end:[redshift-output-connector-v0.s3#bucket] --> */}
      </Tab>

      <Tab title="Cloud Storage">
        {/* <!-- param-start:[storage-only-output-v0.prepareStageStrategy] | warehouses: [redshift] --> */}

        <ResponseField name="Load Strategy" type="drop-down">
          * **Append Files in Folder:** Appends files to storage folder. This is the default setting.
          * **Overwrite Files in Folder:** Overwrite existing files with matching structure.

          See the configuration table for how this parameter works with the Folder Path and File Prefix parameters:

          | Configuration                                                          | Description                                                                                                                                                         |
          | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
          | Append files in folder with defined folder path and file prefix.       | Files will be stored under the structure `uniqueID/timestamp-partX` where X is the part number, starting from 1.                                                    |
          | Append files in folder without defined folder path and file prefix.    | Files will be stored under the structure `folder/prefix-timestamp-partX` where X is the part number, starting from 1.                                               |
          | Overwrite files in folder with defined folder path and file prefix.    | Files will be stored under the structure `folder/prefix-partX` where X is the part number, starting from 1. All files with matching structures will be overwritten. |
          | Overwrite files in folder without defined folder path and file prefix. | Validation will fail. Folder path and file prefix must be supplied for this load strategy.                                                                          |
        </ResponseField>

        {/* <!-- param-end:[storage-only-output-v0.prepareStageStrategy] --> */}

        {/* <!-- param-start:[redshift-output-connector-v0.folderPath, storage-only-output-v0.folderPath] | warehouses: [redshift] --> */}

        <ResponseField name="Folder Path" type="string">
          The folder path of the written files.
        </ResponseField>

        {/* <!-- param-end:[redshift-output-connector-v0.folderPath, storage-only-output-v0.folderPath] --> */}

        {/* <!-- param-start:[redshift-output-connector-v0.filePrefix, storage-only-output-v0.filePrefix] | warehouses: [redshift] --> */}

        <ResponseField name="File Prefix" type="string">
          A string of characters to include at the beginning of the written files. Often used for organizing database objects.
        </ResponseField>

        {/* <!-- param-end:[redshift-output-connector-v0.filePrefix, storage-only-output-v0.filePrefix] --> */}

        {/* <!-- param-start:[storage-only-output-v0.storage] | warehouses: [redshift] --> */}

        <ResponseField name="Storage" type="drop-down" required>
          A cloud storage location to load your data into for storage. Choose either Amazon S3, Azure Storage, or Google Cloud Storage.

          Click the tab that corresponds to your chosen cloud storage service.
        </ResponseField>

        {/* <!-- param-end:[storage-only-output-v0.storage] --> */}

        <Tabs>
          <Tab title="Amazon S3">
            {/* <!-- param-start:[storage-only-output-v0.s3#bucket] | warehouses: [redshift] --> */}

            <ResponseField name="Amazon S3 Bucket" type="drop-down" required>
              An AWS S3 bucket to load data into. The drop-down menu will include buckets tied to the [cloud provider credentials](/docs/guides/cloud-credentials) that you have associated with your [environment](/docs/guides/environments).
            </ResponseField>

            {/* <!-- param-end:[storage-only-output-v0.s3#bucket] --> */}
          </Tab>

          <Tab title="Azure Storage">
            {/* <!-- param-start:[storage-only-output-v0.azure#account] | warehouses: [redshift] --> */}

            <ResponseField name="Storage Account" type="drop-down" required>
              Select a storage account linked to your desired blob container to be used for staging the data. For more information, read [Storage account overview](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-overview).
            </ResponseField>

            {/* <!-- param-end:[storage-only-output-v0.azure#account] --> */}

            {/* <!-- param-start:[storage-only-output-v0.azure#container] | warehouses: [redshift] --> */}

            <ResponseField name="Container" type="drop-down" required>
              Select a Blob container to be used for staging the data. For more information, read [Introduction to Azure Blob storage](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction).
            </ResponseField>

            {/* <!-- param-end:[storage-only-output-v0.azure#container] --> */}
          </Tab>

          <Tab title="Google Cloud Storage">
            {/* <!-- param-start:[storage-only-output-v0.gcs#bucket] | warehouses: [redshift] --> */}

            <ResponseField name="GCS Bucket" type="drop-down" required>
              The drop-down menu will include Google Cloud Storage (GCS) buckets tied to the [cloud provider credentials](/docs/guides/cloud-credentials) that you have associated with your [environment](/docs/guides/environments).
            </ResponseField>

            {/* <!-- param-end:[storage-only-output-v0.gcs#bucket] --> */}

            {/* <!-- param-start:[storage-only-output-v0.gcs#overwriteAllowed] | warehouses: [redshift] --> */}

            <ResponseField name="Overwrite" type="boolean" required>
              Select whether to overwrite files of the same name when this pipeline runs. Default is Yes.
            </ResponseField>

            {/* <!-- param-end:[storage-only-output-v0.gcs#overwriteAllowed] --> */}
          </Tab>
        </Tabs>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Google BigQuery">
    <ResponseField name="Destination" type="drop-down" required>
      Select the destination for your data:

      * **Google BigQuery:** Load your data into a table in Google BigQuery.
      * **Cloud Storage:** Load your data directly into files in your preferred cloud storage location. The format of these files can differ between source systems and will not have a file extension. Check the output to determine the format of the data.
    </ResponseField>

    <Tabs>
      <Tab title="Google BigQuery">
        <ResponseField name="Project" type="drop-down" required>
          Select the Google BigQuery project to load data into. The special value `[Environment Default]` uses the project defined in the environment.
        </ResponseField>

        <ResponseField name="Dataset" type="drop-down" required>
          Select the Google BigQuery dataset to load data into. The special value `[Environment Default]` uses the dataset defined in the environment.
        </ResponseField>

        <ResponseField name="Table Name" type="string" required>
          The name of the table to be created in your Google BigQuery project. You can use a [Table Input](/docs/components/table-input) component in a transformation pipeline to access and transform this data after it has been loaded.
        </ResponseField>

        <ResponseField name="Load Strategy" type="drop-down" required>
          * **Replace:** If the specified table name already exists, that table will be destroyed and replaced by the table created during this pipeline run.
          * **Truncate and Insert:** Each time the pipeline runs, two operations are performed: first, the table is truncated, meaning all existing rows are deleted. Then, your new rows are inserted. The table itself is never destroyed and recreated.
          * **Fail if Exists:** If the specified table name already exists, this pipeline will fail to run.
          * **Append:** If the specified table name already exists, then the data is inserted without altering or deleting the existing data in the table. It's appended onto the end of the existing data in the table. If the specified table name doesn't exist, then the table will be created, and your data will be inserted into the table.
        </ResponseField>

        <ResponseField name="Column Mapping" type="column editor" required>
          In the tree structure representing the source data, select the checkboxes next to the fields that you want to output from this connector, then click **Save**.

          Unselected fields will not be included in the output from this connector.

          For each field you select, you can click the **Edit Alias** icon to change the name used for this field in all downstream components in this pipeline.
        </ResponseField>

        <ResponseField name="Primary Keys" type="dual listbox">
          Select one or more columns to be designated as the table's primary key.
        </ResponseField>

        <ResponseField name="Clean Staged Files" type="boolean" required>
          * **Yes:** Staged files will be destroyed after data is loaded. This is the default setting.
          * **No:** Staged files are retained in the staging area after data is loaded.
        </ResponseField>

        <ResponseField name="Partition Type" type="drop-down">
          Select the time period to use to partition the data loaded into your table, for example **Day** or **Month**.
        </ResponseField>

        <ResponseField name="GCS Bucket" type="drop-down" required>
          Select the Google Cloud Storage (GCS) bucket linked to your Google Cloud Platform account.
        </ResponseField>

        <ResponseField name="Overwrite" type="boolean" required>
          Select whether to overwrite files of the same name when this pipeline runs. Default is **Yes**.
        </ResponseField>
      </Tab>

      <Tab title="Cloud Storage">
        <ResponseField name="Load Strategy" type="drop-down">
          * **Append Files in Folder:** Appends files to storage folder. This is the default setting.
          * **Overwrite Files in Folder:** Overwrite existing files with matching structure.
        </ResponseField>

        <ResponseField name="Folder Path" type="string">
          The folder path for the files to be written to. Note that this path follows, but does not include, the bucket or container name.
        </ResponseField>

        <ResponseField name="File Prefix" type="string">
          A string of characters that precedes the name of the written files. This can be useful for organizing database objects.
        </ResponseField>

        <ResponseField name="Storage" type="drop-down" required>
          A cloud storage location to load your data into files for storage. Choose either Amazon S3, Azure Storage, or Google Cloud Storage.
        </ResponseField>
      </Tab>
    </Tabs>
  </Tab>
</Tabs>

### Advanced Settings

<ResponseField name="Log Level" type="drop-down">
  Set the severity level of logging. Choose from Error, Warn, Info, Debug, or Trace. Logs can be found in the **Message** field of the [task details](/docs/guides/designer-ui-basics#task-history-tab) after the pipeline has been run.
</ResponseField>

{/* <!-- param-start:[api-extract-input-v2.loadSelectedData] | warehouses: [snowflake, databricks, redshift] --> */}

<ResponseField name="Load Selected Data" type="boolean">
  Choose whether to return the entire payload or only selected data objects. Read [Structure](/docs/guides/custom-connector-setup#structure) to learn how to select which data objects to include in your API response.

  * **No:** Will return the entire payload. This is the default setting.
  * **Yes:** Will return only the objects in Custom Connector that are marked as **Selected Data** in the **Structure** setting.
</ResponseField>

## Deactivate soft delete for Azure blobs (Databricks)

If you intend to set your destination as Databricks *and* your stage platform as Azure Storage, you must turn off the "Enable soft delete for blobs" setting in your Azure account for your pipeline to run successfully. To do this:

1. In the [Azure portal](https://portal.azure.com/), navigate to your storage account.
2. In the menu, under **Data management**, click **Data protection**.
3. Clear the **Enable soft delete for blobs** checkbox. For more information, read [Soft delete for blobs](https://learn.microsoft.com/en-gb/azure/storage/blobs/soft-delete-blob-overview).
