Organization Account Management System User Guide

Introduction

The CodeMRI® Organization Account Management (henceforth OAM) system allows administrators of organizations to manage resources within the CodeMRI® infrastructure owned by their organization. Using the management interface, organization administrators are able to:

  • Invite users to join their organization.

  • Delegate administrative responsibilities to users within their organization.

  • Set portfolio & project access to users within their organization.

  • Assign licenses to users within their organization.

Table of Contents

 

Creating an Organization

The first step in managing organization accounts is to create an organization. In order to create an organization, you will need a CodeMRI® account. Once you have a CodeMRI® account, log in, and click the “Organizations” dropdown on the top header, once the menu expands, click “Create New Organization”. This will summon the New Organization form. Fill out the organization’s display name, and click “Create”.

Inviting People to Your Organization

There isn’t much of a point to having an organization if it only contains one person. After creating your organization, use the “Invitations” panel to invite users by e-mail address. To invite someone, enter their e-mail address into the text box in the header of the “Invitations” panel:

The invitation is queued, and will be sent within a few minutes of clicking the “INVITE” button. You should see the invite row on the invitations panel:

Invitation Status

The invitation status will start as PENDING. Once the user accepts the invite, the status will change to ACCEPTED. If the user fails to accept the invite by the Expires At time, the status will change to EXPIRED.

Controlling User License Assignment

Licenses allow users to access product features within the CodeMRI® Platform. When organizations purchase Silverthread products, a license will be assigned to the organization. Organization administrators can then in turn, assign the license to users within their organization. Licenses enable assigned users to make use of the products licensed to the organization.

To view the licenses assigned to your organization, see the Licenses panel:

Clicking the pencil icon will summon the license assignment popover, allowing you to assign the license to users within your organization.

To assign a user, select the username from the dropdown at the top, then click the ASSIGN button.

To remove a user, click the red X next to the user’s name & e-mail address.

Viewing Users and Changing their Access Levels

The Users panel allows an administrator to see all users within the organization. Administrators can assign control over a given set of actions on the organization to users as needed to administrator the organization.

To change a user’s access levels, click “CUSTOMIZE” under the “Access Control” column. This will summon the access control popover, through which you can set very granular permissions for the user:

For more information about organization permissions, see Organization Permissions.

Removing a User from an Organization

To remove a user, click the red “X” to the far right of the user’s name and e-mail address in the Users table:

 

A confirmation dialog is required as this is a destructive action:

Managing Vaults

Organizations making use of the hosted CodeMRI® Portfolio Web solution may have one or more web vaults assigned to them. The vault management interface allows an organization administrator to control which users are able to see specific aspects of the portfolio.

Vault Management Interface

 

Managing Access to a Vault

The user access panel allows the administrator to control users' level of access to the vault. In order to set a user’s access level to the vault, click the “Customize” button next to the user’s row on the user access table to summon the permission selection popover:

Check the boxes next to the names of the permissions you would like to set, then click “Save” to make the changes. See Vault Permissions Reference for more information.

Managing Access to Individual Projects

In addition to managing access to vaults, the management interface allows for setting access to individual projects. Before setting permissions on a project, the administrator will need to create an entry for the project. Project entries are a combination of identifier (a unique machine-readable name for the project), and display name (a human friendly name for the project). If the project already exists within the portfolio, obtain the project identifier via the portfolio interface:

  1. Pull up the portfolio interface for your vault.

  2. Click on the row corresponding to the project you want to determine the identifier of.

  3. Using the address bar, locate the &project=<identifier> portion of the URL. Select the project identifier, and copy it to your clipboard.

 

Once you know what the project identifier is, you can create a new project entry by entering the identifier and display name into the inputs next to the “Project” heading, and clicking the + button.

Managing projects is exactly the same as managing vaults, with the exception that a project can be removed by clicking the red “X” button. Note that this will only remove access control data for the project, it will not remove the project from the portfolio.

To set permissions a project, click the pencil icon by the project’s entry within the project table to summon the project management interface:

You may then customize user access by clicking the “Customize” button next to the user’s name and e-mail address within the “User Access” row. See Vault Permissions Reference for more information about permissions.

User Interface Overview

 

Title Bar

Shows the name of the element being managed in the management interface.

The navigation tree provides a convenient way to jump to specific panels within the current management page, as well as the ability to navigate back to a previous management page.

Panels

Panels provide the ability to manage different aspects of the currently selected element. See the above sections of the user guide for more detailed information about each panel.

Button Icon Reference

Invitations

 

Re-send the invite, extending the expiration date to 30 days beyond the moment the re-send is processed.

 

Revoke the invite. Note that you can only revoke pending or expired invites. Accepted invites are preserved for your records.

Licenses

 

Summon the license user assignment dialog, with which an administrator can assign a user to or remove a user from a license.

Users

 

Customize the user’s level of access to aspects of the organization management interface.

 

Remove the user from the organization.

Vaults

 

Display the vault within the CodeMRI® Portfolio interface.

 

Open the vault in the Vault Management interface, within which one can edit vault properties, manage projects, and user access.

Projects

 

Display the project within the CodeMRI® Portfolio interface.

 

Open the project in the Project Management interface, within which one can edit project properties, and manage user access.

 

Remove the project’s access control information.

Vault and Project User Access

 

Summon the permission selection dialog for the user, with which an administrator can customize the user’s level of access to the vault/project.

Permissions Reference

Organization

Organization level permissions control a user’s access to different aspects of an organization. These permissions are solely for administrative activities; regular users will often have none of these permissions.

Permission Name

Category

Description

Permission Name

Category

Description

View Organization

Organization

Allows the user to view organization properties.

Modify Organization

Organization

Allows the user to change the display name of the organization.

View Licenses

Licensing

Allows the user to view descriptive information about the licenses assigned to the organization.

View User License Assignments

Licensing

Allows the user to view who is assigned to which licenses within the organization.

Modify User License Assignments

Licensing

Allows the user to change who is associated with licenses within the organization.

View User Access

User Management

Allows the user to view organization-level permissions for all users within the organization.

Change User Access

User Management

Allows the user to modify organization-level permissions for all users within the organization.

Note that, as with similar systems, if a user has this permission, they can escalate their own permissions.

View User Properties

User Management

Allows the user to view descriptive information about users within the organization.

Remove Users from Organization

User Management

Allows the user to remove any user from the organization.

View Vault and Project Properties

Vault

Allows the user to view descriptive information about vaults and projects within the organization.

Modify Vaults, Create and Modify Projects.

Vault

Allows the user to change descriptive information of vaults and projects within the organization.

View Vault and Project User Access

Vault

Allows the user to view users' permissions on vaults and projects within the organization.

Modify Vault and Project User Access

Vault

Allows the user to modify users' permissions on vaults and projects within the organization.


Vault and Project

Vault and project permissions control access to aspects of the CodeMRI® Portfolio interface, allowing the administrator to define access at both the vault level (the entire portfolio), or where required, specific projects within the vault.

Some of these permissions only apply to vaults, whereas others apply to both vaults and projects. See the Applies To in the table below.

Name

Category

Applies To

 

Name

Category

Applies To

 

Full Reporting Access

Administration

  • Vault

  • Project

Grants read & write access to all aspects of the portfolio interface. Note that diagnostics require a license to view.

Upload Codebases

Administration

  • Vault

Grants access to use the codebase upload interface in conjunction with the current vault.

Read Portfolio Data

Portfolio & Business Metrics

  • Vault

  • Project

Grants read access to the portfolio, including the overall portfolio & trending as well as project-level trending.

Update Business Data

Portfolio & Business Metrics

  • Vault

  • Project

Grants access to update business metrics on the portfolio view.

Consume Licenses

Diagnostics

  • Vault

Grants permission to consume license usages. Required for viewing diagnostics.

View Diagnostic Reports

Diagnostics

  • Vault

  • Project

Grants access to view diagnostic reports, and use the ROI calculator. Note that diagnostics also require a license.