Governance Toolkit: Group Management

Intro

Group Management allows you to manage your Domo groups in bulk.

Accessing the toolkit

The Governance Toolkit can be found in the Admin section of Domo, under Governance then Toolkit.
https://{INSTANCE}.domo.com/admin/governance-toolkit/

If you are unable to find the Toolkit, ensure your user role has the required grants.

Required Grants

To access the Governance Toolkit a user will need 1 of 2 grants enabled for a user. Grants can be added to a custom user role. By default the Administer Custom Pipeline Process grant is enabled for Admin users.

•  Create Custom Pipeline Processes
  • This grant will allow a user to create, update, share and delete jobs.
  • This grant will only allow a user to see jobs that they created or jobs that have been shared with them.
• Administer Custom Pipeline Processes
  • This Grant will allow a user to create, update, share and delete jobs.
  • this grant will allow a user to see all jobs

To learn more about custom roles and grants see Managing Custom Roles.

Configuration DataSet

• 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.
    
    

Creating a Job

1. Navigate to the Governance Toolkit and select Group Management.
   • https://example.domo.com/admin/governance-toolkit/group-management
2. Click + New Job in the top right-hand corner.
3. Fill out the following information:
   • Job Name (required)
   • Job Description (optional)
   • Configuration DataSet (required)
     • This is the DataSet that defines your groups and users in the group.
   • New group (required)
     • Define if new groups should be created as Open or Closed groups.
   • Run Logs (required)
     • Each job will keep track of executions of the job and information surrounding that.
     • New DataSet
       • Will create a new DataSet in your Domo instance and all runs of the job will write logging to the new DataSet.
     • Existing DataSet
       • Existing DataSet will allow you to combine multiple Group Management jobs into a single logging DataSet.
       • The DataSet must be a DataSet created by the Group Management tool.
         • DataSet must also already contain rows of data.
     • Email notifications (optional)
       • You can add user emails to this field.
       • Each email will receive an email notification from Domo each time the job runs.
       • The notification will outline what the job did during the run and any failures that occurred.
         
         
         
         

Running a Job

Each job has an Enabled Toggle. This will control how a job is run.

• Preview Only
  • The job will only execute when the job is manually run.
• Active
  • The job will execute every six hours.
  • The job will execute every time the configuration DataSet is updated.

Example of Job Run:

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