feat: Add more information around Entity Type #562
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SolomiiaSnihur
suggested changes
Nov 20, 2024
| An entity type is assigned to a clue during the mapping process and plays a critical role in various codes, including entity origin codes and entity codes. | ||
|
|
||
| **Entity type and codes** | ||
| ## Where Is Entity Type Used? |
There was a problem hiding this comment.
Suggested change
| ## Where Is Entity Type Used? | |
| ## Where is entity type used? |
| ## Where Is Entity Type Used? | ||
|
|
||
| An entity type is a foundational element used in the generation of codes. It always appears as the first part of any code. | ||
| ### Adding Semantic Context to Golden Records |
There was a problem hiding this comment.
Suggested change
| ### Adding Semantic Context to Golden Records | |
| ### Adding semantic context to golden records |
| The entity type provides **metadata**, such as a display name, icon, and descriptions, adding a semantic layer to golden records. | ||
|
|
||
| An entity type always starts with a slash (/). CluedIn has a nested hierarchy of entity types that are separated by slashes. For example, “/Sales/Deal” indicates that the “Deal” entity type is a child of the “Sale” entity type. | ||
| Golden records sharing the same entity type inherently share the same "semantic meaning." |
There was a problem hiding this comment.
Suggested change
| Golden records sharing the same entity type inherently share the same "semantic meaning." | |
| Golden records sharing the same entity type inherently share the same semantic meaning. |
| When defining entity types, it’s essential to balance specificity and genericness. Use terminology familiar to your line of business (LOB) to help identify records intuitively. | ||
|
|
||
| {:.important} | ||
| Tip: CluedIn is flexible—if you choose an initial entity type that needs adjustment, you can change it. However, changing entity types mid-project can be cumbersome, especially if deduplication projects, rules or streaming configurations have already been applied. |
There was a problem hiding this comment.
Suggested change
| Tip: CluedIn is flexible—if you choose an initial entity type that needs adjustment, you can change it. However, changing entity types mid-project can be cumbersome, especially if deduplication projects, rules or streaming configurations have already been applied. | |
| CluedIn is flexible—if you choose an initial entity type that needs adjustment, you can change it. However, changing entity types mid-project can be cumbersome, especially if deduplication projects, rules, or streaming configurations have already been applied. |
| {:.important} | ||
| Tip: CluedIn is flexible—if you choose an initial entity type that needs adjustment, you can change it. However, changing entity types mid-project can be cumbersome, especially if deduplication projects, rules or streaming configurations have already been applied. | ||
|
|
||
| ### Filtering Golden Records |
There was a problem hiding this comment.
Suggested change
| ### Filtering Golden Records | |
| ### Filtering golden records |
| /Document/Audio | ||
| ``` | ||
|
|
||
| In this hierarchy, Video is a child of Document: |
There was a problem hiding this comment.
Suggested change
| In this hierarchy, Video is a child of Document: | |
| In this hierarchy, Video is a child of Document. |
Comment on lines
+62
to
+71
| #### Benefits of Nested Entity Types | ||
|
|
||
| 1. **Grouping Filters**: Nested entity types allow you to filter or stream entities collectively. | ||
| For instance, using a filter such as starts with /Document would include all documents, regardless of their specific sub-entity type. | ||
|
|
||
| 2. **Streamline Reporting**: Nested types simplify reporting and analysis across related entity types. | ||
|
|
||
| ## Useful Resource for Entity Type | ||
|
|
||
| - [Add or modify Entity Type](/management/entity-type) |
There was a problem hiding this comment.
Suggested change
| #### Benefits of Nested Entity Types | |
| 1. **Grouping Filters**: Nested entity types allow you to filter or stream entities collectively. | |
| For instance, using a filter such as starts with /Document would include all documents, regardless of their specific sub-entity type. | |
| 2. **Streamline Reporting**: Nested types simplify reporting and analysis across related entity types. | |
| ## Useful Resource for Entity Type | |
| - [Add or modify Entity Type](/management/entity-type) | |
| #### Benefits of nested entity types | |
| - **Filter grouped entities** – nested entity types allow you to filter or stream entities collectively. For instance, using a filter that starts with /Document would include all documents, regardless of their specific sub-entity type. | |
| - **Streamline reporting** – nested types simplify reporting and analysis across related entity types. | |
| ## Useful resources | |
| - [Add or modify an entity type](/management/entity-type) |
|
|
||
| Entity type acts as the default filter for many operations in CluedIn. Selecting the right entity type allows you to target groups of golden records that logically belong together. | ||
|
|
||
| ### Origin Entity Code (Primary Identifier) |
There was a problem hiding this comment.
Suggested change
| ### Origin Entity Code (Primary Identifier) | |
| ### Entity origin code (primary identifier) |
| has_children: false | ||
| permalink: /key-terms-and-features/entity-type | ||
| tags: ["development","entities","entity-types"] | ||
| --- |
There was a problem hiding this comment.
Suggested change
| --- | |
| --- | |
| ## On this page | |
| {: .no_toc .text-delta } | |
| - TOC | |
| {:toc} |
| --- | ||
| layout: cluedin | ||
| title: Entity type | ||
| title: Entity type (Business Domain) |
There was a problem hiding this comment.
Suggested change
| title: Entity type (Business Domain) | |
| title: Entity type (Business domain) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Enhance the definition of Entity Type