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

# Connections Page

export const cloudEnv = false;

export const siteNameShort = "Sync";

export const siteName = "CData Sync";

{siteName} provides a comprehensive framework of connectors that enable you to create connections between various data sources and destinations. These connections establish pipelines through which you can transfer and synchronize your data across disparate systems.

The intuitive interface on the {siteNameShort} **Connections** page enables you to create these connections with ease so you can configure and manage data synchronization tasks efficiently. This summary page facilitates all of the activities related to creating connections, including the following tasks:

* [adding a connection](#adding-a-connection)
* [configuring a connection](#configuring-a-connection)
* [updating a connection](#updating-a-connection)
* [cloning a connection](#cloning-a-connection)
* [removing a connection](#removing-a-connection)

## Viewing Your Connections

You can view a list of all your connections from the **Connections** page. The table on this page summarizes your connections and enables you to manage them from a single access point.

<img src="https://mintcdn.com/cdata-sync/93zzHp_-s2rI0TUA/images/Connections-Page_viewing-your-connections_1.png?fit=max&auto=format&n=93zzHp_-s2rI0TUA&q=85&s=b092596c2c84626fe722c012a51c9f64" width="800" alt="Connections page" data-path="images/Connections-Page_viewing-your-connections_1.png" />

The connection records are displayed in rows, with columns that provide details about each connection. As shown above, you can specify the number of rows that you want to display on the page by selecting a number from the **X records per page** list at the bottom of the page.

{siteNameShort} provides details about your connections in four columns:

* **NAME:** Displays the connection name.
* **LABEL:** Displays any labels that you assign to your connection. You add labels in either of these ways:
  * Select **. . . > Add Labels** at the end of the connection row.
  * Click **Add Labels** in the **Labels** section on the **Overview** tab in the connection settings.
* **STATUS:** Lists the status of whether the connection was successful or whether it failed.
* **LAST MODIFIED:** Specifies the date and time that you last updated your connection.

If you click a connection name, {siteNameShort} displays the **Settings** page for that connection.

You can organize your connections list in ascending or descending order for the **NAME**, **STATUS**, or **LAST MODIFIED** columns. To order the columns, simply click the up (↑) and down (↓) arrows that are next to the column by which you want to sort.

In addition, you can filter the connections table by connection type and label. After you set filters, you can clear all filter options by clicking **Reset**. {siteNameShort} also enables you to save filters that you define so that you can use them later.

To add a filter:

1. Choose your filter options.

2. Select **Saved Filters > Add Saved Filter**.

   <img src="https://mintcdn.com/cdata-sync/93zzHp_-s2rI0TUA/images/Connections-Page_filtering-the-connections-table_1.png?fit=max&auto=format&n=93zzHp_-s2rI0TUA&q=85&s=62bac78d654e28daa4e3eb9872260fc9" width="250" alt="Add Saved Filter" data-path="images/Connections-Page_filtering-the-connections-table_1.png" />

3. This selection opens the **Add Saved Filter** dialog box.

4. Enter a name for your filter. Then, click **Add Saved Filter** to save the filter and exit the dialog box.

   <img src="https://mintcdn.com/cdata-sync/93zzHp_-s2rI0TUA/images/Connections-Page_filtering-the-connections-table_2.png?fit=max&auto=format&n=93zzHp_-s2rI0TUA&q=85&s=36bc8937c6a60ee73f5a3e6944745bbe" width="250" alt="Add Saved Filter dialog box" data-path="images/Connections-Page_filtering-the-connections-table_2.png" />

After you save the filter, its name appears in the **Saved Filter** list. Then, you can choose that filter from the list any time that you want to apply it.

## Adding a Connection

To add a connection:

1. Click **Connections** in the {siteNameShort} navigation bar to open the **Connections** page.
2. Click **Add Connection** to open the **Select Connectors** page.
3. Click either the **Sources** tab or the **Destinations** tab, depending on the type of connector that you want to download.
4. <a name="step4" /><span>Search for the connector that you want to add. Then, click the **Install Connector** (<img src="https://mintcdn.com/cdata-sync/I6gJ4qR9mocXqHNN/images/Connections_install-icon.png?fit=max&auto=format&n=I6gJ4qR9mocXqHNN&q=85&s=e920ba6a31fa6ae78bee16fed5dae789" style={{display: "inline", verticalAlign: "middle", margin: "0"}} alt="Install Connector icon" width="18" height="18" data-path="images/Connections_install-icon.png" />) icon that appears at the end of the row. When the connector installs successfully, you receive a message to that effect in the top right of the window.</span>

   <img src="https://mintcdn.com/cdata-sync/93zzHp_-s2rI0TUA/images/Connections-Page_installing-a-connector_1.png?fit=max&auto=format&n=93zzHp_-s2rI0TUA&q=85&s=80281747213eb19388326b56e85c3ebd" width="800" alt="Installing a connector" data-path="images/Connections-Page_installing-a-connector_1.png" />

<Note>If you want to see a list of only connectors that you already have installed, toggle the **Only Installed** switch to the right. (The switch is in the left corner above the connector list on the **Select Connectors** page.)</Note>

## Configuring a Connection

To configure a connection:

1. In the  {siteNameShort} application, locate your connection on the **Select Connectors** page.
2. Click the **Configure Connection** arrow (→) at the end of the connector row to open the **New Connection** page.
3. Specify basic connection properties on the **Settings** tab of your connector's page. Then, if necessary, configure advanced settings on the **Advanced** tab.
4. Click **Create & Test** to create your connection.

<h2 id="controlling-proxy-and-firewall-settings-at-the-connection-level">Controlling Proxy and Firewall Settings at the Connection Level</h2>

<p>You can control whether a connection uses the global proxy configuration or its own proxy or firewall settings. This behavior is managed by the <strong>Use Global Proxy Settings</strong> option on each connection.</p>

<img src="https://mintcdn.com/cdata-sync/I6gJ4qR9mocXqHNN/images/Connections-Page_controlling-proxy-and-firewall-settings-connection-level_1.png?fit=max&auto=format&n=I6gJ4qR9mocXqHNN&q=85&s=456b583d60e96f2809b6522419e9d41b" width="500" alt="Use Global Proxy Settings option on a connection" data-path="images/Connections-Page_controlling-proxy-and-firewall-settings-connection-level_1.png" />

<p>Depending on how this option is set, {siteNameShort} either applies the global proxy configuration and hides connection-level settings or displays and uses connection-specific proxy or firewall settings on the <strong>Advanced</strong> tab.</p>

<p>For new connections, the <strong>Use Global Proxy Settings</strong> option is enabled by default. For existing connections, it is disabled to preserve the current configuration.</p>

<ul>
  <li>When the option is enabled, the connection inherits the proxy configuration that is defined in <strong>Settings > Advanced > Proxy Settings</strong>. Connection-level proxy and firewall settings on the <strong>Advanced</strong> tab are hidden.</li>

  <li>
    When the option is disabled, the connection displays and uses its own proxy or firewall configuration on the <strong>Advanced</strong> tab. By default, the value for <strong>Firewall Type</strong> is <strong>NONE</strong>; no proxy or firewall settings are applied until you select a type.

    <img src="https://mintcdn.com/cdata-sync/I6gJ4qR9mocXqHNN/images/Connections-Page_controlling-proxy-and-firewall-settings-connection-level_2.png?fit=max&auto=format&n=I6gJ4qR9mocXqHNN&q=85&s=9229fc71fcd6b42e2439dc59a9206e02" width="700" alt="Connection-level proxy and firewall settings on the Advanced tab" data-path="images/Connections-Page_controlling-proxy-and-firewall-settings-connection-level_2.png" />

    <strong>Proxy</strong> and <strong>Firewall</strong> settings are mutually exclusive. {siteNameShort} applies firewall settings when <strong>Type</strong> is set to <strong>TUNNEL</strong>, <strong>SOCKS4</strong>, or <strong>SOCKS5</strong>, and it applies proxy settings when <strong>Type</strong> is set to <strong>HTTP</strong>.
  </li>
</ul>

<p>For information about global proxy and firewall settings, see <a href="./settings-page/settings-page#proxy-settings">Proxy Settings</a>.</p>

## Updating a Connection

In {siteNameShort}, you can update a connection either by adding a new version or by selecting a different version, as explained below. Only users with the **cdata\_admin** role are authorized to update connections.

To update a connection:

1. Click **Connections** in the {siteNameShort} navigation bar to open the **Connections** page.
2. For the connector that you want to update, click the options menu (**...**) at the end of that row and select **Update Connector**. This option opens the **Update Connector** dialog box.

   <img src="https://mintcdn.com/cdata-sync/93zzHp_-s2rI0TUA/images/Connections-Page_updating-a-connection_1.png?fit=max&auto=format&n=93zzHp_-s2rI0TUA&q=85&s=631dc86f186f5b601451529a079fa7af" width="450" alt="Update Connector dialog box" data-path="images/Connections-Page_updating-a-connection_1.png" />

   This dialog box lists the current version and displays two update options:

   * **Select Version:** Provides a list of available connector versions in descending order. (You can change the order of the versions by clicking the arrow next to the **VERSION** column.)

     This option enables you to select from the following items:

     * all installed versions
     * the latest downloadable version that is available from the website

     **Notes:**

     * If the selected version is not installed, it is downloaded and installed automatically from the website.
     * All connections of that same type are updated to use the new version of the connector. However, when you create a new connection, {siteNameShort} always defaults to the latest available version, regardless of the versions that are used by other existing connections of the same type.
     * If more than three versions of the same connector are installed, the latest version is deleted to maintain version control.
   * **Add New Version:** Enables you to manually add a new connector version that is not yet listed. Select this option if you have obtained a connector version through an alternate method of distribution.
3. Select the update option that you want to use.

   * **Select Version:** Select the version that you want to use from the list. Then, click **Update** (bottom right corner). When the update is complete, a message stating that it was successful is displayed in the top right corner of the {siteNameShort} window.
   * **Add New Version:** Click **Choose File** to open an explorer window and select the file from which you want to download the new version, as shown below.

     <img src="https://mintcdn.com/cdata-sync/93zzHp_-s2rI0TUA/images/Connections-Page_updating-a-connection_2.png?fit=max&auto=format&n=93zzHp_-s2rI0TUA&q=85&s=32fe326909b08b30928e4c5b52619a46" width="450" alt="Add New Version" data-path="images/Connections-Page_updating-a-connection_2.png" />

   Then, click **Update** (bottom right corner). When the update is complete, the dialog box closes and a message stating that it was successful is displayed in the top right corner of the {siteNameShort} window.

The next time that you open the **Update Connector** dialog box, the new version appears at the top. The new version also appears at the top of your connection's properties page.

## Cloning a Connection

Instead of adding an entirely new connection, you can clone an existing one. Cloning creates a new connection by copying the settings and tasks from an existing connection.

To clone a connection:

1. Locate the connection that you want to clone and select **Clone** from the options menu (**...**). This option opens the **Clone Connection** dialog box, where you can define the connection that you want to clone.

2. Enter a name for your new connection. The **Type** category below the **Name** text box shows the name and the associated icon for the connection that you are cloning.

   <Note>In order to clone the connection in the current workspace, the name you enter must be different than the original connection name.</Note>

3. (Optional) Select **Clone in a different workspace** if you want to clone the connection in a different workspace. When you choose this option, a **Workspace** list box is displayed from which you can select a different workspace.

   <img src="https://mintcdn.com/cdata-sync/93zzHp_-s2rI0TUA/images/Connections-Page_cloning-a-connection_1.png?fit=max&auto=format&n=93zzHp_-s2rI0TUA&q=85&s=dbd199c9dc3352bdc0e78ceda6240847" width="450" alt="Clone Connection dialog box" data-path="images/Connections-Page_cloning-a-connection_1.png" />

4. Click **Clone Connection** to clone your connection.

After you perform these steps, your cloned connection is displayed in the connections table on the **Connections** page.

If you want to change the configuration for your new connection, select **... > Edit** to open the configuration page for your new connection. This page contains four tabs: **Settings**, **Advanced**, **Logs**, and **Comments**.

1. On the **Settings** tab, define any settings that are not replicated via the cloning process (for example, **Server**) or modify any existing settings that you want to change. You can also add a connection label, set logfile verbosity, or define a refresh interval for the metadata cache from this page.
2. (Optional) Configure any additional settings that you want from the **Advanced** tab.
3. (Optional) Use the **Logs** tab to view, filter, or download logs.
4. (Optional) Add comments about your connection on the **Comments** tab. Each comment is saved with a timestamp for reference on that tab.

When you finish updating the settings:

1. Click **Test** in the top right of the window to verify that your connection settings are valid.
2. <span>Click the **Update Connector** (<img src="https://mintcdn.com/cdata-sync/I6gJ4qR9mocXqHNN/images/Connections_install-icon.png?fit=max&auto=format&n=I6gJ4qR9mocXqHNN&q=85&s=e920ba6a31fa6ae78bee16fed5dae789" style={{display: "inline", verticalAlign: "middle", margin: "0"}} alt="Update Connector icon" width="18" height="18" data-path="images/Connections_install-icon.png" />) icon to save and update your configuration.</span>

## Removing a Connection

To remove a connection:

1. Select **... > Delete** for the connection that you want to remove. This selection opens the **Remove Connection** dialog box.

   <img src="https://mintcdn.com/cdata-sync/93zzHp_-s2rI0TUA/images/Connections-Page_removing-a-connection_1.png?fit=max&auto=format&n=93zzHp_-s2rI0TUA&q=85&s=c03b5dbfd9ce4b0ec14b75615e78f44f" width="300" alt="Remove Connection dialog box" data-path="images/Connections-Page_removing-a-connection_1.png" />

2. Click **Remove** to delete the connection permanently.

## More Information

See [**Connections**](../../connections/connections) for detailed information about the following topics:

* installing new connectors that are not part of your {siteNameShort} bundle
* connection documentation for specific sources and destinations
