Search results


Writing your own plugins

A plugin in ResourceSpace is a collection of PHP code, language files, graphics, CSS files and other related files that are structured to conform to the ResourceSpace plugin architecture. For deployment, the files that constitute a plugin are packaged together into a self-contained file called a ResourceSpace Plugin (.

Read more...


Managing plugins

ResourceSpace is a digital asset management system that can be extended or modified using plugins. Plugins have a managed structure that makes it easy for third parties to write and for site administrators to maintain, even as function and bug fixes are applied to the base code.

Read more...


ResourceSpace Plugins

Explore the range of plugins that are available to expand ResourceSpace's base functionality, including integrations with third party software and systems.

Read more...


Table: plugins

The article provides a table named "plugins" that lists all active plugins on the system and stores their configuration. The table has several columns, including name, descrip, author, update_url, info_url, inst_version, config, config_json, config_url, enabled_groups, priority, disable_group_select, title, and icon.

Read more...


get_active_plugins()

Description Get active plugins Parameters This function accepts no parameters. Return array Location include/plugin_functions.php lines 366 to 369 Definition   function  get_active_plugins ()     {     return  ps_query ( 'SELECT name, enabled_groups, config, config_json FROM plugins WHERE inst_version >= 0 ORDER BY priority' , array(),  'plugins' );     } This article was last updated 23rd February 2024 09:05 Europe/London time based on the source file dated 22nd February 2024 18:25 Europe/London time.

Read more...


Wordpress_SSO

The Wordpress_SSO plugin enables users to log in to ResourceSpace using Wordpress single sign-on (SSO) Identity Provider (IdP). However, the plugin should only be enabled and configured by system administrators as it affects how users log in to ResourceSpace.

Read more...


Navigating Consent and Digital Asset Management

Consent is not just limited to personal contact information or medical records; it also applies to artwork, photos, and videos where a person is identifiable. Digital asset managers need to have robust consent policies and procedures in place to comply with regulations and protect the privacy of individuals.

Read more...


Vimeo publish

The Vimeo Publish plugin allows users to publish video resources to a configured Vimeo account. The plugin uploads data and has configurable mapped fields to automatically add descriptions, titles, and tags.

Read more...


Database schema

Database schema for ResourceSpace.

Read more...


Project structure

A breakdown of the folders used within ResourceSpace, and their typical contents and function.

Read more...


ResourceSpace plugin for WordPress

A new WordPress plugin has been developed that allows users to embed resource files from ResourceSpace in their posts. The plugin was funded by ADRA International and developed by Codecide. To install the plugin, users should download the WordPress plugin zip file, navigate to Plugins->Add plugins from the WordPress Admin menu and click 'Upload plugin', or manually upload the zip file to the wp-content/plugins directory of the WordPress installation.

Read more...


 Sensitive image blurring

The sensitive image blurring plugin can blur selected images from users both in the results and on the resource view page. The plugin can be configured by enabling it and choosing a desired field for the "sensitive message" in the plugin's options page.

Read more...


ResourceSpace software design principles

ResourceSpace, an open-source digital asset management software, has outlined its design principles for developers. The principles include the KISS (Keep It Simple Stupid) principle, which advises against implementing complex solutions when a simple one will suffice, and avoiding introducing new technology when existing technology will suffice.

Read more...


Configuring Leaflet Maps

This article provides a guide to configuring Leaflet maps in ResourceSpace. The article lists several configuration options that can be used to add tile sources and customize how geolocation data is displayed.

Read more...


User preferences

The article provides instructions on how to access user preferences on a website. Users can click on the user profile icon at the top right of the screen and select "Preferences" to make changes to the functionality and interface available to them.

Read more...


get_system_status

The get_system_status API provides system status information, which is configuration-dependent, such as mysql_log_transactions. The API does not require any parameters. The API returns a JSON object that contains the system status information.

Read more...


System reset

The article describes the use of the System Reset plugin in ResourceSpace, which allows users to completely reset their installation by deleting all files and data. To activate the plugin, users must select System then Plugins from the top right menu, and then select the System Reset option from the System menu.

Read more...


User actions

User actions are now enabled for all users by default, unless disabled by a system administrator. Actions alert users to resources or activities that require their attention, and the actions visible to a user will vary depending on system configuration and user permissions.

Read more...


 Integrating with Uppy Companion

Uppy Companion is an open-source server application that can be linked to the Uppy uploader used by ResourceSpace. It allows users to select files directly from sources such as Google Drive, Dropbox and OneDrive without having to download the files locally first.

Read more...


 OpenAI GPT

OpenAI's GPT language model has been integrated into ResourceSpace, a digital asset management system, to automate metadata processing tasks. The plugin allows users to use GPT to populate metadata fields based on data stored in another field.

Read more...


User rating of resources

ResourceSpace has a star rating feature that allows each user to give resources a rating of between one and five stars. User rating of resources can be enabled by super admins in the configuration area via admin, system, configuration, user accounts and enabling "user rating of resources".

Read more...


The Complete Guide to Metadata

Metadata is data that provides information about other data, without describing the content of that data. It is crucial for digital assets and is used to categorize and describe various types of files, such as documents, videos, and audio files.

Read more...


Further videos

The article provides a list of videos that cover various topics related to using the ResourceSpace digital asset management system. The videos cover topics such as creating users, customizing the homepage slideshow, search filters, sharing resources, and more.

Read more...


 Adobe link

This plugin allows you to import files from ResourceSpace directly into Adobe InDesign and Photoshop.

Read more...


New to ResourceSpace?

Find out from the Knowledge Base how to get started with the ResourceSpace Digital Asset Management System.

Read more...


User guides

Introduction to the user guides section of the ResourceSpace Knowledge Base

Read more...


Knowledge Base structure

Article to explain how the ResourceSpace Knowledge Base is structured to assist with finding content specific for the reader

Read more...


Admin overview

Accessible from the top navigation bar, the Admin menu provides a whole range of tools to help manage ResourceSpace and its contents.

Read more...


Batch replace

ResourceSpace has a batch replace functionality that allows users to update multiple resources at once. This feature is useful for replacing original files and regenerating previews of any number of resources.

Read more...


Creating and deleting metadata fields

The article provides guidance on creating and deleting metadata fields in ResourceSpace. Metadata fields should be clear and descriptive, and the right data should be stored in the right field type to achieve this.

Read more...


Advanced workflow

workflow, process, publish, embargo, archive, review,state, status

Read more...


Video tracks

The Video Tracks plugin for ResourceSpace enables users to create custom video files in alternative formats/codecs, including subtitle and audio track files that have been uploaded as alternative files for a video resource.

Read more...


KE EMu database integration

KE EMu is a multi-user and object-oriented database management system that uses a Texpress database engine. The Texpress kernel has features that allow for easy creation and use of applications, accessed via a range of applications.

Read more...


Configuring php.ini

This article provides guidance on how to configure the php.ini file to handle larger files. The php.ini file location can be found on the PHP Info page in the row "Loaded Configuration File", available by running the function phpinfo() on an empty PHP page.

Read more...


Translations

The article provides a guide on how to create an official standard translation and a custom translation for a system. Before starting an official translation, it is important to verify that no other translator is already working with the language.

Read more...


Google Vision API

The Google Vision API plugin sends images to Google's Cloud Vision API on upload and sets appropriate metadata in pre-configured fields based on what has been recognised in the image. The plugin can be found under the 'Asset processing' category.

Read more...


Simple SAML

This plugin allows users to log on to ResourceSpace using a SAML compliant single sign-on (SSO) Identity Provider (IdP)

Read more...


Winauth

Enables users to login to ResourceSpace using Windows Integrated Authentication

Read more...


Cookies notification

The cookies_notification plugin is a tool that can be activated under Plugins via the System menu. It creates a header on the login page to notify users that their activity will be tracked via cookies.

Read more...


MuseumPlus

MuseumPlus is a web-based museum management system that provides real-time museum management and fully documents any type of collection and all related workflow. The system can be integrated with ResourceSpace, a digital asset management system, through its API.

Read more...


Offline job queues

ResourceSpace has developed an offline jobs function to delegate slow processes, such as creating a preview for a video file, to another script/process to be run asynchronously. The upload process focuses on getting files into the filestore, later working from a queue for further processing.

Read more...


Table: job_queue

The job_queue table is a list of active offline jobs such as preview processing. It contains several columns, including ref, which is an auto-incrementing index, type, which is the job type, job_data, which is the JSON-encoded job data, start_date, which is the earliest time to start the job, user, which is the user ID, status, which is the job status code, success_text, which is the text to include in the message if the job completes successfully, failure_text, which is the text to include in the message if the job fails, job_code, which is a unique hash used to prevent duplicate jobs, and priority, which is the job priority.

Read more...


Table: user

The "user" table in ResourceSpace stores all user information, including their username, password, full name, email address, user group, and last activity date. It also includes information on whether the user is currently logged in, their browser user agent string, and their IP address.

Read more...


plugin_decode_complex_configs()

Description Decode complex plugin configuration (e.g mappings defined by users on plugins' setup page) Parameters Column Type Default Description $b64sc string Configuration encoded prior with {@see plugin_encode_complex_configs()} Return mixed Location include/plugin_functions.

Read more...


search_special()

Developer reference for function search_special()

Read more...


plugin_encode_complex_configs()

Description Encode complex plugin configuration (e.g mappings defined by users on plugins' setup page) Parameters Column Type Default Description $c mixed Configuration requiring encoding Return string Location include/plugin_functions.

Read more...


config_add_hidden_input()

Description Generate a data structure to instruct the configuration page generator to add a hidden input Parameters Column Type Default Description $cf_var_name string Plugins' configuration variable name $cf_var_value string '' Value Return array Location include/config_functions.

Read more...


Frequently Asked Questions (FAQs)

The most frequently asked questions about ResourceSpace, the free and open source Digital Asset Management system.

Read more...


DrawOption()

Developer reference for function DrawOption()

Read more...


config_multi_archive_select()

Developer reference for function config_multi_archive_select()

Read more...


job_queue_run_job()

Developer reference for function job_queue_run_job()

Read more...


get_export_tables()

Developer reference for function get_export_tables()

Read more...


activate_plugin()

Developer reference for function activate_plugin()

Read more...


deactivate_plugin()

Developer reference for function deactivate_plugin()

Read more...


purge_plugin_config()

Developer reference for function purge_plugin_config()

Read more...


compile_search_actions()

Developer reference for function compile_search_actions()

Read more...


config_single_ftype_select()

Developer reference for function config_single_ftype_select()

Read more...


leaflet_markers_legend()

Parameters This function accepts no parameters. Location include/map_functions.php lines 518 to 548 Definition   function  leaflet_markers_legend ()     {     global  $lang ,  $marker_metadata_field ,  $marker_metadata_array ,  $MARKER_COLORS ;     if (!isset( $marker_metadata_field ) ||  $lang [ 'custom_metadata_markers' ] ==  '' )         {  ?>         <b>    echo  $lang [ 'legend_text' ] ?> &nbsp;</b>                  $restypes  =  get_resource_types ();         foreach( $restypes  as  $restype )             {              $markercolour  = (isset( $restype [ "colour" ]) &&  $restype [ "colour" ] >  0 ) ? (int) $restype [ "colour" ] : ( $restype [ 'ref' ] %  count ( $MARKER_COLORS ));             echo  "<img src='.

Read more...


get_geolibraries()

Description Definition of providers. see http://leafletjs.com/reference.html#tilelayer for options in the options map. L.TileLayer.Provider.providers = { <?php foreach($geo_leaflet_sources as $leaflet_source) { echo htmlspecialchars($leaflet_source["code"]) .

Read more...


get_geo_maps_scripts()

Parameters This function accepts no parameters. Location include/map_functions.php lines 739 to 745 Definition   function  get_geo_maps_scripts ()     {     global  $baseurl ;      ?>     <script src="   echo  $baseurl?> /lib/leaflet_plugins/leaflet-markercluster-1.

Read more...


config_boolean_select()

Developer reference for function config_boolean_select()

Read more...


config_single_select()

Developer reference for function config_single_select()

Read more...


config_colouroverride_input()

Developer reference for function config_colouroverride_input()

Read more...


config_text_input()

Developer reference for function config_text_input()

Read more...


allow_in_browser()

Description Check if file can be rendered in browser via download.php Parameters Column Type Default Description $path string Path to file Return bool Location include/resource_functions.

Read more...


send_user_notification()

Description Send system notifications to specified users, checking the user preferences first if specified This will contain two arrays:- "emails" array of emails sent, with the following elements:- "email" => Email address "subject" => Email subject "body" => Body text "messages" Array of system messages sent with the following elements :- "user" => User ID "message" => message text "url" => url Parameters Column Type Default Description $users array Array of user IDs or array of user details from get_users() $notifymessage ResourceSpaceUserNotification An instance of a ResourceSpaceUserNotification object holding message properties $forcemail bool false Force system to send email instead of notification? Return array Array containing resulting messages - can be used for testing when emails are not being sent Location include/message_functions.

Read more...


compile_collection_actions()

Developer reference for function compile_collection_actions()

Read more...


actions_filter_by_user()

Description Filter actions in the provided array to return only those applicable to the given user Parameters Column Type Default Description $actionuser int User ref to get actions for $actions array Array of actions as returned by get_user_actions_recent() func_get_args; $actions_resource_requests $actions_account_requests $actions_approve_hide_groups; Return array Subset of actions for the given user as would be provided by get_user_actions() Location include/action_functions.

Read more...


config_multi_rtype_select()

Developer reference for function config_multi_rtype_select()

Read more...


set_plugin_config()

Developer reference for function set_plugin_config()

Read more...


is_plugin_activated()

Developer reference for function is_plugin_activated()

Read more...


handle_rsc_upload()

Developer reference for function handle_rsc_upload()

Read more...


display_rsc_upload()

Developer reference for function display_rsc_upload()

Read more...


config_gen_setup_post()

Developer reference for function config_gen_setup_post()

Read more...


config_gen_setup_html()

Developer reference for function config_gen_setup_html()

Read more...


config_multi_select()

Developer reference for function config_multi_select()

Read more...


config_single_user_select()

Developer reference for function config_single_user_select()

Read more...


config_multi_user_select()

Developer reference for function config_multi_user_select()

Read more...


config_single_group_select()

Developer reference for function config_single_group_select()

Read more...


config_multi_group_select()

Developer reference for function config_multi_group_select()

Read more...


config_multi_ftype_select()

Developer reference for function config_multi_ftype_select()

Read more...


config_single_rtype_select()

Developer reference for function config_single_rtype_select()

Read more...


get_plugin_config()

Developer reference for function get_plugin_config()

Read more...


config_db_single_select()

Developer reference for function config_db_single_select()

Read more...


config_db_multi_select()

Developer reference for function config_db_multi_select()

Read more...


get_plugin_css()

Developer reference for function get_plugin_css()

Read more...


plugin_activate_for_setup()

Developer reference for function plugin_activate_for_setup()

Read more...


register_plugin_language()

Developer reference for function register_plugin_language()

Read more...


get_plugin_path()

Developer reference for function get_plugin_path()

Read more...


register_plugin()

Developer reference for function register_plugin()

Read more...


render_actions()

Developer reference for function render_actions()

Read more...


save_resource_data()

Developer reference for function save_resource_data()

Read more...


save_resource_data_multi()

Developer reference for function save_resource_data_multi()

Read more...


update_field()

Developer reference for function update_field()

Read more...


get_download_filename()

Developer reference for function get_download_filename()

Read more...


delete_resource_type_field()

Developer reference for function delete_resource_type_field()

Read more...