ThreeSixtyGiving / standard

The 360Giving data standard for UK philanthropic giving
http://www.threesixtygiving.org
Other
10 stars 15 forks source link

Proposal: explicit date-time format for 'Last Modified' #218

Closed BobHarper1 closed 6 years ago

BobHarper1 commented 6 years ago

Proposal

An update to the documentation (including description in the schema) to be explicit that dates in the Last Modified group are formatted as:

Year-month-day 'the letter T' hour:minute:second Timezone

yyyy-mm-ddThh:mm:ss<timezone>

<timezone> should be replaced with: 'Z' for UTC, or ±hh:mm for timezones other than UTC

e.g. 2017-10-18T15:01:23Z

Why make this change?

360Giving markers for change (the Last Modified group of fields) provides publishers with a way of signalling to users when information has changed. This is important for systems which aggregate data from multiple sources on a regular basis. It will allow them to know when they need to update their copy of a dataset, and when the data is unchanged.

Currently, the schema expects a date-time which has a specific meaning in JSON Schema, but there is no explicit information on what a date-time should look like in either the documentation or the schema descriptions. This can cause confusion for publishers when they publish their grants information, users checking if the dates are accurate and developers creating validators based on the schema.

Using full timestamps removes any ambiguity that can occur when, for example, a record is updated in a source system multiple times in a single day. Without a full timestamp, there is a risk that systems with overwrite newer data with older data.

Impact

This is not a change as such, but is an area where there has been some confusion and some difficulty to comply. Publishers should check that they are complying with this requirement of the standard and seek help if they need it.

Data users should already be expecting to receive date-time data in these fields. This change should not affect them unless they have been taking steps to deal with non-compliant data in these fields.

You can feedback to this discussion in the topic on the 360 Giving Community Forum.

stevieflow commented 6 years ago

As per https://github.com/ThreeSixtyGiving/standard/issues/63 - Last modifiedtitle should soon be Last Modified

stevieflow commented 6 years ago

Just to clarify - I think a lot of publishers will just use date - eg YYYY-MM-DD in this field already, in line with other date fields. If we do this, will they suddenly become invalid (and not get into GN!)? I dont think so, but want to check -- > @Bjwebb

morchickit commented 6 years ago

Isn't this discussion should be in the forum?

On Wed, Oct 18, 2017 at 5:06 PM, Steven Flower notifications@github.com wrote:

Just to clarify - I think a lot of publishers will just use date - eg YYYY-MM-DD in this field already, in line with other date fields. If we do this, will they suddenly become invalid (and not get into GN!)? I dont think so, but want to check -- > @Bjwebb https://github.com/bjwebb

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/ThreeSixtyGiving/standard/issues/218#issuecomment-337642561, or mute the thread https://github.com/notifications/unsubscribe-auth/ADHzu6xRAE7NXC7brEtTDqSXCKu7pXqeks5stiIhgaJpZM4P9xpR .

BobHarper1 commented 6 years ago

@stevieflow Thanks, I've changed that in the title

@morchickit I've posted in the forum. I think they can exist as three separate issues here, but we can have a discussion around the changes as one topic (as they are closely related) in the forum. Tell me if I'm wrong about that!

morchickit commented 6 years ago

Making total sense Bob!

On 18 Oct 2017 20:32, "Bob Harper" notifications@github.com wrote:

@stevieflow https://github.com/stevieflow Thanks, I've changed that in the title

@morchickit https://github.com/morchickit I've posted in the forum https://forum.threesixtygiving.org/t/proposals-for-change-date-formats/46. I think they can exist as three separate issues here, but we can have a discussion around the changes as one topic (as they are closely related) in the forum. Tell me if I'm wrong about that!

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/ThreeSixtyGiving/standard/issues/218#issuecomment-337703091, or mute the thread https://github.com/notifications/unsubscribe-auth/ADHzu6wYWKHEnb4nMENj86l6EpRwMYonks5stlJCgaJpZM4P9xpR .

morchickit commented 6 years ago

Ok, so looking at @stevieflow comment, I think we just need to see if it will make older entries invalid, but even if so, surely we can provide publishers with an easy way to fix it (ie, excel format).

BobHarper1 commented 6 years ago

@morchickit Just to update you on this, we do have an examples box under the field guidance on how to do dates and times right in Excel in this version of the Documentation. http://standard.threesixtygiving.org/en/date-validation/reference/#dates-and-times

I think we're aware of all of the publishers who need to make these changes, and we'll do another check before implementing them to the live schema/standard.

BobHarper1 commented 6 years ago

I'm just noticing that we also have titles

Since we know that case changes have no effect, should we go ahead any make them consistent? @stevieflow @morchickit ?

stevieflow commented 6 years ago

Good spot @BobHarper1

Since we know that case changes have no effect

If that is the case, then I see no harm.....

morchickit commented 6 years ago

Agree with Steven. Let's go with this.

On 5 Dec 2017 16:21, "Steven Flower" notifications@github.com wrote:

Good spot @BobHarper1 https://github.com/bobharper1

Since we know that case changes have no effect

If that is the case, then I see no harm.....

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/ThreeSixtyGiving/standard/issues/218#issuecomment-349356459, or mute the thread https://github.com/notifications/unsubscribe-auth/ADHzu0vNAJaAJWbNzfkq5j49Ptkudprfks5s9W1ygaJpZM4P9xpR .

BobHarper1 commented 6 years ago

Added to the pull request https://github.com/ThreeSixtyGiving/standard/pull/221

stevieflow commented 6 years ago

https://github.com/ThreeSixtyGiving/standard/pull/221 was merged and deployed on Feb 1 2018