Skip to main content
Gainsight Inc.

Fields and Derived Fields in Object

This article walks you through the options available on the All fields in Object tab and also explains how to configure derived fields in the Adoption Explorer objects.

Overview

This article is the fourth item in a series of Adoption Explorer configuration articles. Gainsight recommends you to refer the initial articles of the series and then start with this article.

This article walks you through the options available on the All fields in Object tab and also explains about how to configure derived fields in the Adoption Explorer objects. Before you configure derived fields, configure a source connection and add the required fields to the Adoption Explorer objects. To configure objects, refer to the Configure Adoption Explorer Objects article.

Fields in Object

Once a source connection is configured and saved, navigate to the All fields in Object tab to view the list of fields ingested. Adoption Explorer has four types of fields:

  • Dimension: This field cannot be aggregated.
  • Measure: This field can be measured, aggregated, or used for mathematical operations
  • Derived Dimension: It is the custom dimension created in an object, using the ingested dimension field.
  • Derived Measure: It is the custom measure created in an object, using the ingested measure field.

The following are the components on the All fields in Object tab:

All fields in Object tab.png

  1. Object Name: The name of the Adoption Explorer object you have selected.
  2. Default Filters: Name, Type, Data Type, Created By, Modified By and Modified At are the default filters available, and you can add additional filters from the Additional Columns dropdown. You can directly type-in the keyword in the search bar or apply a filter on each column, can sort and rearrange each column as required.
    1. Name: You can filter the fields based on the name of the field. When you start typing any set of keywords in the search bar, you will see the filtered results, if the keyword matches with the field name.
    2. Type: You can filter the fields based on the field type.
    3. Data Type: You can filter the fields based on the data type of the field such as All, String, Number, Boolean, Date and Datetime.
    4. Created By: is the display name of the Admin who has created that particular field.
    5. Modified By: is the display name of the Admin who has created that particular field.
    6. Modified At: is the date and time on which the field has been last modified.
    7. Actions: Click the Context Menu icon to view the list of actions. The list of actions available are:
      • Edit: Select the Edit option to edit a derived field. For more information about Derived Fields, refer to the Configure Derived Fields section. 
        Note: You cannot edit the fields ingested from source data.
      • Delete: Select the Delete (trash) icon to delete a field.   
      • Clone: Select the Clone option to clone an existing derived field and can change the function list, based on your business requirements.
      • Lookup: Select this option for a Dimension field to create lookups from the ingested fields in the Adoption Explorer project to the fields on the Gainsight standard/low volume custom/system objects. For more information, refer to the Create Lookup for Fields section.
  3. Additional Columns: Click the Additional Columns dropdown list to select additional filters as mentioned below.

    1. Source Name: You can filter the fields based on the source name of the field. When you start typing any set of keywords in the search bar, you will see the filtered results, if the keyword matches with the source name.
    2. Source Data Type: You can filter the fields based on the Source Data Type of the fields such as All, String, Number, Boolean, Date and Datetime.
    3. Source Display Name: filters the fields based on the Source Display Name of the fields. Source Display Name is the display name of the fields ingested from Source.   
    4. Source Type: You can filter the source types with the available sources such as S3, MDA, SFDC and GA. For derived fields, the source type would be the object from which it has been derived for ex- Usage Info/Time Series.
    5. Created At: is the date and time on which the field has been created.

Note: Additional Columns are not state preserved, once you navigate to other tab, you will lose the selection.

  1. Show fields from Sources: Switching ON the Show fields from Sources toggle button displays all the ingested fields along with the Derived fields. If you switch OFF the toggle button, the derived fields are displayed.
  2. Derived Fields: Click + Derived Field to create a new derived field, using the ingested measures and dimensions. For information on how to create a derived field, refer to the Configure Derived Fields section.
  3. Pagination Tool: If you have configured too many fields, using the pagination tool, you can navigate through different pages and view multiple records, in a set of 20 records on a single page.

Create Lookup for Fields

Once the lookup is set up, you can use the Lookup fields from Gainsight standard/low volume custom/system objects, in the Filter conditions and Usage Reports.

Limitations

  • Maximum of five lookup fields can be selected in a usage report.
  • Only one level of lookup is allowed.

Example Business Use Case: Admin wants to create a report on an Adoption Explorer project that includes the Feature Name and Feature ID fields. But, the Feature ID field is available in the Adoption Explorer project and the Feature Name field is available in Gainsight’s custom object. To achieve this business use case, Lookup in Adoption Explorer project helps create a lookup from Adoption Explorer project to Gainsight’s custom/standard object. With this configuration, while building reports on this project, you can now see the Feature Name field in the custom lookup object.

This creates a lookup between the Adoption Explorer project and selected Gainsight object. While building reports on this Adoption Explorer project, you can see the fields in the custom lookup object as well.

To create a lookup:

  1. Click Lookup on the required field. The Create Lookup dialog appears.
  2. From the Choose Object Type dropdown list, select the required object type.
  3. From the Choose Object dropdown list, select the required object.
  4. From the Choose Field dropdown list, select the required field.
  5. Click Save.

Configure Derived Fields

Derived Fields are the custom measures and dimensions created in an object, using the ingested measures and dimensions. For example, if you have a Page Views field, you can derive the Sum of Page Views by applying Aggregate > Sum function.

Once the Adoption Explorer objects are configured and saved, you are now allowed to create derived fields from the Fields tab. You can add/edit/delete a field in both Active and Inactive status of a project.

To configure Derived Fields:

  1. Navigate to Administration > Adoption Explorer.
  2. Click on the project name.
  3. From the Objects in Project section, click on the Object.
  4. Click on the All fields in Object tab.
  5. Click Add Derived Field.
  6. Enter the Field Name as required.
  7. From the Source dropdown list, select the required source. 
  8. From the Function Type dropdown list, select the required function type. Click ⅀ Fn (Sigma Function) on the top right corner to learn more about the functions. For information about Functions in Adoption Explorer, refer to the Adoption Explorer Functions article.

Note: Function type is an important part of creating a derived field. It is recommended to go through the help text of the functions if you are not aware of what a function does.

Use cases:

  • Segment a customer - Segment (ARR), Segment (TotalPageViews)
  • Last time a user logged into your product - Max (LoginDate) by User
  • Number of days a User has been active in X days - COUNT(Distinct Date) in the Last X days by User
  • Number of Pages viewed by a user - Sum of PageViews by a user in Last X days
  • When a customer is using a feature not purchased - Sum of PageViews by PageTitle or feature by Date
  • Alert when customers usage of a feature increases dramatically - WindowsGrowth(PageViews) week over week. 
  1. From the Function List dropdown list, select the required function. Function list is grouped based on the function type. All the functions associated to the function type are displayed after you select the type.
  2. Function Definition:
    1. Select the required field from the Field dropdown list, on which you want to apply the function.
      Note: dropdown list contain all the fields which are eligible for that particular function. For example, if you select the function type as Aggregate, you will only see the Number data type fields.
    2. Decimal Points: Enter the number of decimal places (digits) you want to assign after the decimal point.
      Note: Decimal points are available only if the resultant data type is number. You need to specify up to what decimal point you want your data to be extracted and saved.
  1. Filter Rule: You can apply your own logic, for filtering the records, based on your business needs. To apply filters:
    1. Select the required Filter Rule, either AND (or) OR.
    2. Click to add a filter. You can add multiple filters in a single filter rule, by clicking +.
    3. Select the required field from the dropdown list, on which you want to apply the criteria.
    4. Select the required operator from the dropdown list, which meets your criteria /(business needs).
    5. Enter the required value of the field that meets your criteria (business needs).

You can also add multiple sub filter rules/Nested filter conditions under the filter rule. The data filtering after applying the sub filter rule starts from the lowest level filter.

To add a sub filter rule within a filter rule:

  1. Click the Rounded-Plus button.
  2. Select the sub filter rule, either AND (or) OR.
  3. Select the required field from the dropdown list, on which you want to apply the criteria.
  4. Select the required operator from the dropdown list, which meets your criteria /(business needs).
  5. Enter the required value of the field that meets your criteria (business needs).

Use Case: For example, in the above expression, the filters applied on the Page Views field are:

OR Filters:

  1. Filter Condition 1: “time on page = 180 sec”   
  2. Filter Condition 2: “LAST N DAYS (includes current run date) = 30”

AND Filters:

  1. Filter Condition 1: “page title = ”Account Widget - RelatedList - Cases”
  2. Filter Condition 2: “exit rate > 40”

This means, the data filtering first happens using the AND filters (starts from lowest level filter), and if both the AND filter conditions are satisfied, then the OR filter conditions are applied on the resultant data.

Note: You can also set filter rules on Date Functions while creating derived fields. Date Functions help you aggregate the measures from a specific time period, like Current Month, Current Quarter, Current Year, etc. You can apply Date Functions on Time Series Objects only. 

  1. Select the Enable Leaderboard checkbox, if required. Selecting the Enable Leaderboard checkbox will create a derived field in Weekly Time Series object, and this action allows you to create a leaderboard usage report from the Dashboard Configuration page.
    Notes:

  • You will see Enable Leaderboard option only in the Time Series objects.
  • Leaderboard can be enabled only on Measures/Derived Measures.

Notes:

  • You can select the Disable Field checkbox, if you want to stop further calculation on the selected field.
  • Select the RollUp to weekly checkbox, to aggregate the data on this field, on a weekly basis also. Selecting the RollUp to weekly checkbox from Daily Time Series object creates a derived field in the Weekly Time Series object. You can also select the function type of your choice from the Aggregation Function dropdown list, while rolling up weekly data.

DerivedField_RollUp to weekly.png

  1. Select the Associate Entitlement checkbox, if required. Selecting the Associate Entitlement checkbox creates a derived field in the same object, and this action allows you to create a usage section from the Layouts screen.

Note: Leaderboard fields are always calculated on Weekly basis, whereas Entitlement depends on the source field configuration, either Daily/Weekly.

DerivedField_Associate Entitlement.png

  1. Group By:
    1. For Company Information and Time Series Objects: By default, the checkbox for Group By with Company is enabled. You can also select the Instance checkbox to group the records by both Company and Instance.

Group By_Company.png

  1. For Person Information and Time Series Objects: By default, the checkbox for Group By with Company and Person are enabled. You can also select the Instance checkbox to group the records by Company, Person and Instance.

Group By_Person.png

  1. Click Save.

Once a derived field is created, you can navigate to the Dashboard Configuration page and can create a usage report using the derived field (measure or dimension). For information on how to create a usage report, refer to the Configure Layouts article.

  • Was this article helpful?