Customizing the sidebar in Eureka Explorer (CTK)
Danger
data.world University!
Check out our Adding metadata fields to the Eureka Explorer Sidebar video!
About the sidebar section for Explorer lineage
Note
To learn about Eureka™️ Explorer lineage, see Eureka Explorer lineage for catalog resources
The sidebar on the lineage pages shows important information about the resource you are looking at.
The sidebar for all the Explorer lineage pages includes the following information by default:
Resource Type: The type of resource.
Resource Parent: The parent of the selected resource.
Description: The description field for the resource.
The following information is shown only for the resources that support it:
Column Type: The data type of the column (supported on Database Columns).
Status: Status of the resource.
To enrich the experience of the users of the lineage information, you can customize the sidebar using custom fields. You must plan a short list of fields to add to the sidebar so that the information stays usable for the customers.Some of the fields that we recommend as usable and relevant are fields that include the following information: Tech Owner, Steward, Query, View Definition SQL, and Calculation Formula. This is just a sample list and will vary based on how your catalog is configured.
Important
You can also show relationships as fields in the sidebar. See this documentation to set it up.
Relationships as field added to Eureka Explorer page:
STEP 1: Define the fields you want to display on Explorer sidebar section
To define the fields you want to display on the Explorer sidebar section:
Locate a resource for which automated lineage metadata is available. On the resource page, move to the Explorer lineage section.
Click the View in fullscreen button to expand the lineage view.
Click on a desired lineage node. In the Sidebar on the lineage page, click the Open in a new page button next to the node name.
On the newly opened resource page, review the fields available for this resource. Decide which additional fields you want to display on the Sidebar.
STEP 2: Display metadata fields on Explorer sidebar section
Note
Perform this task in the Catalog Configuration organization.
To display metadata field on the Explorer sidebar section:
Browse to a metadata field page you want to display on the Explorer sidebar section. For example, we use Number of favorites field.
On the Overview tab, click the Edit button. In the Edit window, go to the Section tab. In the Related resource field, provide Explorer Sidebar Metadata.
Alternatively, on the Relationships tab, click Relate resource. In the Edit relationships window, in the Related resource field, provide Explorer Sidebar Metadata.
Click Save change.
Publish the changes
See: Publishing changes.
View the results 🎉
You can now see the new fields added to the sidebar of the lineage page.
