Skip to main content

Create Connection Window

On the Create Connection window, create and edit connections between Alteryx Analytics Cloud (AAC) and remote storage.

Note

Access to this page is governed by roles in your workspace. For more information, please contact your workspace administrator.

This window is available from the following locations:

  • From Import Data page: By default, the window displays connections that support import. Uncheck the box to display all available connection types.

  • From Run Job page: When you add a new connection as part of a publishing action, the window displays connections that support publishing by default.

  • From the Connections page: All available connections display.

    Note

    Some connection types might not be available for your environment.

Note

In your environment, the creation of connections might be limited to administrators only. For more information, please contact your workspace administrator.

Tip

Administrators can edit any public connection.

General Connection Notes:

  • After you create a connection, you can't change its connection type. You must delete the connection and start again.

  • You can create, manage, share, and delete connections on the Connections page. For more information. go to the Connections Page.

Database Connection Notes:

  • You can't delete database connections if their databases host imported datasets that are in use by AAC. Remove these imported datasets before deleting the connection.

  • Jobs created for datasets sourced from a database can't be executed on a Spark-based running environment.

Create Connection

In the Create Connection window, you search or browse for the type of connection to create.

Actions:

  • Use the Search bar to perform real-time searches of connection types.

  • Select 1 of the categories to browse for connection types that apply to the listed environment.

  • Select the type of connection to continue:

    • Import only: You can only use the connection to import data to AAC.

    • Publish only: You can only use the connection to publish data from AAC to the connection target.

    • Import and Publish: You can use the connection to import data and publish your outputs.

Tip

Early Preview connection types provide read-only access to the designated datastore. These limited-support connection types provide early access so that you can get started using your data. For more information, go to Early Preview Connection Types.

For more information on these connections, go to Connection Types.

Connection Configuration

This table covers the configuration settings for a typical configuration. For information on a specific connection, go to Supported Connection Types or Early Preview Connection Types.

Property

Description

Host

Host of the database.

Port

Port by which to access the database host.

Default values prepopulate based on the connection type you selected.

Connect String Options

(Optional) If access to the database requires special connection string options, you can paste or enter them here.

You only need to provide the parameter and string value. Example:

";transportMode=http;httpPath=cliservice"

Enable SSL

To use SSL to connect, check this box.

If this checkbox is not present, SSL connections for this database type aren't supported or are required.

No additional Connect String Options are required for supported database vendors.

Note

The database must be configured to receive SSL connections.

Service Name

(Oracle only) Name of the service. For example, enter orcl here.

Database

(PostgreSQL only) Name of the database to connect. The name of the default database is the username. You should change this value in most cases.

Credential Type

Depending on the type of datastore to which you are connecting, you might have multiple methods of providing credentials for authentication:

  • Basic: Provide username and password credentials as part of the connection definition.

  • OAuth 2.0: Connection uses OAuth 2.0 authentication to access the datastore.

    Note

    OAuth 2.0 authentication requires additional configuration. For more information, go to Enable OAuth 2.0 Authentication.

    Note

    For each type of connection that uses OAuth 2.0, you must create a client app and a client in AAC. For more information, go to Create OAuth2 Client.

    Note

    When you create the connection in this window for an OAuth 2.0 connection, you must select Authenticate to connect to the app using the OAuth 2.0 client. This step is required.

User Name

(Basic credential type) Username to access the database. This value is encrypted for security.

Password

(Basic credential type) Password for the specified user. This value is encrypted for security.

OAuth 2.0 Client

(OAuth 2.0 credential type) Select the OAuth 2.0 client to use to connect to the datastore.

Note

You must create a separate connection for each OAuth 2.0 client that is available in the dropdown.

Test Connection

After you configure the conneciton, select Test Connection to validate that AAC can connect to the database.

Advanced Options: Default Column Data Type Inference

You can choose to enable or disable type inferencing for individual connections when you create or edit the connection.

Advanced Options: Enable SSH Tunneling

If available, use the SSH tunneling option to configure SSH tunneling authentication between AAC and your database.

Note

SSH tunneling is available on a per-connection basis. It migh not be available for all connections.

For more information, go to Configure SSH Tunnel Connectivity.

Connection Name

Display name of the connection.

Note

This value must be unique among all connections.

Connection Description

User-friendly description for the connection.

When you've finished, select Create to save the connection.

Note

You can make the connection available to all users by sharing it. For more information, go to the Connections Page.

In this section: