​

Intro

• Access the Toolkit
• Required grants
• Configuration DataSet for adding members to a group
• Configuration DataSet for setting a group landing page
• Create a job
• Run a job
• Remote instance configuration
  • Configure Group Management for Remote Instance
  • Configure Domo Access Token Account
  • Generate Access Token

​

Access the Toolkit

1. In the navigation header, go to More > Admin.
2. In the Governance menu, select Toolkit.
   Note: If the Toolkit option does not display in the Governance menu, make sure your user role has the required grants. You may need to enable the Toolkit by reaching out to your Account Executive (AE).

​

Required Grants

• Create Custom Pipeline Processes — Allows the holder to create, update, share, and delete jobs. Only allows the user to view jobs that they created or jobs that have been shared with them.
• Administer Custom Pipeline Processes — Allows the holder to create, update, share, and delete jobs. Allows the user to see all jobs within the pipeline.
• Manage DataSet — Allows the holder to view, edit, and delete any DataSets in this instance.
• Manage All Groups — Allows the holder to create, edit, and delete any groups, and add and remove people from any group.
• Manage All Cards, Pages, Apps (App Studio/Worksheets), and Reports (Report Builder) — Allows the holder to view, edit, share, and delete any card, dashboard, App Studio app, or Report Builder report in the instance. The holder can also subscribe to publications from other instances. Learn more about publications.

​

Configuration DataSet for Adding Members to a Group

• User
  • The users that should be included in the group.
  • Multiple users can be pipe ‘|’ separated.
  • User ID and email can be used.
• Group
  • The name or ID of the group that users should be added to.
  

​

Configuration DataSet for Setting a Group Landing Page

• priority — If a user is a member of multiple groups, the priority determines which landing page they have.
  • If both a card_id and page_id are given, the page is set as the landing page.
  • If a user is a member of multiple groups of equal priority, the landing page is assigned alphabetically based on the group name.
• group — The name or ID of the group that the landing page is set for.
• page_id — The ID of the page being set as the landing page.
  • In each row, the page in the page\_id field must be shared with all members of the group identified in the group field. If multiple groups have the same Group Landing page being set to the same page in the config DataSet, and all members of all groups do not have this shared properly, the job will fail for all included groups.
• card-id — The ID of the card to be set as the landing page.

​

Create a Job

1. In the navigation header, go to More > Admin.
2. In the Governance menu, select Toolkit.
3. In Toolkit, select Group Management.
4. Select + New Job. The new job creation page displays.

5. Enter a Job name and optional Job description.
6. In the Configuration section, check one or both of the boxes for your Job options:
   • Manage Groups — Use this option to create membership groups as necessary and manage them.
   • Manage Landing Pages — Use this option to assign landing pages or cards to members of existing groups. This option includes assigning landing pages for directory groups inherited from SSO.
7. (Required) Select a Configuration DataSet for each selected job option.
   • The Group Management Configuration DataSet defines your groups and users in each group.
   • The Landing Page Management Configuration DataSet defines which landing pages are set.
8. (Required for group management) Choose how to handle creating new groups. Select the radio button for Open or Closed.
9. In Reporting, select where you would like to save run logs.
   • New DataSet — This option creates a new DataSet in your Domo instance and all runs of the job write logging to the new DataSet.
   • Existing DataSet — This option allows you to combine multiple Group Management jobs into a single logging DataSet.
   Important: The DataSet must be a DataSet created by the Group Management tool. The DataSet must also already contain rows of data.
10. In Reporting, enter any email addresses you would like to receive notifications from Domo each time the job runs. The notification outlines what the job did during the run and any failures that occurred. Sample Notification Email

11. After you fill out the new job creation page, select Submit.

​

Run a Job

​

Example Job Run

• Groups before run:
  
• Configuration DataSet:
  
• Groups after run:
  
• Logging DataSet:
  

​

Remote Instance Configuration

​

Configure Group Management for Remote Instance

1. While creating or editing a job for Group Management, in the Configuration section, select a configuration DataSet populated with valid values for the remote instance according to Group Management guidelines given in this article. See Configuration DataSet.
2. Still in the Configuration section, choose Remote Instance for where to run the job. The Instance Settings display.
3. In the Instance: field, enter the domain for the remote instance you want to manage groups for.
4. From the Select the account for your instance: list, select a valid Domo Access Token account. To learn how to configure a Domo Access Token account, see the next section.
5. Fill in the details for the Reporting section.
   Note: The notification emails and metric logs are written to the instance the policy is running from, not to the remote instance.
6. Select Submit to save your changes to the job.

​

Configure Domo Access Token Account

1. In the Domo navigation header, select Data. The Data Center opens.
2. In the sidebar, select Accounts.
3. Select Add New > Account. The Add Account modal displays.
   
4. In the modal, complete one of the following options:
   • Access Token — Enter an access token in the Remote Instance Access Token field. To learn how to generate a token, see Generate Access Token.
   • Username and password — Enter your credentials in the Remote Instance Username and Remote Instance Password fields.
5. Select Connect.

​

Generate Access Token

1. In the Domo navigation header, select More > Admin. The Admin Settings display.
2. In the Authentication menu of the Admin Settings, select Access tokens.
3. On the Access tokens page, select + Generate access token.
   
4. Enter a description in the Access token description field.
5. Search for and select a user for whom you are generating the access token.
6. Select an expiration interval in the Expire after list.
7. Select Generate.
8. Copy the code to use.