Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: [SEI-9294]: Adds merge identities docs #8851

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The following permissions are needed to customize the Trellis Factors at the Acc

1. To perform **Admin Level** operations on the **Trellis Factors at the Account Level**, you need to have **Edit & Manage** access to **SEI Configuration Settings**
2. To configure **Trellis Factors at the Collection Level** i.e. **Collection** specific Trellis settings, one must have **Collection Edit/Create** access to the SEI project
3. At least one **Contributor** with an associated **Email ID** must be present in the newly created account. For more information, go to [Contributors](/docs/software-engineering-insights/sei-projects-and-collections/manage-contributors).
3. At least one **Contributor** with an associated **Email ID** must be present in the newly created account. For more information, go to [Contributors](/docs/software-engineering-insights/sei-contributors/manage-contributors).

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ To start using SEI, configure the following:

* [Collections](/docs/software-engineering-insights/sei-projects-and-collections/project-and-collection-overview)
* [Integrations](/docs/software-engineering-insights/sei-integrations/sei-integrations-overview)
* [Contributors](/docs/software-engineering-insights/sei-projects-and-collections/manage-contributors)
* [Contributors](/docs/software-engineering-insights/sei-contributors/manage-contributors)
* [Projects](/docs/platform/organizations-and-projects/projects-and-organizations)
* [Collections](/docs/software-engineering-insights/sei-projects-and-collections/project-and-collection-overview)
* [Profiles](/docs/category/profiles)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ If you're migrating to Harness SEI from Propelo standalone application, review t
| <a href="/docs/software-engineering-insights/sei-projects-and-collections/project-and-collection-overview#collection-categories">Collection Hierarchy</a> | Learn how to use collection-level hierarchies to keep data in SEI organized | [Click here](/docs/software-engineering-insights/sei-projects-and-collections/project-and-collection-overview#collection-categories) |
| <a href="/docs/software-engineering-insights/sei-projects-and-collections/manage-collection-cat">Manage Collection Categories</a> | View, add, edit, enable/disable collection categories | [Click here](/docs/software-engineering-insights/sei-projects-and-collections/manage-collection-cat) |
| <a href="/docs/software-engineering-insights/sei-projects-and-collections/manage-collections">Manage Collections</a> | View, add, edit and remove collections | [Click here](/docs/software-engineering-insights/sei-projects-and-collections/manage-collections) |
| <a href="/docs/software-engineering-insights/sei-projects-and-collections/manage-contributors">Manage Contributors</a> | View, add, edit and remove contributors | [Click here](/docs/software-engineering-insights/sei-projects-and-collections/manage-contributors) |
| <a href="/docs/software-engineering-insights/sei-contributors/manage-contributors">Manage Contributors</a> | View, add, edit and remove contributors | [Click here](/docs/software-engineering-insights/sei-contributors/manage-contributors) |

### <a href="#phase-5-profiles-setup"> Phase 5: Profiles Setup </a>

Expand Down Expand Up @@ -241,7 +241,7 @@ Review the following resources to learn more about **Collection Categories** and
* [Project and Collection Hierarchy](/docs/software-engineering-insights/sei-projects-and-collections/project-and-collection-overview): Learn about how the collection hierarchy is defined on Harness SEI
* [Manage collection categories](/docs/software-engineering-insights/sei-projects-and-collections/manage-collection-cat): Learn how you can add, view, edit, and enable/disable Collection categories
* [Manage collections](/docs/software-engineering-insights/sei-projects-and-collections/manage-collections): Learn how you can add, view, edit, and manage Insight associations with a collection
* [Manage contributors](/docs/software-engineering-insights/sei-projects-and-collections/manage-contributors): Learn how to add contributors and configure the contributor attributes
* [Manage contributors](/docs/software-engineering-insights/sei-contributors/manage-contributors): Learn how to add contributors and configure the contributor attributes

## Phase 5: Profiles Setup

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label":"Insights",
"position": 21,
"position": 22,
"collapsible":"true",
"collapsed":"true",
"className":"default",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"label":"Contributors",
"position": 21,
"collapsible":"true",
"collapsed":"true",
"className":"default",
"link":{
"type":"generated-index",
"title":"Contributors"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Manage Contributors
description: Manage contributor attributes and associations.
sidebar_position: 50
sidebar_label: Manage contributors
---

Contributors are developers and other team members that complete actions and activities that contribute to your SEI metrics and insights. Contributors are represented by contributor records in SEI. SEI contributor records serve two primary functions: Account association and Collection association.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
title: Merge Contributors (BETA)
description: Manage contributor attributes and associations.
sidebar_position: 50
sidebar_label: Merge user profiles (BETA)
---

## Overview

When setting up Software Engineering Insights with multiple integrations, the data ingested by each creates different integration-specific user profiles. SEI uses email addresses to unify these user profiles, but sometimes you might encounter multiple user profiles for the same user.

This happens when the same individual is linked to different accounts across integrations. Managing and merging these profiles ensures accurate data representation and prevents issues like:

* **Incomplete ticket tracking:** Missing links between contributors and associated tasks.
* **Missing commit information:** Difficulty tracking contributions accurately.
* **Fragmented pull request data:** Pull request history appears under multiple users.
* **Inaccurate contributor metrics:** Skewed analytics and performance metrics.

## Connected user accounts

To identify and manage duplicate profiles:

* Navigate to the **Contributors** section in the SEI dashboard.
* Click on **Connected User Accounts** to view all user profiles linked to your integrations.

## User profile matching

SEI uses intelligent algorithms to group similar user profiles under two categories: **Candidates** and **Outstanding**. The grouping is based on matching criteria that can be customized for specific use cases.

### Matching criteria

* **Email Address (default):** User profiles with the same email are grouped together. You can enable an option to ignore email domains for scenarios where users use different domain emails (e.g., [email protected] and [email protected]).
* **Name:** Match profiles by first name, last name, or a combination of both.
* **Username:** Identify contributors based on unique usernames.
* **No Criteria:** Profiles can be grouped manually without predefined rules.

### Profile categories

Profile categories define how SEI organizes user profiles based on matching criteria:

* **Candidates:** Groups of profiles automatically matched by SEI based on the chosen criteria. You can review and fine-tune these groups by adding or removing profiles.
* **Outstanding:** Unmatched profiles that the system couldn’t group. Requires manual intervention to add to existing groups or create new ones.

## Merging contributor profiles

Merging ensures all data associated with multiple user profiles is unified. Follow these steps to merge profiles effectively:

### Step 1: Identify duplicate profiles

* Navigate to **Contributors > Connected User Accounts**.
* Review the **Candidates** section:
* Click on a group to expand and view matched profiles.
* Verify that profiles belong to the same individual.
* Adjust groups by adding or removing profiles as needed.

### Step 2: Choose merge options

* **Merge Contributors:** Instantly merge profiles into a single contributor record.
* **Identify as Draft:** Save proposed matches for later review.

### Step 3: Finalize and publish changes

* Navigate to the **Contributors > Draft** tab to review matches saved as drafts.
* Verify details such as:
* Number of new contributors created.
* Profiles added or removed from existing contributors.
* Profiles flagged for deletion.
* Once satisfied, click **Publish All Changes** to update the contributor records.


:::info
Changes made during merging are irreversible. Use the draft mode to ensure accuracy before publishing.
:::

### Best practices

To maintain clean and accurate contributor records:

* **Regular reviews:** Periodically check for duplicate profiles and merge them.
* **Verify matches:** Ensure the accuracy of automatic matching before merging.
* **Use draft mode:** Always use the draft feature to review changes in bulk.
* **Customize matching criteria:** Adjust the criteria based on your organization’s specific needs.
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ For information about configuring Collections, go to [Manage Collections](/docs/

Contributors are developers and other team members that complete actions and activities that contribute to your SEI metrics and insights. Contributors are represented by contributor records in SEI. SEI contributor records associate related user accounts across your SDLC tools and can be used to populate contributor-based Collections.

For information about managing contributors, go to [Manage contributors](/docs/software-engineering-insights/sei-projects-and-collections/manage-contributors).
For information about managing contributors, go to [Manage contributors](/docs/software-engineering-insights/sei-contributors/manage-contributors).
Loading