> ## 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.

# SuiteCRM

export const CommonDatasourceMoreInformation = ({datasource = "the data source", advancedurl = "", siteName = "CData Sync", driverVersion = ""}) => {
  return <>
      <p>
        For more information about interactions between {siteName} and {datasource}, see{' '}
        <a href={`https://cdn.cdata.com/help/${advancedurl}${driverVersion}/synch/default.htm`}>
          {datasource} Connector for {siteName}
        </a>.
      </p>
    </>;
};

export const CommonDatasourceAddConnector = ({datasource = "the data source", title = "the connector", destination = false, siteNameShort = "Sync"}) => {
  return <>
      <p>
        To enable {siteNameShort} to use data from {datasource}, you first must add the
        connector, as follows:
      </p>
      <ol>
        <li>Open the <strong>Connections</strong> page of the {siteNameShort} dashboard.</li>
        <li>Click <strong>Add Connection</strong> to open the <strong>Select Connectors</strong> page.</li>
        <li>
          Click the <strong>{destination ? "Destinations" : "Sources"}</strong> tab and locate
          the <strong>{title}</strong> row.
        </li>
        <li>
          Click the <strong>Configure Connection</strong> icon at the end of that row to open
          the <strong>New Connection</strong> page. This action opens the{' '}
          <strong>Add Connection</strong> dialog box.
          <br />
          <strong>Note:</strong> If the <strong>Configure Connection</strong> icon is not
          available, click the <strong>Download Connector</strong> icon to install
          the {title} connector.
        </li>
        <li>Enter a name for your connection in the <strong>Add Connection</strong> dialog box.</li>
        <li>Click <strong>Add</strong> to open the <strong>Settings</strong> tab for your connector.</li>
      </ol>
      <p>
        For more information about installing new connectors, see{' '}
        <a href="../connections">Connections</a>.
      </p>
    </>;
};

export const CommonDatasourceIntroSource = ({datasource = "the data source", siteName = "CData Sync"}) => {
  return <p>
      You can use the {datasource} connector from the {siteName} application to capture data
      from {datasource} and move it to any supported destination. To do so, you need to add
      the connector, authenticate to the connector, and complete your connection.
    </p>;
};

export const driverVersion = "M";

export const siteNameShort = "Sync";

export const siteName = "CData Sync";

export const datasource = "SuiteCRM";
export const pageTitle = "SuiteCRM";
export const advancedurl = "ET";

<CommonDatasourceIntroSource datasource={datasource} siteName={siteName} />

## Add the SuiteCRM Connector

<CommonDatasourceAddConnector datasource={datasource} title={pageTitle} destination={false} siteNameShort={siteNameShort} />

## Authenticate to SuiteCRM

After you add the connector, you need to set the required properties.

**URL:** Enter the URL for your SuiteCRM account (for example, http\://*YourSuiteCRMInstance*.com.).

{datasource} supports two API schema types. Select your schema below to proceed to the relevant section for your schema.

* [**SuiteCRM V4.1 API**](#suitecrm-v41-api) (default)
* [**SuiteCRM V8 API**](#suitecrm-v8-api)

### SuiteCRM V4.1 API

To connect to {datasource} with the SuiteCRM V4.1 API, specify the following properties:

* **Schema:** Select **suitecrmv4**.
* **Auth Scheme:** The only available authentication (auth) scheme for the **suitecrmv4** schema is [**Basic**](#basic).

### SuiteCRM V8 API

To connect to {datasource} with the SuiteCRM V8 API, specify the following properties:

* **Schema:** Select **suitecrmv8**.
* **OAuth Client Id:** Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.
* **OAuth Client Secret:** Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.
* **Auth Scheme:** Select the authentication method that you want to use to connect to {datasource}.
  * [**OAuth Client**](#oauth-client) (default)
  * [**OAuth Password**](#oauth-password)

## SuiteCRM V4.1 Authentication Method

### Basic

To connect with your user credentials, set the following properties:

* **Auth Scheme:** Select **Basic**.
* **User:** Enter the username that you use to authenticate to your {datasource} account.
* **Password:** Enter the password that you use to authenticate to your {datasource} account.

## SuiteCRM V8 Authentication Methods

### OAuth Client

To connect with OAuth client credentials, select **OAuthClient** for **Auth Scheme**. No additional properties are required.

### OAuth Password

To connect with your user credentials, specify the following properties:

* **Auth Scheme:** Select **OAuthPassword**.
* **User:** Enter the username that you use to authenticate to your {datasource} account.
* **Password:** Enter the password that you use to authenticate to your {datasource} account.

## Complete Your Connection

To complete your connection:

1. Define advanced connection settings on the **Advanced** tab. (In most cases, though, you should not need these settings.)
2. Click **Create & Test** to create your connection.

## More Information

<CommonDatasourceMoreInformation datasource={datasource} advancedurl={advancedurl} siteName={siteName} driverVersion={driverVersion} />