New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable dynamic linking to third party services for each dataset #602

Closed
philipashlock opened this Issue Mar 2, 2015 · 12 comments

Comments

Projects
None yet
7 participants
@philipashlock
Copy link
Member

philipashlock commented Mar 2, 2015

Much like a typical desktop operating system allows you to choose which application you use to open a certain kind of file, we should enable users to choose which third party service to use to open a dataset on data.gov without needing to download/upload to that service.

@philipashlock philipashlock added this to the Release 2.14 milestone Mar 2, 2015

@philipashlock

This comment has been minimized.

Copy link
Member

philipashlock commented Mar 2, 2015

Ideally this would compliment the built-in "Preview" functionality and would work in a somewhat similar way. Currently the "Preview" button only appears after we verify that the file linked to is previewable. We'll need to do this for third party services as well and so we might as well display the "Preview" option in the same way as third party services.

Here's what the UI could look like:

screen shot 2015-03-02 at 4 52 32 pm

Ideally each provider would simply be a configuration option. Here's what configuration might look like in YAML:

external_file_readers: 
  - 
    name: "Map Provider"
    url_scheme: "https://www.map-provider.demo/external/?url="
    media_type: 
      - application/vnd.ms-excel
      - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
      - text/csv
      - application/vnd.google-earth.kml+xml
      - application/vnd.geo+json
  - 
    name: "Data Viz Provider"
    url_scheme: "https://www.dataviz-provider.demo/external/?url="
    media_type: 
      - application/vnd.ms-excel
      - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
      - text/csv
      - text/tab-separated-values
@deniszgonjanin

This comment has been minimized.

Copy link

deniszgonjanin commented Mar 18, 2015

This is amazing. Just saw the post about this on data.gov. Can anyone point me to the relevant code? Would love to port this to work with core CKAN as a ckan extension.

@philipashlock

This comment has been minimized.

Copy link
Member

philipashlock commented Mar 18, 2015

@deniszgonjanin Right now it's just directly in the template. We were certainly planning to port this to an extension, but might not get to that as quickly as you could, so by all means feel free to take the lead and keep us posted

Here's the relevant part of the template: https://github.com/GSA/ckanext-geodatagov/blob/8042226584764b12b68e391616dc2c86c564e829/ckanext/geodatagov/templates/package/snippets/resource_item.html

cc: @ajturner

@ajturner

This comment has been minimized.

Copy link

ajturner commented Mar 18, 2015

Thanks - this would be interesting to make a configuration as different CKAN deploys may prefer or have different tools.

We'll also want to split out the Web types so we can also handle the GeoService URLs

@philipashlock

This comment has been minimized.

Copy link
Member

philipashlock commented Mar 18, 2015

@ajturner I think geoservice URLs are already covered by https://github.com/GSA/ckanext-geodatagov/blob/1b75ee95e6f4954871d0e1728c43affe7abc04c9/ckanext/geodatagov/helpers.py#L161 but currently the "Open With" option for WMS is limited to a map viewer hosted on data.gov. The built in viewer on Data.gov should be replaced soon, but obviously the same model should apply here for third party services.

Since these can't be referenced by mediatype, it would be great to have a more consistent way to reference API endpoints that adhere to a common spec like WMS and WFS. There's some direction for this with the new API guidance in the Project Open Data schema, but I don't think these specs/standards are easily or consistently identified thru ISO ISO-19139 metadata.

@ajturner

This comment has been minimized.

Copy link

ajturner commented Mar 18, 2015

@hkdctol

This comment has been minimized.

Copy link

hkdctol commented Mar 23, 2015

@philipashlock As discussed, we will incorporate our usual language for external links: "This link will direct you to an external website that may have different content and privacy policies from Data.gov."

@rebeccawilliams

This comment has been minimized.

Copy link
Contributor

rebeccawilliams commented Mar 24, 2015

Noting there is a slight delay before the 'Open With' button appears on the dataset page.

@kvuppala

This comment has been minimized.

Copy link
Contributor

kvuppala commented Mar 24, 2015

@FuhuXia to merge the pull request

@kvuppala

This comment has been minimized.

Copy link
Contributor

kvuppala commented Mar 27, 2015

pull request from @ajturner is in live site now.

Closing this ticket, any new changes we can create a new ticket.

@kvuppala kvuppala closed this Mar 27, 2015

@hkdctol

This comment has been minimized.

Copy link

hkdctol commented Apr 24, 2015

Re-opening. We didn't incorporate the usual language for external links: "This link will direct you to an external website that may have different content and privacy policies from Data.gov." OGC pointed this out this week.

@hkdctol hkdctol reopened this Apr 24, 2015

@kvuppala kvuppala modified the milestones: Release 2.17, Release 2.14 Apr 29, 2015

@hkdctol

This comment has been minimized.

Copy link

hkdctol commented Apr 29, 2015

Closing this and creating a new issue to address external link message

@hkdctol hkdctol closed this Apr 29, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment