Add component descriptions

Descriptions help users know how to best use the various components when building projects in Analysis Workspace or when viewing reports.

Analytics administrators can add descriptions for components (dimensions, metrics, segments, and date ranges) either within a report suite or using the Data Dictionary directly within Analysis Workspace.

Report suite

You can add descriptions to components in a report suite.

  1. Select Admin > All admin > Report suites.
  2. Select the report suite in the Report Suite Manager for which you want to provide component descriptions.
  3. Select Edit Settings > Conversion > Conversion variables.
  4. Select Add to show details for a conversion variable.
  5. Select the checkbox for Description and add a description.
  6. Repeat step 4 and 5 for any other variable you want to add a description.
  7. Select Save.

See VideoCheckedOut Add component descriptions for a demo video.

Data Dictionary add-descriptions

The Data Dictionary in Analysis Workspace helps both users and administrators keep track of and better understand the components in their Analytics environment. The Data Dictionary allows Analytics administrators to add component descriptions directly within Analysis Workspace.

For information about editing a component description in the data dictionary, see Edit component entries in the Data Dictionary.

For general information about the Data Dictionary, see Data Dictionary overview.

Automatically generate descriptions

AVAILABILITY
The functionality described in this section is in the Limited Testing phase of release and might not be available yet in your environment. This note will be removed when the functionality is generally available. For information about the Analytics release process, see Adobe Analytics feature releases.

Instead of writing each description manually, Adobe Analytics can use generative AI to write descriptions for you. You can generate a description for a single component or generate descriptions for many components at the same time.

Generated descriptions:

  • Are no more than 3 sentences long.
  • End with the text Generated by Adobe using AI, so users know the description was generated.
  • Can be edited after they’re generated.

Prerequisites

Before you can generate descriptions, your organization must agree to certain generative AI legal terms. If your organization hasn’t agreed to these terms, the option to generate descriptions is dimmed. Select the information icon Info next to the option to learn how to enable the feature, or contact your organization’s administrator or Adobe account team.

How descriptions are generated

Generated descriptions are based on the component’s definition and on additional context about how the component is used in your report suite, such as:

  • The top items of a dimension
  • Components that are frequently used with the component

When a calculated metric or segment references another segment, the generated description explains the definition of the referenced segment.

Generate descriptions from various locations

You can generate descriptions in the following areas of Adobe Analytics. Some locations allow you to generate descriptions for multiple components while others do not.

Select a location to learn how to generate descriptions there.

Location
Supported components
Single component
Multiple components
Data Dictionary
  • Dimensions
  • Metrics
  • Calculated metrics
  • Segments
  • Date ranges
Yes
Yes
Segment Builder
Segments
Yes
No
Segments manager
Segments
No
Yes
Calculated metric builder
Calculated metrics
Yes
No
Calculated metrics manager
Calculated metrics
No
Yes
Date range builder
Date ranges
Yes
No
Date ranges manager
Date ranges
No
Yes
recommendation-more-help
analytics-help-analyze