Custom Properties

Custom Properties is currently in Private Preview, and is available only to participant of the private preview. To participate in the Custom Properties private preivew, contact customer support.

Custom properties are special fields created using common model properties through EQL (Euno Query Language) statements. These properties can be defined in the following ways:

  • Boolean Property: A property with a true/false value.

  • Text Property: A property that assigns specific text values based on an EQL statement.

  • Relationship Aggregation: A property that aggregates values by:

    • SUM

    • COUNT

    • MIN

    • MAX

Custom properties are particularly useful for categorizing data based on specific conditions and can be used as filters or added as columns in the data model view.

Note: Currently custom properties of type relation aggregation cannot be used as a filter.

Text Property

A Text Property allows users to assign a specific string to an EQL statement, enabling them to create custom buckets based on the conditions defined in the statement.

Example – Usage

One common custom property is Usage, which categorizes data based on query and user activity over the past 60 days. This property groups resources into four categories:

  • High: Resources with 60 or more impressions, or more than 25 distinct users in the last 60 days.

  • Medium: Resources with at least 10 but fewer than 60 impressions, or more than 10 but fewer than 25 distinct users in the last 60 days.

  • Low: Resources with fewer than 10 impressions, but more than 1, or fewer than 10 distinct users, but more than 1 in the last 60 days.

  • Not Used: Resources with either 0 impressions or 0 distinct users in the last 60 days.

name: usage

description: Buckets resources based number of impression, and distinct users over the past 60 days.

high: total_impressions_60d >= 60 or distinct_impressions_users_60d >= 25

medium: (total_impressions_60d >= 10 and total_impressions_60d < 60) or (distinct_impressions_users_60d >= 10 and distinct_impressions_users_60d < 25)

low: (total_impressions_60d < 10 and total_impressions_60d > 1) or (distinct_impressions_users_60d < 10 and distinct_impressions_users_60d > 1)

not used: total_impressions_60d < 1 or distinct_impressions_users_60d < 1  

Boolean Property

A Boolean Property allows users to tag resources as true or false based on a specific EQL statement. If the condition is met, the property is marked as true; otherwise, it defaults to false. For cases where a null value is required, a Text Custom Property should be used instead.

Example – Active Usage

This boolean custom property indicates whether a resource has been actively used:

A resource is considered active if it has more than one impression in the last 60 days.

name: active_usage

description: A resource is considered active if it has more than one impression in the last 60 days.

true: total_impressions_60d > 0

This property returns true if the item has any queries in the last 60 days, otherwise false.

Relationship Aggregation Property

A Relationship Aggregation Property allows users to count or sum relationships that a resource has. This property can be customized by specifying the path_length (how close the relationship is), which is optional. If left blank, it considers all relationships. Additionally, a target_property can be defined to further refine the aggregation.

Example – Number of data sources in workbook

This custom property counts the number of data sources within a Tableau workbook.

name: number_of_datasources_in_workbook

description: This custom property counts the number of data sources within a Tableau workbook.

applies_to: type="tableau_workbook"
# Defines the EQL statement specifying which resources this custom property applies to.

type_of_relationship: child
# Specifies the type of relationship between the resource defined in applies_to and the target_eql. Options include: child, parent, upstream, or downstream.

path_length:
# Optional. If left blank, all relationship lengths will be considered.For children and parents, the length doesn't apply.

target_eql: type="tableau_embedded_datasource"
# Defines the target EQL statement for the relationship.

aggregation: count
# Specifies the aggregation type. Options are count, sum min or max.

target_property:
# Optional. Allows the specification of a target property for aggregation.

Last updated