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.

Sign up for GitHub

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

Jump to bottom

OCR-D Workflow integration (without entity implementation) #5809

Merged
merged 13 commits into from
Nov 28, 2023
Merged

OCR-D Workflow integration (without entity implementation) #5809

merged 13 commits into from
Nov 28, 2023

Conversation

markusweigelt
Copy link
Collaborator

This pull request re-implements the PR #5697 without the use of an explicit OCR-D workflow entity.

The workflows are currently selected from a directory that can be configured via the kitodo_config.properties. In the future, it should be possible to load OCR-D workflows through an OCR-D manager endpoint. This PR provides the preparation for this by using Pair objects to combine ID and name instead of using a simple string list.

  • Add new authority to assign OCR-D Workflow
  • OCR-D workflow directory can be configured using the ocrd.workflows.directory parameter
  • Choose the OCR-D workflow from the workflows directory in the process template, or replace it within the process details.
  • Incorporate the OCR-D workflow identifier as a shell script variable using the (ocrdworkflowid) placeholder
  • Added documentation among others for the placeholder https://github.com/kitodo/kitodo-production/wiki/Workflow-Editor#platzhalter

@markusweigelt markusweigelt mentioned this pull request Oct 11, 2023
Closed
@solth solth added this to the Kitodo.Production 3.7.0 milestone Oct 21, 2023
solth
solth requested changes Oct 23, 2023
View reviewed changes
Copy link
Member

@solth solth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code looks good, just some very minor change suggestions. (Please rebase your branch against the current master.)

This is just a code review. Functional review will follow.

Kitodo/src/main/java/org/kitodo/production/services/ocr/OcrdWorkflowService.java Outdated Show resolved Hide resolved
Kitodo/src/main/resources/messages/messages_de.properties Outdated Show resolved Hide resolved
Kitodo/src/main/resources/messages/messages_en.properties Outdated Show resolved Hide resolved
Kitodo/src/main/webapp/WEB-INF/templates/includes/processEdit/details.xhtml Outdated Show resolved Hide resolved
@markusweigelt markusweigelt requested a review from solth November 1, 2023 16:26
solth
solth reviewed Nov 27, 2023
View reviewed changes
Copy link
Member

@solth solth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code seems to work as intended. (Just some small comments - see below). I was able to configure a OCRD workflow for a template and later change it for individual processes.

Just one small remark I think could be improved upon:
Bildschirmfoto 2023-11-27 um 11 19 17
I think the from Template option should contain information about which OCRD workflow it is that will be derived from the template, otherwise this might not be very informative (a user would first have to check the template to see if it defines a workflow appropriate for the current process and whether he has to change something in the process or not)

Also, there is a conflict in ProcessForm.java that needs to be resolved.

Kitodo/src/main/resources/kitodo_config.properties Outdated Show resolved Hide resolved
Kitodo/src/main/java/org/kitodo/production/services/ocr/OcrdWorkflowService.java Outdated Show resolved Hide resolved
Kitodo/src/main/java/org/kitodo/production/services/ocr/OcrdWorkflowService.java Outdated Show resolved Hide resolved
Kitodo/src/main/java/org/kitodo/production/services/ocr/OcrdWorkflowService.java Outdated Show resolved Hide resolved
Kitodo/src/main/java/org/kitodo/production/forms/ProcessForm.java Outdated Show resolved Hide resolved
Kitodo/src/main/java/org/kitodo/production/forms/ProcessForm.java Outdated Show resolved Hide resolved
Kitodo/src/main/java/org/kitodo/production/forms/ProcessForm.java Outdated Show resolved Hide resolved
Kitodo/src/main/java/org/kitodo/production/forms/TemplateForm.java Outdated Show resolved Hide resolved
Kitodo/src/main/java/org/kitodo/production/forms/TemplateForm.java Outdated Show resolved Hide resolved
Kitodo/src/main/java/org/kitodo/production/forms/TemplateForm.java Outdated Show resolved Hide resolved
@solth
Copy link
Member

solth commented Nov 28, 2023 •
edited
Loading

@markusweigelt I think you need to rename your SQL migration file because there already is another V2_125... sql by now (added by you, too)!

@markusweigelt
Copy link
Collaborator Author

I think the from Template option should contain information about which OCRD workflow it is that will be derived from the template, otherwise this might not be very informative (a user would first have to check the template to see if it defines a workflow appropriate for the current process and whether he has to change something in the process or not)

Good point! I have now added the selected file from the template. If there is no selection in the project template, the message of no selection will be shown.

@markusweigelt markusweigelt requested a review from solth November 28, 2023 14:54
@solth solth merged commit 3d3ef85 into kitodo:master Nov 28, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@solth solth solth approved these changes

@matthias-ronge matthias-ronge Awaiting requested review from matthias-ronge

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Kitodo.Production 3.7.0
Development

Successfully merging this pull request may close these issues.
2 participants
@markusweigelt @solth