Skip to first unread message
cecil...@yahoo.com
Apr 8, 2020, 7:02:31 AM4/8/20
to AtoM Users
Good afternoon, sorry to bother you about this but I did not find the answer to my question in the documentation, nor in the forum. Does anyone know where, in AtoM, are used the taxonomies "User actions" and "Note types" ? Many thanks in advance ; best regards
Dan Gillean
Apr 8, 2020, 3:14:43 PM4/8/20
to ICA-AtoM Users
Hi there,
Both of these taxonomies are examples of what we call in the documentation "locked taxonomies," and "locked terms" AtoM uses these taxonomies and their underlying terms to manage code behaviors elsewhere in the application - for example, one of the things that the User actions taxonomy supports is the description audit log functionality added in 2.5:
Two of the terms added to the User actions taxonomy are "creation" and "modification" - terms that are shown in the audit log associated with descriptions when it is enabled. This is a locked taxonomy - we do not make the taxonomy and its terms available via the Taxonomy module in the user interface.
With locked taxonomies and locked terms, other parts of AtoM's code rely on using these protected terms, and it would require development to add new terms and have them supported throughout AtoM - for this reason, to present users from breaking the application by making taxonomy changes via the user interface, we keep these taxonomies hidden and locked.
Similarly, "Note types" determines the types of notes available in some of the standards-based edit templates - for example, the Canadian RAD standard template has many Note types, such as "continuation of title proper," "Cast note," and many more. In the user interface, these note types appear in drop-down boxes next to the relevant note fields. We do make this taxonomy available via the user interface, and you can add new terms to it - but the default terms are locked, meaning they cannot be modified or deleted.
Once again, AtoM's code relies on the default terms being exactly as they are to support all the various other behaviors the application can perform around these note types. While you can add a new Note type term via the user interface, adding one does not automatically add all the corresponding behavior you might want to fully support your new note type's use in AtoM. First of all, there are filters in the PHP code in the various forms to make sure that only the Note type terms associated with the current standards template show up in the drop-down on that specific template - without making code changes, your new terms may not show up in the edit templates, as they would be filtered out along with terms from other standards-based templates.
Additionally, you would also need to consider supporting functionality, such as import and export (in various types of XML as well as CSV), finding aid generation, API endpoints, and more. Consequently, you would need to make a number of code changes and enhancements, possibly including adding a database schema migration script (so upgrading users will have their database updated when upgrading to conform to any associated changes) before adding a new note type term to the taxonomy would have any useful effect in the application. Doing so without also doing the underlying development work not only ignores the standards from which these terms are derived, but may pose a risk to your data maintenance long-term, as you will have no way of exporting custom note type data without development.
You can see a brief explanation of locked terms and locked taxonomies in the documentation, in the green "Note" box, in the opening sections of the Terms documentation page:
You can see where the User actions taxonomy and some of its terms are created on installation by looking in the data fixtures, here:
You can see where we added "creation" and "modification" as terms in the user actions taxonomy as part of the audit log functionality in this schema migration, which also adds the relevant new audit_log table to AtoM's database and updates the overall data model:
Please let me know if you have other questions! Regards,
he / him
On Wed, Apr 8, 2020 at 7:02 AM cecile_gass via AtoM Users <ica-ato...@googlegroups.com> wrote:
Good afternoon, sorry to bother you about this but I did not find the answer to my question in the documentation, nor in the forum. Does anyone know where, in AtoM, are used the taxonomies "User actions" and "Note types" ? Many thanks in advance ; best regards
--
You received this message because you are subscribed to the Google Groups "AtoM Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to ica-atom-user...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/ica-atom-users/7c4bdc88-db91-4b48-b9b9-3617c8becd79%40googlegroups.com.
Dan Gillean
Apr 8, 2020, 3:19:24 PM4/8/20
to ICA-AtoM Users
Hello again,
I've just realized that the User actions taxonomy is not in fact locked currently, and is available in the user interface. However, I consider this to be a bug, and will be filing a report - I haven't tried it myself, but I suspect that editing the default terms might break the audit log module, and at the very least, these terms should be locked.
he / him
Reply all
Reply to author
Forward
0 new messages