Skip to content

Latest commit

 

History

History
88 lines (55 loc) · 3.88 KB

destination-setup-guide-template.md

File metadata and controls

88 lines (55 loc) · 3.88 KB

{This is a destination connector setup guide template. Items between curly brackets need to be replaced with specific names or directions. For links to Fivetran documentation pages/sections, do not use the absolute path format like page name, use page/section name instead. Also, do not include /index.md in the path, trim the path at the page directory. For example, connector page name is correct, while connector page name is incorrect.}

name: {Item name in the left nav menu} title: {SEO title} description: {Meta Description} hidden: {true or false. Set to true if the article should only be accessible via a direct link and not indexed by crawlers.}

{Destination Name} Setup Guide

Follow our setup guide to connect {Destination} to Fivetran.

Prerequisites

To connect a {Destination} to Fivetran, you need the following:

{List what the user needs to know or do before they get started}

  • A Fivetran role with the Create Destinations or Manage Destinations permissions

  • Administrator account {this is an example}*

  • Version 17 of Acme installed {this is an example}

    *NOTE: If you have an account tier system, this section should specify the minimum account tier required for your customers to set up a destination.

Setup instructions

{Descriptive name of the step; for example, Get your API key}

  1. Enumerate the steps.
  2. List one action per step. {use screenshots when needed}

Second step

  1. Enumerate the steps.
  2. List one action per step. {use screenshots when needed}

Complete Fivetran configuration

{Required}

  1. Log in to your Fivetran account.

  2. Go to the Destinations page and click Add destination.

  3. Enter a Destination name of your choice and then click Add.

  4. Select as the destination type.

  5. In the destination setup form, enter the Host name you found in Step 1.

  6. Enumerate the steps in from the destination setup form.

  7. List one action per step.

  8. Click Save & Test.

    Fivetran tests and validates the connection. Upon successfully completing the setup tests, you can sync your data using Fivetran connectors to the destination.

Setup tests

Fivetran performs the following {Destination} connection tests: :

The Host Connection test checks the host's accessibility and validates the database credentials you provided in the setup form.

  • The Validate Passphrase test validates your private key against the passphrase if you use key-pair authentication.

  • The Default Warehouse test checks if the Snowflake warehouse exists and if you have set it as the default warehouse.

  • The Database Connection test checks if we can connect to your Snowflake database. The Permission test checks whether we have the CREATE SCHEMA and CREATE TEMPORARY TABLES permissions on your Snowflake database.

    NOTE: The tests may take a couple of minutes to complete.

Related articles

description Destination Overview

assignment Release Notes

settings API Destination Configuration

home Documentation Home