diff --git a/openmetadata-docs/content/v1.6.x/collate-menu.md b/openmetadata-docs/content/v1.6.x/collate-menu.md index 27269677618..fc22c10aba7 100644 --- a/openmetadata-docs/content/v1.6.x/collate-menu.md +++ b/openmetadata-docs/content/v1.6.x/collate-menu.md @@ -947,6 +947,8 @@ site_menu: url: /how-to-guides/data-governance/classification/assets - category: How-to Guides / Data Governance / Classification / How to Request for Classification Tags url: /how-to-guides/data-governance/classification/request-tags + - category: How-to Guides / Data Governance / Classification / Sample Data Handling Using PII Tags + url: /how-to-guides/data-governance/classification/sample-data-using-pii-tag - category: How-to Guides / Data Governance / Classification / Auto-Classification Workflow url: /how-to-guides/data-governance/classification/auto-classification - category: How-to Guides / Data Governance / Classification / Auto-Classification Workflow / Workflow diff --git a/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/classification/sample-data-using-pii-tag.md b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/classification/sample-data-using-pii-tag.md new file mode 100644 index 00000000000..e5d322185cc --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/classification/sample-data-using-pii-tag.md @@ -0,0 +1,59 @@ +--- +title: Sample Data Handling Using PII Tags +slug: /how-to-guides/data-governance/classification/sample-data-using-pii-tag +--- + +# Sample Data Handling Using PII Tags + +In OpenMetadata, sensitive information is protected through **automatic masking** of sample data when PII (Personally Identifiable Information) tags are applied. + +## How It Works + +- If a **PII tag** is applied to a **specific column**: + - Only that column’s sample data will be **masked** and displayed as `******` in the UI. + +{% image +src="/images/v1.6/how-to-guides/governance/pii-tags.png" +alt="PII Tag Application at Column Level" +caption="PII Tag Application at Column Level" +/%} + +- If a **PII tag** is applied at the **table level**: + - **All columns** within that table will have their sample data masked automatically. + +{% image +src="/images/v1.6/how-to-guides/governance/pii-tags2.png" +alt="PII Tag Application at Table Level" +caption="PII Tag Application at Table Level" +/%} + +This behavior ensures that sensitive data is not exposed through sample data views in OpenMetadata. + +## Example + +| Column Name | Tag | Sample Data Displayed | +|-------------|------------------|------------------------| +| email | PII.Sensitive | ****** | +| phoneNumber | PII.Sensitive | ****** | +| age | (None) | 25 | + +When the tag is applied at the **table level**, the result would be: + +| Column Name | Tag | Sample Data Displayed | +|-------------|------------------------|------------------------| +| email | Inherited from Table | ****** | +| phoneNumber | Inherited from Table | ****** | +| age | Inherited from Table | ****** | + +## How to Apply PII Tags + +1. Navigate to the **column** or **table** in the OpenMetadata UI. +2. Apply the **PII.Sensitive** tag via the tagging options. + +{% image +src="/images/v1.6/how-to-guides/governance/pii-tags1.png" +alt="PII.Sensitive Tagging" +caption="PII.Sensitive Tagging" +/%} + +3. Ensure auto-classification or manual tagging captures the correct columns during ingestion. diff --git a/openmetadata-docs/content/v1.6.x/menu.md b/openmetadata-docs/content/v1.6.x/menu.md index 1344540b507..3d2b2d18a96 100644 --- a/openmetadata-docs/content/v1.6.x/menu.md +++ b/openmetadata-docs/content/v1.6.x/menu.md @@ -1074,6 +1074,8 @@ site_menu: url: /how-to-guides/data-governance/classification/assets - category: How-to Guides / Data Governance / Classification / How to Request for Classification Tags url: /how-to-guides/data-governance/classification/request-tags + - category: How-to Guides / Data Governance / Classification / Sample Data Handling Using PII Tags + url: /how-to-guides/data-governance/classification/sample-data-using-pii-tag - category: How-to Guides / Data Governance / Classification / Auto-Classification Workflow url: /how-to-guides/data-governance/classification/auto-classification - category: How-to Guides / Data Governance / Classification / Auto-Classification Workflow / Workflow diff --git a/openmetadata-docs/content/v1.7.x/collate-menu.md b/openmetadata-docs/content/v1.7.x/collate-menu.md index f2baf3ccab1..fdfae9bd8ea 100644 --- a/openmetadata-docs/content/v1.7.x/collate-menu.md +++ b/openmetadata-docs/content/v1.7.x/collate-menu.md @@ -983,6 +983,8 @@ site_menu: url: /how-to-guides/data-governance/classification/assets - category: How-to Guides / Data Governance / Classification / How to Request for Classification Tags url: /how-to-guides/data-governance/classification/request-tags + - category: How-to Guides / Data Governance / Classification / Sample Data Handling Using PII Tags + url: /how-to-guides/data-governance/classification/sample-data-using-pii-tag - category: How-to Guides / Data Governance / Classification / Auto-Classification Workflow url: /how-to-guides/data-governance/classification/auto-classification - category: How-to Guides / Data Governance / Classification / Auto-Classification Workflow / Workflow diff --git a/openmetadata-docs/content/v1.7.x/how-to-guides/data-governance/classification/sample-data-using-pii-tag.md b/openmetadata-docs/content/v1.7.x/how-to-guides/data-governance/classification/sample-data-using-pii-tag.md new file mode 100644 index 00000000000..6a32a8e2ec7 --- /dev/null +++ b/openmetadata-docs/content/v1.7.x/how-to-guides/data-governance/classification/sample-data-using-pii-tag.md @@ -0,0 +1,59 @@ +--- +title: Sample Data Handling Using PII Tags +slug: /how-to-guides/data-governance/classification/sample-data-using-pii-tag +--- + +# Sample Data Handling Using PII Tags + +In OpenMetadata, sensitive information is protected through **automatic masking** of sample data when PII (Personally Identifiable Information) tags are applied. + +## How It Works + +- If a **PII tag** is applied to a **specific column**: + - Only that column’s sample data will be **masked** and displayed as `******` in the UI. + +{% image +src="/images/v1.7/how-to-guides/governance/pii-tags.png" +alt="PII Tag Application at Column Level" +caption="PII Tag Application at Column Level" +/%} + +- If a **PII tag** is applied at the **table level**: + - **All columns** within that table will have their sample data masked automatically. + +{% image +src="/images/v1.7/how-to-guides/governance/pii-tags2.png" +alt="PII Tag Application at Table Level" +caption="PII Tag Application at Table Level" +/%} + +This behavior ensures that sensitive data is not exposed through sample data views in OpenMetadata. + +## Example + +| Column Name | Tag | Sample Data Displayed | +|-------------|------------------|------------------------| +| email | PII.Sensitive | ****** | +| phoneNumber | PII.Sensitive | ****** | +| age | (None) | 25 | + +When the tag is applied at the **table level**, the result would be: + +| Column Name | Tag | Sample Data Displayed | +|-------------|------------------------|------------------------| +| email | Inherited from Table | ****** | +| phoneNumber | Inherited from Table | ****** | +| age | Inherited from Table | ****** | + +## How to Apply PII Tags + +1. Navigate to the **column** or **table** in the OpenMetadata UI. +2. Apply the **PII.Sensitive** tag via the tagging options. + +{% image +src="/images/v1.7/how-to-guides/governance/pii-tags1.png" +alt="PII.Sensitive Tagging" +caption="PII.Sensitive Tagging" +/%} + +3. Ensure auto-classification or manual tagging captures the correct columns during ingestion. diff --git a/openmetadata-docs/content/v1.7.x/menu.md b/openmetadata-docs/content/v1.7.x/menu.md index e1ab7f536c6..3878de92b71 100644 --- a/openmetadata-docs/content/v1.7.x/menu.md +++ b/openmetadata-docs/content/v1.7.x/menu.md @@ -1096,6 +1096,8 @@ site_menu: url: /how-to-guides/data-governance/classification/assets - category: How-to Guides / Data Governance / Classification / How to Request for Classification Tags url: /how-to-guides/data-governance/classification/request-tags + - category: How-to Guides / Data Governance / Classification / Sample Data Handling Using PII Tags + url: /how-to-guides/data-governance/classification/sample-data-using-pii-tag - category: How-to Guides / Data Governance / Classification / Auto-Classification Workflow url: /how-to-guides/data-governance/classification/auto-classification - category: How-to Guides / Data Governance / Classification / Auto-Classification Workflow / Workflow diff --git a/openmetadata-docs/content/v1.8.x-SNAPSHOT/collate-menu.md b/openmetadata-docs/content/v1.8.x-SNAPSHOT/collate-menu.md index f2baf3ccab1..fdfae9bd8ea 100644 --- a/openmetadata-docs/content/v1.8.x-SNAPSHOT/collate-menu.md +++ b/openmetadata-docs/content/v1.8.x-SNAPSHOT/collate-menu.md @@ -983,6 +983,8 @@ site_menu: url: /how-to-guides/data-governance/classification/assets - category: How-to Guides / Data Governance / Classification / How to Request for Classification Tags url: /how-to-guides/data-governance/classification/request-tags + - category: How-to Guides / Data Governance / Classification / Sample Data Handling Using PII Tags + url: /how-to-guides/data-governance/classification/sample-data-using-pii-tag - category: How-to Guides / Data Governance / Classification / Auto-Classification Workflow url: /how-to-guides/data-governance/classification/auto-classification - category: How-to Guides / Data Governance / Classification / Auto-Classification Workflow / Workflow diff --git a/openmetadata-docs/content/v1.8.x-SNAPSHOT/how-to-guides/data-governance/classification/sample-data-using-pii-tag.md b/openmetadata-docs/content/v1.8.x-SNAPSHOT/how-to-guides/data-governance/classification/sample-data-using-pii-tag.md new file mode 100644 index 00000000000..7510f79be9e --- /dev/null +++ b/openmetadata-docs/content/v1.8.x-SNAPSHOT/how-to-guides/data-governance/classification/sample-data-using-pii-tag.md @@ -0,0 +1,59 @@ +--- +title: Sample Data Handling Using PII Tags +slug: /how-to-guides/data-governance/classification/sample-data-using-pii-tag +--- + +# Sample Data Handling Using PII Tags + +In OpenMetadata, sensitive information is protected through **automatic masking** of sample data when PII (Personally Identifiable Information) tags are applied. + +## How It Works + +- If a **PII tag** is applied to a **specific column**: + - Only that column’s sample data will be **masked** and displayed as `******` in the UI. + +{% image +src="/images/v1.8/how-to-guides/governance/pii-tags.png" +alt="PII Tag Application at Column Level" +caption="PII Tag Application at Column Level" +/%} + +- If a **PII tag** is applied at the **table level**: + - **All columns** within that table will have their sample data masked automatically. + +{% image +src="/images/v1.8/how-to-guides/governance/pii-tags2.png" +alt="PII Tag Application at Table Level" +caption="PII Tag Application at Table Level" +/%} + +This behavior ensures that sensitive data is not exposed through sample data views in OpenMetadata. + +## Example + +| Column Name | Tag | Sample Data Displayed | +|-------------|------------------|------------------------| +| email | PII.Sensitive | ****** | +| phoneNumber | PII.Sensitive | ****** | +| age | (None) | 25 | + +When the tag is applied at the **table level**, the result would be: + +| Column Name | Tag | Sample Data Displayed | +|-------------|------------------------|------------------------| +| email | Inherited from Table | ****** | +| phoneNumber | Inherited from Table | ****** | +| age | Inherited from Table | ****** | + +## How to Apply PII Tags + +1. Navigate to the **column** or **table** in the OpenMetadata UI. +2. Apply the **PII.Sensitive** tag via the tagging options. + +{% image +src="/images/v1.8/how-to-guides/governance/pii-tags1.png" +alt="PII.Sensitive Tagging" +caption="PII.Sensitive Tagging" +/%} + +3. Ensure auto-classification or manual tagging captures the correct columns during ingestion. diff --git a/openmetadata-docs/content/v1.8.x-SNAPSHOT/menu.md b/openmetadata-docs/content/v1.8.x-SNAPSHOT/menu.md index e1ab7f536c6..3878de92b71 100644 --- a/openmetadata-docs/content/v1.8.x-SNAPSHOT/menu.md +++ b/openmetadata-docs/content/v1.8.x-SNAPSHOT/menu.md @@ -1096,6 +1096,8 @@ site_menu: url: /how-to-guides/data-governance/classification/assets - category: How-to Guides / Data Governance / Classification / How to Request for Classification Tags url: /how-to-guides/data-governance/classification/request-tags + - category: How-to Guides / Data Governance / Classification / Sample Data Handling Using PII Tags + url: /how-to-guides/data-governance/classification/sample-data-using-pii-tag - category: How-to Guides / Data Governance / Classification / Auto-Classification Workflow url: /how-to-guides/data-governance/classification/auto-classification - category: How-to Guides / Data Governance / Classification / Auto-Classification Workflow / Workflow diff --git a/openmetadata-docs/images/v1.6/how-to-guides/governance/pii-tags.png b/openmetadata-docs/images/v1.6/how-to-guides/governance/pii-tags.png new file mode 100644 index 00000000000..7a261e50a61 Binary files /dev/null and b/openmetadata-docs/images/v1.6/how-to-guides/governance/pii-tags.png differ diff --git a/openmetadata-docs/images/v1.6/how-to-guides/governance/pii-tags1.png b/openmetadata-docs/images/v1.6/how-to-guides/governance/pii-tags1.png new file mode 100644 index 00000000000..31f260b7cd4 Binary files /dev/null and b/openmetadata-docs/images/v1.6/how-to-guides/governance/pii-tags1.png differ diff --git a/openmetadata-docs/images/v1.6/how-to-guides/governance/pii-tags2.png b/openmetadata-docs/images/v1.6/how-to-guides/governance/pii-tags2.png new file mode 100644 index 00000000000..b34481913aa Binary files /dev/null and b/openmetadata-docs/images/v1.6/how-to-guides/governance/pii-tags2.png differ diff --git a/openmetadata-docs/images/v1.7/how-to-guides/governance/pii-tags.png b/openmetadata-docs/images/v1.7/how-to-guides/governance/pii-tags.png new file mode 100644 index 00000000000..7a261e50a61 Binary files /dev/null and b/openmetadata-docs/images/v1.7/how-to-guides/governance/pii-tags.png differ diff --git a/openmetadata-docs/images/v1.7/how-to-guides/governance/pii-tags1.png b/openmetadata-docs/images/v1.7/how-to-guides/governance/pii-tags1.png new file mode 100644 index 00000000000..31f260b7cd4 Binary files /dev/null and b/openmetadata-docs/images/v1.7/how-to-guides/governance/pii-tags1.png differ diff --git a/openmetadata-docs/images/v1.7/how-to-guides/governance/pii-tags2.png b/openmetadata-docs/images/v1.7/how-to-guides/governance/pii-tags2.png new file mode 100644 index 00000000000..b34481913aa Binary files /dev/null and b/openmetadata-docs/images/v1.7/how-to-guides/governance/pii-tags2.png differ diff --git a/openmetadata-docs/images/v1.8/how-to-guides/governance/pii-tags.png b/openmetadata-docs/images/v1.8/how-to-guides/governance/pii-tags.png new file mode 100644 index 00000000000..7a261e50a61 Binary files /dev/null and b/openmetadata-docs/images/v1.8/how-to-guides/governance/pii-tags.png differ diff --git a/openmetadata-docs/images/v1.8/how-to-guides/governance/pii-tags1.png b/openmetadata-docs/images/v1.8/how-to-guides/governance/pii-tags1.png new file mode 100644 index 00000000000..31f260b7cd4 Binary files /dev/null and b/openmetadata-docs/images/v1.8/how-to-guides/governance/pii-tags1.png differ diff --git a/openmetadata-docs/images/v1.8/how-to-guides/governance/pii-tags2.png b/openmetadata-docs/images/v1.8/how-to-guides/governance/pii-tags2.png new file mode 100644 index 00000000000..b34481913aa Binary files /dev/null and b/openmetadata-docs/images/v1.8/how-to-guides/governance/pii-tags2.png differ