Plugins & Commonly Used Tools
SobekCM Plug-Ins
Although the plug-in architecture is fairly new, we already have some good sample plug-ins with code released. Below is the current list of known plug-ins. If you create a plug-in and would like to have it listed here, please contact us.
Custom Metadata Plug-Ins
1. PostcardCore Metadata ( https://github.com/rbernardy/SobekCM-plugin-metadataModule-PostcardCore )
This is a fully functional plug-in which adds new custom metadata, for postcards. This is a great template for adding your own new custom metadata. We will also be releasing a tool to help create all the stub classes for standard additional metadata fields, but this is a complete working example.
Builder Module Plug-Ins
1. Wolfsonian Builder Folder Module ( https://github.com/SobekCM/SobekCM-plugin-builder-wolf-sample )
This is a sample builder module plug-in, which changes the behavior of the builder. This adds a new module near the front of the process which looks at each incoming (usually FTP) folder. This allows packages to be submitted that are not in valid BibID_VID format, but rather use accession number as the folder name or metadata file name. If the accession number already exists in the system, the folder is prepared as an update to the existing item. If the accession number is new, the folder is prepared as a new ite. In addition, the metadata is non-standard, being stand-alone MODS. The MODS file is read, several processes are run on it to clean the data, and then a valid SobekCM METS is written.
This is a great sample for developers who are wondering how they can build their own plug-ins to modify what the builder accepts in the incoming folders.
2. Demo Builder Module Plug-In ( https://github.com/SobekCM/sobekcm-plugin-builder-demo-modules )
This sample plug-in includes multiple new custom builder modules. One example module includes processing non-BibID:VID type folder by the builder as a custom folder builder module. The second example builder module included does simple logging in an external file as each item is processed. This is a single item builder module. This was developed at Code Camp 2017.
Item Viewer Plug-Ins
1. RTI Item Viewer ( https://github.com/rbernardy/SobekCM-plugin-viewer-WebRTIViewer )
This is a new item viewer, which allows the display of RTI ( http://dis.lib.usf.edu/special/webViewer/viewer.html ) within the framework of the SobekCM item viewers. If the item does not have any RTI files (should appear in a RTI subfolder under the digital resource folder) than the sample RTI item is displayed from the plug-in folders. ( sample )
2. Model3D Viewer ( https://github.com/rbernardy/SobekCM-plugin-viewer-MODEL3D )
SobekCM-plugin-viewer-MODEL3D is a plugin for the open-source SobekCM Digital Repository software (Mark V. Sullivan, lead developer). It provides a viewer for 3D model content using 3DHOP, a HTML5-WebGL viewer created by Marco Potenziani and Marco Callieri. ( sample )
3. Downloads with JPEG2000s Viewer ( https://github.com/SobekCM/DownloadsWithJp2s_ItemViewer )
Plugin adds an additional downloads item viewer which allows any JPEG2000s in the package to be downloaded by public users as well. The new download item viewer is available to be assigned through behaviors and is called DOWNLOADS_JP2s. Note: the configuration file for this is a bit different and requires the very latest code to utilize. ( sample )
4. Sanborn Index Item Viewer ( https://github.com/SobekCM/sobekcm-plugin-sanborn-viewer )
Special SobekCM plug-in adds a Sanborn-specific item viewer. This item viewer uses existing GIF images and a HTML map file to display an index for the Sanborn map set. This allows users to view the map from far above, and select a set rectangle to view that page more closely.
Engine API Endpoint Plug-Ins
1. EDS Results Engine Endpoints ( https://github.com/rbernardy/SobekCM-plugin-endpoint-EDS )
SobekCM-plugin-endpoint-EDS is a plugin for the open-source SobekCM Digital Repository software. It provides a REST API endpoint to support a dynamic search request from the EBSCO Discovery Service™ to include search results from an individual SobekCM-based repository in the its search results.
2. Simple Results and Item Endpoints ( https://github.com/SobekCM/SobekCM-plugin-simple-endpoints )
This plug-in is similar to the EDS plug-in above, but removes some extraneous features which Ebsco needed. In addition, it adds a simple endpoint for viewing information about a single item. The results and item displays may prove easier to ingest in external systems, whether they be javascript/jquery or some other language. This code is provided as another example, particularly since these simple endpoints are expected to be included in the core system by default as well.
Result Viewer Plug-Ins
1. Timeline Results Viewer Plug-In ( https://github.com/SobekDigital/TimelineResultsViewer )
Plug-in adds a new results viewer for the open-source SobekCM digital repository software. This allows the results of a search (or browse across a collection) to appear within a timeline. This is currently under development, but is a great sample of the result viewer architecture.
In addition, a plug-in "store" is planned to be added to the software in the next six months, that will allow browsing from within the system-wide settings page in the SobekCM web applicaton.
Information for developers on creating plug-ins can be found in these technical pages.
SobekCM Official Tools
There are several tools that are released from the same code base as the SobekCM system that may help you when creating materials or bulk importing on a local instance.
The open-source SobekCM METS Editor tool is a fully stand-alone application that can be quite useful for either creating METS files in a disconnected, individual basis, or for doing mass ingests. In addition, it can be used to create image derivatives by recursively looking through a folder hierarchy and creating JPEG2000's, JPEGs, and smaller JPEG thumbnails per your individual settings.
This tool is really helpful for digital resource management, even independent of the SobekCM Digital Repository.
Development on this tool has been suspended, although this may change in the future.
The SobekCM Management and Reporting Tool (SMaRT) is helpful in support of a local SobekCM digital repository instance. In many respects, the SMaRT tool does much of the same things that the METS Editor tool does, but must be connected to the SobekCM database to complete those tasks. For example, the SMaRT tool does bulk ingest and also saves the new items into the SobekCM database directly.
This tool is being slowly deprecated as much of this functionality is transitioned to the web application directly.
Integration Tools
These tools allow the SobekCM system to be integrated into other external systems, such as Omeka.....
Other Tools
Other useful tools for general work around digital repositories and the SobekCM system include:
Do you have tools to contribute to this site?
Either register and request access to make changes, or send an email to us to make the changes for you.