Search results


Metadata read/write mapping

ResourceSpace can map between embedded metadata stored in original files and the metadata fields in ResourceSpace itself. This synchronisation can be two-way, so that imported metadata can be automatically extracted into a configured field, but also that metadata added to the resource after import is written back to the file at download.

Read more...


 Advanced metadata field configuration

This page covers the advanced options for metadata field configuration including display templates, smart featured collections, display conditions, autocomplete options and additional settings for ExifTool and IPTC metadata.

Read more...


Metadata

ResourceSpace Digital Asset Management System uses embedded and user inserted metadata to describe and track your resources

Read more...


Fixed list metadata

Article in the ResourceSpace Knowledge Base explaining Concepts about Fixed List Metadata.

Read more...


Managing metadata

The article discusses the importance of managing metadata in a system to make searching for resources faster, easier and more intuitive. The article suggests that metadata should be descriptive, clear and complete to ensure that users can search effectively and get the best out of using the system.

Read more...


Understanding resource metadata

Metadata is essential for describing resources and forms the basis of search. When a resource is uploaded into ResourceSpace, it is tagged with words or phrases that best describe the asset. These tags form the resource metadata and are how users search for the resources they need.

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...


Metadata field types

This article provides a list of metadata field types that can be used to capture data in an appropriate form for communicating to users what it represents. The list includes text boxes for single-line, multi-line, large multi-line, and formatted text, as well as check box lists, drop-down lists, radio buttons, and date fields.

Read more...


Ordering metadata fields

Metadata fields can be ordered to determine where they appear on search, edit and upload pages. Global fields are placed first, followed by resource type-specific fields in a collapsible section below.

Read more...


Indexing metadata

ResourceSpace has announced that from version 10.1, indexing of text fields will be limited to the first 500 characters of text. This change is being made to enable ResourceSpace to quickly search resource metadata, rather than the full file contents.

Read more...


Lockable metadata

The article discusses the use of lockable metadata fields to speed up the process of refining metadata after uploading new resources. The feature is intended for use when the default upload sequence is set to 'Upload first, then set metadata'.

Read more...


Basic metadata field configuration

This article provides an overview of the basic options for metadata field configuration in ResourceSpace. The article covers the following options: Enabled, Required, Index, Display full width on view page, Display field, Enable advanced search, Enable simple search, May contain personal data, Hide when uploading, and Hide when restricted.

Read more...


Metadata templates

Metadata templates are a useful tool for saving time and ensuring consistency when uploading resources with common metadata sets. A metadata template is a data-only resource that inherits all global fields and resource type-specific fields, meaning that each template may contain a complete set of values for every field within ResourceSpace.

Read more...


 Push metadata

The article explains how to display related resources alongside resource metadata on the resource view page. By default, related resources appear as thumbnails in a panel located below the resource metadata.

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...


collection_writeable()

Developer reference for function collection_writeable()

Read more...


collection_readable()

Developer reference for function collection_readable()

Read more...


collection_download_log_resource_ready()

Developer reference for function collection_download_log_resource_ready()

Read more...


collection_download_process_csv_metadata_file()

Developer reference for function collection_download_process_csv_metadata_file()

Read more...


generateResourcesMetadataCSV()

Developer reference for function generateResourcesMetadataCSV()

Read more...


message_send_unread_emails()

Developer reference for function message_send_unread_emails()

Read more...


getFitsMetadataFieldValue()

Developer reference for function getFitsMetadataFieldValue()

Read more...


extractFitsMetadata()

Developer reference for function extractFitsMetadata()

Read more...


remove_all_node_keyword_mappings()

Developer reference for function remove_all_node_keyword_mappings()

Read more...


add_node_keyword_mappings()

Developer reference for function add_node_keyword_mappings()

Read more...


remove_node_keyword_mappings()

Developer reference for function remove_node_keyword_mappings()

Read more...


renderBreadcrumbs()

Developer reference for function renderBreadcrumbs()

Read more...


remove_keyword_mappings()

Developer reference for function remove_keyword_mappings()

Read more...


add_keyword_mappings()

Developer reference for function add_keyword_mappings()

Read more...


remove_all_keyword_mappings_for_field()

Developer reference for function remove_all_keyword_mappings_for_field()

Read more...


stripMetadata()

Developer reference for function stripMetadata()

Read more...


write_metadata()

Developer reference for function write_metadata()

Read more...


get_metadata_templates()

Developer reference for function get_metadata_templates()

Read more...


resource_file_readonly()

Developer reference for function resource_file_readonly()

Read more...


metadata_field_edit_access()

Developer reference for function metadata_field_edit_access()

Read more...


metadata_field_view_access()

Developer reference for function metadata_field_view_access()

Read more...


remove_invalid_node_keyword_mappings()

Description Delete invalid node_keyword associations. Note, by invalid, it's meant where the node is missing. Parameters This function accepts no parameters. Location include/node_functions.

Read more...


remove_invalid_resource_node_mappings()

Description Delete invalid resource_node associations. Note, by invalid, it's meant where the node is missing. Parameters This function accepts no parameters. Location include/node_functions.

Read more...


 StaticSync - keep your files in situ

StaticSync is a tool that allows users to keep their files in situ, meaning that they can remain in their existing folder structure. It is not intended to be used as a way to store resources externally to increase storage capability.

Read more...


 Collection options

There is a list of options available to you from the collection actions dropdown menu. This menu is present in the collection bar and from the "Manage My Collections" page, as well as on the search page when viewing resources in a collection.

Read more...


Data only resource types

Data only resources are metadata-only resources that do not have an associated file. They can be used to store a record or set of data that does not directly relate to a specific asset. Data only resources can be configured to provide a PDF of metadata based on templates that must be set up by the system administrator and placed in the filestore under system/pdf_templates as an HTML file.

Read more...


Configuring the database

This article provides instructions on how to configure a database for ResourceSpace, an open-source digital asset management system. The article explains how to create a new database and how to create dedicated users for ResourceSpace, which is a good security practice.

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...


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...


Resources and structure

Article to explain the concept of Resources and how they are structured with ResourceSpace Digital Asset Manager

Read more...


Collections, public collections and featured collections

ResourceSpace allows resources to be tagged with various metadata, eliminating the need for a traditional hierarchical folder structure. This means that a resource can exist in multiple collections and can be found through metadata searches.

Read more...


 Uploading

Uploading files into ResourceSpace is a very simple process, however it is at this stage that you will be adding the metadata that ensures your resources can found and used effectively. It is key that you put as much relevant metadata into the resource fields as possible now to make your contributions as valuable as they can be.

Read more...


Pending review and submission

ResourceSpace allows users to upload assets to the library with restricted permissions. Members of the General Users group first upload their assets in the 'Pending Submission' state, where they can check and verify the necessary metadata.

Read more...


Exiftool

Exiftool is a third-party tool that allows for the extraction of embedded data within a file and automatically adds it to the resource metadata upon upload. Administrators can configure the fields where the extracted data is placed, allowing for the inclusion of any metadata stored within the file.

Read more...


Simple search

The article discusses the simple search panel in ResourceSpace, a system that allows for easy searching within the platform. The basic panel includes a general search box for quick text searching across all indexed fields, as well as options to search by resource type and date.

Read more...


Advanced search

The advanced search page in ResourceSpace allows users to access a wider selection of metadata fields, enabling them to create more refined searches. The fields are grouped by resource type, with global fields at the top and resource-specific fields further down.

Read more...


Featured & public collections

Featured Collections are a way to showcase the best and most in-demand content. They can contain a select number of resources and encourage users to browse content by directing them to relevant tags or ideas.

Read more...


Searching in ResourceSpace

The ResourceSpace search feature is a powerful tool that allows users to quickly find the resources they need. Users can start with a broad search and then refine the results to find the most relevant content.

Read more...


Resource tools

The article discusses the various resource tools available in the resource downloads area of the resource view page. These tools allow users to download, view, and request resource files, as well as perform actions such as adding to a collection or sharing.

Read more...


Alternative files

Alternative files are a feature in ResourceSpace that allows users to store multiple versions of a resource together with a single set of metadata. This is useful when there are different variations of a resource that need to be easily accessible from a single point.

Read more...


Editing resources

The article discusses the importance of adding and maintaining metadata for uploaded resources. It emphasizes the need to monitor and update metadata to ensure that resources are easily found and useful.

Read more...


Editing multiple resources

The article explains how to edit multiple resources in ResourceSpace using batch editing. Batch editing allows users to apply the same change to multiple resources at once, ensuring continuity. To perform a batch edit, users need to add the selected resources to a collection and then choose "Edit all resources" from the collection actions list.

Read more...


Resource status & access

Resource status and access are important factors in controlling how users interact with resources in ResourceSpace. The status of a resource determines whether it can be found or edited by users, while the access controls which users can download the resource.

Read more...


 Related resources

The article explains how resources can be related to each other in order to group similar or mutually relevant resources. There are three ways to relate resources: relating all resources in a collection, manually relating resources by editing each resource individually, and relating resources on upload.

Read more...


PDF contact sheet

The article explains how to create a PDF contact sheet for a collection in ResourceSpace. A contact sheet is a quick reference overview of what is in a collection, which can be printed or downloaded. To create a contact sheet, users need to choose the "Contact Sheet" option in the collection Actions list.

Read more...


 Annotate

The article discusses the Annotate feature that allows users to add annotations to a resource and connect them to a part of the resource preview. The annotations could include names or features of note within an image.

Read more...


Flickr publishing

The Flickr publishing plugin allows users to publish selected resources from selected collections to a Flickr account. To use the plugin, users must create a featured collection or collection that contains resources they wish to publish.

Read more...


 Propose changes

The article explains how users who cannot edit a resource can propose changes to its metadata to administrators. The administrators can then approve or reject these changes. To submit a change, the user must navigate to a resource page and click "Propose Changes" in Resource Tools.

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...


 Reports

ResourceSpace offers a reporting section that allows users to access information about downloads, uploads, and views. The reporting section provides a detailed table structure that can be downloaded as a CSV file for spreadsheet software or viewed directly in the browser.

Read more...


Useful user permissions

The article provides an overview of user group permissions and how they affect user actions when accessing and interacting with resources. The permissions are divided into different categories, including searching/access, metadata fields, resource types, resource creation/management, collections, and administration.

Read more...


User resource requests

ResourceSpace allows users to request access to restricted resources. The request mode setting on the user group determines what happens with the request. If the request mode is set to email only, an email is sent to the administration notification address containing the request details.

Read more...


Collection and resource promotion

The article discusses ways to promote resources and collections using ResourceSpace. The homepage slideshow is a great way to showcase new and useful content, and careful management of it will keep the system looking fresh and encourage users to check regularly for new content.

Read more...


Homepage slideshow

ResourceSpace, a digital asset management software, has highlighted the importance of updating the homepage slideshow regularly to keep users engaged and the system looking appealing. The "big slideshow" provides a full-screen background image or slideshow for the homepage, while the "small slideshow" moves the slideshow window to the upper left side of the screen, leaving white space on the homepage for displaying dash tiles.

Read more...


User contributions

ResourceSpace allows for user contributions to be managed through user group upload permissions. Trusted uploaders, such as administrators, can add resources without review, while new users must upload their resources in a pending state for review by resource administrators.

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...


Deleted resources

The article provides information on how to manage deleted resources in a system. The directory for deleted resources can be found in the Admin section of the system, and it contains all the deleted resources.

Read more...


Resource types

Resource types are a key way to organise metadata in ResourceSpace, allowing users to record different metadata for different types of assets. Resource types can be created as needed, and separating resources into types allows users to apply certain media-specific fields only where they will be useful, saving time and effort.

Read more...


Configuring category trees

The category tree field type is useful for selecting metadata tags from a nested tree, particularly where resource subjects follow a hierarchical classification, such as product taxonomy or projects within campaigns.

Read more...


Modifying field options

The article explains how to modify field options in fixed list metadata fields in ResourceSpace. Users can add, remove or edit options by editing the field and selecting the "manage options" link. To add a new option, users can enter the name of the tag and click "Add".

Read more...


 Related keywords

The article explains how to manage related keywords in a website's admin panel. This feature allows creating relationships between search terms so that a search for one will also return resources that have the other keyword present in their metadata.

Read more...


 Smart featured collections

Smart featured collections are an automated way of collating resources with a common theme.

Read more...


Edit & upload tabs

This article provides guidance on how to set up and manage tabs in ResourceSpace, a digital asset management system. Tabs can be used to group related metadata fields together, making it easier for users to navigate and edit metadata.

Read more...


 Advanced user group options

The article explains the advanced user group options available in ResourceSpace. These options are hidden by default to make the user group page easier to use, but they can be accessed by clicking on the "Advanced options" header above the save button.

Read more...


 Search filters

Each user group can have a 'search filter' set (via the user group options in System Setup), which allows for resource visibility restrictions.

Read more...


Edit filters

Edit filters are used to determine if users in a group can edit resources based on the metadata in the resource. The existing 'e0' (or e1, e2 etc.) permissions must be used first to open up edit access.

Read more...


Derestrict filters

The article discusses the use of derestrict filters in ResourceSpace, which allows users to access resources that would normally be restricted to them. This feature is useful when some users need to access only a few resources within the system while being completely restricted from all others.

Read more...


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...


Adding resources to a collection

This article explains the different ways to add resources to a collection in a learning management system. Resources can be added to multiple collections at any given time. The first way to add resources is during upload, where the resources can be added to an existing or new collection.

Read more...


 CSV upload

The CSV upload plugin for ResourceSpace allows users to edit existing resource metadata and create new resources by uploading a CSV file. The plugin is recommended for administrators and users with elevated permissions due to the risk of inserting incorrect data into ResourceSpace.

Read more...


Advanced workflow

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

Read more...


Version control

The article explains how to use version control functions from the resource log. Users can click on a log entry to bring up a page showing the full log entry, and a revert link will be displayed where it is relevant.

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...


API

ResourceSpace implements a RESTful API that returns JSON. All requests must be signed using a shared private key specific to each user. This can be performed via GET or POST.

Read more...


get_resource_field_data

The article provides information about the function "get_resource_field_data" which returns all field data for a given resource. The function requires the ID of the resource as input and returns a JSON containing the resource metadata.

Read more...


create_resource

The article provides a function called "create_resource" that creates a new resource. The function requires the ID of the resource type for the new resource, which is an integer value. The archival state of the new resource is optional, and the default value is 999.

Read more...


update_field

The article provides information on the update_field function, which is used to set the value of a metadata field. The function requires the ID of the resource, the numeric ID or shortname of the field, and the value to set the field to.

Read more...


copy_resource

The article provides information on the "copy_resource" function, which is used to copy a resource. The function only copies metadata and property, not the attached files. The function requires the ID of the resource to be copied and the ID of the resource type for the new resource.

Read more...


get_resource_data

The article provides information about the function get_resource_data() which returns the top-level property data for a resource. The function includes truncated summary metadata, and for full, non-truncated metadata, the function get_resource_field_data() should be used.

Read more...


get_resource_types

The "get_resource_types" function returns all the configured resource types available to the user. The function does not require any parameters and returns a list of resource types. The list includes the reference number, name, allowed extensions, order by, configuration options, tab name, and push metadata for each resource type.

Read more...


upload_file

The "upload_file" function allows users to upload a new local file to an existing resource, replacing any file that is already attached. The function takes in several variables, including the ID of the resource, a flag to process embedded metadata, a flag to re-process an existing file, a flag to automatically rotate images, and the path on disk of the file to upload.

Read more...


upload_file_by_url

The "upload_file_by_url" function allows users to upload a new remote file to an existing resource, replacing any file that is already attached. The function requires the ID of the resource, which must already exist, and the URL of the file to upload.

Read more...


delete_collection

The "delete_collection" function is used to delete a collection, and the user must have write access to the collection. The function requires the ID of the collection, which is an integer data type. The return values of the function are either true or false, depending on the success of the operation.

Read more...


Installation overview

The article provides an overview of the installation process for ResourceSpace, a standard PHP/MySQL application. The installation process is similar to other PHP/MySQL applications, and most issues encountered relate to the default php.

Read more...


Installing on Ubuntu Linux

The article provides a step-by-step guide to install ResourceSpace on Ubuntu Linux. The installation process involves installing programs and dependencies, configuring PHP, creating a database, checking out ResourceSpace, finishing installation via a web browser, setting up the cron job for relevance matching and periodic emails, setting the file and folder permissions, and setting up Apache correctly.

Read more...


Installing on CentOS Linux

The article provides a guide for installing ResourceSpace on CentOS Linux. The installation process involves updating the system, installing MySQL Community Repo, and then installing mysql-server. Other packages that need to be installed include httpd, php, php-dev, php-gd, php-mysql, php-mbstring, subversion, vim, nano, ghostscript, ImageMagick, poppler, antiword, ExifTool, and FFmpeg.

Read more...


Installing on macOS

The article provides a step-by-step guide to install ResourceSpace on macOS. The installation process involves installing Homebrew, programs, and dependencies, PHP extensions using pecl, enabling PHP in Apache, configuring PHP, creating a database, checking out ResourceSpace, and finishing the installation via a web browser.

Read more...


Upgrading

The article provides instructions for upgrading ResourceSpace, a digital asset management system, using Subversion (SVN). Before upgrading, users should ensure that their system meets the general installation requirements.

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...


Creating custom reports

ResourceSpace allows users to create custom reports by writing SQL queries. Reports can be created in Admin > System > Reports, and existing reports can be viewed and edited from the same location. Users can create reports that show resources pending submission, and reports that allow date range selection.

Read more...


Configuring for multi-client use

The article provides a method for setting up ResourceSpace as an environment where multiple users can use the system, but their resources remain private from each other. The method involves creating a new global field called 'client' that can be attached to all types of resources.

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...


Simple LDAP

The Simple LDAP plugin enables consistent sign-on (CSO) for ResourceSpace users, allowing them to log in using the same credentials they use to log in to their organisation's network. The plugin has been tested with Microsoft Active Directory and Oracle Directory servers.

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...


Facial recognition

Open source digital asset management software, ResourceSpace, has integrated facial recognition technology via OpenCV, an open source computer vision and machine learning software library. The ResourceSpace annotate feature has been used to create the association between a fixed list field and a face.

Read more...


Google VR View

Google VR View is a plugin that displays previews of 360-degree images and videos using the Google VR View browser API. The plugin is supported on modern versions of Chrome, Opera, Safari, Firefox, IE 11 and Edge on Windows, macOS, Linux, Android and iOS.

Read more...


How to back up your ResourceSpace installation

Ensure that your ResourceSpace open source Digital Asset Management system has appropriate backups in place.

Read more...


 Action dates

The 'action_dates' plugin will automatically perform certain actions based on resource metadata, for example, archiving a resource when an expiry date is reached.

Read more...


 CSV user import

The CSV user import plugin allows administrators to create user accounts in bulk based on information stored in a CSV file. The CSV file must be encoded in UTF-8 format and without BOM, and should have text cells quoted in case they contain commas or other special characters.

Read more...


Installing on Windows Server

The article provides a step-by-step guide to installing ResourceSpace on Windows Server. The instructions include setting up the IIS Web Server role, installing Web Platform Installer to help with PHP and MySQL install, configuring php.

Read more...


Falcon link

The Falcon Link plugin allows users to publish resources as templates in Falcon.io. However, users must have an account with Falcon.io to use this plugin. The plugin creates a share link with no expiration date instead of copying the file itself when a resource is published to Falcon.

Read more...


IIIF

IIIF is an API specification that aims to improve interoperability between digital image repositories. ResourceSpace provides basic support for the IIIF presentation API, which was originally created to link with the TMS plugin to enable publishing of resources related to a specified TMS object as a IIIF manifest.

Read more...


Troubleshooting

The article provides a troubleshooting guide for common issues encountered while using ResourceSpace. The guide suggests visiting the Installation Check page to resolve any error messages, checking server logs to resolve error code 500, and ensuring the latest version of ResourceSpace is being used by running the command 'svn update' in the web root.

Read more...


Migrating free text data to fixed list field options

The article explains how to migrate free text data to fixed list field options when changing a metadata field type from a free text field to a fixed option field type. The fixed option field types include checkbox, radio button, dropdown, and dynamic tag list.

Read more...


set_node

The article provides information on the set_node function, which is used to create a new node in ResourceSpace. The function requires the ID of the node to be updated, the ID of the related metadata field, and the name of the node.

Read more...


resource_log_last_rows

adding information on the log codes recorded in the type field

Read more...


User opt-in consent

The article discusses the configuration option for user opt-in consent, which is enabled by default in certain data protection regulations such as the General Data Protection Regulation (GDPR). The configuration option requires users to give consent for their personal data to be processed before they can submit an account request.

Read more...


 Image banks

The Image Banks plugin allows users to search external image banks for photos without having to navigate manually to the external system. Users can run searches in the external image bank using the simple search box and the dropdown selector called "Search external image banks".

Read more...


General installation requirements

ResourceSpace requires a MySQL compliant database, a web server, and PHP to operate on the LAMP stack. The supported versions of PHP are 7.4, 8.0, and 8.1, and the following PHP extensions are required: php-mysqli, php-curl, php-dom, php-gd, php-intl, php-mbstring, php-xml, php-zip, php-ldap, php-imap, php-json, php-apcu, and php-cli.

Read more...


What file formats can be uploaded to ResourceSpace?

ResourceSpace allows any type of file to be uploaded except for banned extensions such as php, cgi, pl, exe, asp, jsp, sh, and bash. The list of banned extensions can be changed using the config option $banned_extensions.

Read more...


ResourceSpace messages

ResourceSpace uses messages to ensure that notifications are prominently displayed so that important messages are not overlooked. A counter next to the user's profile will increase to indicate the activity as new messages are received.

Read more...


Emails

ResourceSpace uses emails to notify users of relevant activity such as resource submissions, user account requests, or resource download requests. However, most email notifications have been replaced by system messages, but users can still opt to receive emails by modifying their user preferences.

Read more...


Configuring email and messaging

This article provides guidance on how to configure email and messaging settings in ResourceSpace. To change the email address that system emails are sent from, users should navigate to Admin > System > System configuration and change the 'Email from address'.

Read more...


All user permissions

ResourceSpace is a digital asset management system that allows users to control which resources other users can see and how they can interact with them. The system offers a range of permission options, including search, metadata fields, resource types, resource creation, featured collections, restrictive permissions, and administration.

Read more...


The config file

The article provides an overview of the configuration file for ResourceSpace, which can be found in the 'include' folder. The file contains various PHP variables that can be changed to configure the system.

Read more...


TMS link

Help for setting up the tms_link plugin.

Read more...


CSV export

ResourceSpace allows users to extract metadata from its database as a CSV file, which can be opened in most standard spreadsheet or database programs. The metadata fields included in the CSV file can be customised by editing metadata fields and enabling the "Include in CSV export" option.

Read more...


Logs

ResourceSpace has a log that records the actions of each user, which is accessible in the Users section of the Admin area. The logs record the date and time of user logins, resources they have created, deleted and downloaded, and edits they have made to resources, showing both the previous and new values.

Read more...


Upload here

ResourceSpace has introduced a new feature called "Upload here" that helps users create new resources based on a recent advanced search. The feature directs users to the upload page where the options will have been automatically selected, meaning they can easily add more resources that this metadata set describes.

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...


Browse bar

ResourceSpace has introduced a browse bar to help users find resources more easily. The bar is a collapsible side tab available from all pages, offering the options to search by resource type, tag, collection or workflow state.

Read more...


 Adobe link

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

Read more...


Resource commenting

Resource commenting can be enabled in ResourceSpace by using the config option $comments_resource_enable. This feature adds a new area below the resource metadata, allowing users to add and respond to comments about the resource.

Read more...


 Image text

The Image Text plugin enables metadata fields to be included as captions when a resource is downloaded. The plugin can be configured to apply captions to specific resource types and file extensions, and to extract text from a chosen field, such as the title.

Read more...


 Grant edit

The Grant Edit plugin allows administrators to grant edit access to a user or user group for the metadata of a resource they would not normally have permission to edit. Plugin settings determine which user group has the ability to grant edit access to the resource and to remove access previously granted.

Read more...


Checkmail

The Checkmail plugin has been developed to expand ResourceSpace's capabilities by enabling the ingestion of resources using email. The plugin allows devices to contribute digital assets to the system, and provides advanced configuration options and the ability to handle a wide range of email types.

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...


 Conditional terms

Montala has launched a plugin that enables users to make acceptance of terms and conditions necessary prior to downloading certain resources based on their metadata. The plugin configuration allows users to select a metadata field value which, when met, will require the terms to be accepted.

Read more...


Coding standards v1.3

The article provides coding standards for developers working on the ResourceSpace project. The standards cover various aspects of coding, including security, documentation, functionality, PHP version, MySQL strict mode, backward compatibility, file format, coding style, indentation, line length, control structures, function calls, function definitions, MySQL statements, readability of code blocks, returning early, and avoiding cross-site scripting vulnerabilities.

Read more...


 Auto assign

The autoassign_mrequests plugin enables managed resource requests to be automatically assigned to a specific user for approval, based on a metadata field value mapping. The user to which the request is assigned must be in a user group able to access the admin area and with the permissions to manage requests and to be assigned resource requests.

Read more...


 1. Finding your way around

An overview of the ResourceSpace user interface.

Read more...


 2. Uploading and editing

We can simply drag and drop the files or an entire folder directly from our computer on to the upload queue.

Read more...


 3. File sizes and formats

When we click on a resource we are shown all the available metadata for that resource, and also a list of available versions.

Read more...


 4. Sharing and collections

Sharing single resources is very straightforward. We can send the resource to other users of the system, but we can also enter e-mail addresses and share with people that are not users of the system. They receive a special link that allows them to access only the resource you've shared with them.

Read more...


 5. Working with collections

There are various actions that can be performed that will affect the items in the collection, available from an actions menu on the collection bar.

Read more...


 7. Reporting

ResourceSpace include comprehensive reporting and analytics capabilities.

Read more...


File integrity checking

ResourceSpace has a tool to verify the file integrity of primary resource files, which notifies users of any corruption and allows them to take remedial action. To configure the system to check file integrity, users need to have full file checksums configured, the ResourceSpace cron script configured to run frequently as a cron task or scheduled task, and the file integrity verify window enabled to set the hours between which the script will run.

Read more...


The Complete Guide to Developing Your Brand Guidelines

Your brand characterises your business. Without it, your products and services become indistinguishable from those offered by competitors.

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...


replace_resource_file

The article describes the function 'replace_resource_file' which replaces the primary resource file for a given resource. The function requires the ID of the resource to replace the file for and the file path or URL of the file to use as the replacement.

Read more...


Debugging ResourceSpace

The article provides three methods for debugging ResourceSpace, an open-source digital asset management system. The first method is to use the internal function called debug(), which writes debug text to a file specified in the config file.

Read more...


get_node_id

The get_node_id function is used to find a node ID in a fixed tag field by providing the name of the node and the ID of the related metadata field. The function returns the ID of the existing node or boolean FALSE if no matching node was found for the specified field.

Read more...


Checksums

Checksums are a sequence of numbers and letters that are produced by running a file through an algorithm that uses a cryptographic hash to create a unique identifier. Even the slightest change in the original file will produce a different checksum, making them useful for ensuring file integrity and preventing resource duplication.

Read more...


 Track field history

The track field history plugin is a tool that allows users to easily view the history of metadata for a resource by breaking it down by field. Users can select which fields to track and a History link will be placed next to those fields on the resource details panel of the resource view page.

Read more...


Exporting data

ResourceSpace allows users to export data and configuration files for testing purposes. This feature requires offline jobs to be configured and the config option $system_download_config to be enabled. Users can navigate to Admin > System > Export data to choose the options for the exported data.

Read more...


Injection

Injection attacks are a type of attack vector that occur when an attacker can send hostile data to an interpreter as part of a command or query, which alters the execution of that program. The most common injection flaws are cross-site scripting (XSS), SQL injections (SQLi), command injections which can lead to remote code execution (RCE) vulnerabilities, and LDAP injections.

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...


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...


Creating and editing filters

Creating and editing filters. Filters can be set to control access to resources

Read more...


Digital object identifier

The Digital Object Identifier (DOI) is a unique alphanumeric string that is used to permanently identify an object and link it to its metadata and digital location. The DOI plugin enables users to create DOIs for their resources individually or in bulk as a collection action.

Read more...


Resource locking

Resource locking is a feature that allows users with edit access to lock resources to prevent other users from editing them and causing metadata conflicts. Once a resource is locked, metadata cannot be changed, and alternative files cannot be managed.

Read more...


put_resource_data

The put_resource_data API endpoint allows users with edit access to update the properties of a resource. The endpoint requires the ID of the resource and an associative array of columns and values in JSON format.

Read more...


Project structure

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

Read more...


Fixed list fields

ResourceSpace has various metadata field types, including text boxes, check box lists, dropdown lists, date fields, category trees, and radio button lists. Some of these fields can have their options defined by an administrator of the system, and these fields are called fixed list fields.

Read more...


Downloading multiple resources

Users can download multiple resources in one go by adding the resources to a collection or selecting a number of resources from the search results page and clicking on 'Download' from the 'Actions' dropdown box.

Read more...


Extracted text

ResourceSpace, a digital asset management software, can extract text from document files and use it to populate metadata fields. This feature enables users to search for resource contents within the system and by applied metadata tags.

Read more...


Anonymous access

ResourceSpace has introduced anonymous access, which allows non-registered users to access the system without requiring a login. The feature is useful for those who frequently work with third-party agencies and do not want to create new user accounts, or for those who want to make selected resources available to the public.

Read more...


 Sharing upload links

ResourceSpace has introduced a new feature that allows users to share upload links externally. This feature enables external media creators to upload files into ResourceSpace without requiring an account.

Read more...


My Profile

The My Profile page in ResourceSpace allows users to configure their user profile to collaborate more effectively with team members and other users. The page has two fields: Profile/Bio and Profile image.

Read more...


RSS Feed

The RSS Feed plugin generates RSS URLs for a resource search in ResourceSpace using the API. After enabling the plugin, a new link appears at the bottom of the Simple Search area, which takes the user to the RSS feed for the 50 most recently uploaded resources.

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...


 Image tools

The Image Tools plugin enables users to edit images by rotating, cropping or scaling them. The plugin also allows users to modify the home slideshow image using resources that have previously been uploaded to ResourceSpace.

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...


Messaging

The article provides instructions on how to view and send messages on a website. To view messages, users need to click on the user profile icon and select "Messages". Messages are listed in date order, newest first, and users can mark them as read, delete them, or reply to them.

Read more...


Mobile responsive mode

ResourceSpace, the open source digital asset management software, is now available on mobile devices. The software's interface automatically adjusts to account for the smaller screen, but the functionality remains the same.

Read more...


Speed tagging

Speed tagging is a feature that can be enabled by system administrators to help users add metadata to resources without requiring edit access. It places a link in the top navigation bar that directs users to all resources that do not have an entry in a nominated metadata field.

Read more...


Offline archive

The Offline Archive plugin allows users to relocate archived files to an offline location. Once enabled, users can configure the plugin to specify how the relocation will occur. There are four configuration options available: selecting the metadata field that will hold the archive reference code, entering the location that the archives will be created in, specifying a subfolder of the StaticSync folder that restored files will be placed in, and determining whether to carry across the timestamp of the original file.

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...


get_nodes

The get_nodes function retrieves all nodes from a database for a specific metadata field or parent. The function takes several parameters, including the ID of the metadata field, the ID of the parent node, a boolean flag to indicate whether to retrieve children nodes, an offset value to specify the first row to return, a maximum number of rows to return, a filter by name of node, a flag to show how many resources use a particular node in the node properties, and a flag to order by translated names rather than the order_by column.

Read more...


 The Digital Asset Management Buyer's Guide

In this guide we look at what DAM software actually is, the problems it solves and some questions to ask a vendor before making a buying decision.

Read more...


Integrating ResourceSpace with RightMarket

Create branded marketing materials, including posters, social graphics or point of sale materials, with ResourceSpace's RightMarket integration.

Read more...


Prepared statements

ResourceSpace, an open-source digital asset management software, has announced that all new code must use prepared statements for any SQL execution. The new functions ps_query(), ps_array() and ps_value() replace functions sql_query(), sql_array() and sql_value() respectively.

Read more...


Managing resource requests notifications

Resource requests notifications in ResourceSpace v10+ can now be managed using a metadata field value. The metadata field is designated to hold information that the system can use to determine the user group responsible for a resource.

Read more...


API Webhooks

API Webhooks is a plugin that allows developers to synchronise data between ResourceSpace and third-party systems. The plugin enables remote scripts to be called from within ResourceSpace, allowing users to drive the timing of the synchronisation between the two systems.

Read more...


Full text searching

ResourceSpace has changed the way it handles long text stored in metadata fields. From version 10.1, keywords (tags) will only be processed for the first 500 characters of any text. To search the full text, there is a new option on the advanced search page that will utilise native database full-text indexing.

Read more...


 Video timestamp links

The article discusses a plugin that enables the use of timestamp links on videos in ResourceSpace. The plugin allows users to bookmark specific points in a video and add them to an appropriate metadata field, such as a caption or long description field.

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...


What is Digital Asset Management?

Explore the world of Digital Asset Management (DAM) and its pivotal role in organising and securing digital assets. Dive into its benefits, practical applications, and how it streamlines the asset management process.

Read more...


Do you need a Digital Asset Management system? Find out here.

A Digital Asset Management (DAM) system can help organizations overcome various challenges related to managing digital assets. These challenges may include difficulties in finding specific files, using outdated assets, licensing and copyright issues, and sharing large files with external contacts.

Read more...


upload_multipart

The "upload_multipart" function allows users to upload files using HTTP multipart to an existing resource. This function is available from version 10.2+ of the software. The function requires several variables to be provided, including the ID of the resource, a boolean value to indicate whether to process embedded metadata, a boolean value to indicate whether to re-process the existing file, and the file to be uploaded.

Read more...


get_resource_type_fields

The "get_resource_type_fields" function allows users to retrieve metadata field information for all matching fields. This function is available from version 10.3+ and requires permission "a". Users can filter the results by resource type, fuzzy searching, and field type.

Read more...


create_resource_type_field

The article provides information about the "create_resource_type_field" function. This function allows users to retrieve metadata field information for all matching fields. It is available from version 10.

Read more...


Configuring the download filename format

ResourceSpace version 10.3 introduces a new system-wide configuration that allows administrators to format the final download filename. This configuration applies to resources and their alternatives, including preview sizes.

Read more...


A Comprehensive Guide to Digital Curation: Tools and Techniques

Explore the world of digital curation. Learn about the concepts, tools, and techniques used to curate and preserve historical and culturally significant assets.

Read more...


I'm receiving too many notifications - help!

The article provides instructions on how to control and manage notifications in a system. It explains that notifications can be customized through the personal menu and preferences settings. Users can enable or disable options for receiving notifications via emails, in-system messages, and in-system actions.

Read more...


How do I publish resources that have been uploaded in bulk?

To publish resources that have been uploaded in bulk, you can go to the "Actions" area in your profile. There are three options available: managing your preferences, adding the resources to a collection, or viewing them as a result set.

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...


Can I change which fields are shown in List view?

The article explains that most metadata fields can be added as column headings in list view on the search results page. This can be done through configuration in the back end of the system. If the user has a support contract, they can ask their account manager to set it up for them.

Read more...


get_edit_access

The "get_edit_access" function is used to check if the current user has edit access to a resource. It checks both the edit permissions and the group edit filter. The function takes a resource ID as a parameter and returns TRUE if the user has edit access to the resource, and FALSE otherwise.

Read more...


consentmanager_get_consents

The "consentmanager_get_consents" function is used to retrieve all consent data for a given resource. The function takes a variable called "$resource" which represents the ID of the resource. The data type for this variable is an integer.

Read more...


licensemanager_get_licenses

The article provides information about the "licensemanager_get_licenses" function, which is used to return all licenses held for a given resource. The function takes a variable called "$resource" as input, which represents the ID of the resource.

Read more...


How do I edit multiple resources at the same time?

To edit multiple resources at the same time in ResourceSpace, you can add the selected resources to a collection and then choose "Edit all resources" from the collection actions menu. Alternatively, you can edit resources directly from the search results page by selecting the checkbox next to each resource or using Shift + click to select multiple resources before clicking on the "Edit selected" button.

Read more...


Table: resource_type_field

Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 10794 tokens. Please reduce the length of the messages.

Read more...


Table: annotation_node

The article provides information about the "annotation_node" table, which is a join table that connects resource annotations to keyword nodes for annotating resources with fixed list metadata. The table has two columns: "annotation" and "node," both of which are of type "int(11).

Read more...


Table: keyword

Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 13661 tokens. Please reduce the length of the messages.

Read more...


Table: node

Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, your messages resulted in 10911 tokens. Please reduce the length of the messages.

Read more...


Table: resource

The article provides a table of the resource, which is the central record within ResourceSpace mapping to a single asset/file. The table includes various columns such as ref, title, resource_type, has_image, is_transcoding, hit_count, new_hit_count, creation_date, rating, user_rating, user_rating_count, user_rating_total, country, file_extension, preview_extension, image_red, image_green, image_blue, thumb_width, thumb_height, archive, access, colour_key, created_by, file_path, file_modified, file_checksum, request_count, expiry_notification_sent, preview_tweaks, geo_lat, geo_long, mapzoom, disk_usage, disk_usage_last_updated, file_size, preview_attempts, modified, last_verified, integrity_fail, and lock_user.

Read more...


Table: resource_data

The resource_data table is a database table in ResourceSpace that stores free text metadata for a resource. It has three columns: resource, resource_type_field, and value. The resource column is a foreign key that references the resource table, while the resource_type_field column is a foreign key that references the resource_type_field table.

Read more...


Table: resource_keyword

The article provides information about the "resource_keyword" table, which is used to store indexed keywords for free text metadata. The table has six columns, including "resource," which is a foreign key referencing the "resource" table, and "keyword," which is a foreign key referencing the "keyword" table.

Read more...


Table: resource_node

The resource_node table in ResourceSpace links fixed metadata nodes with resources to store metadata for fixed metadata types such as dropdowns. The table has three columns: resource, node, and hit_count.

Read more...


Table: resource_type

This article provides a table of the resource_type database schema used in ResourceSpace, a digital asset management system. The resource_type table contains information about the types of resources, such as photo, video, or case study, and determines the metadata fields that a resource has.

Read more...


Table: usergroup

The article provides a table called "usergroup" that defines user groups. The table contains several columns, including "ref," which is an auto-incrementing index, "name," which is the name of the user group, and "permissions," which is a list of permissions that the user group has.

Read more...


Table: tab

This article provides information about the "tab" table, which is used for organising metadata fields on the edit and view pages. The table has three columns: "ref", which is an auto-incrementing index; "name", which is a varchar(255) type; and "order_by", which is an integer type.

Read more...


I've missed out an important keyword. Can I add this to my resource(s) after I've published them?

The article explains that it is possible to add keywords to resources after they have been published. Users can make metadata edits at any time by choosing the "Edit metadata" option from the individual resource preview.

Read more...


 YT2RS (Youtube embed)

The Youtube to ResourceSpace plugin allows users to embed a YouTube video into the Resource view page. Users can enter the ID of a metadata field that stores the URL of the Youtube video on the options page for the plugin.

Read more...


VM2RS (Vimeo embed)

The VM2RS plugin is a Vimeo to ResourceSpace plugin that allows users to embed Vimeo videos on the Resource view page. Users can enter the ID of a metadata field that stores the URL of the Vimeo video on the options page for the plugin.

Read more...


ResourceSpace file storage (filestore)

ResourceSpace stores resource files in obfuscated folder paths on the server and not in the database. The folders are not meaningful to an administrator browsing the folders on the server because they are derived from the unique resource ID and are not related in any way to metadata or collections that the resources belong to.

Read more...


Custom fields ("user" defined)

ResourceSpace, a digital asset management system, allows users to configure custom fields. These fields can be used to add additional metadata to assets, such as images or documents, and can be used to filter and search for specific assets.

Read more...


update_resource_type_field_order()

Developer reference for function update_resource_type_field_order()

Read more...


annotationEditable()

Developer reference for function annotationEditable()

Read more...


prepareTags()

Developer reference for function prepareTags()

Read more...


execute_api_call()

Developer reference for function execute_api_call()

Read more...


iiif_get_canvases()

Developer reference for function iiif_get_canvases()

Read more...


iiif_get_thumbnail()

Developer reference for function iiif_get_thumbnail()

Read more...


iiif_get_image()

Developer reference for function iiif_get_image()

Read more...


add_resource_to_collection()

Developer reference for function add_resource_to_collection()

Read more...


remove_resource_from_collection()

Developer reference for function remove_resource_from_collection()

Read more...


delete_collection()

Developer reference for function delete_collection()

Read more...


save_collection()

Developer reference for function save_collection()

Read more...


get_smart_themes_nodes()

Developer reference for function get_smart_themes_nodes()

Read more...


add_saved_search_items()

Developer reference for function add_saved_search_items()

Read more...


update_collection_user()

Developer reference for function update_collection_user()

Read more...


compile_collection_actions()

Developer reference for function compile_collection_actions()

Read more...


collection_download_use_original_filenames_when_downloading()

Developer reference for function collection_download_use_original_filenames_when_downloading()

Read more...


update_zip_progress_file()

Developer reference for function update_zip_progress_file()

Read more...


collection_download_process_data_only_types()

Developer reference for function collection_download_process_data_only_types()

Read more...


collection_download_process_summary_notes()

Developer reference for function collection_download_process_summary_notes()

Read more...


collection_download_process_command_to_file()

Developer reference for function collection_download_process_command_to_file()

Read more...


collection_download_clean_temp_files()

Developer reference for function collection_download_clean_temp_files()

Read more...


comments_submit()

Developer reference for function comments_submit()

Read more...


get_header_image()

Developer reference for function get_header_image()

Read more...


generateNodesExport()

Developer reference for function generateNodesExport()

Read more...


create_dash_tile()

Developer reference for function create_dash_tile()

Read more...


build_usergroup_dash()

Developer reference for function build_usergroup_dash()

Read more...


render_dash_tile_colour_chooser()

Developer reference for function render_dash_tile_colour_chooser()

Read more...


generate_dash_tile_toolbar()

Developer reference for function generate_dash_tile_toolbar()

Read more...


db_use_multiple_connection_modes()

Developer reference for function db_use_multiple_connection_modes()

Read more...


sql_connect()

Developer reference for function sql_connect()

Read more...


clear_query_cache()

Developer reference for function clear_query_cache()

Read more...


rsDecrypt()

Developer reference for function rsDecrypt()

Read more...


prepareFaceImage()

Developer reference for function prepareFaceImage()

Read more...


get_checksum()

Developer reference for function get_checksum()

Read more...


formatfilesize()

Developer reference for function formatfilesize()

Read more...


filesize2bytes()

Developer reference for function filesize2bytes()

Read more...


format_display_field()

Developer reference for function format_display_field()

Read more...


job_queue_run_job()

Developer reference for function job_queue_run_job()

Read more...


generateSecureKey()

Developer reference for function generateSecureKey()

Read more...


IsModal()

Developer reference for function IsModal()

Read more...


text()

Developer reference for function text()

Read more...


logScript()

Developer reference for function logScript()

Read more...


resource_log_last_rows()

Developer reference for function resource_log_last_rows()

Read more...


message_add()

Developer reference for function message_add()

Read more...


message_seen_all()

Developer reference for function message_seen_all()

Read more...


message_purge()

Developer reference for function message_purge()

Read more...


runFitsForFile()

Developer reference for function runFitsForFile()

Read more...


check_date_format()

Developer reference for function check_date_format()

Read more...


check_date_parts()

Developer reference for function check_date_parts()

Read more...


check_view_display_condition()

Developer reference for function check_view_display_condition()

Read more...


populate_resource_nodes()

Developer reference for function populate_resource_nodes()

Read more...


migrate_filter()

Developer reference for function migrate_filter()

Read more...


get_export_tables()

Developer reference for function get_export_tables()

Read more...


set_node()

Developer reference for function set_node()

Read more...


delete_node()

Developer reference for function delete_node()

Read more...


get_nodes()

Developer reference for function get_nodes()

Read more...


get_node_order_by()

Developer reference for function get_node_order_by()

Read more...


draw_tree_node_table()

Developer reference for function draw_tree_node_table()

Read more...


node_field_options_override()

Developer reference for function node_field_options_override()

Read more...


add_node_keyword()

Developer reference for function add_node_keyword()

Read more...


check_node_indexed()

Developer reference for function check_node_indexed()

Read more...


copy_resource_nodes()

Developer reference for function copy_resource_nodes()

Read more...


copy_resource_type_field_nodes()

Developer reference for function copy_resource_type_field_nodes()

Read more...


get_nodes_count()

Developer reference for function get_nodes_count()

Read more...


get_node_by_name()

Developer reference for function get_node_by_name()

Read more...


generate_pdf()

Developer reference for function generate_pdf()

Read more...


process_template()

Developer reference for function process_template()

Read more...


activate_plugin()

Developer reference for function activate_plugin()

Read more...


get_plugin_yaml()

Developer reference for function get_plugin_yaml()

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...


render_search_field()

Developer reference for function render_search_field()

Read more...


render_actions()

Developer reference for function render_actions()

Read more...


is_field_displayed()

Developer reference for function is_field_displayed()

Read more...


display_field()

Developer reference for function display_field()

Read more...


render_date_range_field()

Developer reference for function render_date_range_field()

Read more...


renderLockButton()

Developer reference for function renderLockButton()

Read more...


render_field_selector_question()

Developer reference for function render_field_selector_question()

Read more...


render_upload_here_button()

Developer reference for function render_upload_here_button()

Read more...


render_browse_bar()

Developer reference for function render_browse_bar()

Read more...


render_custom_fields()

Developer reference for function render_custom_fields()

Read more...


render_selected_collection_actions()

Developer reference for function render_selected_collection_actions()

Read more...


check_display_condition()

Developer reference for function check_display_condition()

Read more...


display_upload_options()

Developer reference for function display_upload_options()

Read more...


display_field_data()

Developer reference for function display_field_data()

Read more...


send_periodic_report_emails()

Developer reference for function send_periodic_report_emails()

Read more...


get_user_requests()

Developer reference for function get_user_requests()

Read more...


managed_collection_request()

Developer reference for function managed_collection_request()

Read more...


get_valid_custom_fields()

Developer reference for function get_valid_custom_fields()

Read more...


get_resource_path()

Developer reference for function get_resource_path()

Read more...


get_resource_data()

Developer reference for function get_resource_data()

Read more...


put_resource_data()

Developer reference for function put_resource_data()

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...


add_keyword_to_resource()

Developer reference for function add_keyword_to_resource()

Read more...


update_field()

Developer reference for function update_field()

Read more...


delete_resource()

Developer reference for function delete_resource()

Read more...


get_resource_field_data()

Developer reference for function get_resource_field_data()

Read more...


get_resource_field_data_batch()

Developer reference for function get_resource_field_data_batch()

Read more...


get_resource_top_keywords()

Developer reference for function get_resource_top_keywords()

Read more...


copy_resource()

Developer reference for function copy_resource()

Read more...


get_exiftool_fields()

Developer reference for function get_exiftool_fields()

Read more...


createTempFile()

Developer reference for function createTempFile()

Read more...


update_resource()

Developer reference for function update_resource()

Read more...


get_resource_access()

Developer reference for function get_resource_access()

Read more...


resource_download_allowed()

Developer reference for function resource_download_allowed()

Read more...


get_edit_access()

Developer reference for function get_edit_access()

Read more...


log_diff()

Developer reference for function log_diff()

Read more...


autocomplete_blank_fields()

Developer reference for function autocomplete_blank_fields()

Read more...


get_resource_files()

Developer reference for function get_resource_files()

Read more...


reindex_resource()

Developer reference for function reindex_resource()

Read more...


get_page_count()

Developer reference for function get_page_count()

Read more...


update_disk_usage()

Developer reference for function update_disk_usage()

Read more...


update_disk_usage_cron()

Developer reference for function update_disk_usage_cron()

Read more...


notify_user_resources_approved()

Developer reference for function notify_user_resources_approved()

Read more...


generate_resource_access_key()

Developer reference for function generate_resource_access_key()

Read more...


copyAllDataToResource()

Developer reference for function copyAllDataToResource()

Read more...


copyResourceDataValues()

Developer reference for function copyResourceDataValues()

Read more...


copy_locked_fields()

Developer reference for function copy_locked_fields()

Read more...


get_field_options()

Developer reference for function get_field_options()

Read more...


get_data_by_field()

Developer reference for function get_data_by_field()

Read more...


get_fields()

Developer reference for function get_fields()

Read more...


get_hidden_indexed_fields()

Developer reference for function get_hidden_indexed_fields()

Read more...


get_nopreview_icon()

Developer reference for function get_nopreview_icon()

Read more...


get_resource_type_fields()

Developer reference for function get_resource_type_fields()

Read more...


get_download_filename()

Developer reference for function get_download_filename()

Read more...


get_resource_type_from_extension()

Developer reference for function get_resource_type_from_extension()

Read more...


delete_resource_type_field()

Developer reference for function delete_resource_type_field()

Read more...


tab_names()

Developer reference for function tab_names()

Read more...


get_resource_table_joins()

Developer reference for function get_resource_table_joins()

Read more...


get_advanced_search_fields()

Developer reference for function get_advanced_search_fields()

Read more...


search_form_to_search_query()

Developer reference for function search_form_to_search_query()

Read more...


compile_search_actions()

Developer reference for function compile_search_actions()

Read more...


search_filter()

Developer reference for function search_filter()

Read more...


search_special()

Developer reference for function search_special()

Read more...


cleanse_string()

Developer reference for function cleanse_string()

Read more...


add_partial_index()

Developer reference for function add_partial_index()

Read more...


str_highlight()

Developer reference for function str_highlight()

Read more...


get_simple_search_fields()

Developer reference for function get_simple_search_fields()

Read more...


get_fields_for_search_display()

Developer reference for function get_fields_for_search_display()

Read more...


get_filters()

Developer reference for function get_filters()

Read more...


save_filter()

Developer reference for function save_filter()

Read more...


save_filter_rule()

Developer reference for function save_filter_rule()

Read more...


get_slideshow_image_file_path()

Developer reference for function get_slideshow_image_file_path()

Read more...


new_user()

Developer reference for function new_user()

Read more...


get_rs_session_id()

Developer reference for function get_rs_session_id()

Read more...


get_notification_users()

Developer reference for function get_notification_users()

Read more...


render_table()

Developer reference for function render_table()

Read more...


allow_collection_share()

Developer reference for function allow_collection_share()

Read more...


allow_featured_collection_share()

Developer reference for function allow_featured_collection_share()

Read more...


render_featured_collections()

Developer reference for function render_featured_collections()

Read more...


compute_featured_collections_acess_control()

Developer reference for function compute_featured_collections_acess_control()

Read more...


compute_node_branch_path()

Developer reference for function compute_node_branch_path()

Read more...


get_resource_data_batch()

Developer reference for function get_resource_data_batch()

Read more...


update_fieldx()

Description updates the value of fieldx field further to a metadata field value update Parameters Column Type Default Description $metadata_field_ref: int get_resource_table_joins $metadata_field_ref integer - metadata field ref Location include/metadata_functions.

Read more...


get_languages_notify_users()

Description load language files for all users that need to be notified into an array - use for message and email notification load in default language strings first and then overwrite with preferred language strings Parameters Column Type Default Description $languages array array - array of language strings Return array $language_strings_all This article was last updated 28th February 2024 08:05 Europe/London time based on the source file dated 27th February 2024 17:30 Europe/London time.

Read more...


Frequently Asked Questions (FAQs)

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

Read more...


config_register_core_field_refs()

Description Used to block deletion of 'core' fields. Parameters Column Type Default Description $source string What part (e.

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...


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...


set_unique_filename()

Description Ensures filename is unique in $filenames array and adds resulting filename to the array Parameters Column Type Default Description &$filename &$filenames $filename string Requested filename to be added.

Read more...


leaflet_osm_basemaps()

Parameters Column Type Default Description OpenStreetMap // { '" detectRetina: 19 maxZoom: osm_attribute attribution: 18 maxZoom: 20 maxZoom: osm_fr_attribute attribution: L.

Read more...


leaflet_markers_legend()

Parameters This function accepts no parameters. Location include/map_functions.php lines 502 to 532 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...


header_add_map_providers()

Parameters This function accepts no parameters. Location include/map_functions.php lines 534 to 683 Definition   function  header_add_map_providers ()     {     global  $geo_leaflet_sources ,  $baseurl ,  $geo_tile_caching ;      ?>     <script>     // Copied from leaflet-providers.

Read more...


debug_stringify()

Description Stringify variables for use in the debug log. This is used more as fallback to json_encode() failing to maintain quick readability of the logs. Parameters Column Type Default Description $value mixed Any value that needs stringified Return string Location include/debug_functions.

Read more...


debug_track_vars()

Description Debug log tracked variables (as configured in System > System console). IMPORTANT: the debug log will contain the JSON encoded version of the tracked variable. For further analysis, just copy the value (ie.

Read more...


get_job_type_priority()

Description Get the default priority for a given job type Parameters Column Type Default Description $type string "" Name of job type e.

Read more...


exiftool_resolution_calc()

Description Set resource dimensions using data from exiftool. Parameters Column Type Default Description $file_path string Path to the original file.

Read more...


collection_add_resources()

Description Add resource(s) $resources to collection $collection Parameters Column Type Default Description $collection mixed $resources mixed '' $search '' $selected false Return boolean | string Location include/collections_functions.

Read more...


collection_remove_resources()

Description collection_remove_resources Parameters Column Type Default Description $collection mixed $resources mixed '' $removeall mixed false $selected false Return boolean | string Location include/collections_functions.

Read more...


tltype_srch_generate_js_for_background_and_count()

Description Generate client side logic for doing expensive computation async for retrieving the tile background and total results count. Parameters Column Type Default Description $tile array Tile information {@see pages/ajax/dash_tile.

Read more...


temp_local_download_remote_file()

Description Download remote file to the temp filestore location. Parameters Column Type Default Description $url string Source URL $key string "" Optional key to use - to prevent conflicts when simultaneous calls use same file name Return string|bool Returns the new temp filestore location or false otherwise.

Read more...


get_approver_usergroups()

Description Returns an array of the user groups the supplied user group acts as an approver for. Uses config $usergroup_approval_mappings. Parameters Column Type Default Description $usergroup int "" Approving user group Return array Array of subordinate user group ids.

Read more...


get_usergroup_approvers()

Description Returns an array of user groups who act as user request approvers to the user group supplied. Uses config $usergroup_approval_mappings. Parameters Column Type Default Description $usergroup int "" Subordinate user group who's approval user group we need to find.

Read more...


find_root_comment()

Description Find the root of a comment tree that the ref provided is a part of Parameters Column Type Default Description $ref int ref of a comment Return int|null ref of the root comment or null if the comment tree has been completely removed / the comment being checked has already been deleted.

Read more...


eval_check_signed()

Description Prior to eval() checks to make sure the code has been signed first, by the offline script / migration script. Parameters Column Type Default Description $code string The code to check Return string The code, if correctly signed, or an empty string if not.

Read more...


resign_all_code()

Description Returns a signature for a given block of code. Parameters Column Type Default Description $confirm bool true Require user to approve code changes when resigning from the server side.

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...


 Manage (system) tabs

The article provides guidance on managing system tabs in version 10+ of the system. Tabs can be used by metadata fields and resource types, and to manage them, users should go to Admin > System > Tabs.

Read more...


delete_unused_non_fixed_list_nodes()

Description Delete unused non-fixed list field nodes with a 1:1 resource association Parameters Column Type Default Description $resource_type_field integer Resource type field (metadata field) ID Location include/node_functions.

Read more...


update_resource_field_column()

The update_resource_field_column() function is used to update the value of a specific metadata field on a resource table. It takes three parameters: the resource ID, the metadata field ID, and the new value.

Read more...


can_use_owner_field()

The can_use_owner_field() function is used for initialization and system checks to ensure that the configuration is correctly enabled to use the owner field and mappings logic. The function accepts no parameters and returns a boolean value.

Read more...


get_notification_users_by_owner_field()

The get_notification_users_by_owner_field() function is used to retrieve users to notify for requested resources owned by particular groups. The function takes two parameters: an array of notification users and an array of resource IDs.

Read more...


setup_search_chunks()

The function `setup_search_chunks()` allows `$fetchrows` to support an integer or array. If an integer is supplied, the search will receive the number of rows with no offset. If an array is supplied, the search will receive the number of rows to return and an offset, allowing for chunking of results.

Read more...


canSeeAnnotationsFields()

The canSeeAnnotationsFields() function is a helper function that determines whether annotations are to be displayed. It takes an array of annotation fields as a parameter and returns an array of annotation fields that can be viewed.

Read more...


display_related_resources()

Description Render all related resources on view page Parameters Column Type Default Description $context array Array with all required info from the view page Return void * Location include/render_functions.

Read more...


update_resource_type_field_resource_types()

Description Update the resource_type_field - resource_type mappings Parameters Column Type Default Description $ref int Resource type field ref $resource_types array Array of resource type refs Return void * Location include/config_functions.

Read more...


save_resource_type()

Description Save updated resource_type data Parameters Column Type Default Description $ref int Ref of resource type $savedata array Array of column values Return bool * Location include/config_functions.

Read more...


save_resource_type_field()

Description Save resource type field - used on pages/admin/admin_resource_type_field_edit.php Parameters Column Type Default Description $ref int Field ID $columns array Array of column data bool $postdata: $migrate_data $onload_message $lang true; []; foreach$resource_types as $resource_type true false $postdata mixed POST'd data Return bool * Location include/config_functions.

Read more...


cleanup_invalid_nodes()

Description Remove invalid field data from resources, optionally just for the specified resource types and/or fields Parameters Column Type Default Description $fields array [] $restypes array [] $dryrun bool false Don't delete, just return count of rows that will be affected $fields=[] array Array of resource_type_field refs $restypes=[] array Array of resource_type refs Return int Count of rows deleted/to delete Location include/node_functions.

Read more...


admin_resource_type_field_constraint()

Description Display appropriate field constraint for use on admin_resource_type_field_edit.php e.g. single select/Number Parameters Column Type Default Description $ref int $currentvalue: int array"i" 0 "schema"; Metadata int field ID Current int field type Return void * Location include/render_functions.

Read more...


admin_resource_type_field_option()

Description Render metadata field option input on admin_resource_type_field_edit.php Parameters Column Type Default Description $propertyname string Field property/column name $propertytitle string Title $helptext string Help text $type mixed Input type (0=text,1=boolean,2=text area) $currentvalue mixed Current field setting $fieldtype int Field type.

Read more...


get_resource_type_field_columns()

Parameters This function accepts no parameters. Location include/config_functions.php lines 1790 to 1842 Definition   function  get_resource_type_field_columns ()     {     global  $lang ;      $resource_type_field_column_definitions  =  execution_lockout_remove_resource_type_field_props ([          'active'                    => [ $lang [ 'property-field_active' ], '' , 1 , 1 ],          'global'                    => [ $lang [ 'property-resource_type' ], '' , 1 , 0 ],          'title'                     => [ $lang [ 'property-title' ], '' , 0 , 1 ],          'type'                      => [ $lang [ 'property-field_type' ], '' , 0 , 1 ],          'linked_data_field'         => [ $lang [ 'property-field_raw_edtf' ], '' , 0 , 1 ],          'name'                      => [ $lang [ 'property-shorthand_name' ], $lang [ 'information-shorthand_name' ], 0 , 1 ],          'required'                  => [ $lang [ 'property-required' ], '' , 1 , 1 ],          'order_by'                  => [ $lang [ 'property-order_by' ], '' , 0 , 0 ],          'keywords_index'            => [ $lang [ 'property-index_this_field' ], $lang [ "information_index_warning" ] .

Read more...


execution_lockout_remove_resource_type_field_props()

Description Remove metadata field properties during execution lockout Parameters Column Type Default Description $rtf: array [ 'autocomplete_macro' 'value_filter' 'exiftool_filter' 'onchange_macro' ]; : array_flip$props $rtf array Resource type field data structure Return array Returns without the relevant properties if execution lockout is enabled This article was last updated 28th February 2024 08:05 Europe/London time based on the source file dated 26th February 2024 14:45 Europe/London time.

Read more...


render_resource_view_image()

Description Render image on view.php "access" - Resource access "edit_access" - Resource edit access Parameters Column Type Default Description $resource array Resource data $context array Array with following named elements Return void * Location include/render_functions.

Read more...


set_search_order_by()

Description Validate and set the order_by for the current search from the requested values passed to search_do() Parameters Column Type Default Description $search string $order_by string $sort string Return string * Location include/search_functions.

Read more...