Skip to main content
waffle.svg
Domo Knowledge Base

Inline Editing Implementation Guide

Version 3

 

Inline Editing Implementation Guide 

This guide is intended to help you connect your Inline Editing app with your own data. For more information on the Inline Editing app, please visit the Inline Editing App article.

 Step 1: Prepare Your Data

The Inline Editing app is built to handle two types of data models: standard and upsert datasets. For this version of the app, connector-based datasets that are updated through outside sources are not recommended, as any changes you save will be overwritten by data coming through the connector. 
 

Standard datasets have some inherent limitations in terms of how they can be updated, and because of this if your app is using a standard dataset you will be limited to datasets that have 100,000 or fewer rows and 500 or fewer columns. 

Upsert datasets can be any size, but they take a little extra effort to set up. To convert a dataset to an upset dataset, follow these optional steps: 

Set Your Dataset to 'Append' Updating in Domo

1. Navigate to your dataset in Domo

2. Click on the Settings tab, then click on the 'Update Mode' setting

3. Click 'Change update settings', then choose 'Append' from the dropdown and save.

Define Your Upsert Keys

Upsert keys are a group of columns in your data that when put together create a unique key for each row—these keys need to be manually set. Follow this process to set your keys: 

1. Download the Java CLI tool using the following link: 

https://app-domo-com-prod.s3.amazonaws.com/labs/java-sdk/latest/domoUtil.jar

2. Navigate to and run the JAR file from either your terminal or command line tool.
 

EG: To do this in the Mac Terminal, make sure you have java installed and then navigate to the correct directory and use the following command: 'java -jar domoUtil.jar'

3. When the program is running in your command line, you'll first need to connect to your Domo instance and use the command:

connect -s <domain> -t <access_token>

Where domain is the name of your Domo instance (ex: mycompany.domo.com) and access_token is a generated access token from your Domo instance. Access tokens can be generated by Admins in your Domo instance by navigating in Domo to Admin > Security > Access Tokens and clicking 'Generate Access Token'.

4. After you have connected to your instance, use the following command: 

define-upsert -i <dataset_id> -c <columns>

Where dataset_id is the dataset id of the dataset that you want to set as an upsert dataset and <columns> is a comma-separated list of columns names that you want to use as upsert keys (ex: "Column 1", "Column 2"). Remember to use double quotes around any columns that have spaces in the column name. 

5. To check to see if this process worked, use the following command:

get-schema -i <dataset_id> 

and check to see if 'upsertKey' is set to true for the columns that you passed through in the last command. After you've done this, you can close the CLI tool and your dataset should now be ready to go! 

Step 2: Deploy the App with Your Dataset

If you have access to the app asset, deploy the app from your Asset Library and connect your dataset to it—otherwise have whoever is deploying the app for you connect it to your dataset. 

Finally, using the configuration pieces of the app is limited to members of a configuration group that needs to be created in your Domo instance. Have a Domo admin in your instance navigate to Admin > Group and create a new group called _Inline_Edit_Owners (case sensitive). Add anyone to this group that you want to be able to set configuration options for the columns in the app. 

Step 3: Enjoy!

After these steps, the app should now be ready to use. Members of the group you've set up should see a three-dot menu at the top of each column in the app. Use this menu to set if a column can be edited, if an entry in that column is required, and the entry method for each column.