Generated URN does not contain check number

[NateWr]

Describe the bug
The URN should generate a check number that is calculated based on the URN. When the URN plugin is configured with a default pattern, the generated URN for an article does not include the check number.

To Reproduce
Steps to reproduce the behavior:

1. Go to Settings > Website > Plugins.
2. Enable the URN plugin, open the settings, and enable the URN for articles. Set the required settings to anything and under URN Suffix, select "Use Default Patterns".
3. Open a submission's workflow and make sure it is scheduled in an issue.
4. Reload the submission's worklow and go to Publication > Identifiers.
5. Click "Generate URN".

The URN follows the suffix pattern but does not include the check number. This is because it uses FieldPubId, which doesn't by default apply a check number. The URN plugin needs to extend FieldPubId or otherwise implement a solution that applys the check number when FieldPubId::generateId is called.

What application are you using?
OJS 3.2.1

Additional information
Reported in the forum.

---

PRs:

• pkp/pkp-lib#6293 fix checkDuplicate in PKPPubIdPlugin #8986
• pkp/pkp-lib#6293 consider urnCheckNo setting, fix checkDuplicate in PubIdPlugin  ojs#3897
• pkp/pkp-lib#8940 consider urnCheckNo setting, fix checkDuplicate, fix publish preview, clear old code omp#1398

[asmecher]

@NateWr, I'm drawing a bit of a blank on this -- do you have a reference for the check number calculation?

[NateWr]

That's a good question! I did a quick search and couldn't find a specification for how to apply a check number either. I think URNs are used mostly in Germany. @bozana or @withanage do you know if URNs have a check number applied and where we might find documentation of how to generate that?

[withanage]

@NateWr

URNs have a check number (one digit ) applied as a suffix to the characters. I

I have found a PHP project which calculates the digit here.
https://github.com/bohnelang/URN-Pruefziffer

$purn is the check number, which should be added to a calculation.

I am not sure, if it should work for urns not registered in German national library, cause I remember slightly seing that it depdens on the registration agency.

[NateWr]

cause I remember slightly seing that it depdens on the registration agency.

Uff... do you know anyone we can talk to learn more?

[bozana]

Hmmm... I think I do not understand the problem here -- I do not understand why the number is not calculated/displayed -- will have to take a further look -- but:
There is the urn plugin setting "The check number will be automatically calculated and added at the end, as the last digit of an URN." that should be enabled for check numbers to be considered/calculated, and we also do calculate the number in https://github.com/pkp/ojs/blob/master/plugins/pubIds/urn/js/checkNumber.js (the link for the algorithm used is in there, but unfortunately DNB moved the URL) .
I am not sure if other national libraries need that number, but the German National Library does/did -- that's why the manager can configure it in the plugin settings.

[NateWr]

Thanks @bozana, that helps! This issue has to do with the new pub id field in the publication area, which bypasses some of the previous pub ID stuff and does not call on checkNumber.js as it should.

[bozana]

@NateWr, i have forgotten to say that there is also a function _calculateCheckNo in URNPubIdPlugin class that is/was used to add the number automatically (e.g. for default suffixes), and JS function was used for custom suffixes clicking on a button...

[bozana]

@asmecher, could you take a look at the PRs above i.e. can we add these changes to the next stable release, that will need a new npm install and npm run build ?
Nate has already taken a look at the Vue components added/changed here in this issue: #8940. Thus they should be OK...

[asmecher]

@bozana, updating the JS will be fine for anyone using the .tar.gz distribution, but may affect git-based hosting if the JS isn't rebuilt. @mfelczak, does hosting tend to build the node dependencies when updating from one 3.3.0-x build to another?

[bozana]

In our documentation in Notion it seems that node dependencies are build, but I am still not sure if I should merge the changes now... 🤔

[asmecher]

I say yes. I'll send a reminder to Michael in advance of the release so when they update they can double-check.