​

Intro

• Multi-user — Multiple users can access and manage your pool of Workbench jobs.
• Web-based — You can use different platforms/browsers to remotely access and manage Workbench jobs even though the web server remains on-prem.
• Multi-platform — Works on Linux, Windows, and macOS.
• High availability — Better failover logic between jobs and the capability to split up large jobs between many different worker nodes on the server.

​

Prerequisites

• Docker installed on your machine
• (Conditional) If you want to use an existing RabbitMQ account, provide the credentials
• The Workbench Enterprise grants—see below.

​

Required Grants

• Login to Workbench Enterprise — Required to log in to Workbench Enterprise. All users who want to use Workbench Enterprise must have this grant enabled for their role.
• Create Jobs in Workbench Enterprise — Allows the creation of jobs in Workbench Enterprise.
• Manage Workbench Enterprise — Allows a user to edit all jobs and configurations in Workbench Enterprise.

​

Configure Workbench Enterprise

​

Domo Configuration

1. From the main nav, select More
   Admin . The Admin Settings display.
2. Under Authentication, select Workbench Enterprise. The Workbench Enterprise page displays.
3. Enter the URL(s) for your Workbench Enterprise instance so that you can use OAuth for secure access.
   
4. Select Generate Key. The key displays in the Key field.
5. Select Copy to copy the key to your clipboard.
   

​

Download Docker Images

docker pull public.ecr.aws/domo/workbench/workbenchenterprise:latest
docker pull rabbitmq:management

​

Launch the Docker Image

docker run -p 80:8080 --mount type=bind,source=/usr/share/Domo,target=/usr/share/Domo --mount type=bind,source=/usr/share/Domo,target=/app/Data public.ecr.aws/domo/workbench/workbenchenterprise:latest

docker run -d -p 5672:5672 -p 15672:15672 --mount type=bind,source=/usr/share/Domo/rabbitmq,target=/var/lib/rabbitmq/mnesia/ rabbitmq:management

​

Configure a Reverse Proxy

# Complete Nginx Docker reverse proxy config file
events { 
  worker_connections 4096; 
} 
 
http{ 
server { 
  listen 80; 
  listen [::]:80; 
  server_name {Your-server-name}; #The IP of your Workbench Enterprise 
 
  location / { 
    proxy_set_header Host $host; 
    proxy_set_header X-Real-IP $remote_addr; 
    proxy_set_header   X-Forwarded-For  $proxy_add_x_forwarded_for; 
    proxy_set_header Upgrade $http_upgrade; 
    proxy_set_header Connection $http_connection; 
    proxy_pass {Your-passthrough-location}; 
  } 
 
}
}

​

One-Time Setup

1. Under RabbitMQ Setup, enter all required credentials in the appropriate fields.
   • If you have an existing server you want to use, you must enter an admin credential.
   • If you are using the RabbitMQ Server from the Docker command posted earlier, you are setting up the admin credentials and do not need existing ones.
2. Under Domo Setup, enter your Domo domain.
3. Paste the key you copied to your clipboard above from the Workbench Authentication.
4. Select Submit. You are redirected to the Workbench Enterprise login page and can give Workbench Enterprise access to your Domo instance.

​

Log In

​

Configure Your First Node

1. As an administrator for your machine, launch your web browser and navigate to your Workbench Enterprise server.
2. Log in to Workbench Enterprise.
3. Go to Nodes.
4. Download the Windows package.
5. Extract the ZIP file and move the folder to a known location.
6. From the Start menu on your machine, launch Command Prompt as an administrator. Follow the steps below depending on your system

Windows

1. Navigate to the folder where you placed the ZIP file and register your Workbench node as a Windows service by entering
   Copy

   Ask AI

   EnterpriseThinClient.exe -i
   
   • A protection mechanism exists to prevent the ThinClient from being run in standalone mode when it’s installed as a service. The service the ThinClient creates should be set up to launch automatically and restart on failure.
   • After it’s installed as a service, the ThinClient must be managed through the service for all subsequent use.
2. In Workbench Enterprise, go to Nodes > Untrusted.
3. Locate the node and select Trust to enable Workbench Enterprise to run jobs on the node.
   

Linux

1. Navigate to the folder where you placed the ZIP file and register your Workbench node as a Linux daemon by completing the following steps:
   • Use chmod to update the ACL on EnterpriseThinClient to allow execution.
   • Launch the EnterpriseThinClient -i
2. In Workbench Enterprise, go to Nodes > Untrusted.
3. Locate the node you added and select Trust to enable Workbench Enterprise to run jobs on the node.
   
   Nodes:

   • There is no limit to the number of nodes that can be connected to Workbench Enterprise.
   • Jobs are not tied to specific nodes. They can be tied to “clusters,” which are assigned to nodes.
   • The job will always execute on the first available node. If the job is assigned to a cluster, it will execute on the first node available in that cluster. If a node goes down, the job will execute on the next available node.
   • There is no Workbench Enterprise master node. All nodes are treated the same way.

​

Configure Your First Shared Credential

1. Inside Workbench Enterprise, go to Admin > Shared Credentials.
2. Select New Shared Credentials > Database to open the creation modal.
   
3. Enter the values for the shared credential in the Database modal.
   
4. Select Save Credentials.

​

Configure Your First Job

1. Inside Workbench Enterprise, select Jobs in the left navigation.
2. Select New Job.
3. Enter a name for your job and select Submit.
4. In the jobs list, locate and select your job.
5. In the job details view, go to the Configure tab.
6. Under Data, change the Connection Type to Connection String Builder.
7. Select Use a database shared credential.
8. Select the shared credential you configured earlier.
9. Enter the query for your job.
10. Select Save.
11. Select Preview.

​

Import a Job to Workbench Enterprise

1. In your previous Workbench installation, create a backup file that contains your job.
2. In Workbench Enterprise, go to Admin > Workbench Import.
   
3. Drop your Workbench backup file in the designated space.
4. Under Backup file password, enter the password for your backup file and select Load Jobs.
5. Select the jobs you want to import from the list and assign them a cluster.
6. When you are ready, select Import.

​

Run Your First Job

1. Inside Workbench Enterprise, select Jobs in the left navigation.
2. In the jobs list, locate the job you want to run.
3. Select More > Execute.

​

Share Credentials

​

Use File Watch

1. Find and select your job in the jobs list.
   
2. In the Schedule tab of the job details, check the box labeled Watch for changes in the Basic Schedule OR Advanced Schedule tab.
   
   WBE will begin monitoring changes to your source. In the example below, WBE will watch for changes in File2.csv. If the file changes, the job will execute.
   
   Tip: Learn how to launch Workbench Enterprise jobs with third-party tools.

​

FAQ

Connectivity

Upgrading & Plug-ins