Adding Field Comments

When working with big data, it can be very helpful to have access to comprehensive field-level descriptions.

This article includes the following topics:

Add Field Comments in Dataset

The following steps demonstrate how to add description to a column of a dataset, as a 'comment'. We are using the column iso_cc (the ISO-compliant country code) in the dataset World Life Expectancy [data source samples.world_life_expectancy].

  1. On the main navigation bar, click Data.

    Click DATA on main navigation bar

    The Data view appears, open on the Datasets tab.

    Main landing page of DATA
  2. In the left navigation menu, click samples.

  3. In the Datasets area, select World Life Expectancy (samples.world_life_expectancy).

    selecting a dataset
    Selecting Dataset 'World Life Expectancy'

  4. In the Dataset Detail menu, select Fields.

    detail of 'World Life Expectancy'
    Dataset Detail for 'World Life Expectancy'

  5. In the Fields interface, select Edit Field.

    Editing Fields of Dataset 'World Life Expectancy'
    Editing the Fields of Dataset 'World Life Expectancy'

  6. Under Dimensions, find the field iso_cc, and click the (down arrow) icon on the right.

    From the menu, select Edit Fields.

    selecting edit field window
    Editing Field Properties

  7. The Edit Field Parameters window modal appears.

    Under Field Comment, add the following text:

    ISO 3166 Country Code Standard, Numeric, described in http://www.iso.org/iso/country_codes. Mappings are at https://www.iso.org/obp/ui/#search.

    Click Apply.

    adding comment to the field
    Adding Field Comment

  8. Under Dataset: World Life Expectancy, click Save.

  9. Click Show Comments. Notice that the comment appears with the field iso-cc.

    changing display name
    Displaying Field Comments

  10. To hide column comments, click Hide Comments.

View Field Comments in Visual Builder

To view field comments in the Visual Builder, create a new visual using the World Life Expectancy dataset [data source samples.world_life_expectancy]. See Creating Visuals.

Notice that the fields iso-cc and gdp-per-capita display a gray triangle on the top right corner of the field. Hover over the triangle to view the field comments defined in the dataset.

Viewing field comments in Visual Builder
Displaying Field Comments in Visual Builder