Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Added links and copy edits
  • Loading branch information
Neelima Janardhanan authored and Neelima Janardhanan committed Mar 15, 2024
commit 932aa821a70141a8280ae8fd0cb37d695c62b3af
6 changes: 3 additions & 3 deletions documentation/extensions/dei/guidance.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ This isn’t a reporting process, it’s an opportunity to collect and share dat

This guidance is for those who want to publish information using the DEI Data Standard in the context of their grant information. The guidance in this section focuses on the fields and codes defined in the DEI Extension.

If you are new to publishing 360Giving data but are doing so with a view to also including DEI Data Standard data, we suggest you begin at the [Guidance for Publishers](../../guidance/#). This will help you understand the key principles involved in publishing 360Giving data. Once you are familiar with the steps and process, you will be able use this guidance to understand how to integrate the DEI Data Standard data into your 360Giving data publication.
If you are new to publishing 360Giving data but are doing so with a view to also including DEI Data Standard data, we suggest you begin at the [Guidance for Publishers](../../../guidance). This will help you understand the key principles involved in publishing 360Giving data. Once you are familiar with the steps and process, you will be able use this guidance to understand how to integrate the DEI Data Standard data into your 360Giving data publication.

If you are already a 360Giving publisher, or are otherwise already familiar with how to publish 360Giving data, this guidance will help you integrate the DEI Data Standard data alongside your existing 360Giving grants data.
If you publish or plan to publish data about grants made to individuals, it is not possible to publish DEI data alongside your 360Giving grants data as, combined with other data published, this risks making grant recipients personally identifiable. However, it is possible to collect this data and share it in aggregate, for example on your own website. For more on this, see the [data protection section]() of our grants to individuals guide.
If you publish or plan to publish data about grants made to individuals, it is not possible to publish DEI data alongside your 360Giving grants data as, combined with other data published, this risks making grant recipients personally identifiable. However, it is possible to collect this data and share it in aggregate, for example on your own website. For more on this, see the [data protection section](../../../individuals/publisher-guidance/#demographic-data) of our grants to individuals guide.


<div class="box box--teal">
<p>
If you are familiar with the DEI Data Standard and have already collected some DEI data, visit the <a href = "prepare.html/#dei-extension-field-guidance">DEI Extension guidance section</a>
If you are familiar with the DEI Data Standard and have already collected some DEI data, visit the <a href = "#about-the-dei-extension">DEI Extension guidance section</a>
</p></div>

## About the DEI Standard
Expand Down
16 changes: 8 additions & 8 deletions documentation/extensions/dei/prepare.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ In order to publish DEI Data Standard data using the 360Giving Data Standard DEI
* Ensure the grant information linked to the DEI data you intend to publish meets the requirements of the 360Giving Data Standard.
* Add the appropriate fields, rows, and/or sheets required by the DEI Extension to your file

The following sections cover these steps in more detail, providing guidance for publishing data in [spreadsheet]() and [JSON file formats]().
The following sections cover these steps in more detail, providing guidance for publishing data in <a href="../../../_static/360-giving-schema-titles-with-dei-extension-2024.xlsx">spreadsheet</a> and [JSON file formats](#json-format-guidance-for-developers).

<div class="box box--teal">
<h2 class="box__heading">Not sure what file format to use?</h2>
<p>
Read our <a href = "../../guidance/prepare-data/#choosing-your-file-format">guidance on choosing a file format</a>
Read our <a href = "../../../guidance/prepare-data#choosing-your-file-format">guidance on choosing a file format</a>
</p></div>


Expand Down Expand Up @@ -243,35 +243,35 @@ Note that the DEI Data Standard criteria for each application area require that

A key step to using the DEI Extension data is declaring that you are using it in a **Meta sheet** included in your file. 

This Meta sheet is the way 360Giving data publishers include metadata about their grants data in their files. It is separate and different from the metadata fields in the DEI Extension itself which are usually included in the main grants sheet. For further information read our guidance on 360Giving Data Standard [Metadata](../../technical/metadata/#guide-to-including-metadata-in-spreadsheet-files).
This Meta sheet is the way 360Giving data publishers include metadata about their grants data in their files. It is separate and different from the metadata fields in the DEI Extension itself which are usually included in the main grants sheet. For further information read our guidance on 360Giving Data Standard [Metadata](../../../technical/metadata/#guide-to-including-metadata-in-spreadsheet-files).

It is only once you have declared that you are using the DEI Extension in the Meta sheet that your data can be checked and validated by the 360Giving [Data Quality Tool](https://dataquality.threesixtygiving.org/) and used by GrantNav and 360Insights. If you miss this crucial step, the Data Quality Tool will not recognise the fields for the DEI Extension and treat them as non-Standard [Additional Fields](../../technical/reference/#additional-fields).
It is only once you have declared that you are using the DEI Extension in the Meta sheet that your data can be checked and validated by the 360Giving [Data Quality Tool](https://dataquality.threesixtygiving.org/) and used by GrantNav and 360Insights. If you miss this crucial step, the Data Quality Tool will not recognise the fields for the DEI Extension and treat them as non-Standard [Additional Fields](../../../technical/reference/#additional-fields).

Once you have a Meta sheet in your file, you can declare the extension by adding the Metadata field with the title \`Extensions\`. Usually this is in column A. In the next column (usually column B), add the value **dei**

You should also fill in the Version, which should be **1.4** or higher, as extensions were not available before version 1.4 of 360Giving Data Standard.

We recommend adding other useful pieces of metadata to your file, following the [Metadata guidance](../../technical/metadata/#guide-to-including-metadata-in-spreadsheet-files) provided.
We recommend adding other useful pieces of metadata to your file, following the [Metadata guidance](../../../technical/metadata/#guide-to-including-metadata-in-spreadsheet-files) provided.

## Spreadsheet templates

A blank spreadsheet template including all 360Giving Data Standard fields and a sheet including DEI Extension fields is available for [download for reference]().
A blank spreadsheet template including all 360Giving Data Standard fields and a sheet including DEI Extension fields is available for <a href="../../../_static/360-giving-schema-titles-with-dei-extension-2024.xlsx">download for reference</a>.

360Giving is developing a DEI Extension mapping template to make it easier for publishers to select the correct metadata values appropriate for their implementation of the DEI Data Standard, and support adding the appropriate Taxonomy codes that must be used.

Please contact 360Giving Helpdesk to find out about more tailored templates and guidance for your organisation via <[email protected]> putting **DEI template** in the email subject line.

## JSON Format Guidance for Developers

The 360Giving Data Standard is defined by a JSON Schema, which details the entities that can be described using the Standard, and the properties it recognises. The DEI Extension, which is also defined by a JSON Schema, is an optional extension designed to be added to the [360Giving JSON Schema](../../technical/reference/#json-format), and makes use of [360Giving’s extension mechanism]() to allow you to validate the fields and codes used in your data.
The 360Giving Data Standard is defined by a JSON Schema, which details the entities that can be described using the Standard, and the properties it recognises. The DEI Extension, which is also defined by a JSON Schema, is an optional extension designed to be added to the [360Giving JSON Schema](../../../technical/reference/#json-format), and makes use of 360Giving’s extension mechanism to allow you to validate the fields and codes used in your data.

The normative reference for the fields and codes added by the DEI Extension JSON Schema can be found alongside documentation in the [Technical Reference](../reference) section.

It is straightforward to implement the DEI Extension into an existing JSON format file of 360Giving data:

1. Ensure that the **version** field in your package data has a value greater than **1.4**, since extensions were not available prior to this.

If you're updating an existing publication and your current version is **1.0** or greater, you can declare **1.4** without any problems related to backwards incompatibility (see also: our [Versioning and Upgrade Process](../../about/governance/#versioning-and-upgrade-process)). 
If you're updating an existing publication and your current version is **1.0** or greater, you can declare **1.4** without any problems related to backwards incompatibility (see also: our [Versioning and Upgrade Process](../../../about/governance/#versioning-and-upgrade-process)). 

If you don’t have a **version** field currently, it is safe to add this with the value of **1.4** unless your data isn’t conformant to Version **1.0** or later. You can verify this by checking the 360Giving Data Standard data in your file in the [Data Quality Tool (DQT)](https://dataquality.threesixtygiving.org/), as all data that passes the tool’s validation checks is conformant with Version 1.0 or later.

Expand Down
3 changes: 2 additions & 1 deletion documentation/extensions/dei/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,8 @@ The authoritative source for the DEI Taxonomy codes vocabulary is the [DEI Data

The DEI Extension for 360Giving creates and maintains this codelist by taking the hierarchical codes defined in the DEI Data Standard, encoding them into JSON, and then generating this codelist automatically. This is necessary to provide a machine-readable codelist to support validation.

Please see the [Guiding Principles](#guiding-principles) section for more information on how we respond to updates in the DEI Standard.
Please see the [Governance and Versioning](governance) section for more information on how we respond to updates in the DEI Standard.


```eval_rst
.. csv-table::
Expand Down