Saltar al contenido principal

Domo University Videos

Domo

Connecting to JSON Data in Workbench 4

Important: When referencing this page outside of Knowledge Base, use this link: https://knowledge.domo.com?cid=wb4json

You can create a JSON DataSet Job in Workbench 4. When you select JSON as your Data Source type, you can specify the data node with data you want to retrieve, the delimiter, and how you want the data to be flattened.

To create a JSON DataSet Job in Workbench 4,

  1. Click Add New in the DataSet Jobs grouping in the Buttons toolbar at the top of the Workbench window.
    This opens the Workbench DataSet Job Creation Wizard.

  2. (Conditional) If requested, select the desired Domo server. (This screen only appears if you have more than one server set up in Workbench.)

  3. In the DataSet Job Name field, enter a name for the DataSet Job. This is the name of the job as it appears in Workbench, not the name of the uploaded DataSet in Domo.

  4. In the DataSet Name field, enter the name of the DataSet. This is the name of the uploaded DataSet in Domo.

  5. Select the desired update method in the Update Method menu:

    • Select Replace DataSet if you want the DataSet to be replaced entirely upon updating.

    • Select Append to DataSet if you want new data to be added to the existing data set upon updating.

  6. In the Transport Method menu, select Local File Provider, External Process File Provider, or FTP/SFTP File Provider.

    Descriptions for these transport methods are as follows:

    Transport Method

    Description

    Local File Provider

    Lets you select a file from your machine or a network.

    External Process File Provider 

    Lets you use a third-party application to pull data into Domo using a script. 

    FTP/SFTP File Provider Lets you retrieve a file via FTP, SFTP (SSH-FTP), or FTPS (FTP-SSL)

     

  7. Click Next.

  8. In the Data Source menu, select JSON.

  9. In the DataSet Type field, select the type of DataSet in the dropdown or enter a custom name.
    The DataSet type you select or enter here is reflected as the connector type in Domo after you execute the job.

    Tip: It is recommended that you select or enter the DataSet type that tells users what data is being represented, not the data reader you are using to present the data. For example, you might be connecting to a JSON file that contains Twitter data. In this case the best option would be to enter "Twitter" rather than selecting JSON because the data you are representing in Domo is from Twitter.
  10. (Optional) Enter a description in the DataSet Description field.

    Note: You can change any of the settings you made in the above steps in the Source panel for the DataSet Job after you complete all of the steps in the Wizard except the transport method.  

     

  11. Click Next.
    A new JSON DataSet Job is added to the list of jobs for the currently authenticated server in the Accounts pane.

  12. Under the JSON DataSet Job that was just added to the jobs list, select Source
    A panel opens with options for configuring your file transport and setting options for your JSON data source.

  13. (Conditional) Do one of the following:

    • If you selected Local File Provider as your Transport Method...

      1. Click the ellipsis (...) in the File Path field.

      2. Select the desired JSON file from your machine or network.

    • If you selected External Process File Provider as your Transport Method...

      1. Click the ellipsis (...) in the Program Executable field.

      2. Select the desired executable file from your machine or network.

      3. (Optional) Enter arguments in the Arguments field, if any.

      4. Click the ellipsis (...) in the Output File Path field.

      5. Select the desired output file path on your machine or network.
        The file type for the output path must be JSON.

    • If you selected FTP/SFTP File Provider as your Transport Method...

      1. Enter the server name in the Server field.

      2. Enter the port number in the Port field.

      3. Enter your server credentials in the Username and Password fields.

      4. Select the desired protocol (FTP, SFTP, or FTPS).

      5. (Optional) If you have an SSL certificate (SFTP and FTPS only), configure the settings as necessary.
        For more information about these settings, see SFTP File Provider.

      6. In the Remote File field, enter the filename for the field you want to import.

  14. Click Validate Configuration.

  15. In the Data Source field, enter the data node where you want to begin pulling JSON data. 
    This should be an array of objects (for example, Key5_Key3). 

  16. In the Delimiter field, enter the delimiter that should be inserted into the column name in flattened results.

  17. In the Flattening Options menu, select how you want the data to be flattened. Options are as follows: 

    Option

    Description

    None 

    Returns  the unflattened JSON string.

    Deep 

    Adds new rows for all nested objects. 

    Wide 

    Adds new columns for all nested objects. Only one row is returned. 

You are now ready to execute the DataSet Job, thereby creating a JSON DataSet in Domo. However, there are many other actions you can take on the DataSet job before you send it to Domo. These include the following: