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

IATI organisation file support #959

Open
siemvaessen opened this issue Jan 31, 2018 · 23 comments
Open

IATI organisation file support #959

siemvaessen opened this issue Jan 31, 2018 · 23 comments
Assignees
Labels
IATI roundtripping Working between formats

Comments

@siemvaessen
Copy link

We are looking into CoVe for converting IATI organisation file types, next to the activity file.

We don't see support for this in CoVe (yet?) so we are wondering what your thinking is on implementing such a feature and if you do not have short term plans to do so, we'd be happy to talk about how we could contribute to this.

@Bjwebb
Copy link
Member

Bjwebb commented Feb 1, 2018

Yes, support for this doesn't exist yet, and it makes sense to implement this in CoVE.
Our conversion library flatten-tool nearly supports this, it's just missing a way to name the root XML element (iati-organisations). There's an issue for this OpenDataServices/flatten-tool#150

There's also some discussion in this issue - #732 - about how CoVE might auto detect organisation spreadsheets from the Meta tab.

We have no short terms plans to do anything on this, so would by happy to see you contribute.

@siemvaessen
Copy link
Author

Thanks @Bjwebb. On the library flatten-tool, any ETA on delivery?

And, where should we look for relevant code in CoVe on the org file detection yet?

@Bjwebb
Copy link
Member

Bjwebb commented Feb 7, 2018

Sorry for the delay on this, I had a long weekend away at FOSDEM.

We don't have an ETA on that flatten-tool issue atm, but it should be fairly straightforward, so something we can slot into our backlog. How quickly are you hoping to get this functionality?

For the CoVE the changes need to happen in a few places. I'm thinking a call might be useful to talk over these?

@Bjwebb Bjwebb added the IATI label Feb 23, 2018
@siemvaessen
Copy link
Author

Hi @Bjwebb - delay in answering. Will CoVE support this in Q2 this year? We'd be happy to contibute, but I'd first like to find out where CoVE now stands with org.file support. We could on the base what is out there continue building.

@Bjwebb
Copy link
Member

Bjwebb commented Mar 19, 2018

We don't currently have this on our roadmap, but we'd definitely be happy to support you to do this.

@siemvaessen
Copy link
Author

check. Closing this ticket then.

@andylolz
Copy link
Contributor

andylolz commented Apr 18, 2018

Any chance of reopening this issue? I’d also find org file support useful. Thanks!

@Bjwebb Bjwebb reopened this Apr 18, 2018
@andylolz
Copy link
Contributor

Thanks for reopening, @Bjwebb!

we'd definitely be happy to support you to do this.

I don’t know how far this invitation extends?! But OpenDataServices/flatten-tool#201 is my first blocker. Can I get a sense of whether / when it will be reviewed / merged? Thanks!

@Bjwebb
Copy link
Member

Bjwebb commented Apr 19, 2018

Thanks, I'll try and take a look at that this week.

@siemvaessen
Copy link
Author

Bumping this up. @Bjwebb any updates on this? We'd be happy to assist, seeing we need it :-) so let me know, also happy to setup a brief call for specs so we can continue.

@andylolz
Copy link
Contributor

andylolz commented Jun 20, 2018

I started making progress on this (with OpenDataServices/flatten-tool#201), but it transpired that to do it properly was a bigger job than I’d originally anticipated.

It turns out it’s sort of helpful to get roundtripping working correctly first, and then to remove hard-coded assumptions that we’re dealing with an activity file.

Next up on my list is: OpenDataServices/flatten-tool#176

@siemvaessen
Copy link
Author

@andylolz - how can we contribute. Got a plan of action so we can distribute tasks?

So PR Nr. 201 has been accepted, so it's just #180 ?

@andylolz
Copy link
Contributor

andylolz commented Jun 24, 2018

@siemvaessen really good point, and thanks for pushing this ticket forward.

I know back in April I had a plan for this, and I regret not detailing it in a ticket (in fact I can see I have a local branch and a bunch of unstaged work on this, too.)

I’ll try to retrace my steps, and will break it down here next this week.

@Bjwebb
Copy link
Member

Bjwebb commented Jun 25, 2018

I've not had chance to look into what's still needed for organisation files in CoVE. @andylolz if you do write up a plan, that would be helpful. I'm happy to check it.

@andylolz
Copy link
Contributor

if you do write up a plan, that would be helpful.

Sure, why not.

I'm happy to check it.

Thanks!

@Bjwebb Bjwebb self-assigned this Aug 13, 2018
@Bjwebb
Copy link
Member

Bjwebb commented Aug 13, 2018

I will be doing some work on IATI Organisation file support this week.

@andylolz
Copy link
Contributor

I will be doing some work on IATI Organisation file support this week.

Haha, kk. So as mentioned in #993 (comment), I think this was blocked by OpenDataServices/flatten-tool#196, which is now sorted. But by all means.

Bjwebb added a commit that referenced this issue Aug 15, 2018
#959

(this is instead of specifying root_list_path which takes precedence)

This approach is intead of changing order of precedence in flatten-tool
OpenDataServices/flatten-tool#214
@Bjwebb
Copy link
Member

Bjwebb commented Aug 15, 2018

Here's a dev deploy of the work so far: http://959-org-file.dev.cove.opendataservices.coop/
Here's a spreadsheet file to test with it: https://github.com/OpenDataServices/cove/raw/959-org-file/cove_iati/fixtures/basic_iati_org_valid.xlsx

What works:

Still TODO:

  • One to many relationships, because we need to use organisation-identifier as the key instead of iati-identifier
  • CoVE doesn't tell you that you've uploaded an organisation file, or that it is validating against the organisation schema
  • More work on tests
  • Multilingual template generation
  • Add an issue for IATI organisation XML -> spreadsheet (includes meta tab roundtripping)

Additionally IATI organisation XML -> spreadsheet doesn't work, you just get a blank spreadsheet. I am unlikely to get time to fix this.

@andylolz
Copy link
Contributor

COOL!

Additionally IATI organisation XML -> spreadsheet doesn't work, you just get a blank spreadsheet. I am unlikely to get time to fix this.

^^ Right yeah, I guess this bit is about meta tab roundtripping.

Bjwebb added a commit to OpenDataServices/flatten-tool that referenced this issue Aug 16, 2018
Bjwebb added a commit to OpenDataServices/flatten-tool that referenced this issue Aug 16, 2018
Bjwebb added a commit that referenced this issue Aug 16, 2018
Bjwebb added a commit that referenced this issue Aug 16, 2018
Bjwebb added a commit that referenced this issue Aug 16, 2018
State that the file is an organisation file, and has been validated
against the organisation schema.

Disable the rulesets section, as this doesn't support organisation files
properly atm.
@Bjwebb
Copy link
Member

Bjwebb commented Aug 16, 2018

Okay, so I think we're done in terms of CoVE feature development for this PR. Still some to do work on tests and template generation.

Many thanks to @andylolz for having done a lot of the work on this!

Dev deploy: http://959-org-file.dev.cove.opendataservices.coop/
Here's a spreadsheet file to test with it, that's been updated to have multiple tabs with one to many relationships: https://github.com/OpenDataServices/cove/raw/959-org-file/cove_iati/fixtures/basic_iati_org_valid.xlsx

Bjwebb added a commit to OpenDataServices/flatten-tool that referenced this issue Aug 21, 2018
rhiaro pushed a commit that referenced this issue Oct 28, 2018
#959

(this is instead of specifying root_list_path which takes precedence)

This approach is intead of changing order of precedence in flatten-tool
OpenDataServices/flatten-tool#214
rhiaro pushed a commit that referenced this issue Oct 28, 2018
rhiaro pushed a commit that referenced this issue Oct 28, 2018
State that the file is an organisation file, and has been validated
against the organisation schema.

Disable the rulesets section, as this doesn't support organisation files
properly atm.
@Lathrisk
Copy link
Contributor

#959 (comment)

Organisation XML -> Spreadsheet is now implemented (pending deployment), but round trip is still not possible as the spreadsheet is still missing the Meta-tab.

Multilingual support is still missing also.

See: #1219

@stevieflow
Copy link
Member

What's blocking us getting this to deployed @Bjwebb @Lathrisk ?

@Lathrisk
Copy link
Contributor

@stevieflow I'm just updating the PR and refreshing my memory just now, but it will need re-reviewed (@Bjwebb had previously requested changes). I'm not sure if the meta-tab work that Ben has been doing will tie in with this as well? I will mention it at stand-up tomorrow morning.

@stevieflow stevieflow added the roundtripping Working between formats label Oct 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
IATI roundtripping Working between formats
Projects
None yet
Development

No branches or pull requests

5 participants