Feature #12800

Add JSON export of AtoM clipboard items

Added by Dan Gillean over 3 years ago. Updated almost 2 years ago.

Status:VerifiedStart date:02/08/2019
Priority:MediumDue date:
Assignee:-% Done:

0%

Category:ClipboardEstimated time:50.00 hours
Target version:Release 2.6.0
Google Code Legacy ID: Tested version:
Sponsored:Yes Requires documentation:

Description

This feature enhancement provides AtoM users with a way of exposing clipboard data in JSON and delivering it to an external URL via HTTP POST or GET methods, so that it can be consumed and used by a third-party application. We will also be adding an administrator setting to enable/disable the feature (it will be disabled by default in new and upgraded installations), and a method of configuring the POST to a third-party system.

Task summary

  • Design JSON schema for clipboard data
  • Add admin settings to enable and configure HTTP send methods of JSON clipboard data to third-party system
  • Develop functionality to POST clipboard data to designated host in JSON format
  • Merge to public branch

History

#2 Updated by Dan Gillean about 3 years ago

  • Target version set to Release 2.6.0

#3 Updated by Mike Cantelon about 3 years ago

  • Status changed from New to Code Review

#4 Updated by Mike Cantelon about 3 years ago

  • Assignee set to Steve Breker

#5 Updated by Mike Cantelon about 3 years ago

  • Status changed from Code Review to QA/Review
  • Assignee changed from Steve Breker to Mike Cantelon

Merged into qa/2.6.x.

#6 Updated by Mike Cantelon about 3 years ago

  • Assignee deleted (Mike Cantelon)

#9 Updated by Mike Cantelon almost 3 years ago

  • Status changed from QA/Review to Code Review

New CR to address translation issues:

https://github.com/artefactual/atom/pull/899

#10 Updated by Mike Cantelon almost 3 years ago

  • Status changed from Code Review to QA/Review

Merged into qa/2.6.x.

#11 Updated by Mike Cantelon almost 3 years ago

  • Status changed from QA/Review to Code Review
  • Assignee set to Steve Breker

New CR to fix bug in translation handling: https://github.com/artefactual/atom/pull/907

#12 Updated by Mike Cantelon almost 3 years ago

  • Status changed from Code Review to QA/Review
  • Assignee deleted (Steve Breker)

Merged into qa/2.6.x.

#13 Updated by Dan Gillean almost 3 years ago

  • Status changed from QA/Review to Verified

#14 Updated by José Raddaoui Marín about 2 years ago

Hi Mike and Dan,

Sorry to bring this up after such a long time, but I just saw this feature on a recent document and I have a couple of concerns about it:

- Why are we calling this JSON-LD? It looks to me like it's only sending the serialized slugs array.

- This is probably going to be affected by the same-origin policy. In the test you did, you're sending the clipboard to the same origin but, in a normal scenario, the slugs will be sent to a different domain. The current implementation sends the request from the browser and that will require the receiver to implement a CORS system. This could be easily avoided by sending the request from the back-end instead of from the browser and I think we should try to address that before we release this feature. Otherwise, we should add a big warning about it in the documentation.

#17 Updated by Dan Gillean about 2 years ago

  • Status changed from Verified to Feedback
  • Private changed from No to Yes

Setting this to feedback so we can discuss and hopefully implement Radda's suggested changes

#18 Updated by Dan Gillean almost 2 years ago

  • Subject changed from Add JSON-LD export of AtoM clipboard items to Add JSON export of AtoM clipboard items

#19 Updated by Dan Gillean almost 2 years ago

  • Status changed from Feedback to Verified
  • Requires documentation deleted (Yes)

Actually, setting this to verified - I'll file a different ticket for potential changes in future releases.

Docs added to 2.6 in https://github.com/artefactual/atom-docs/commit/8e2a340dffe3973cde4c95395e688d7a424f52e5

#20 Updated by Dan Gillean almost 2 years ago

  • Private changed from Yes to No

#21 Updated by Dan Gillean almost 2 years ago

  • Description updated (diff)

Also available in: Atom PDF