Manage data products

Preview

This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA products and features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

This document is intended for data product owners who want to update, delete, and grant access to data products in Dataplex Universal Catalog.

For more information about the architecture and key concepts of data products, see About data products.

Before you begin

1. Enable the Dataplex, BigQuery APIs.

   Roles required to enable APIs

   To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

   Enable the APIs

Note: This guide assumes you have existing data products to manage. For more information about creating and configuring data products, see Create data products.

Required roles

To get the permissions that you need to manage data products, ask your administrator to grant you the following IAM roles on the project:

• Full permissions to create, update, delete, and manage permissions for data products: Dataplex Data Products Admin (roles/dataplex.dataProductAdmin)
• Update and manage existing data products: Dataplex Data Products Editor (roles/dataplex.dataProductEditor)
• Add aspects such as schema, overview, and contacts: Dataplex Entry and EntryLink Owner (roles/dataplex.entryOwner)
• Search for and add assets: Dataplex Catalog Viewer (roles/dataplex.catalogViewer)
• Edit system aspect types such as documentation and contract aspect of refresh cadence: Dataplex Catalog Editor (roles/dataplex.catalogEditor)

For more information about granting roles, see Manage access to projects, folders, and organizations.

These predefined roles contain the permissions required to manage data products. To see the exact permissions that are required, expand the Required permissions section:

Required permissions

The following permissions are required to manage data products:

• Edit the overview system aspect type: dataplex.entryGroups.useOverviewAspect
• Edit the refresh cadence system aspect type: dataplex.entryGroups.useRefreshCadenceAspect

You might also be able to get these permissions with custom roles or other predefined roles.

Grant access to a data product

Data product owners must make their products discoverable and grant necessary roles, allowing consumers to search for, view, and request access to data products.

To grant data product consumers the permissions they need to interact with the data product, grant them the following IAM roles on the data product resource:

• Search for data products and access them in Dataplex Universal Catalog search: Dataplex Data Product Consumer (dataplex.dataProductsConsumer)
• Read-only access to view data product definitions and metadata: Dataplex Data Product Viewer (dataplex.dataProductViewer)
• Request access to data products: Dataplex Data Product Consumer (dataplex.dataProductsConsumer)

When a data product consumer requests access to a data product, the data product owner receives an email notification.

To grant access, follow these steps:

1. In the Google Cloud console, go to the Groups page.

   Go to the Groups page

2. Search for the group associated with the requested permission level and select it.

3. Click  Add members.

4. Add the principal.

5. Click Save.

For more information, see Create and manage Google groups in the Google Cloud console.

Update a data product

You can update the basic details (for example, data product name, description, owner details), assets, access groups, permissions, contract, aspects, and additional documentation for an existing data product.

Update the basic details of a data product

1. In the Google Cloud console, go to the Dataplex Universal Catalog Data products page.

   Go to Data products

2. Click the data product that you want to update.

3. Click Edit data product.

4. Update the Data product name, Icon, Description, Owner contacts, and Labels as required.

5. Click Update data product.

Update assets of a data product

1. In the Google Cloud console, go to the Dataplex Universal Catalog Data products page.

   Go to Data products

2. Click the data product for which you want to update assets.

3. Click the Assets tab.

4. To add a new asset, follow these steps:

   1. Click +Add.

   2. Search for and select the assets that you want to add to your data product. The assets you select must reside in the same region as the data product.

      If you have necessary permissions, you can view the metadata of assets by clicking the asset.

   3. To refine the search results, use Filters.

   4. After you select the assets, click Add.

5. To remove an asset from the data product, follow these steps:

   1. For the asset that you want to remove, click > Remove.

   2. To confirm the action, click Remove.

Update access groups and permissions

1. In the Google Cloud console, go to the Dataplex Universal Catalog Data products page.

   Go to Data products

2. Click the data product for which you want to update the access groups and permissions.

3. Click the Access groups & permissions tab.

4. To update an access group, follow these steps:

   1. Click Edit.

   2. Update the access group name, description, and identifier as required.

   3. To add a new access group, click Add access group and follow these steps:

      1. In the Access group name field, enter a name for the new access group. For example, Analyst.

      2. In the Access group description field, enter a description for the access group.

      3. In the Access group identifier field, enter the email address of a Google group that you want to assign to this access group. Data product consumers who request access to this access group can be added as members to the mapped Google group.

         You can add a maximum of three access groups per data product.

   4. Click Add.

5. To remove an access group, follow these steps:

   1. For the access group that you want to remove, click > Remove.

   2. To confirm the action, click Remove.

6. If no access groups are configured for the selected data product, you can add a new access group by clicking Add access group.

7. To update asset permissions, follow these steps:

   1. For the asset you want to update permissions, click > Permissions.

   2. Update the required access groups and IAM roles.

   3. Click Configure.

Update the data product contract

Note: The refresh cadence isn't editable after you add it to the contract. If you try to modify this value, the following error is displayed: You don't have permission to change contract values.

1. In the Google Cloud console, go to the Dataplex Universal Catalog Data products page.

   Go to Data products

2. Click the data product for which you want to update the contract.

3. Click the Contract tab.

4. To update the existing contract, follow these steps:

   1. Click .

   2. Update the necessary fields.

   3. Click Save.

5. If no contract is attached to the selected data product, you can add one by clicking Add contract.

Update aspects of a data product

1. In the Google Cloud console, go to the Dataplex Universal Catalog Data products page.

   Go to Data products

2. Click the data product for which you want to update the aspects.

3. Click the Aspects tab.

4. To update an aspect, follow these steps:

   1. Click the aspect you want to update.

   2. Click Edit.

   3. Update the Aspect type, Country, and Region as required.

   4. Click Save.

5. To add a new aspect for the data product, follow these steps:

   1. Click + Add aspect.

   2. In the Select aspect type field, search for and select an aspect type from the list. For example, Geo context.

      1. In the Country field, select the country to which the asset belongs.

      2. In the Region field, select the business region to which the asset belongs.

      3. Click Save.

6. To delete an aspect, follow these steps:

   1. Click the aspect you want to delete.

   2. Click .

   3. To confirm the action, click Confirm.

Update the data product documentation

1. In the Google Cloud console, go to the Dataplex Universal Catalog Data products page.

   Go to Data products

2. Click the data product for which you want to update the documentation.

3. Click the Overview tab.

4. Click Edit against Documentation.

5. Update user guide, sample queries, and other documentation as required.

6. Click Save.

Delete a data product

Before you delete a data product, you must remove all the assets from the data product. To do this, complete the following steps:

1. In the Google Cloud console, go to the Dataplex Universal Catalog Data products page.

   Go to Data products

2. Click the data product that you want to delete.

3. Click the Assets tab.

4. For every asset listed, click > Remove. Confirm the action by clicking Remove.

5. After you remove all the assets, delete the data product by clicking Delete.

6. In the confirmation dialog, enter delete and click Delete.

What's next

• Learn how to search for data products.
• Learn how to request access for data products.