Skip to content
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

connect IQuOD database as ODIS node #395

Open
jmckenna opened this issue Feb 6, 2024 · 9 comments
Open

connect IQuOD database as ODIS node #395

jmckenna opened this issue Feb 6, 2024 · 9 comments
Labels

Comments

@jmckenna
Copy link
Contributor

jmckenna commented Feb 6, 2024

Possible next steps:

  • verify that the NCEI record is not exposed through the NCEI microplastics endpoint (which will become an ODIS node through connect NCEI catalogue as an ODIS node #361 )
  • OIH team to review the embedded JSON-LD on the landing page
  • IQuOD to create a sitemap.xml pointing to the record page(s), and place that file on the web
  • IQuOD to create an entry in the ODIS Catalogue
    • important fields are
      • Startpoint URL for ODIS-Arch (this is the url to your sitemap.xml file)
      • Type of the ODIS-Arch URL (select "Sitemap")
@pbuttigieg
Copy link
Collaborator

@jmckenna

A quick meeting with the IQuOD representative at the MG gives some initial intel.

This resource will be closely linked to WOD. Some WOD records will have IQuOD flags on them, indicating that they've been screened through IQuOD processes.

If there's a one-to-one match between these flags and the WOD JSON-LD records coming in to ODIS, we can consider adding a stanza to the WOD records that cover the IQuOD flag.

However, it seems the preferred route is that IQUoD publishes its own JSON-LD that reports its flag and any associated metadata, and links this to WOD records.

@castelao
Copy link

@jmckenna @pbuttigieg , I'm sorry for such a late response. There are different products from IQuOD, but the most important one is a variation of WOD, which WOD itself provides. My understanding is that the best solution here would be for me to create a JSON-LD and embed that in the IQuOD variation of WOD? Is that correct?

@pbuttigieg
Copy link
Collaborator

pbuttigieg commented Jul 10, 2024

@castelao linked data gives us several options, and it's best if you choose the one that best works for your team.

Here are some to consider:

The independent Node

  • IQuOD sets up its own ODIS Node
    • It publishes metadata about all its assets/products it wants the world to know about
    • It publishes the variations it makes to WOD assets itself, and uses WOD identifiers to cross-link them to the WOD metadata, with appropriate provenance metadata

I like this approach as it increases modularity and the independence of IQuOD, and is the "right" way to use LOD. It also allows IQuOD to publish the rest of its product catalogue through ODIS

The augmentation approach

  • As you describe above, IQuOD (with help from us if you need it) figures out the JSON-LD / schema.org representation of its WOD variation
  • This would then be served by WOD
  • IQuOD would validate that WOD is pushing that metadata to ODIS in the way IQuOD wishes.
  • IQuOD periodically verifies that the WOD relay is operational and validated

This is fine, but I would recommend it only if you don't have the local capacity to run an independent node. The added dependency can cause issues (e.g. we're having some issues with WOD's spatial metadata, so we may have to pause that ingest until it's fixed), and coordination can easily take as much time as setting up and running an ODIS Node independently

A hybrid approach

A mix of the previous two.

  • IQuOD sets up an ODIS Node for all assets / products that are not shared by WOD.
  • For those that are shared by WOD, have their identifier (of the metadata record) in the IQuOD catalogue to allow redirects

While possible, if you can do this you may as well do the independent Node approach to reduce overhead

@castelao
Copy link

@pbuttigieg , thanks! So you recommend IQuOD has its own node, right? Some questions:

  • What are the requirements for maintaining our own node?
  • This is a product in partnership with WOD. By having our node and defining it as our product, how do we keep credits to WOD as a product from a partnership? It is crucial to leave no doubt that it is a product from IQuOD with WOD.

Thanks!

@jmckenna
Copy link
Contributor Author

jmckenna commented Oct 10, 2024

@castelao we created a short Getting Started with ODIS for a node to go through, which explains what is required by a node. I would recommend that you go through those steps, starting with creating your ODISCat (ODIS Catalogue) entry.

@castelao
Copy link

@jmckenna , thanks for creating that documentation. That's great! A few questions to start:

  • In OceanExpert it suggests creating a new record for each organization as the first step. We have one organization SG-IQuOD entry in OceanExpert. This is a source of great confusion to me for a long time. Should we create a new entry for the general IQuOD there? I was told that only members of the Steering Group would go there, so how to register the IQuOD members that are not in the SG? It sounds like another organization would be required to include the general members, and the products (including the node) from IQuOD. Do you agree?
  • I think I'm missing something. It says that would take a few minutes to register a new organization, but I can't even find where to do it.

My understand is that we have to clear that before be able to create the node, is that right?

Thanks!

@pbuttigieg
Copy link
Collaborator

pbuttigieg commented Nov 12, 2024

@castelao

  • In OceanExpert it suggests creating a new record for each organization as the first step. We have one organization SG-IQuOD entry in OceanExpert. This is a source of great confusion to me for a long time. Should we create a new entry for the general IQuOD there? I was told that only members of the Steering Group would go there, so how to register the IQuOD members that are not in the SG? It sounds like another organization would be required to include the general members, and the products (including the node) from IQuOD. Do you agree?

You need an OceanExpert ID to use things like ODISCat and OTGA. This OE account doesn't need to be the IQuOD identity, just a person or institution which can legitimately create an IQuOD ODISCat entry (i.e. the data source which will provide the ODIS content, as described here). This should be a small and quick step.

In this case, if you or another IQuOD Co-chair created a personal account, that can be used to create the ODISCat entry. If and when IQuOD membership changes, you can request that the control of the ODISCat entry be shifted to another OE Account. This is better practice than sharing passwords to a central IQuOD account.

The above being true, @arnounesco can create an "IQuOD Community" group in OE so all the IQuOD members can be gathered in it. We need an admin from your side, @castelao to add and remove members as needed.

@pbuttigieg
Copy link
Collaborator

If and when IQuOD membership changes, you can request that the control of the ODISCat entry be shifted to another OE Account.

@jmckenna could we update the getting started guide to add a note about this? That if the person responsible for maintaining the ODISCat entry changes, they should contact ODISCat admin to shift the role.

@arnounesco is there a way that an admin can do that without admin intervention?

@castelao
Copy link

I believe I successfully created a new node for IQuOD. I'll get back to this once we create a JSON-LD for IQuOD flags. Right the way, we should transfer already the person responsible for that node to guarantee a better communication for the long term. Thank you all very much for your patience and guidance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants