# Getting started with data packages

Adding a data package to your OS Select+Build recipe allows you to select the area, format, and update frequency to receive for your data.&#x20;

The following sub-sections on this page cover:

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Creating data packages</strong></td><td><a href="#how-do-i-create-a-new-data-package">#how-do-i-create-a-new-data-package</a></td></tr><tr><td><strong>Finding and downloading existing data packages</strong></td><td><a href="#how-do-i-find-and-download-an-existing-data-package">#how-do-i-find-and-download-an-existing-data-package</a></td></tr><tr><td><strong>Deleting data packages</strong></td><td><a href="#how-do-i-delete-a-data-package">#how-do-i-delete-a-data-package</a></td></tr><tr><td><strong>Viewing Order Summary files</strong></td><td><a href="#what-is-the-order-summary-file">#what-is-the-order-summary-file</a></td></tr></tbody></table>

## :arrows\_clockwise: How do I create a new data package?

Once you've created a recipe, you'll then need to create a data package against it to receive your OS NGD data.&#x20;

{% embed url="<https://youtu.be/9IQzzDB2uO4?t=439>" %}
YouTube video showing how to create a recipe using OS Select+Build, add filters to the recipe, then create a data package to receive your OS NGD data. (Creating data packages is discussed around seven minutes into the video.)
{% endembed %}

To create a new OS NGD data package:

{% stepper %}
{% step %}

#### Log into your [OS Data Hub](https://osdatahub.os.uk/) account

Click *Login* on the OS Data Hub menu bar to log into your account.

<figure><img src="https://170091638-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0pZjHxkAvY7Mn6TqFBMD%2Fuploads%2F1Gd3vBvSOqXLYTPpZsO9%2Fimage.png?alt=media&#x26;token=afd47dd4-6005-4d33-a8ef-ec6540a138fb" alt="A screenshot of the OS Data Hub home page showing the sign up and log in buttons in the top right hand corner" width="563"><figcaption><p>Screenshot showing the OS Data Hub homepage.</p></figcaption></figure>
{% endstep %}

{% step %}

#### Navigate to the OS Data Hub workspace

Select *Data* from the menu bar to view your workspace.
{% endstep %}

{% step %}

#### Navigate to the OS *Select+Build Recipe Library*

Choose *Downloads* > *OS Select+Build Recipe Library* from the left hand side secondary navigation menu. You will then be taken to your organisation's OS Select+Build Recipe Library.

<figure><img src="https://170091638-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0pZjHxkAvY7Mn6TqFBMD%2Fuploads%2FamiHxVEA8ivdYWmhdcR0%2FScreenshot%20Recipe%20Library.png?alt=media&#x26;token=1bd9e5df-cb7d-45c5-8f08-3c1ab13b25f1" alt="Screenshot of the OS Data Hub, showing the OS Select+Build Recipe Library screen."><figcaption><p>Screenshot of the OS Select+Build Recipe Library screen in the OS Data Hub.</p></figcaption></figure>
{% endstep %}

{% step %}

#### Find the recipe you plan to add a data package against

In your OS NGD Select+Build Recipe Library, scroll or search for the recipe you wish to create a data package against, select that recipe, then click the *Add data package* button.
{% endstep %}

{% step %}

#### Add details to the data package

Add the following details to your data package under *Add a data package* in the secondary navigation menu:

* Give your data package a name.
* Choose the area you want to receive your data for: Either 'All of Britain or Predefined Area' (this means you receive data and it will not be refined by location) or 'Draw a polygon / upload a file / use an OS polygon' (to select a smaller area for your data to be provided for).
* Select the desired [coordinate reference system](https://docs.os.uk/osngd/getting-started/os-ngd-fundamentals/coordinate-reference-systems).
* Select a file format: [CSV](https://docs.os.uk/osngd/os-ngd-fundamentals/file-formats-and-naming#csv-overview) or [GeoPackage](https://docs.os.uk/osngd/os-ngd-fundamentals/file-formats-and-naming#geopackage-overview).
* Select the updates you want: Either not required or [COU](https://docs.os.uk/osngd/getting-started/os-ngd-fundamentals/cou-supplies) (Change-Only Update) frequency. There is also an option to select a one-off snapshot of a current or past date.
* Set your initial supply date.
  {% endstep %}

{% step %}

#### Finish creating the data package

Click the *Create data package* button.&#x20;

<figure><img src="https://170091638-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0pZjHxkAvY7Mn6TqFBMD%2Fuploads%2Ft2fL7lfmxkIycgc9TeBT%2FScreenshot%20Create%20data%20package.png?alt=media&#x26;token=4caad2a6-87b5-423b-a3af-53fb9f40927f" alt="Screenshot of the Add a data package screen in the OS Data Hub, showing an example of adding a data package to a recipe."><figcaption><p>Screenshot showing an example of adding a data package to a recipe using OS Select+Build in the OS Data Hub.</p></figcaption></figure>

{% hint style="success" %}
You will receive an email confirming that your data package is being created and another one when your new data package is ready to download.
{% endhint %}
{% endstep %}
{% endstepper %}

{% hint style="info" %}
Please note:

* When you order data through OS Select+Build, the data package/s you receive will be provided at a feature type level. Each feature type you order will be available to download as a .zip file. Currently, grouped files are not available for OS NGD data packages.
* Single or multiple data packages can be created from a single defined recipe. Creating multiple data packages from a single recipe is useful if you want to select a different file format or area of interest for a recipe.
* The Annual Full Supply order frequency option will not be available for a data package containing one (or more) of the new feature types or new data schema versions of existing feature types released in March and / or September of the current year. If you select an Annual Full Supply frequency for your OS NGD data order in OS Select+Build, we will provide you with the data as it was on 01 January of the current year. This means if a new feature type or a new data schema version of an existing feature type was released after 01 January and you order either of these as part of your Annual Full Supply, you will receive an empty data package for the newly released feature type / new data schema version of an existing feature type. The data for the new feature type / new data schema version of an existing feature type will then be included in your supply on the next 01 January after the release, after which point, data packages containing one of these feature types will no longer contain blank files.
  {% endhint %}

## How do I find and download an existing data package?

All OS NGD, OS OpenData and OS Premium data packages created and ordered by your organisation will be catalogued in your Data Packages list in the OS Data Hub.

To find and download an existing data package:

{% stepper %}
{% step %}

#### Log into your [OS Data Hub](https://osdatahub.os.uk/) account

Click *Login* on the OS Data Hub menu bar to log into your account.

<figure><img src="https://170091638-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0pZjHxkAvY7Mn6TqFBMD%2Fuploads%2F1Gd3vBvSOqXLYTPpZsO9%2Fimage.png?alt=media&#x26;token=afd47dd4-6005-4d33-a8ef-ec6540a138fb" alt="A screenshot of the OS Data Hub home page showing the sign up and log in buttons in the top right hand corner" width="563"><figcaption><p>Screenshot showing the OS Data Hub homepage.</p></figcaption></figure>
{% endstep %}

{% step %}

#### Navigate to the OS Data Hub workspace

Select *Data* from the menu bar to view your workspace.
{% endstep %}

{% step %}

#### Navigate to Data packages

Choose *Downloads* > *Data packages* from the secondary navigation menu. You will then be taken to your data package list.
{% endstep %}

{% step %}

#### Find the data package you're looking for

Scroll through the list to find a particular data package or use the search bar to search by data package name, data package number, or product name.

<figure><img src="https://170091638-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0pZjHxkAvY7Mn6TqFBMD%2Fuploads%2FbMVYGWBpA7DSODsmgyOF%2FScreenshot%20Data%20Package%20list.png?alt=media&#x26;token=446ab28f-6e9b-4eb4-b16d-1d3831d02c94" alt="Screenshot of OS Data Hub, showing an example of the Data packages list screen."><figcaption><p>Screenshot showing an example of the Data packages list screen in the OS Data Hub.</p></figcaption></figure>

{% hint style="info" %}

#### Data packages linked to an OS NGD recipe

Data packages linked to an OS NGD recipe can be identified by their prefix of 'OS NGD Recipe' against the recipe name in the Product column in the Data packages list.
{% endhint %}

<figure><img src="https://170091638-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0pZjHxkAvY7Mn6TqFBMD%2Fuploads%2F50dIKjprHvWirMNW1Bpt%2FScreenshot%20Create%20data%20package%20OS%20NGD%20Recipe%20prefix.png?alt=media&#x26;token=2c73e51c-6f5b-47b6-a07c-a7c81596c7cc" alt="Screenshot showing an example of the OS NGD Recipe prefix on a recipe name. The OS NGD Recipe prefix on the recipe name is highlighted in yellow."><figcaption><p>Screenshot showing an example of the 'OS NGD Recipe' prefix.</p></figcaption></figure>
{% endstep %}

{% step %}

#### Download the desired data package

* Once you have found the data package you want from the list, click the *Download* button in the Status column.
* You are now within the Data package summary screen, where you can view and download files. Under 'Individual file downloads' in the bottom left-hand side of your screen, you will see a .zip file for every feature type in your data package order. *Click* on a file to download it.
  {% endstep %}
  {% endstepper %}

## What is the Order Summary file?

Feature types downloaded via OS Select+Build will be supplied with an Order Summary File, a small JSON manifest that provides key metadata about the supplied file. You can use this file to validate the data to ensure the currency, record count, schema version, feature name and coordinate reference system (CRS) match your expected order.

The following file naming convention will be applied to each Order Summary File you receive:

* collection\_featuretype\_orderSummary.json

For example, the file name for the Building Part Feature Type Order Summary File would look like this:

* bld\_fts\_buildingline\_orderSummary.json

The example below shows the information an Order Summary File contains:

```json
{
 "featureName": "bld-fts-buildingline",
 "crs": "http://www.opengis.net/def/crs/EPSG/0/27700",
 "schemaVersion": "1.0",
 "validFromDate": null,
 "validToDate": "2023-03-01",
 "recordCount": 202653
}
```

The following table provides a brief description of each field:

| Field         | Description                                              | Use                                                                                                                             |
| ------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| featureName   | The feature type delivered in this order.                | Validate the downloaded feature against your recipe.                                                                            |
| crs           | The coordinate reference system used for your supply.    | Validate the coordinate reference system against the CRS selected for your recipe.                                              |
| schemaVersion | The OS NGD data schema version provided for the feature. | Coordinate data schema updates with changes to your data.                                                                       |
| validFromDate | The start date of coverage for this supply.              | Validate the currency of your data to ensure the earliest date aligns with the expected supply window for your order frequency. |
| validToDate   | The end date of coverage for this supply.                | Validate the currency of your data to ensure the latest date aligns with the expected supply window for your order frequency.   |
| recordCount   | The total number of records delivered in the file.       | Check that delivered entries match the number of records expected for your download.                                            |

## How do I delete a data package?

To delete an existing OS NGD data package:

{% stepper %}
{% step %}

#### Log into your [OS Data Hub](https://osdatahub.os.uk/) account

Click *Login* on the OS Data Hub menu bar to log into your account.

<figure><img src="https://170091638-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0pZjHxkAvY7Mn6TqFBMD%2Fuploads%2F1Gd3vBvSOqXLYTPpZsO9%2Fimage.png?alt=media&#x26;token=afd47dd4-6005-4d33-a8ef-ec6540a138fb" alt="A screenshot of the OS Data Hub home page showing the sign up and log in buttons in the top right hand corner" width="563"><figcaption><p>Screenshot showing the OS Data Hub homepage.</p></figcaption></figure>
{% endstep %}

{% step %}

#### Navigate to the OS Data Hub workspace

Select *Data* from the menu bar to view your workspace.
{% endstep %}

{% step %}

#### Navigate to Data packages

Choose *Downloads* > *Data packages* from the secondary navigation menu. You will then be taken to your data package list.
{% endstep %}

{% step %}

#### Find the data package you are looking for

Scroll through the list to find a particular data package or use the search bar to search by data package name, data package number, or product name.

<figure><img src="https://170091638-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0pZjHxkAvY7Mn6TqFBMD%2Fuploads%2FbMVYGWBpA7DSODsmgyOF%2FScreenshot%20Data%20Package%20list.png?alt=media&#x26;token=446ab28f-6e9b-4eb4-b16d-1d3831d02c94" alt="Screenshot of OS Data Hub, showing an example of the Data packages list screen."><figcaption><p>Screenshot showing an example of the Data packages list screen in the OS Data Hub.</p></figcaption></figure>

{% hint style="info" %}

#### Data packages linked to an OS NGD recipe

Data packages linked to an OS NGD recipe can be identified by their prefix of 'OS NGD Recipe' against the recipe name in the Product column in the Data packages list.
{% endhint %}

<figure><img src="https://170091638-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0pZjHxkAvY7Mn6TqFBMD%2Fuploads%2F50dIKjprHvWirMNW1Bpt%2FScreenshot%20Create%20data%20package%20OS%20NGD%20Recipe%20prefix.png?alt=media&#x26;token=2c73e51c-6f5b-47b6-a07c-a7c81596c7cc" alt="Screenshot showing an example of the OS NGD Recipe prefix on a recipe name. The OS NGD Recipe prefix on the recipe name is highlighted in yellow."><figcaption><p>Screenshot showing an example of the 'OS NGD Recipe' prefix.</p></figcaption></figure>
{% endstep %}

{% step %}

#### Delete the package from the data packages summary screen

* Click the *Package options* dropdown in the top right-hand side of your screen.
* Click *Delete package*.

<figure><img src="https://170091638-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0pZjHxkAvY7Mn6TqFBMD%2Fuploads%2FGjaLmnt89Cg7LmTCPO8L%2FScreenshot%20deleting%20a%20data%20package.png?alt=media&#x26;token=ddac2229-e5f4-48bb-8a88-d529c3cd40a8" alt="Screenshot showing an example of a Data package summary screen in the OS Data Hub, with the Package options dropdown open."><figcaption><p>Screenshot showing an example of a Data package summary screen in the OS Data Hub with the Package options dropdown open.</p></figcaption></figure>

A warning pop up will appear.&#x20;

* Click the *Delete package* button in the pop up.
  {% endstep %}
  {% endstepper %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.os.uk/osngd/getting-started/downloading-with-os-select+build/getting-started-with-data-packages.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
