Skip to main content
waffle.svg
Domo Knowledge Base

Adding a DataSet Using a Data Connector

Version 41

 

Intro

You can add a DataSet using a data connector. A data connector (similar to an alias or DSN) lets you define connection information to a DataSet. While adding a DataSet using a data connector, you can specify the connection information for the specific data provider. Afterwards when you power up cards you can use the DataSet by selecting the data connector by name.

This topic discusses the interface components common to all third-party connectors. For detailed information about connecting to all of Domo's 500+ public connectors, see Configuring Each Connector.

For information about the Data Center, see Data Center Layout.

Notes: 

  • Domo does not store or transmit user passwords.

  • If you experience issues connecting to connectors, ensure that appropriate IP addresses have been whitelisted. For more information, see Whitelisting IP Addresses for Connectors.

Video - Using Connectors

 

 

Adding a DataSet using a connector

When you add a DataSet using a data connector, it is stored in Domo where you can use it to power multiple cards without having to specify connection information to that DataSet in each card.

When you add a DataSet, you are automatically assigned as the DataSet owner. For information about changing the owner of a DataSet, see Changing the Owner of a DataSet.

You can access the interface for adding connector DataSets via the Appstore, the Data Center, or the  menu. 

 To add a DataSet using a data connector,

  1. Choose one of the following:

    • (Conditional) If you want to connect to data via the APPSTORE, do the following:

      1. Select Appstore in the toolbar at the top of the screen.

      2. Click the Connectors tab.

      3. Use the search bar or page navigation to locate the connector you want to connect to, then click it to open its details view.

      4. Click Get the Data.

        Alternatively, for some of the most popular connectors, a Get the Sample App button is available. This allows you to power up several prebuilt, live cards based on your own data, without having to configure advanced options. This is a great way to "preview" the connector to make sure it provides the data you want. If you choose this option, you are asked to select the desired account or input your account information if you haven't created an account for this connector yet.  

    • (Conditional) If you want to connect to data via the DATA CENTER, do the following:

      1. Select Data in the toolbar at the top of the screen.

      2. In the Connect Data area at the top of the screen, select Cloud AppFile, or Database, depending on the connection type.

        You can use the following table to learn more about these connector types:

        Connector Type

        Description

        Cloud App

        A connector for a third-party app in which data is stored in the cloud. Most of Domo's connectors fall into this category. Examples include Facebook, Salesforce, Adobe Analytics, and so on.

        File

        A connector used to pull files into Domo. Examples include Excel, Google Sheets, and Box.

        Database

        A connector in which you write a query to pull data from a database into Domo. Examples include MySQL, Amazon Redshift, and MongoDB.<


        The other two icons in this area denote other non-connector methods for bringing data into Domo. On Premise refers to Workbench, and API refers to Domo's development environment, where you can build your own custom connectors. For more information about Workbench, see Connecting to Data Using Workbench 5. For more information about Domo's development environment, see Building Custom Connectors in Domo.

      3. Select the data connector you want.
        If the connector you want is not in the list, you can click Show All Connectors.

      4. Click Get the Data.

        Alternatively, for some of the most popular connectors, a Get the Sample App button is available. This allows you to power up several prebuilt, live cards based on your own data, without having to configure advanced options. This is a great way to "preview" the connector to make sure it provides the data you want. If you choose this option, you are asked to select the desired account or input your account information if you haven't created an account for this connector yet.  

    • (Conditional) If you want to connect to data via the  menu, do the following:

      1. Select  > Data.

      2. Select Select Cloud AppFile, or Database.
        For more information about these connector types, see the above table.

  2. Specify the settings in each section.
    Refer to the general information included in this topic and to the help in the specific data connector.
    For more information about configuring specific data connectors, see Configuring Each Connector.
    As applicable, click Next or Save and open the next section.

  3. When finished, click Save.
    You are taken to the details view for the DataSet in the Data Center. For more information about this view, see Data Center Layout.

Connector settings

All connector types in Domo have different options for setting up a DataSet. Most connectors require you to enter login credentials, an API key, a server URL, or a combination of these to access the connector. If you cannot connect after entering your credentials, you have most likely entered incorrect credentials. For information about finding credentials, see the documentation for your specific connector. You can find this under Configuring Each Connector.

After you connect, you are usually asked for information about the data you want to pull and the desired format. Most connectors have two or more associated report types. In addition, many connectors request a timeframe for the data to be retrieved. You may also be asked to submit a query for retrieving data. For example, when connecting to JIRA you can enter a JQL query to retrieve data for a specified search filter.

For most connectors you are also asked to schedule data updates. You can use basic scheduling, in which you select a single, specific unit of time (such as "Every hour") and enter the time of day when the update is to occur, if required. Or you can use advanced scheduling, in which you can select multiple update times.

The information in this section is general and may or may not be required for a certain connector. For specific requirements for connectors, see Configuring Each Connector.         

Credentials

If required, specify the credentials for connecting to the data provider. If available, you can select an account or create an account to use in connecting. For more information about accounts, see Managing User Accounts for Connectors.

Some connectors, such as Google Drive, use OAuth to connect. This means that you only need to enter your credentials once for a given account. In the future, when you go to create a DataSet using this connector account, your credentials are passed in automatically. Other connectors do not use OAuth, so you must enter your credentials each time you create a DataSet using this connector account.

Details

Most connectors include a Details settings category. Here you usually specify options like the report to run, the timeframe for the data, a data query for pulling specific information from a database, and so on. If a query is required, the type of query you need to use depends on the connector type and the source data in your system.  

Click Load Preview to verify that your data is accessible. If connection errors occur, verify the specified connection information.

Scheduling

In the Scheduling settings category, you can specify the update schedule, retry settings, and update method you want for this DataSet.  

You can use either basic or advanced scheduling for connectors.

Basic scheduling

Update

In the Basic Scheduling tab, you can create a basic update schedule in which you specify a predefined update interval for this DataSet (such as "every Monday at 10:00 AM"). 

By default, schedules are set from the current time. Update intervals include every hour, day, weekday, week, month, and manually. Schedule times are based on UTC.

For hour, day, and week options, you can specify the interval (every # hours/days/weekdays) and the start period.

If you select Manually for your update interval, you can instruct Domo to send you a notification when the data has not been updated for a given period of time. Time periods range from one hour to three months.

Update Method

By default, Replace is the update method selected. Every time the DataSet runs, all new data brought in, based on the selections made under the Settings tab, will replace the data from the previous run.

When using the Append method, all of the new data brought in based on the selections made under the Settings tab will be appended to the bottom of the existing DataSet table. 

Advanced scheduling

In the Advanced Scheduling tab, you have more control over when data is updated than you do when using basic scheduling. You can create schedules by month, day of the month, or day of the week. You can even specify which days of the week out of the month you want to update (for example, every second and fourth Sunday).

You can indicate whether updates are done on a set interval (such as "every 15 minutes," "every 8 hours," etc.) or at a specified time. You can also set the start time (based on the current minute). If you want, you can set the update schedule to start immediately.

Schedule times are based on UTC.

Retry settings

Retry settings determine whether Domo should attempt to retry if updates fail for this DataSet and, if so, the frequency and maximum number of retries. These settings apply only to scheduled runs, not manual runs. You access the retry options dialog by clicking Change retry settings.

The options in this dialog are as follows:

Option

Description

Retry if the update is unsuccessful

Domo retries to update the DataSet. After retrying the specified number of times, Domo sends a notification if the update attempt is unsuccessful.

Do not retry if the update is unsuccessful

Domo sends a notification if the update attempt is unsuccessful, and no retries are made.

Update Method

When creating or editing a DataSet, you can specify whether to append or replace data when updates occur. The update options are found at the bottom of the Basic Scheduling and Advanced Scheduling tabs.

Option

Description

Replace

Replace the current version of the data with a new version of the data. Previous versions are preserved.

Append

Add data to the current version of the data, increasing the size of the DataSet.