Skip to main content

​
Intro

Workbench is a Windows-based application and one way to securely bring your data into Domo. You can bring data in manually or automatically on a schedule.
  • ou can upload data from databases via data queries in ODBC/OLAP System DSNs, CSV and delimted text files, Microsoft Excel spreadsheets, Jira, QuickBooks, JSON and XML namespaces.
  • You can upload data manually or through scheduled jobs.
Workbench validates the data and securely transfers it to Domo. Workbench allows you to import/export files of the following types:
  • CSV
  • Excel
  • JSON
  • ODBC
  • OLAP
  • Quickbooks
  • XML
  • Create groups of DataSet jobs that run on the same schedule
  • Import and export job files
  • Preview and validate jobs before you run them
  • Add, create, save, and delete accounts
  • Add, create, save, delete, open, preview, and cancel jobs
  • Revert back to a previous version of a job you saved
  • Add/delete transforms to/from jobs, which includes the following:
    • Add new columns
    • Change date format
    • Encrypt sensitive data in specific columns
    • Filter columns in the DataSet
    • Set the time zone for the DataSet job
    • Replace column values in the DataSet
    • Combine the DataSet with another DataSet
  • View logs
  • Send logs as a zip file
  • Run logs from the command line
  • Add and manage plugins for using Workbench
  • Set up notifications for DataSet jobs that can email you if DataSets are uploaded successfully or if it experiences an error
To read a white paper about making your Workbench data more secure in Domo by means of encryption, click here: Whitepaper_Domo+Data+Security+and+Encryption+Draft.pdf Workbench also allows you to do some transformations on your data: calculations, custom dates, filtering, search and replace. If you need to perform encryptions on data files, Workbench is the only place in Domo to do that.
This article provides information about Workbench in the following topics:
  • Available languages
  • Security settings
  • Install latest version of Workbench
  • Run Workbench 5

​
Available Languages

Workbench 5 is available in the same languages as the rest of the Domo product, listed below:
  • English
  • Japanese
  • French
  • German
  • Spanish
  • Chinese
Workbench 5 automatically syncs with the configured user language on your machine. If the language of your machine is not available for Workbench, the default language for the tool is English. If you would like Workbench in a language not shown in the list above, contact Domo Support.

​
Security Settings

Access the security settings for Workbench 5 from the sidebar by selecting More > Settings.
security settings.png
Under Security, you can check boxes to enable the following options, described below:
  • Only run locally managed jobs — When enabled, this option only allows jobs to be run that are created on this specific machine. Jobs created through the API or any other sources do not run. This prevents hacking of your Workbench API.
  • Limit concurrent jobs — When enabled, this option causes Workbench to request non-default credentials for all DataSet jobs. This means that no jobs can be run as the local system. Because users are forced to enter non-default credentials, jobs are run at the proper security level. This option is only available if you have administrator privileges.

​
Can Workbench update or make any changes to our original data?

No, Workbench does not modify your original data. It is designed to read and transmit data to Domo. Workbench does let you modify the data going in to Domo through transforms, calculations, and joins.
Note: For database connections only, if your ODBC driver supports read/write, any queries you pass into your database can be considered a “write.” For example, temp tables, inserts, or deletes are entirely possible with Workbench and database connections. Consider using read-only credentials for your database connections if there is cause for concern.
What type of encryption does Workbench use to transmit data? All data transferred from Workbench into Domo’s production systems is sent using encrypted HTTPS sessions, the same technology you typically use to conduct online banking and online purchases. No data is sent from Workbench to Domo in an unencrypted manner. If access credentials cannot be stored as part of the Windows DSN, how are those credentials stored? Workbench stores access credentials for ODBC DataSets. To properly protect these credentials, Workbench uses industry standard AES-256 bit encryption or RSA encryption with a key stored locally on your computer (depending on the length of data being encrypted). Workbench enforces encryption automatically so users do not have the opportunity of mistakenly storing their passwords or other credentials inappropriately. How are access controls configured for Workbench? Workbench is configured by the client from an access control perspective. Workbench allows users to upload DataSets into Domo to enable KPI card creation and automated updates. Users select DataSets (System DSNs, flat files, Microsoft Excel spreadsheets, JIRA, QuickBooks, JSON, XML namespaces) to which they already have access. Workbench can connect to DataSets only if the Microsoft Windows system running the software can reach the DataSet, and if the machine has access to read the DataSet files or databases. Is any of the data transmitted by Workbench cached on the local machine? Workbench uses a temp directory (%PROGRAMDATA%\Domo\Workbench\DomoCache) to stage incoming data. If you have many DataSet Jobs with a large number of rows, this temp directory can fill up with a large amount of data. Make sure the C:\ drive has a reasonable amount of free space for these files. These files are cleared when the job is complete and are not permanently stored. Do you support Windows 32 and 64-bit versions? Yes, both 32 and 64-bit Windows versions are supported. For more system requirements information, see Installing Workbench 5. Are 32-bit ODBC connections supported? Yes. Workbench concurrently supports both 32- and 64-bit ODBC drivers. What is the maximum size of a DataSet that Workbench supports? Workbench has no row limit for a single upload job. You can use a `lastvalue` variable to upload rows incrementally. For more information about query parameters, see Understanding the Workbench 5 User Interface. Can Workbench run from a command line? Yes, Workbench can be executed directly from a command line and/or added as a task in an ETL package. For more information about running Workbench from the command line, see Running Workbench from the command line. How can I improve the performance of a MySQL driver? When using a MySQL driver, you can decrease its memory usage and improve its performance by configuring parameters for the DSN. Follow these steps to configure your MySQL DSN:
  1. Open the the Windows ODBC Data Source Administrator by entering “ODBC” in the Start Menu search, then selecting “Data Sources (ODBC)”.
  2. Select your DSN, then click Configure.
  3. Click Details to display additional settings.
    1. In the Connection tab, mark the Allow big result sets box.
      When selected, the driver does not set packet limits for results.
    2. In the Cursors/Results tab, mark the Don’t cache results of forward-only cursors box and the Force use of forward-only cursors box.
      When selected, the driver does not cache results and uses forward-only cursors.
Note: Workbench does not need anything other than “forward only” cursors and the MySQL ODBC driver performs better using the “forward only” cursors option. How do I get access to network files to run a scheduled job? When running a job on a schedule, if the file is not located on the local machine Workbench is running on, you must set up impersonation for access rights. Follow these steps to set up impersonation:
  1. Click the icon in the left-hand icon bar.
  2. Double-click the name of the job you want to set up impersonation for.
  3. Select Configure.
  4. Click Impersonation to expand that section.
  5. Check the Requires Impersonation box.
  6. Enter your domain, username, and password in the boxes.
  7. Click Validate.
If you are connecting to a file on a domain file share that the Workbench computer is not on, the domain impersonation will not work if you are not on the domain computer. You will have to give domain access to it. Follow these steps to give domain access:
  1. Click the icon in the left-hand icon bar.
  2. Double-click the name of the job you want to provide domain access for.
  3. Click Edit under “Source.”
  4. Enter the network file path in the File Path field.
  5. Check the File on an external network box.
  6. Enter your credentials.
  7. Click Apply.
How do I clear the queue in Workbench? Say you have a dataset set up to update every hour, and you keep getting an error when you’re trying to run the job in Workbench. More specifically, you’re not able to add that job to the queue because it is either already queued or currently executing. There are a few reasons why this error can occur and ways to avoid it:
  • The current job could be in a non-responsive state. If a job is running longer than expected, open a case with Domo Support to investigate the issue further (support@domo.com).
  • You can also restart the Workbench service, which will flush the queue. Normal workflow of Workbench jobs should return after restarting. If restarting the service does not return your Workbench to normal operation, please open a case with Domo Support (support@domo.com).
How do I change data capture using Workbench? You can create a new job that will append the data that has changes in the RDBMS (Relational database management system) since the last load. Follow the steps below to do it.
  1. Perform the initial load of the data using Create New Data Source.
  2. The two key setup lines in the SQL that are very important are as follows:
  • Where “ReportDate” > '!{lastvalue:ReportDate}!'
    Ensure the Where clause contains the field that holds the value that indicate the changes since last load. The '!{lastvalue:ReportDate}!' contains the last value for the Query Variable as shown (see the Query Variable Setup section below). Call the Query Variable the same name as the field in the query that indicates the changes since the last Load.
  • Order by
    Ensure you have an Order By clause in the SQL statement, since it will be the value from the last row that will be saved in the Lastvalue variable. If you don’t order by the column that contains the change data capture field, then you might not get the changed rows in the query.
  1. After the initial load change, the job will start appending data to the existing dataset, as shown in the example below:

​
Query Variable Setup Steps

  1. Perform the Query Variable setup on the separate ‘Edit Query Variables’ screen. Note that you have the option of setting a Job Variable or a Global Variable.
  2. Create a Job Variable that matches the ‘Name’ of the field that contains the data that controls the Changed data.
  1. The ‘Current Value’ will indicate the last value the job loaded. The initial value must be less than the first record you want to import.
What proxy settings does Workbench use? When you first connect to Domo via Workbench, Workbench leverages your Windows system proxy settings. You can open your proxy settings for editing by clicking and selecting Proxy. Can I save Workbench jobs to a shared folder? I want multiple users to be able to access and edit the jobs, but I can’t figure out where jobs are saved on the drive. All Workbench jobs are saved in the cloud and tied to a specific login, not saved locally. Therefore, the recommended solution to this problem is to install Workbench on a common server then create an admin user to be used by all users who need to modify jobs. Thus, all these users will be able to access the jobs, and you will not need to worry about saving copies of the job on a physical drive. Although multiple users can use Workbench simultaneously, only the first opened instance will get the live updates from the Workbench service. We generally do not recommend having multiple instances of Workbench open because of multiple people have the same job open and are making changes, the last person to save will overwrite all other changes. Can I share Workbench jobs? Jobs are tied to the Workbench installation in which they were created. If you wanted to share a job, you would need to export that job on the Workbench installation in which it was created then import it into the second installation of Workbench.
Note: It is not recommended to have the same job running on two different instances of Workbench at the same time. If you do export a job from one and import it into another, be sure to remove it from its original Workbench instance after successfully importing it into another.
Is multi-factor authentication available for Workbench? Not at this time. Can I do a mass export of all my job files? Yes. Workbench 5 allows the mass import/export of job files. Click and select Export. You can then choose a save folder and select all of the jobs you want to export.
What are the recommended specifications to run Workbench?
  • Operating system: Any version of Windows still supported by Microsoft
  • CPU: A modern 4- or 8-core processor
  • Memory: 8-16 GB
  • Hard drive: 250 MB of space minimum, 2 GB recommended (though more may be required depending on the amount of data in your jobs)
Important: If you have space issues with C: Drive, then contact your IT team to investigate what else is taking up space on that drive.
How many refresh tokens are available per client? Due to OAuth 2.0, each user is allowed 50 refresh tokens per client. This means that only 50 Workbench machines can be running at a time per user. If you set up more machines using the same set of credentials, you will likely run into problems while executing jobs. Will changing my password cause my OAuth tokens to expire in Workbench? Yes. Changing your password causes your OAuth tokens to expire, and Workbench is no longer authenticated. What firewall rules or ports need to be open for Workbench? Port 443 bi-directional Does Workbench throttle CPU usage? Not by default, but Workbench does have this as a configurable option. Where does Workbench store staging data by default? And can I move this staging data? The data is stored in %PROGRAMDATA\Domo\Workbench\DomoCache. Currently you cannot move the staging folder. How do I get the list of table names or stored procedures on my database? The query builder is in the Source pane. This may give you a list of tables, views, and procedures. Be aware this is not compatible with all database types. I am unable to add a user to the Domo Workbench users group. Why is this? Ensure your Windows username is not the same as the PC name. Windows 10 appears to enforce this. Older versions of Windows may also be impacted. Workbench failed to install. Where can I find the logs? You can find the logs in the following directory: C:\Users\NAME_OF_USER\AppData\Local\Temp The file names are Domo_Workbench_<datestamp>.log and Domo_Workbench_<Datestamp>_001_DomoWorkbench64.log My QuickBooks Workbench jobs will not run on schedule. What do I do? You must be logged into Windows with an active session for QuickBooks integrated applications to run unattended. What do I do if the Unsafe Save dialog appears? The “Unsafe Save” dialog is displayed when your local job configuration and the remote job configuration stored in Domo do not match up or the job is currently running. To prevent the loss of data, you must first wait for the job to finish if it’s running, then re-sync your local configuration with Domo. This can be done by either clicking Revert or pressing F5 on your keyboard to refresh your entire job list. Unfortunately you will lose any changes that you have made when you take either of these actions. If your job runs long enough or frequently enough that you constantly see this dialog when attempting to make changes, you likely need to temporarily turn off the Workbench service, make your changes, then re-enable the service to start running your newly modified job. My IT department requires a whitelist for all outgoing internet traffic from our network. Does Domo have an IP whitelist for purposes of running Workbench? Domo Support can provide you with an IP to whitelist. Note that although unlikely, the IP can change at any moment and without notice, resulting in Workbench job failures. It is advised that you whitelist by DNS name if possible. (e.g. instance.domo.com). Is there a way to move my DomoCache directory to a different disk drive? The current version of Workbench doesn’t allow you to separate the operating system from the application data, but you can work around this issue using hard-coded symbolic links. The following example shows how a user moved his DomoCache directory to the E: drive: mklink /J "C:\ProgramData\Domo\Workbench\DomoCache" "E:\Domo\Workbench\DomoCache" What does it mean when Workbench says “Live updates are not available”? This could mean a few different things. If another person is running Workbench on the same computer, this message will appear. This could also appear if there are port conflicts with other applications on the computer. To fix this, go to Workbench Settings, and in the Notifications section you will be able to update the Port. Can I run jobs more frequently than every 15 minutes? Yes, if you need this ability, please reach out to your account team for evaluation.

​
Install the Latest Version of Workbench

You can only download and use Workbench on a Windows OS. It does work on a virtual machine.
Follow these steps to install the latest version of Workbench:
  1. From the navigation header, select More > Admin. The Admin Settings display.
  2. In the More menu, select Tool Downloads.
  3. On the Tool Downloads page, locate the section for the latest version of Workbench and select Download Domo Workbench.
  4. Locate the file in the downloads area of your machine.
  5. Open the file and follow the steps ---
Video - Workbench 5 Overview