Release Data

Who is this guide for?

Role: Data Owner, Data Gatekeeper

Goal: You want to review a DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions., make it available, and define who can access its data.

Required Permissions:

• Data Permissions: Read, Update, Release DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.
• Additional Data Permissions: Read and Release Data structureData structureA versioned data-related element that defines the schema and organization of data. It specifies how data is structured and interpreted within the Platform.; Read and Release Data sourceData sourceA data-related element that represents the origin of data. It defines how data is connected, accessed, and ingested into the Platform, such as an external database or sensor network. if dependent Draft entities need to be released
• System Permissions: Read Group, Read Role when managing DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. access

What you will achieve

After completing this guide, you will have:

• Reviewed a DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. and its dependent data-related elementsData-related elementsA collective term for Datasets, Data structures, Data pools and Data sources.
• Released required Data structuresData structureA versioned data-related element that defines the schema and organization of data. It specifies how data is structured and interpreted within the Platform. and Data sourcesData sourceA data-related element that represents the origin of data. It defines how data is connected, accessed, and ingested into the Platform, such as an external database or sensor network.
• Reviewed and optionally configured access
• Optionally enabled Open Data access
• Set the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. to Available

Before you start

• the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. is in status Ready
• its Pipelines and APIs have been configured
• you have permission to release DatasetsDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.

Understand Dataset availability

Setting a DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. to Available releases it for use.

Once the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. is Available:

• its Pipelines can start processing data
• required infrastructure is provisioned
• its configured APIs provide access to the stored data
• access is controlled through the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.'s access configuration
• Open Data can provide unauthenticated access where enabled

Example use case: Integrate Smart Meter energy usage data

In this guide, you review and release the smart meter DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. created in the previous steps. Once the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. is available, its data can be accessed through the API. You can control access through Groups and Roles or make the data publicly accessible by enabling Open Data in the Access area.

Step-by-step guide

Step 1: Review the Dataset and its dependencies

Review the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. before releasing it.

1. Go to DatasetsDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.
2. Open the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.
3. Review:
   • Base Information
   • Pipelines
   • APIs
   • Access
   • dependent Data structuresData structureA versioned data-related element that defines the schema and organization of data. It specifies how data is structured and interpreted within the Platform. and Data sourcesData sourceA data-related element that represents the origin of data. It defines how data is connected, accessed, and ingested into the Platform, such as an external database or sensor network. used by the Pipeline nodes

Optional Step: Manage Access permissions

Access permissions are optional

Permissions can be granted at different levels:

• Platform-wide
• Through permission inheritance from the assigned Data poolData poolA governed, centralized collection of Datasets that are managed together within the Platform. It provides a shared place to organize, discover, and access data, including associated metadata, ownership, and access permissions. With Data pools users can cluster their Datasets according to their organizational structure (e.g., by Departments, Offices). Formerly called Data space.
• Directly on the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.

Configure DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.-specific permissions only when they differ from inherited or platform-wide access.

Required Permissions Update DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. is required to manage DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.-specific access.

Adding a new Group–Role Assignment additionally requires the Read Group and Read Role system permissions. Existing Assignments can be removed with Update DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. without these system permissions.

Access defines who can view and use the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions..

1. Click Edit Groups and Roles in the section Access

Add access

1. Add a Group

2. Assign a Role to the Group

3. Repeat these steps to add more Groups and Roles

Remove access

1. In the table, locate the Group-Role assignment you want to remove
2. Click ⋮ in the Actions column
3. Select Remove Group

→ Removing a Group also removes all associated Role assignments for this DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions..

4. Hit Save and Turn back to the detail view of the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.

Understand access changes

• Access is defined by assigning a Role to a Group within the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.
• Adding or removing assignments directly changes who can access the data
• Access can be granted platform-wide, through the assigned Data poolData poolA governed, centralized collection of Datasets that are managed together within the Platform. It provides a shared place to organize, discover, and access data, including associated metadata, ownership, and access permissions. With Data pools users can cluster their Datasets according to their organizational structure (e.g., by Departments, Offices). Formerly called Data space., or directly on the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.
• DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.-specific assignments override neither inherited nor platform-wide permissions
• Make sure the correct Groups and Roles are assigned before releasing the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.

Optional Step: Enable Open Data access

Open Data allows access to the data of the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. without authentication.

1. Activate Open Data in the section Access

2. Hit Save

Step 2: Release the Dataset and its dependencies

Editing after release

Setting a DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. to Available provisions its Data storagesData storageA Pipeline node that persists data inside the Platform so that it can be provided through an API. The Platform offers the Sensor Data storage, which stores sensor data for the SensorThings API, and the Geospatial Data storage, which stores geospatial data in tables for WFS/WMS APIs. The Data storages used in the Pipelines of a Dataset determine which API types the Dataset can offer. and may restrict later changes.

The DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. can be returned to Draft for further editing. However, Data storagesData storageA Pipeline node that persists data inside the Platform so that it can be provided through an API. The Platform offers the Sensor Data storage, which stores sensor data for the SensorThings API, and the Geospatial Data storage, which stores geospatial data in tables for WFS/WMS APIs. The Data storages used in the Pipelines of a Dataset determine which API types the Dataset can offer. that have already been provisioned remain restricted and cannot be edited or removed individually.

→ Learn more about Status lifecycle and editing

1. Change the status to Available
2. Hit Save and Exit

If no Draft dependencies are detected, the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. can be released.

If Draft dependencies are detected:

1. Open the Pipelines of the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.
2. In the Properties panel, check the status of the Data structuresData structureA versioned data-related element that defines the schema and organization of data. It specifies how data is structured and interpreted within the Platform. and Data sourcesData sourceA data-related element that represents the origin of data. It defines how data is connected, accessed, and ingested into the Platform, such as an external database or sensor network. used by the Pipeline nodes

3. Open the affected Data structuresData structureA versioned data-related element that defines the schema and organization of data. It specifies how data is structured and interpreted within the Platform. or Data sourcesData sourceA data-related element that represents the origin of data. It defines how data is connected, accessed, and ingested into the Platform, such as an external database or sensor network.
4. Set them to Available
5. Return to the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. and change its status to Available again

Once the release is completed, the DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. is Available. Its Pipelines can start processing data and its configured APIs can provide access to the stored data.

Step 3: Locate the API URL

1. Go to Data flow → APIs
2. Locate the API tile
3. Copy the API URL

The API URL can now be used by authorized consumers. If Open Data is enabled, the API can be accessed without authentication.

Outcome

The DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. is Available:

• its Pipelines can process data
• its configured APIs provide access to the stored data
• access is controlled through the configured Groups and Roles
• Open Data provides unauthenticated access if enabled

Next

Your DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions. and its data are now available for use.

In the next guide, you will:

• access an Available DatasetDatasetA data-related element that contains processed data and makes it available for consumption. A Dataset is populated via Pipelines and carries Metadata and access permissions.
• consume its data through an API

→ Continue with Consume Data