Skip to content
New issue

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

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

Already on GitHub? # to your account

Warn about forms with old version of entity spec <2024.* #730

Open
ktuite opened this issue Oct 2, 2024 · 1 comment · May be fixed by getodk/central-backend#1272
Open

Warn about forms with old version of entity spec <2024.* #730

ktuite opened this issue Oct 2, 2024 · 1 comment · May be fixed by getodk/central-backend#1272
Assignees
Labels
backend Requires a change to the API server entities Multiple Encounter workflows frontend Requires a change to the UI needs testing Needs manual testing

Comments

@ktuite
Copy link
Member

ktuite commented Oct 2, 2024

When we migrate the entity form spec in existing entity forms we will not want to accept want to warn about new forms with an old entity spec.

From the above issue:

Once forms are migrated, we will need to check going forward that all form definitions that are uploaded (for new or existing forms) are capable of making offline changes. Specifically, we should reject form definitions that specify an entities spec before 2024.1. That shouldn't be an issue for users using XLSForms (things should work seamlessly), because pyxform will automatically specify 2024.1.

UPDATE: The issue mentioned rejecting form definitions, but we've decided to show a warning about them instead.

One hurdle users might encounter is if they have an old version of their form in XML and it has an old entity spec version. In that case, we can give users info on how to recover (e.g. download upgraded XML, look at spec to figure out changes to apply).

@ktuite ktuite added backend Requires a change to the API server documentation API docs, readme, developer docs entities Multiple Encounter workflows labels Oct 2, 2024
@ktuite ktuite moved this to 🕒 backlog in ODK Central Oct 2, 2024
@ktuite ktuite self-assigned this Oct 2, 2024
@matthew-white matthew-white added the needs testing Needs manual testing label Oct 2, 2024
@matthew-white matthew-white added frontend Requires a change to the UI and removed documentation API docs, readme, developer docs labels Oct 24, 2024
@matthew-white matthew-white changed the title Reject forms with old version of entity spec <2024.* Warn about forms with old version of entity spec <2024.* Oct 24, 2024
@matthew-white
Copy link
Member

We've discussed that it'd be nice not to outright reject forms like this if doing so is not necessary. Instead, we can warn users if the form definition they've uploaded specifies an old spec. I'll update the description above.

Surfacing the warning in Frontend will probably require changes to Frontend. I've added the frontend label to the issue.

I've also removed the documentation label, since it isn't a docs issue. There's an issue at getodk/docs#1855 to update user docs, and an issue at getodk/central-backend#1211 to update API docs. Feel free to edit those!

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
backend Requires a change to the API server entities Multiple Encounter workflows frontend Requires a change to the UI needs testing Needs manual testing
Projects
Status: ✏️ in progress
Development

Successfully merging a pull request may close this issue.

2 participants