Dynamic Item Sets

By Daniel Berthereau Allow to include/exclude items to item sets automatically with a standard query.
Download 3.4.5

Dynamic Item Sets (module for Omeka S)

New versions of this module and support for Omeka S version 3.0 and above are available on GitLab, which seems to respect users and privacy better than the previous repository.

Voir le Lisez-moi en français.

Dynamic Item Sets is a module for Omeka S that allows to include items in item sets automatically via a standard query, via two ways, so the items will be removed (dynamic item sets) or not (static item sets filled dynamically) from the item sets if their metadata does not match any more.

For example, it is possible to create an item set bringing together all the items with blue color, or all items with type Audio or all items of the 14th century, or any other query adapted to your item sets.

Automatic attachment of items to item sets

Installation

See general end user documentation for installing a module.

The module Common should be installed first.

  • From the zip

Download the last release DynamicItemSets.zip from the list of releases and uncompress it in the modules directory.

  • From the source and for development

If the module was installed from the source, rename the name of the folder of the module to DynamicItemSets.

The module Easy Admin can be installed to run a reindexation of all item sets.

Usage

Dynamic item sets

To make an item set dynamic, simply define the query that will define its items via the field in the Advanced tab of item set edition.

When a query is set in the tab Advanced of the item set form, all existing and new items will be automatically attached to this item set, according to the request.

Warning: items that are manually attached to the item set will be automatically detached if they are no more in the results of the request.

There is no difference between dynamic item sets and others. So, it may be useful to use a specific resource model or to add a property with a boolean (module Data Type Rdf) to identify and to use them more easily.

Anyway, dynamic item sets can be identified via the advanced search with the "Is dynamic" radio button or by adding is_dynamic=1 in the url (https://example.org/admin/item-set?is_dynamic=1) or exclude them with is_dynamic=0.

When the request is removed, the item set become a static one and existing items remain attached.

When it looks like item sets are not indexed, you can reindex them all via a task in module Easy Admin. Most of the time, the process without events is enough. The events are useful only to reindex items in an external search engine, and even in that case, it's better to reindex it separately.

Static item sets filled automatically

In main settings, an option allows to define a list of item sets in which an item will be included when its metadata will match the query.

Unlike dynamic item sets, the item is never removed automatically from these item sets, that remains standard ones.

TODO

  • [x] Add a column in item sets browse.

Warning

Use it at your own risk.

It’s always recommended to backup your files and your databases and to check your archives regularly so you can roll back if needed.

Troubleshooting

See online issues on the module issues page on GitLab.

License

This module is published under the CeCILL v2.1 license, compatible with GNU/GPL and approved by FSF and OSI.

In consideration of access to the source code and the rights to copy, modify and redistribute granted by the license, users are provided only with a limited warranty and the software’s author, the holder of the economic rights, and the successive licensors only have limited liability.

In this respect, the risks associated with loading, using, modifying and/or developing or reproducing the software by the user are brought to the user’s attention, given its Free Software status, which may make it complicated to use, with the result that its use is reserved for developers and experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the suitability of the software as regards their requirements in conditions enabling the security of their systems and/or data to be ensured and, more generally, to use and operate it in the same conditions of security. This Agreement may be freely reproduced and published, provided it is not altered, and that no provisions are either added or removed herefrom.

Copyright

  • Copyright Daniel Berthereau, 2023-2025 (see Daniel-KM on GitLab)

This feature was initially present in the module Advanced Resource Template, before being extracted as an independent module for the collections de la Maison de Salins. Improvements were made for the Curiothèque of the Institut Curie.

Version Released Minimum Omeka version
3.4.5June 02, 2025 [info]^4.0.0
3.4.4March 17, 2025 [info]^4.0.0
3.4.3March 03, 2025 [info]^4.0.0
3.4.2February 03, 2025 [info]^4.0.0
3.4.1January 06, 2025 [info]^4.0.0