User guide

Creating a Managed Group

Navigate to Managed Groups -> Add a group.
Type the name of the group to create in the “Name” field.
If desired, add any notes about the Managed Group in the “note” field.
Click on “Save group”. This can take some time due to delays from AnVIL.

If successful, you will be shown a success message and information about the group that you just created.

Importing a Billing Project

Note that the service account running the website must be added as a user of the billing project that you are trying to import.

Navigate to Billing Projects -> Import a billing project.
In the “name” field, type the name of the billing project to import.
If desired, add any notes about the Billing Project in the “note” field.
Click on the “Import billing project” button.

If successful, you will be shown a success message and information about the billing project that you just imported.

Creating a new workspace

Navigate to Workspaces -> Create a new a workspace. Make sure to select the “Create a new workspace” link under the workspace type that you would like to create.
In the “Billing project” field, select the billing project in which to create the workspace (e.g., primed-cc). If it doesn’t exist, you may need to import a billing project (see instructions).
In the “name” field, type the name of the workspace that you would like to create within the selected billing project (e.g., test-workspace).
If applicable, in the “authorization domains” box, select one or more authorization domains for this workspace.
- You can select multiple authorization domains using Command-click.
- To de-select an authorization domain, click on it while holding the Command key.
If desired, add any notes about the Workspace in the “note” field.
Fill out all other required fields for the type of workspace you are creating.
Click on the “Save workspace” button. This can take some time due to delays from AnVIL.

If successful, you will be shown a success message and information about the workspace that you just created. The examples would create a workspace named “primed-cc/test-workspace”.

Importing an existing workspace

Note that the service account running the website must be an owner of the workspace (or in a group that has owner permissions) to be able to import it to the app. If the workspace has any auth domains, they will be imported into the app even if the service account is not an admin of those groups.

Navigate to Workspaces -> Import a workspace from AnVIL. Make sure to select the “Create a new workspace” link under the workspace type that you would like to import.
From the “Workspace” dropdown, select the workspace you would like to import. Only workspaces where the service account is an owner are shown in this dropdown.
Fill out all other required fields for this workspace type.
If desired, add any notes about the Workspace in the “note” field.
Click on the “Import workspace” button. This can take some time due to delays from AnVIL.

If successful, you will be shown a success message and information about the workspace that you just imported.

Adding a user account to a group

You can add a user account to a group using three different options.

Navigate to Managed Groups -> Add an account to a group. This allows you to select both the Managed Group and the Account on one form.
Navigate to a Managed Group detail page and click the “Add an account to this group” button. This allows you to select the Account to add to the group.
Navigate to a Account detail page and click the “Add this account to a group” button. This allows you to select the Managed Group to add to the Account to.

In any case, once you have arrived at the form using one of the above three methods, follow these instructions to add an account to a group.

If applicable, select the Managed Group and/or Account that you would like to add to the group from the Managed Group and Account fields. You can start typing to autocomplete the Managed Group name and Account email.
In the Role field, select the role that this Account should have in the Managed Group. Typically, everyone should be added as a “Member”.
Click on the “Save membership” button. This can take some time due to delays from AnVIL.

If successful, you will be shown a success message.

Adding a group to another group

You can add a user account to a group using three different options.

Navigate to Managed Groups -> Add a group to a group. This allows you to select both the parent and child Managed Groups on one form.
Navigate to a Managed Group detail page and click the “Add a group to this group” button. This allows you to select a child group to add to this group.
Navigate to a Managed Group detail page and click the “Add this group to a group” button. This allows you to select the parent Managed Group to add to this group to.

In any case, once you have arrived at the form using one of the above three methods, follow these instructions to add an account to a group.

If applicable, select the Parent Group and/or Child Group that you would like to add to the group from the Parent Group and Child Group fields. You can start typing to autocomplete the Parent Group name and Child Group email.
In the Role field, select the role that the Child Group should have in the Group. In most cases, everyone should be added as a “Member”.
Click on the “Save membership” button. This can take some time due to delays from AnVIL.

If successful, you will be shown a success message.

Auditing information in the app

For each type of AnVIL resource (Billing Projects, Accounts, Managed Groups, and Workspaces), you can run an audit to compare the information in the app against the information on AnVIL to make sure they match. For now, you can do this by navigating to a specific page for each type of resource. Note that this page makes a number of API calls, so you shouldn’t load it too frequently.

For Billing Projects: Navigate to Billing projects -> Audit billing projects
For Accounts: Navigate to Accounts -> Audit accounts
For Managed Groups: Navigate to Managed groups -> Audit managed groups

For workspaces: Navigate to Workspaces -> Audit workspaces

The audit page explains more about the audit and what is checked for each type of AnVIL resource. Also see the Auditing information in the app section for more information.

Importing an AnVIL account

Typically, consortium users should link their AnVIL accounts instead of having a coordinating center staff member follow these steps. There are two general cases where staff may wish to import an AnVIL account:

A consortium member would like a service account to upload data.
The coordinating center would like to give access to non-consortium members, such as allowing AnVIL staff to access a workspace to help troubleshoot an issue.

For those two cases, follow these steps. Note that the account must already exist on AnVIL to be able to import it.

Navigate to Accounts -> Import an Account.
Type the email of the account in the “email” field.
If the account that you are importing is a service account instead of a user account, check the “I service account” box.
If desired, add any notes about the Account in the “note” field.
Click on “Save account”. This can take some time due to delays from AnVIL.

If successful, you will be shown a message and information about the account that you just imported. Otherwise, you will be shown an error message at the top of the page.