Skip to main content
waffle.svg
Domo Knowledge Base

Using the Domo Excel Admin Plugin

Version 17

 

Intro

The Domo Admin plugin for Microsoft Excel provides a number of powerful capabilities not available within Domo itself, including the following:

  • The ability to retrieve lists of all users, groups, publication groups, Beast Mode calculations, and more from a specified Domo instance.

  • The ability to configure actions to be run in Domo, either singly or in bulk. For example, you could upload a list of new users into Domo instead of having to add users one at a time in the Admin Settings.

  • The ability to migrate from Publication Groups to PDP.

To obtain this plugin please request access through your Domo Customer Success Manager. Due to the nature of the functions provided by the Excel Admin Plugin, it is recommended only for Admin users or developers who have received additional training on its use. 

Training

For a quick overview of the use cases available through this plugin, download the following PDF: Administering Domo through the Excel Admin Plugin3.pdf.

Installing the Domo Excel Admin as an Administrator

Installing the Domo Excel Admin Plugin as an Administrator can help to prevent any permission issues that can be caused by certain Windows environments and policies. 

To download Excel Admin using Command Prompt,

  1. Right click on the Windows icon at the bottom left corner of your computer screen.
  2. Click on Command Prompt (Admin).

  3.  Type the pathway to the drive and directory where the downloaded .msi Domo Excel Admin file exists.

  4. Click enter. 

  5. Your result should look like this:

  6. Click Next .

Parts of the Domo Admin Tab in Excel

After you have installed the Domo Admin Excel plugin, a Domo Admin tab appears near the end of the main tab row in Excel. This tab initially appears as follows, with only a few options appearing:

domo_admin_tab_default.png

There are two additional sections in this tab, Insert Commands into Excel and Feature Migration, which do not appear by default. 

domo_admin_tab_hidden.png

To show these tabs, you must go into Settings and enable Domo Admin Commands and Migration Tools.

The following table describes the components of the Domo Admin tab:

Component

Description

Connect to Domo

Lets you connect to a specified Domo instance. You can be connected to multiple instances at once. If you are already connected to an instance, this button reads Connected. In this case, you can add new connections or delete connections using this option. 

Export Domo Admin Data options

Let you pull lists of selected Domo entities from a selected Domo instance into Excel, such as users, cards, pages, Beast Mode calculations, Publication Groups, and more. If you check more than one box at a time when exporting, each list is pulled into its own Excel worksheet.

You can get detailed information about each of the available Export Domo Admin Data options in the in-tool documentation. To access this documentation, select Help > Documentation in the Domo Admin toolbar. Information about these options is found in the default tab, Export Admin Data

Insert Commands into Excel options

Let you configure various actions to be run in Domo, such as adding or deleting users, copying pages or cards, managing PDP policies, etc. When you click one of these commands in the Domo Admin tab, two rows are added to the first encountered empty rows in your Excel worksheet—a header row and a second row with a number of variables pertinent to the command. For example, for the Copy Card option, variables include the source domain, the source card ID or name, the destination domain, etc. You would update each variable with the required information—in this case, the source domain would be the Domo instance you are copying the card from; the source card ID or name would be the ID or name of the card you are copying; and so on. After filling in the variables, you could then click Execute Commands to perform the action—in this example, copying the specified card from the source domain to the destination domain.

If you click a command again, or click another command, another variable row is added under the first. You can run actions on as many rows as you want, making this a great time-saving alternative to performing actions manually in Domo.

You can get detailed information about each of the available Insert Commands into Excel options in the in-tool documentation. To access this documentation, select Help > Documentation in the Domo Admin toolbar, then open the Domo Commands tab.

Feature Migration options

Let you migrate Publication Groups to PDP. For more information about this process, please reach out to the Domo Engineering Services team at eps@domo.com

Important: Do not attempt to use this tool without first receiving training from the Engineering Services team!
Settings Opens the Settings dialog, in which you can show or hide the Insert Commands into Excel and Feature Migration sections in the Domo Admin tab.

Help

Provides options for viewing the in-tool documentation and opening the About dialog, in which you can view the version number of the plugin as well as check for and download newer versions.

Connecting to a Domo Server

You can connect to the server for any Domo instance for which you have access. You can be connected to multiple instances at once.

To connect to a Domo server,

  1. Click the Connect to Domo button on the left side of the Domo Admin tab in Excel. (If you are already connected to any servers, the button reads Connected.)

    domo_admin_connect.png

    A dialog appears requesting that you add a connection.

  2. Click Add.

  3. Enter the URL for your Domo server in the field, then click Next.

    domo_excel_server.png

  4. Enter your Domo credentials in the fields, then click Next.

    You must have an "Admin" or "Privileged" security profile to connect.
    If you have entered your credentials correctly, a "Success" dialog appears.

  5. Click Finish.

Deleting a Server Connection

You can delete a connection to a server in the same dialog in which you add a server connection.

To delete a server connection,

  1. Click the Connected button on the left side of the Domo Admin tab in Excel.

  2. Select the server you want to disconnect from.

  3. Click Delete. 

  4. Click Yes to confirm the deletion.

Use Cases

Because of the large number of possible actions you can take using this plugin, instead of documenting each one individually, we provide a single common use case to illustrate three capabilities of the tool. For explanations of each action, visit the in-tool documentation by selecting Help > Documentation in the Domo Admin tab.

Use Case #1: Exporting Beast Mode Data

You can use the Domo Admin Excel plugin to retrieve a list of all Beast Mode calculations in a Domo instance, with their names, formulae, data types, status (valid or invalid), the cards and DataSets in which they are found, and other information. 

To export Beast Mode data into Excel,

  1. (Conditional) If you are not connected to the Domo instance you want to pull data from, connect using the above information.

  2. Click Export Domo Data.

  3. Scroll to the bottom of the dialog and check the Beast Modes box (found in the "Filtration" section).

  4. Click Export Data.

  5. Click Yes to confirm the action.
    If you are connected to only one server, the export begins immediately. Otherwise, you are asked to select the server you want to export from.

  6. Select a server if prompted to do so then click Next.

The data you have requested is downloaded into Excel. Depending on the amount of data, this process may take a few seconds or ten minutes or longer.

Use Case #2: Creating Users in Bulk

You can use the Domo Admin Excel plugin to set up a list of users you want to add to Domo with their names, email addresses, and user types. You can also configure optional attributes for each user, such as default password, phone number, default group in Domo, and so on. Once you have set up your list the way you want it, you can send it to Domo, and accounts will be set up for all users in the list just as you have specified. 

To create a list of users and send it to Domo,

  1. (Conditional) If you are not connected to the Domo instance you want to pull data from, connect using the above information.

  2. Click User Commands.

  3. Select Add User.
    Two rows are added to your spreadsheet—a header row and a template row in which you will enter the attributes for each user you want to add to Domo.

  4. (Optional) To add additional user rows to the spreadsheet, copy row 2, select all of the empty rows you want to add users to, and paste. 

  5. Fill in the cells for each user row with the correct user attributes.

    Some things to be aware of when filling in user rows:

    • The setting in the "Active" column determines whether the associated user information is sent to Domo when you click Execute. By default this is set to "True," indicating that this user's information will be sent to Domo. If you do not want this information to be sent to Domo for a given user, change this value to "False" for that user.

    • Because you selected Add User in step 3, all cells in the "Command" column are set to "adduser" by default, indicating that all users in the spreadsheet will be added to Domo when you click Execute. You can initiate different actions in the same list of users by adding rows for different commands. For example, one of your employees may have left the company and been replaced by another user. In this event, you could add the new user as described in these steps; at the same time you could also delete the departing employee by adding a "deleteuser" row (by selecting Delete User in the User Commands menu). For a full list of commands, visit Help > Documentation and click the Domo Commands tab.

    • If you want a user to be sent to your default group in Domo, ignore column N. Otherwise, enter the names of the Domo groups you want the user to be a member of, separating each group with a pipe (|). 

    • If you want users to have a default password, enter it in column O. 

  6. Once your list is ready to upload, click Execute.