Customizations to InvenioRDM¶
The Knowledge Commons Works is built as an instance of InvenioRDM. The InvenioRDM Documentation, including customization and development information, can be found at https://inveniordm.docs.cern.ch/.
Template Customizations¶
Page templates¶
Email templates¶
Custom email templates are located in site/kcworks/templates/semantic-ui/invenio_notifications. These override the default templates provided by InvenioRDM, and include both html and plaintext versions of each email, as well has markdown templates for other notification backends.
Additional email templates are added for KCWorks-specific email types.
user-first-record.create.jinja: sent to KCWorks moderators when a user has created their first record.user-first-record.publish.jinja: sent to KCWorks moderators when a user’s first record is published.
Record Detail Page Customizations¶
Modular Framework (invenio-modular-detail-page)¶
Detail Page Overrides in the KCWorks Package (knowledge-commons-works/site)¶
Deposit Form Customizations¶
Modular Framework (invenio-modular-deposit-form)¶
Deposit Form Overrides in the KCWorks Package (knowledge-commons-works/site)¶
Collections¶
Collections for KC Groups (invenio-group-collections-kcworks)¶
Record Permissions¶
Per-field editing permissions¶
KCWorks adds the ability to set per-field editing permissions for record owners. This is implemented by two custom service components:
kcworks.services.records.components.PerFieldPermissionsComponentthat runs when record metadata is modified by the RDMRecordService and selectively blocks edits to certain fields. Attempts to edit restricted fields will result in a validation error message being added to the result’s list of errors. The field value will not be changed, although other fields may be updated successfully.kcworks.services.records.record_communities.CommunityChangePermissionsComponentthat runs when a record’s communities are changed by the RecordCommunitiesService and prevents unauthorized changes to a record’s default community. (It cannot presently block other changes to the record’s communities. Communities other than the default community may be freely added and removed.)
The PerFieldPermissionsComponent runs during the RDMRecordService’s update_draft record operation. It only takes effect if the record has already been published and has a default community. The component looks at which fields have been modified from the last published version of the record and checks to see whether the current user has permission to edit the field in question. If not, it adds a message to the result’s list of errors that looks like this:
{
"field": "custom_fields.kcr:commons_domain",
"messages": ["You do not have permission to edit this field because the record is included in the sample_community community. Please contact the community owner or manager for assistance."]
}
The CommunityChangePermissionsComponent runs during the RecordCommunitiesService’s remove and set_default record operations. It too only takes effect if the record has already been published. The component checks whether the current user has permission to change the record’s default community. The result if the user does not have permission varies depending on the operation:
remove: the community is not removed from the record, and a message is added to the result’s list of errors that looks like this:
{
"field": "parent.communities.default",
"messages": ["You do not have permission to edit this field because the record is included in the sample_community community. Please contact the community owner or manager for assistance."]
}
set_default: the default community is not changed, and ainvenio_communities.errors.SetDefaultCommunityErroris raised.
Per-field permissions configuration¶
The permissions are configured in the invenio.cfg file using the RDM_RECORDS_PERMISSIONS_PER_FIELD variable like this:
RDM_RECORDS_PERMISSIONS_PER_FIELD = {
"default": {
"policy": [ "custom_fields.kcr:commons_domain" ],
"default_editors": [Administration, SystemProcess],
"notify_on_change": False,
"grace_period": None,
},
"sample_community": {
"policy": {
"parent.communities.default": ["manager", "owner"],
},
"notify_on_change": True,
"grace_period": "1 day",
},
"sample_community_2": {
"policy": {
"custom_fields.kcr:commons_domain": [CommunityManagers, CommunityCurators, CommunityOwners],
},
"notify_on_change": True,
"grace_period": "1 day",
}
}
The default key is used to configure the permissions for all records that do not have a specific community configuration. Other keys are the URL slugs for specific communities and are used to configure the permissions for records in specific communities. These community-specific configurations are optional but take precedence over the default configuration. If no community-specific configuration is found, the default configuration will be used. If no default configuration is found, per-field permissions will only be applied to records published to a community that has a community-specific configuration.
The keys for each community or default configuration dictionary are:
Key |
Type |
Required |
Description |
|---|---|---|---|
|
list[str] or dict[str, list[str]] or dict[str, list[Generator]] |
Yes |
A list of field names to restrict, a dictionary mapping field names to lists of community role levels, or a dictionary mapping field names to lists of invenio_records_permissions.generators.Generator objects |
|
list[str] or list[Generator] |
No |
A list of community role levels (one or more of |
|
bool |
No |
A boolean indicating whether to notify the record owners when the community’s per-field permissions are changed |
|
str |
No |
A string indicating the grace period for the community’s per-field permissions |
The configuration above would:
restrict any non-administrative user from editing the
custom_fields.kcr:commons_domainfield for any record that does not have a primary community with its own editing restrictions. The only users able to edit the field will be the ones defined by the either the Administration or SystemProcess generator,restrict anyone (including record owners) from editing the
parent.communities.defaultfield for a record whose primary community issample_community. Only users with the “manager” or “owner” role insample_communitywill be able to edit this field.restrict anyone (including record owners) from editing the
custom_fields.kcr:commons_domainfield for a record whose primary community issample_community_2. Only users with the “manager”, “owner”, or “curator” role insample_community_2will be able to edit this field. Owners of records insample_community_2will be notified when the community’s per-field permissions are changed, and they will have a grace period of 1 day to update their records before the new permissions are enforced.
Note
The policy for sample_community_2 affects the same field as the policy for default, but since sample_community_2 has a community-specific configuration, it will take precedence. This means more the sample_community_2 managers, owners, and curators can edit this field for their collection’s records, where otherwise that field could only be edited by KCWorks administrators.
Defining the permissions¶
The values for each key in the RDM_RECORDS_PERMISSIONS_PER_FIELD config variable can take one of three forms:
a list of field names (strings) to restrict. In this case, all of the listed fields will be editable only by users with the “manager”, “owner”, or “curator” role in the community.
a dictionary mapping field names to lists of community role levels (one or more of
owner,manager,curator,admin,reader). In this case, the community roles required to make edits can be specified individually for each field.a dictionary mapping field names to lists of invenio_records_permissions.generators.Generator objects. In this case, different permissions can again be specified for each field. But the requirements can be more complex than simple community roles. For more details on available generators, or how to define custom generators, see the invenio-records-permissions documentation as well as the
generators.pyfiles in a number of the InvenioRDM packages.
In order to restrict changes to the community’s default community, the parent.communities.default field must be included in the list of fields to restrict.
Enabling per-field permissions¶
In order to enable per-field permissions, the PerFieldPermissionsComponent must be added to the RDM_RECORDS_SERVICE_COMPONENTS config variable.
RDM_RECORDS_SERVICE_COMPONENTS = [
RDM_RECORDS_SERVICE_COMPONENTS*,
"kcworks.services.records.components.PerFieldPermissionsComponent",
]
Which community’s permissions apply?¶
Since KCWorks records can be included in multiple communities, the per-field permissions component needs to know which community’s permissions to apply. There are two controls for this:
The default display community for the record is the one whose permissions are applied. This is the community whose id is stored in
parent.communities.defaultfield of the record.The default display community can be set as one of the restricted fields for the record.
So if a record is included in the romantic_literature community, and that community is set as the default community for the record, then the permissions applied will be those of the romantic_literature community. If the romantic_literature community has no per-field permissions configured, then the default permissions will be used. If no default permissions are configured, then the record will be unrestricted.
If the romantic_literature community’s per-field permissions restrict changing the parent.communities.default field, then the record owner will not be able to remove the record from the romantic_literature community or change the default community for the record. The record can only be removed from the community, or its default community changed to another community, by an owner, manager, or curator of the romantic_literature community.
Note
If a community has per-field permission restrictions configured, this will be displayed in the user interface when the record owner submits it to the community.
Note
A one-time notification to all record owners if/when the community’s per-field permissions are changed. Depending on collection policy, record owners may be allowed a grace period to update their records before the permissions are enforced.
Notifications¶
In-app notifications¶
A user’s unread notifications are tracked in the user’s profile record.
Content moderation notifications¶
User-first-record notifications¶
Emails are sent to the KCWorks moderators when a user creates their first draft and publishes their first record. This is implemented using
a custom service component for the RDMRecord service (kcworks.services.notifications.services.FirstRecordCreatedNotificationService) that runs during draft creation and publication and
checks whether the user has any other drafts or published records.
if not, adds a NotificationOp to the unit of work for the record operation to emit a notification of the type “user-first-record.create” or “user-first-record.publish”.
two custom notification builder classes (kcworks.services.notifications.builders.FirstRecordPublishedNotificationBuilder and kcworks.services.notifications.builders.FirstRecordCreatedNotificationBuilder) that build the notifications.
these builders define the notification recipients using a custom ModeratorRoleRecipient generator (kcworks.services.notifications.generators.ModeratorRoleRecipient) and sends the notification to all users with the role defined in the NOTIFICATIONS_MODERATOR_ROLE config variable.
they also define the notification backends to be used for sending the notification. In this case, a custom EmailBackend (kcworks.services.notifications.backends.EmailBackend) that sends email via the Flask-Mail extension.
custom email templates for the notifications, located at
site/kcworks/templates/semantic-ui/invenio_notifications/.
Notifications for import API record owners¶
The streamlined import API sends notifications to the owners of the records being imported. These notifications are implemented by the invenio-record-importer-kcworks package. They are configured using the RECORD_IMPORTER_COMMUNITIES config variable, like this:
RECORD_IMPORTER_COMMUNITIES = {
"sample_community": {
"email_subject_register": "Your KCWorks Record is Ready",
"email_template_register": "welcome_sample_community",
}
}
This configuration would be for a community with the URL slug sample_community. The email_subject_register value sets the subject line for the email notification sent to the record owners. The email_template_register value sets the template to use for the email notification. The template must be located in the templates/security/email directory of the KCWorks instance directory.
Note
These notifications will only be sent for records imported using the streamlined import API. They will not be sent for records imported using the old importer API.
Integrations with KC¶
User Data Sync (invenio-remote-user-data-kcworks)¶
User data is synced uni-directionally from KC to KCWorks. A user’s data is synced with KC when
the user’s SAML authentication info is first saved in KCWorks
the user logs into KCWorks
a webhook signal is received by KCWorks from KC
KC Search Provisioning (invenio-remote-api-provisioner)¶
SAML Authentication¶
Metadata Schema Customizations¶
The default InvenioRDM metadata schema is defined in the invenio-rdm-records package and documented here. It also includes a number of optional metadata fields which have been enabled in KCWorks, documented here.
Beyond these InvenioRDM fields, KCWorks adds a number of custom metadata fields to the schema using InvenioRDM’s custom field mechanism. These are all located in the top-level custom_fields field of the record metadata. They are prefixed with two different namespaces:
kcr: custom fields that are used to store data from the KC system. These fields may be used for new data, but are not required.hclegacy: custom fields that are used to store data from the legacy CORE database. These fields must not be used for new data.
Notes about Implementation of Core InvenioRDM Fields¶
metadata.subjects¶
Note that KCWorks employs the FAST controlled vocabulary (https://www.oclc.org/research/areas/data-science/fast.html) for the subjects field, complemented by the Homosaurus vocabulary (https://homosaurus.org/).
The FAST vocabulary is divided into a number of sub-vocabularies called “facets”, allowing more efficient searching and less ambiguity in the subject headings. FAST subjects in the metadata.subjects array must include the complete WorldCat url for the subject heading, the standard human-readable label, and a scheme including “FAST” followed by a hyphen and the FAST facet name in lowercase: i.e., one of
“FAST-topical”
“FAST-geographic”
“FAST-corporate”
“FAST-formgenre”
“FAST-event”
“FAST-meeting”
“FAST-personal”
“FAST-title”
“FAST-chronological”
You can search the FAST subject headings and their corresponding WorldCat urls here. The OCLC also provides helpful tools such as assignFAST, which suggests FAST subject headings based on a string (https://fast.oclc.org/assignfast/) and a converter from LCSH subject headings to FAST subject (http://fast.oclc.org/lcsh2fast).
Subject from the Homosaurus vocabulary must similarly include the complete homosaurus.org url as the id, the standard human-readable label as the subject, and a scheme with the value “Homosaurus”. The Homosaurus subject headings can be searched here.
Example:
{
"subjects": [
{
"id": "http://id.worldcat.org/fast/123456",
"subject": "Art History",
"scheme": "FAST-topical"
},
{
"id": "https://homosaurus.org/v3/homoit0000669",
"subject": "Intersex variations",
"scheme": "Homosaurus"
}
]
}
metadata.creators/metadata.contributors¶
Note that the KC username of a creator or contributor may be stored in the person_or_org.identifiers array of the creator or contributor object with the scheme kc_username.
Users are also strongly encouraged to include an ORCID identifier in the person_or_org.identifiers array with the scheme orcid.
Note
The KC username is the primary link between a KCWorks record and a KC user. If you want a work to be associated with a KC user, you must include the KC username in creator or contributor object.
Example:
{
"person_or_org": {
"identifiers": [
{
"scheme": "kc_username",
"identifier": "jdoe"
},
{
"scheme": "orcid",
"identifier": "0000-0000-0000-0000"
}
]
}
}
KCWorks Custom Fields (kcworks/site/metadata_fields)¶
kcr:ai_usage¶
Type: Object[boolean, string]
This field stores data about any use of generative AI in the production of the record.
Example:
{
"kcr:ai_usage": {
"ai_used": true,
"ai_description": "This paper was edited using generative AI editing software."
}
}
kcr:media¶
Type: Array[string]
This field stores a list of media or materials involved in the creation of the record. This field is used to store free-form user-defined descriptors of the media or materials and does not impose any controlled vocabulary.
Example:
{
"kcr:media": ["watercolor", "found objects", "audio recordings"]
}
kcr:commons_domain¶
Type: string
This field stores the KC organizational (Commons) domain associated with the KCWorks record, if any. The record should also be placed in the KCWorks collection associated with this organization.
Example:
{
"kcr:commons_domain": "arlisna.hcommons.org"
}
kcr:chapter_label¶
Type: string
This field stores the label of the chapter associated with the KCWorks record, if any. This allows us to differentiate between a simple chapter label (e.g. “Chapter 1”) and a more substantive title for the same chapter (e.g., “The Role of AI in Modern Art”).
Example:
{
"kcr:chapter_label": "Chapter 1"
}
kcr:content_warning¶
Type: string
This field stores an optional content warning for the KCWorks record. This is used to flag the record for KCWorks users so that they can be aware of potentially problematic content in the record. This field is not to be used for content moderation by KCWorks moderators or admins. It is only to be used voluntarily and as desired by the record submitter.
Example:
{
"kcr:content_warning": "This work contains detailed accounts of abuse that may be distressing to some readers."
}
kcr:course_title¶
Type: string
This field stores the title of the course associated with the KCWorks record. It is intended primarily for use with syllabi and instructional materials.
Example:
{
"kcr:course_title": "Introduction to Modern Art"
}
kcr:degree¶
Type: string
This field stores the educational degree (e.g., PhD, DPhil, MA, etc.) associated with the KCWorks record. It is intended primarily for use with theses and dissertations.
Example:
{
"kcr:degree": "PhD"
}
kcr:discipline¶
Type: string
This field stores the academic discipline associated with the KCWorks record. It is intended primarily for use with theses, dissertations, and other educational artifacts. It is not intended as a general-purpose field for describing the subject matter of the KCWorks record. For that, you should use the metadata.subjects and kcr:user_defined_tags fields.
This field is intended to complement the thesis:university and kcr:institution_department fields.
This field is not constrained by any controlled vocabulary.
Example:
{
"kcr:discipline": "Latin American Literature"
}
kcr:edition¶
Type: string
This field stores a descriptor for the edition of the KCWorks record, if any.
Example:
{
"kcr:edition": "Second Edition"
}
kcr:meeting_organization¶
Type: string
This field stores the name of the organization associated with the meeting or conference associated with the KCWorks record. It is intended primarily for use with conference papers, presentations, proceedings, etc.
Example:
{
"kcr:meeting_organization": "American Association of Art Historians"
}
kcr:project_title¶
Type: string
This field stores the title of a project for which the KCWorks record was created. It can be used flexibly for, e.g., grant-funded projects, research projects, artistic projects, etc.
Example:
{
"kcr:project_title": "Kingston Poetry Residency, 2024"
}
kcr:publication_url¶
Type: string (URL)
This field stores the URL of the publication associated with the KCWorks record. It is not the URL of the KCWorks record itself or of the work it contains. For example, if the KCWorks record contains a journal article, it would not hold the URL for the published journal article. It is intended to hold the URL of the publication as a whole that the KCWorks record is based on or is a part of. So it might hold the main URL for the journal in which the article was published, or the main URL for the book in which the chapter was published, etc.
This string must be a valid URL.
Example:
{
"kcr:publication_url": "https://www.example.com/publication/123456"
}
kcr:sponsoring_institution¶
Type: string
This field stores the name of the institution that sponsored the KCWorks record. One intended use is for unpublished materials such white papers that were sponsored or commissioned by an institution. The field may also be used for the institution hosting a conference or workshop associated with the KCWorks record (as distinct from the organization that sponsored the event).
Note that this field is not intended for the degree-granting institution associated with a thesis or dissertation. That institution’s title should be stored in the thesis:university field.
Example:
{
"kcr:sponsoring_institution": "University of Toronto"
}
kcr:submitter_email¶
Type: string (email address)
This field stores the email address of the submitter of the KCWorks record. It must be a valid email address.
Example:
{
"kcr:submitter_email": "john.doe@example.com"
}
kcr:submitter_username¶
Type: string
This field stores the KC username of the submitter of the KCWorks record. This should be used even if the submitter is also a contributor to the KCWorks record and has included the same username in the metadata.creators.person_or_org.identifiers array.
Example:
{
"kcr:submitter_username": "jdoe"
}
kcr:institution_department¶
Type: string
This field stores the institutional department in which a thesis, dissertation, or other educational artifact was produced. It is intended to complement the thesis:university field, which stores the degree-granting institution.
Example:
{
"kcr:institution_department": "Art History"
}
kcr:book_series¶
Type: Object[string, string]
This field stores the title of a series that contains the KCWorks record, along with the optional volume number of the work within the series.
Example:
{
"kcr:book_series": {
"series_title": "The Complete Works of Jane Austen",
"series_volume": "Volume 1"
}
}
kcr:commons_search_recid (system field)¶
This field is used to store the persistent identifier for the KCWorks record in the KC central search index.
Warning
This field is automatically generated by the invenio-remote-api-provisioner service when a KCWorks record is published. It must not be set by the user.
kcr:commons_search_updated (system field)¶
Type: string (ISO 8601 datetime string)
This field stores the date and time when the KCWorks record was last updated in the KC central search index.
Warning
This field is automatically generated by the invenio-remote-api-provisioner service when a KCWorks record is published. It must not be set by the user.
HC Legacy Custom Fields¶
The hclegacy namespace is used for custom fields that are used to store data from the legacy CORE database. These fields should not be used for new data.
custom_fields.hclegacy:groups_for_deposit¶
Type: Array[Object[string, string]]
This field is used to store the groups to which a legacy CORE record belonged before import into KCWorks. It was used to create corresponding KCWorks collections during migration.
Example:
{
"hclegacy:groups_for_deposit": [
{
"group_name": "Group Name",
"group_identifier": "Group Identifier"
}
]
}
custom_fields.hclegacy:collection¶
Type: string
This field is used to store the org collection to which a legacy CORE record belonged before import into KCWorks. It was used to create corresponding KCWorks org collections during migration.
Example:
{
"hclegacy:collection": "Collection Name"
}
custom_fields.hclegacy:committee_deposit¶
Type: integer
This field is used to store the committee deposit number for a legacy CORE record. It was not used during migration and is only preserved for historical purposes. It should not be used for new data.
Example:
{
"hclegacy:committee_deposit": 123456
}
custom_fields.hclegacy:file_location¶
Type: string
This field is used to store the relative path the the file for a legacy CORE record. It was not used during migration and is only preserved for historical purposes. It should not be used for new data.
Example:
{
"hclegacy:file_location": "/path/to/file.pdf"
}
custom_fields.hclegacy:file_pid¶
Type: string
This field is used to store the persistent identifier for the file for a legacy CORE record. It was not used during migration and is only preserved for historical purposes. It should not be used for new data.
Example:
{
"hclegacy:file_pid": "hc:123456"
}
custom_fields.hclegacy:previously_published¶
Type: string
This field is used to store the previously published status for a legacy CORE record. It was not used during migration and is only preserved for historical purposes. It should not be used for new data.
Example:
{
"hclegacy:previously_published": "true"
}
custom_fields.hclegacy:publication_type¶
Type: string
This field is used to store the publication type for a legacy CORE record. It was used during migration to help determine the KCWorks resource type of the record. It is only preserved for historical purposes. It should not be used for new data.
Example:
{
"hclegacy:publication_type": "Journal Article"
}
custom_fields.hclegacy:record_change_date¶
Type: string (ISO 8601 datetime string)
This field is used to store the date of the last change to a legacy CORE record. It was not used during migration to KCWorks and is only preserved for historical purposes. It should not be used for new data.
Example:
{
"hclegacy:record_change_date": "2024-01-01T00:00:00Z"
}
custom_fields.hclegacy:record_creation_date¶
Type: string (ISO 8601 datetime string)
This field is used to store the date of the creation of a legacy CORE record. It was not used during migration because InvenioRDM does not allow overriding of the record creation date. It is only preserved for historical purposes and should not be used for new data.
Example:
{
"hclegacy:record_creation_date": "2024-01-01T00:00:00Z"
}
custom_fields.hclegacy:record_identifier¶
Type: string
This field is used to store the internal system identifier for a legacy CORE record. It was not used during migration and is only preserved for historical purposes. It should not be used for new data.
Example:
{
"hclegacy:record_identifier": "1001634-1263"
}
custom_fields.hclegacy:submitter_org_memberships¶
Type: array[string]
This field is used to store the organizations to which a legacy CORE record’s submitter belonged before import into KCWorks. It was used to create corresponding KCWorks org collections during migration and assign the work to those org collections.
Example:
{
"hclegacy:submitter_org_memberships": ["arlisna", "mla"]
}
custom_fields.hclegacy:submitter_affiliation¶
Type: string
This field is used to store the organizational affiliation of a legacy CORE record’s submitter at the time of import into KCWorks. It was not used during migration and is only preserved for historical purposes. It should not be used for new data.
Example:
{
"hclegacy:submitter_affiliation": "University of Toronto"
}
custom_fields.hclegacy:submitter_id¶
Type: string
This field is used to store the internal KC system user id of a legacy CORE record’s submitter. It was used during migration to assign ownership of the newly created record, and is preserved for historical purposes. It should not be used for new data.
Example:
{
"hclegacy:submitter_id": "123456"
}
custom_fields.hclegacy:total_views¶
Type: integer
This field is used to store the total number of views for a legacy CORE record prior to import into KCWorks. It was used during migration to create KCWorks usage stats aggregations for the record. It is only preserved for historical purposes. It should not be used for new data.
Example:
{
"hclegacy:total_views": 123456
}
custom_fields.hclegacy:total_downloads¶
Type: integer
This field is used to store the total number of downloads for a legacy CORE record prior to import into KCWorks. It was used during migration to create KCWorks usage stats aggregations for the record. It is only preserved for historical purposes. It should not be used for new data.
Example:
{
"hclegacy:total_downloads": 123456
}