diff --git a/docs/assets/explore/profiles/arrow-dark.png b/docs/assets/explore/profiles/arrow-dark.png new file mode 100644 index 000000000..b827b0c33 Binary files /dev/null and b/docs/assets/explore/profiles/arrow-dark.png differ diff --git a/docs/assets/explore/profiles/arrow-light.png b/docs/assets/explore/profiles/arrow-light.png new file mode 100644 index 000000000..36fa9ab1d Binary files /dev/null and b/docs/assets/explore/profiles/arrow-light.png differ diff --git a/docs/assets/explore/profiles/assign-dark.png b/docs/assets/explore/profiles/assign-dark.png new file mode 100644 index 000000000..8b9b86259 Binary files /dev/null and b/docs/assets/explore/profiles/assign-dark.png differ diff --git a/docs/assets/explore/profiles/assign-light.png b/docs/assets/explore/profiles/assign-light.png new file mode 100644 index 000000000..2874c0f2a Binary files /dev/null and b/docs/assets/explore/profiles/assign-light.png differ diff --git a/docs/assets/explore/profiles/caret-dark.png b/docs/assets/explore/profiles/caret-dark.png new file mode 100644 index 000000000..eff08a436 Binary files /dev/null and b/docs/assets/explore/profiles/caret-dark.png differ diff --git a/docs/assets/explore/profiles/caret-light.png b/docs/assets/explore/profiles/caret-light.png new file mode 100644 index 000000000..e6a4620a5 Binary files /dev/null and b/docs/assets/explore/profiles/caret-light.png differ diff --git a/docs/assets/explore/profiles/caret2-dark.png b/docs/assets/explore/profiles/caret2-dark.png new file mode 100644 index 000000000..f85c5bea3 Binary files /dev/null and b/docs/assets/explore/profiles/caret2-dark.png differ diff --git a/docs/assets/explore/profiles/caret2-light.png b/docs/assets/explore/profiles/caret2-light.png new file mode 100644 index 000000000..fcb39efff Binary files /dev/null and b/docs/assets/explore/profiles/caret2-light.png differ diff --git a/docs/assets/explore/profiles/container-dark.png b/docs/assets/explore/profiles/container-dark.png new file mode 100644 index 000000000..01cc2242a Binary files /dev/null and b/docs/assets/explore/profiles/container-dark.png differ diff --git a/docs/assets/explore/profiles/container-light.png b/docs/assets/explore/profiles/container-light.png new file mode 100644 index 000000000..362cf7610 Binary files /dev/null and b/docs/assets/explore/profiles/container-light.png differ diff --git a/docs/assets/explore/profiles/create-dark.png b/docs/assets/explore/profiles/create-dark.png new file mode 100644 index 000000000..68b44be3d Binary files /dev/null and b/docs/assets/explore/profiles/create-dark.png differ diff --git a/docs/assets/explore/profiles/create-light.png b/docs/assets/explore/profiles/create-light.png new file mode 100644 index 000000000..612395c35 Binary files /dev/null and b/docs/assets/explore/profiles/create-light.png differ diff --git a/docs/assets/explore/profiles/dates-dark.png b/docs/assets/explore/profiles/dates-dark.png new file mode 100644 index 000000000..ff060f699 Binary files /dev/null and b/docs/assets/explore/profiles/dates-dark.png differ diff --git a/docs/assets/explore/profiles/dates-light.png b/docs/assets/explore/profiles/dates-light.png new file mode 100644 index 000000000..c8af22df8 Binary files /dev/null and b/docs/assets/explore/profiles/dates-light.png differ diff --git a/docs/assets/explore/profiles/directed-dark.png b/docs/assets/explore/profiles/directed-dark.png new file mode 100644 index 000000000..4144012d8 Binary files /dev/null and b/docs/assets/explore/profiles/directed-dark.png differ diff --git a/docs/assets/explore/profiles/directed-light.png b/docs/assets/explore/profiles/directed-light.png new file mode 100644 index 000000000..42a026956 Binary files /dev/null and b/docs/assets/explore/profiles/directed-light.png differ diff --git a/docs/assets/explore/profiles/explore-dark.png b/docs/assets/explore/profiles/explore-dark.png new file mode 100644 index 000000000..9aea1aaba Binary files /dev/null and b/docs/assets/explore/profiles/explore-dark.png differ diff --git a/docs/assets/explore/profiles/explore-light.png b/docs/assets/explore/profiles/explore-light.png new file mode 100644 index 000000000..da798b7af Binary files /dev/null and b/docs/assets/explore/profiles/explore-light.png differ diff --git a/docs/assets/explore/profiles/field-dark.png b/docs/assets/explore/profiles/field-dark.png new file mode 100644 index 000000000..748ac7e49 Binary files /dev/null and b/docs/assets/explore/profiles/field-dark.png differ diff --git a/docs/assets/explore/profiles/field-light.png b/docs/assets/explore/profiles/field-light.png new file mode 100644 index 000000000..af08d01ca Binary files /dev/null and b/docs/assets/explore/profiles/field-light.png differ diff --git a/docs/assets/explore/profiles/filter-dark.png b/docs/assets/explore/profiles/filter-dark.png new file mode 100644 index 000000000..872db05f8 Binary files /dev/null and b/docs/assets/explore/profiles/filter-dark.png differ diff --git a/docs/assets/explore/profiles/filter-light.png b/docs/assets/explore/profiles/filter-light.png new file mode 100644 index 000000000..a8c3c7973 Binary files /dev/null and b/docs/assets/explore/profiles/filter-light.png differ diff --git a/docs/assets/explore/profiles/filter2-dark.png b/docs/assets/explore/profiles/filter2-dark.png new file mode 100644 index 000000000..4b709a58f Binary files /dev/null and b/docs/assets/explore/profiles/filter2-dark.png differ diff --git a/docs/assets/explore/profiles/filter2-light.png b/docs/assets/explore/profiles/filter2-light.png new file mode 100644 index 000000000..4234d7c70 Binary files /dev/null and b/docs/assets/explore/profiles/filter2-light.png differ diff --git a/docs/assets/explore/profiles/info-dark.png b/docs/assets/explore/profiles/info-dark.png new file mode 100644 index 000000000..48b9b1421 Binary files /dev/null and b/docs/assets/explore/profiles/info-dark.png differ diff --git a/docs/assets/explore/profiles/info-light.png b/docs/assets/explore/profiles/info-light.png new file mode 100644 index 000000000..245d12f69 Binary files /dev/null and b/docs/assets/explore/profiles/info-light.png differ diff --git a/docs/assets/explore/profiles/mark-dark.png b/docs/assets/explore/profiles/mark-dark.png new file mode 100644 index 000000000..1b409d73e Binary files /dev/null and b/docs/assets/explore/profiles/mark-dark.png differ diff --git a/docs/assets/explore/profiles/mark-light.png b/docs/assets/explore/profiles/mark-light.png new file mode 100644 index 000000000..23850704a Binary files /dev/null and b/docs/assets/explore/profiles/mark-light.png differ diff --git a/docs/assets/explore/profiles/msg-dark.png b/docs/assets/explore/profiles/msg-dark.png new file mode 100644 index 000000000..5a4c2439d Binary files /dev/null and b/docs/assets/explore/profiles/msg-dark.png differ diff --git a/docs/assets/explore/profiles/msg-light.png b/docs/assets/explore/profiles/msg-light.png new file mode 100644 index 000000000..c2155ee4c Binary files /dev/null and b/docs/assets/explore/profiles/msg-light.png differ diff --git a/docs/assets/explore/profiles/netsuite-dark.png b/docs/assets/explore/profiles/netsuite-dark.png new file mode 100644 index 000000000..2f71d3c47 Binary files /dev/null and b/docs/assets/explore/profiles/netsuite-dark.png differ diff --git a/docs/assets/explore/profiles/netsuite-light.png b/docs/assets/explore/profiles/netsuite-light.png new file mode 100644 index 000000000..bcb2f1d93 Binary files /dev/null and b/docs/assets/explore/profiles/netsuite-light.png differ diff --git a/docs/assets/explore/profiles/new-dark.png b/docs/assets/explore/profiles/new-dark.png new file mode 100644 index 000000000..64f99d037 Binary files /dev/null and b/docs/assets/explore/profiles/new-dark.png differ diff --git a/docs/assets/explore/profiles/new-light.png b/docs/assets/explore/profiles/new-light.png new file mode 100644 index 000000000..b86f36e2e Binary files /dev/null and b/docs/assets/explore/profiles/new-light.png differ diff --git a/docs/assets/explore/profiles/organized-dark.png b/docs/assets/explore/profiles/organized-dark.png new file mode 100644 index 000000000..79be3a4ea Binary files /dev/null and b/docs/assets/explore/profiles/organized-dark.png differ diff --git a/docs/assets/explore/profiles/organized-light.png b/docs/assets/explore/profiles/organized-light.png new file mode 100644 index 000000000..320ac3a01 Binary files /dev/null and b/docs/assets/explore/profiles/organized-light.png differ diff --git a/docs/assets/explore/profiles/profiles-dark.png b/docs/assets/explore/profiles/profiles-dark.png new file mode 100644 index 000000000..5fc63285f Binary files /dev/null and b/docs/assets/explore/profiles/profiles-dark.png differ diff --git a/docs/assets/explore/profiles/profiles-light.png b/docs/assets/explore/profiles/profiles-light.png new file mode 100644 index 000000000..36f2967f1 Binary files /dev/null and b/docs/assets/explore/profiles/profiles-light.png differ diff --git a/docs/assets/explore/profiles/sort-dark.png b/docs/assets/explore/profiles/sort-dark.png new file mode 100644 index 000000000..fa28a4cde Binary files /dev/null and b/docs/assets/explore/profiles/sort-dark.png differ diff --git a/docs/assets/explore/profiles/sort-light.png b/docs/assets/explore/profiles/sort-light.png new file mode 100644 index 000000000..7ec40f3e3 Binary files /dev/null and b/docs/assets/explore/profiles/sort-light.png differ diff --git a/docs/assets/explore/profiles/sort2-dark.png b/docs/assets/explore/profiles/sort2-dark.png new file mode 100644 index 000000000..814fd263b Binary files /dev/null and b/docs/assets/explore/profiles/sort2-dark.png differ diff --git a/docs/assets/explore/profiles/sort2-light.png b/docs/assets/explore/profiles/sort2-light.png new file mode 100644 index 000000000..89b8a0b5b Binary files /dev/null and b/docs/assets/explore/profiles/sort2-light.png differ diff --git a/docs/assets/explore/profiles/sortt-dark.png b/docs/assets/explore/profiles/sortt-dark.png new file mode 100644 index 000000000..a62b03302 Binary files /dev/null and b/docs/assets/explore/profiles/sortt-dark.png differ diff --git a/docs/assets/explore/profiles/sortt-light.png b/docs/assets/explore/profiles/sortt-light.png new file mode 100644 index 000000000..5f380df6a Binary files /dev/null and b/docs/assets/explore/profiles/sortt-light.png differ diff --git a/docs/assets/explore/profiles/sortt2-dark.png b/docs/assets/explore/profiles/sortt2-dark.png new file mode 100644 index 000000000..80a705031 Binary files /dev/null and b/docs/assets/explore/profiles/sortt2-dark.png differ diff --git a/docs/assets/explore/profiles/sortt2-light.png b/docs/assets/explore/profiles/sortt2-light.png new file mode 100644 index 000000000..4a43399b5 Binary files /dev/null and b/docs/assets/explore/profiles/sortt2-light.png differ diff --git a/docs/assets/explore/profiles/table-dark.png b/docs/assets/explore/profiles/table-dark.png new file mode 100644 index 000000000..44ac44810 Binary files /dev/null and b/docs/assets/explore/profiles/table-dark.png differ diff --git a/docs/assets/explore/profiles/table-light.png b/docs/assets/explore/profiles/table-light.png new file mode 100644 index 000000000..4e4f59fa9 Binary files /dev/null and b/docs/assets/explore/profiles/table-light.png differ diff --git a/docs/assets/explore/profiles/unmark-dark.png b/docs/assets/explore/profiles/unmark-dark.png new file mode 100644 index 000000000..d31a82542 Binary files /dev/null and b/docs/assets/explore/profiles/unmark-dark.png differ diff --git a/docs/assets/explore/profiles/unmark-light.png b/docs/assets/explore/profiles/unmark-light.png new file mode 100644 index 000000000..d09123d59 Binary files /dev/null and b/docs/assets/explore/profiles/unmark-light.png differ diff --git a/docs/assets/explore/profiles/window-dark.png b/docs/assets/explore/profiles/window-dark.png new file mode 100644 index 000000000..6b0a50b31 Binary files /dev/null and b/docs/assets/explore/profiles/window-dark.png differ diff --git a/docs/assets/explore/profiles/window-light.png b/docs/assets/explore/profiles/window-light.png new file mode 100644 index 000000000..62938b60b Binary files /dev/null and b/docs/assets/explore/profiles/window-light.png differ diff --git a/docs/explore/profiles.md b/docs/explore/profiles.md index bffdf48d1..7a100c98d 100644 --- a/docs/explore/profiles.md +++ b/docs/explore/profiles.md @@ -1,3 +1,288 @@ +# Profiles + +**Profiles** in Qualytics helps you explore and manage your containers and fields. With features like filtering, sorting, tagging, and detailed profiling, it provides a clear understanding of data quality and structure. This simplifies navigation and enhances data management for quickly, informed decisions. + +Let’s get started 🚀 + +## Navigation + +**Step 1:** Log in to your Qualytics account and click the **Explore** button on the left side panel of the interface. + +![explore](../assets/explore/profiles/explore-light.png#only-light) +![explore](../assets/explore/profiles/explore-dark.png#only-dark) + +**Step 2:** Click on the **"Profiles"** from the Navigation Tab. + +![profiles](../assets/explore/profiles/profiles-light.png#only-light) +![profiles](../assets/explore/profiles/profiles-dark.png#only-dark) + +You will be navigated to the **Profiles** section. Here, you will see the data organized into two sections: **Containers** and **Fields**, allowing you to explore and analyze the datasets efficiently. + +![organized](../assets/explore/profiles/organized-light.png#only-light) +![organized](../assets/explore/profiles/organized-dark.png#only-dark) + +## Containers + +By selecting the **Containers section**, you can explore structured datasets that are organized as either JDBC or DFS containers. JDBC containers represent tables or views within relational databases, while DFS containers include files such as CSV, JSON, or Parquet, typically stored in distributed systems like Hadoop or cloud storage. + +![container](../assets/explore/profiles/container-light.png#only-light) +![container](../assets/explore/profiles/container-dark.png#only-dark) + +### Container Details + +**Containers** section provides key details about each container, including the **last profiled** and **last scanned** dates. Hovering over the **info icon** for a specific container reveals these details instantly. + +**Step 1:** Locate the container you want to review, then hover over the info icon to view the container Details. + +![info](../assets/explore/profiles/info-light.png#only-light) +![info](../assets/explore/profiles/info-dark.png#only-dark) + +**Step 2:** A pop-up will appear with additional details about the container, such as the last **profiled** and last **scanned** dates. + +![dates](../assets/explore/profiles/dates-light.png#only-light) +![dates](../assets/explore/profiles/dates-dark.png#only-dark) + +### Explore Tables and Fields + +By clicking on a specific container, users can view its associated fields, including detailed profiling information. Additionally, clicking the arrow icon on the right side of a specific container allows users to navigate directly to its corresponding table for a more in-depth exploration. + +#### Explore Fields + +To explore the data within a container, you can view all its fields. This allows you to gain insights into the structure and quality of the data stored in the container. + +**Step 1:** Click on the specific container whose fields you want to preview. + +For demonstration purposes, we have selected the Netsuite Financials container. + +![netsuite](../assets/explore/profiles/netsuite-light.png#only-light) +![netsuite](../assets/explore/profiles/netsuite-dark.png#only-dark) + +**Step 2:** You will be directed to the fields of the selected container, where all the fields of the container will be displayed. + +![directed](../assets/explore/profiles/directed-light.png#only-light) +![directed](../assets/explore/profiles/directed-dark.png#only-dark) + +#### Explore Tables + +To explore the data in more detail, you can view the corresponding table of a selected container. This provides a comprehensive look at the data stored within, allowing for deeper analysis and exploration. + +**Step 1:** Click on the arrow icon on the right side of the container you want to preview. + +![arrow](../assets/explore/profiles/arrow-light.png#only-light) +![arrow](../assets/explore/profiles/arrow-dark.png#only-dark) + +**Step 2:** You will be directed to the corresponding table, providing a comprehensive view of the data stored in the container. + +![table](../assets/explore/profiles/table-light.png#only-light) +![table](../assets/explore/profiles/table-dark.png#only-dark) + +### Filter and Sort + +Filter and Sort options allow you to organize your containers by various criteria, such as Name, Last Profiled, Last Scanned, Quality Score, Records and Type. You can also apply filters to refine your list of containers based on Type + +#### Sort + +You can sort your containers by various criteria, such as Name, Last Profiled, Last Scanned, Quality Score, Records and Type to easily organize and prioritize them according to your needs. + +![sort](../assets/explore/profiles/sort-light.png#only-light) +![sort](../assets/explore/profiles/sort-dark.png#only-dark) + +| No | Sort By | Description | +| :---- | :---- | :---- | +| 1. | Anomalies | Sorts containers based on the number of detected anomalies. | +| 2. | Checks | Sorts containers by the number of active validation checks applied. | +| 3. | Completeness | Sorts containers based on their data completeness percentage. | +| 4. | Created Date | Sorts containers by the date they were created, showing the newest or oldest fields first. | +| 5. | Fields | Sorts containers by the number of fields profiled. | +| 6. | Last Profiled | Sorts by the most recent profiling container. | +| 7. | Last Scanned | Sorts by the most recent scanned container. | +| 8. | Name | Sorts containers alphabetically by their names. | +| 9. | Quality Score | Sorts containers based on their quality score, indicating the reliability of the data in the field. | +| 10. | Records | Sorts containers by the number of records profiled. | +| 11. | Type | Sorts containers based on their data type (e.g., string, boolean, etc.). | + +![sortt](../assets/explore/profiles/sortt-light.png#only-light) +![sortt](../assets/explore/profiles/sortt-dark.png#only-dark) + +Whatever sorting option is selected, you can arrange the data either in ascending or descending order by clicking the caret button next to the selected sorting criteria. + +![caret](../assets/explore/profiles/caret-light.png#only-light) +![caret](../assets/explore/profiles/caret-dark.png#only-dark) + +#### Filter + +You can filter your containers based on values Type (Table, View, File, Computed Table and Computed File) to easily organize and prioritize them according to your needs. + +![filter](../assets/explore/profiles/filter-light.png#only-light) +![filter](../assets/explore/profiles/filter-dark.png#only-dark) + +### Mark as Favorite + +Marking a container as a favorite allows you to quickly access and prioritize the containers that are most important to your work, ensuring faster navigation and improved efficiency. + +**Step 1:** Locate the container which you want to mark as a favorite and click on the bookmark icon located on the left side of the container. + +![mark](../assets/explore/profiles/mark-light.png#only-light) +![mark](../assets/explore/profiles/mark-dark.png#only-dark) + +After Clicking on the bookmark icon your container is successfully marked as a favorite and a success flash message will appear stating **"The Table has been favorited"** + +![msg](../assets/explore/profiles/msg-light.png#only-light) +![msg](../assets/explore/profiles/msg-dark.png#only-dark) + +To unmark, simply click on the bookmark icon of the marked container. This will remove it from your favorites. + +![unmark](../assets/explore/profiles/unmark-light.png#only-light) +![unmark](../assets/explore/profiles/unmark-dark.png#only-dark) + +## Fields + +By selecting the Fields section in the Qualytics platform, you can view all the fields across your data sources, including their quality scores, completeness, and metadata, for streamlined data management. + +### Fields Details + +Field Details view in the Qualytics platform provides in-depth insights into a selected field. It displays key information, including the field’s declared type, number of distinct values, minimum and maximum length of observed values, entropy, and unique/distinct ratio. This detailed profiling allows you to understand the field's data structure, quality, and variability, enabling better data governance and decision-making. + +**Step 1:** Click on the specific field whose fields details you want to preview. + +![field](../assets/explore/profiles/field-light.png#only-light) +![filed](../assets/explore/profiles/field-dark.png#only-dark) + +A modal window will appear, providing detailed information about the selected field, such as its declared type, distinct values, length range, and more. + +![window](../assets/explore/profiles/window-light.png#only-light) +![window](../assets/explore/profiles/window-dark.png#only-dark) + +### Manage Tags in Field Details + +Tags can now be directly managed in the field profile within the Explore section. Simply access the Field Details panel to create, add, or remove tags, enabling more efficient and organized data management. + +**Step 1**: Click on the specific field that you want to manage tags. + +![tag](../assets/explore/profiles/field-light.png#only-light) +![tag](../assets/explore/profiles/field-dark.png#only-dark) + +A Field Details modal window will appear. Click on the + button to assign tags to the selected field. + +![assign](../assets/explore/profiles/assign-light.png#only-light) +![assign](../assets/explore/profiles/assign-dark.png#only-dark) + +**Step 2:** You can also create the new tag by clicking on the ➕ button. + +![new](../assets/explore/profiles/new-light.png#only-light) +![new](../assets/explore/profiles/new-dark.png#only-dark) + +A modal window will appear, providing the options to create the tag. Enter the required values to get started. + +![create](../assets/explore/profiles/create-light.png#only-light) +![create](../assets/explore/profiles/create-dark.png#only-dark) + +For more information on creating tags, refer to the [Add Tag section](../userguide/docs/settings/tags/overview-of-a-tag.md/#add-a-tag). + +### Filter and Sort + +Filter and Sort options allow you to organize your fileds by various criteria, such as Anomalies, Checks, Completeness, Created Date, Name, Quality Score and Type. You can also apply filters to refine your list of fields based on Profile and Type. + +#### Sort + +You can sort your containers by various criteria, such as Anomalies, Checks, Completeness, Created Date, Name, Quality Score and Type to easily organize and prioritize them according to your needs. + +![sort2](../assets/explore/profiles/sort2-light.png#only-light) +![sort2](../assets/explore/profiles/sort2-dark.png#only-dark) + +| No | Sort By | Description | +| :---- | :---- | :---- | +| 1. | Anomalies | Sorts fields based on the number of detected anomalies. | +| 2. | Checks | Sorts fields by the number of active validation checks applied. | +| 3. | Completeness | Sorts fields based on their data completeness percentage. | +| 4. | Created Date | Sorts fields by the date they were created, showing the newest or oldest fields first. | +| 5. | Name | Sorts fields alphabetically by their names. | +| 6. | Quality Score | Sorts fields based on their quality score, indicating the reliability of the data in the field. | +| 7. | Type | Sorts fields based on their data type (e.g., string, boolean, etc.). | + +![sortt2](../assets/explore/profiles/sortt2-light.png#only-light) +![sortt2](../assets/explore/profiles/sortt2-dark.png#only-dark) + +Whatever sorting option is selected, you can arrange the data either in ascending or descending order by clicking the caret button next to the selected sorting criteria. + +![caret2](../assets/explore/profiles/caret2-light.png#only-light) +![caret2](../assets/explore/profiles/caret2-dark.png#only-dark) + +#### Filter + +You can filter your fields based on Profiles and Type to easily organize and prioritize them according to your needs. + +| No. | Filter | Description | +| :---- | :---- | :---- | +| 1. | Profile | Filters fields based on the Profiles (e.g., accounts, accounts.csv, etc.). | +| 2. | Type | Filters fields based on the data type (e.g., string, boolean, date, etc.). | + +![filter2](../assets/explore/profiles/filter2-light.png#only-light) +![filter2](../assets/explore/profiles/filter2-dark.png#only-dark) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + **Profiles Tab: Your Data Asset Inventory** ![Screenshot](../assets/explore/profiles/profiles-tab-light.png#only-light){: style="height:auto;width:450px;"}