Manage data usage labels in the UI

Last update: 2023-06-05
  • Created for:
  • User
    Developer
    Admin

This user guide covers steps for working with data usage labels within the Experience Platform user interface.

Manage labels

To apply labels to your data, you need the Manage Usage Labels permission for use on the default production sandbox called “prod”. To create a custom label, you must also have administrative rights on the product profile. Each organization only has one list of applicable labels, and currently, deleting labels is not supported.

See the guide on how to configure permissions or the access control overview for more information on how to assign a permission. If you do not have access to the Admin Console for your organization, please contact your organization admin.

Manage labels at the schema level

You can add labels directly to a schema or fields within that schema. Any fields applied at the schema level will propagate to all datasets based on that schema.

In order to manage data usage labels at the schema level, you must select an existing schema or create a new one. After logging into Adobe Experience Platform, select Schemas on the left-navigation to open the Schemas workspace. This page lists all created schemas belonging to your organization, along with useful details related to each schema.

The Adobe Experience Platform UI with the Schema tab highlighted.

The next section provides steps for creating a new schema to apply labels to. If you wish to edit labels for an existing schema, select the schema from the list and skip ahead to adding data usage labels to the schema.

Create a new schema

To create a new schema, select Create schema in the top-right corner of the Schemas workspace. See the guide on how to create a schema using the Schema Editor for complete instructions. Alternatively, you can create a schema using the Schema Registry API if required.

Add data usage labels to a schema

After creating a new schema, or selecting an existing schema from the list in the Browse tab of the Schemas workspace, select a field from your schema in the Schema Editor. In the Field properties sidebar, select Apply Access and Data Governance Labels.

The Schemas workspace Structure tab displaying the visualization of your schema with Apply Access and Data Governance Labels highlighted.

A dialog appears that allows you to apply and manage data usage labels at the schema level and field level. See the XDM tutorial for complete instructions on how to add or edit data usage labels for XDM schemas.

Add data usage labels to a specific dataset

IMPORTANT

Labels can no longer be applied to fields at the dataset level. This workflow has been deprecated in favour of applying labels at the schema level. Any labels previously applied at the dataset object level will still be supported through the Platform UI until 31st May 2024. To ensure that your labels are consistent across all schemas, any labels previously attached to fields at the dataset level must be migrated to the schema level by you over the coming year. See the documentation for instructions on how to migrate previously applied labels from the dataset to the schema level.

Labels can be applied to the entire dataset from the Data Governance tab of the Datasets workspace. The workspace allows you to manage data usage labels at the dataset level.

The Data Governance tab of the Datasets workspace with Data Governance highlighted.

To edit data usage labels at the dataset level, start by selecting the pencil icon (A pencil icon.) in the row of the dataset name.

The Data Governance tab of the Datasets workspace with the edit pencil icon highlighted.

The Edit Governance Labels dialog opens. Within the dialog, check the boxes next to the labels you wish to apply to the dataset. Remember that these labels will be inherited by all fields within the dataset. The Applied Labels header updates as you check each box, showing the labels you have chosen. Once you have selected the desired labels, select Save Changes.

The Edit Governance Labels dialog with label checkboxes and Save changes highlighted.

The Data Governance workspace reappears, showing the labels that you have applied at the dataset level in the initial row of the table. You can also see the labels, indicated by individual cards, that are inherited down to each of the fields within the dataset.

The Data Governance tab of the Datasets workspace with applied dataset level labels and inherited dataset filed labels highlighted.

Remove labels from a dataset

Labels added at the dataset level have an “x” next to their card. This allows you to remove the labels from the entire dataset. Inherited labels beside each field do not have an “x” next to them and appear “greyed out”. These inherited labels are read-only, meaning they cannot be removed or edited at the field level.

The Show Inherited Labels toggle is on by default, which allows you to see any labels inherited down from the schema to its fields. Switching the toggle off hides any inherited labels within the dataset.

The Data Governance tab of the Datasets workspace with the Show inherited labels toggle highlighted.

NOTE

Labels that were applied before the dataset labelling feature was deprecated can be removed from the dataset by finding the relevant dataset and selecting the cancel icon on the label.
The Data Governance tab of the Datasets workspace with a deletable label highlighted.
See the documentation for instructions on how to migrate previously applied labels from the dataset to the schema level.

Manage custom labels

You can create your own custom usage labels within the Policies workspace in the Experience Platform UI. Select Policies in the left-navigation, then select Labels to view a list of existing labels. From here, select Create label.

The Policies workspace with create policy highlighted.

The Create label dialog appears. From here, provide the following information for the new label:

  • Name: A unique identifier for the label. This value is used for lookup purposes and should therefore be short and concise.
  • Friendly name: A friendly display name for the label.
  • Description: (Optional) A description for the label to provide further context.

When finished, select Create.

The Policies workspace Create label dialog with Create highlighted.

The dialog closes, and the newly created custom label appears in the list under the Labels tab.

The Labels tab of the Policies workspace with the new custom label highlighted.

The label can now be selected under Custom Labels when editing usage labels for datasets and fields, or when creating data usage policies.

The Apply Access and Data Governance Labels dialog with the custom labels highlighted.

Next steps

Now that you have added data usage labels at the dataset and field level, you can begin to ingest data into Experience Platform. To learn more, start by reading the data ingestion documentation.

You can also now define data usage policies based on the labels you have applied. For more information, see the data usage policies overview.

On this page