Search results


 Language options

ResourceSpace is a platform that supports multiple languages and allows users to change their language preferences. The platform can detect and suggest the default language based on the user's browser.

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


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


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


get_field_options

The get_field_options function returns all the available tags or selectable options for a given field. The function takes two parameters: $ref, which is the ID or shortname of the field, and $nodeinfo, which provides extended field option information if set to TRUE.

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


save_field_options()

Developer reference for function save_field_options()

Read more...


get_config_options()

Developer reference for function get_config_options()

Read more...


process_config_options()

Developer reference for function process_config_options()

Read more...


http_get_preferred_language()

Developer reference for function http_get_preferred_language()

Read more...


setLanguage()

Developer reference for function setLanguage()

Read more...


node_field_options_override()

Developer reference for function node_field_options_override()

Read more...


extract_node_options()

Developer reference for function extract_node_options()

Read more...


resolve_pdf_language()

Developer reference for function resolve_pdf_language()

Read more...


register_plugin_language()

Developer reference for function register_plugin_language()

Read more...


render_share_options()

Developer reference for function render_share_options()

Read more...


display_upload_options()

Developer reference for function display_upload_options()

Read more...


get_field_options_with_stats()

Developer reference for function get_field_options_with_stats()

Read more...


get_field_options()

Developer reference for function get_field_options()

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 26th December 2024 11:35 Europe/London time based on the source file dated 16th December 2024 15:35 Europe/London time.

Read more...


get_tab_name_options()

The article describes a function called `get_tab_name_options()` that returns a list of all tabs sorted based on the current configuration. The function takes no parameters and returns an array where the key is the tab's ID and the value is its translated name.

Read more...


add_sql_node_language()

Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, you requested 5106 tokens (4082 in the messages, 1024 in the completion). Please reduce the length of the messages or completion.

Read more...


generate_videojs_options()

Description Generate JSON array of VideoJS options to be used in the data-setup attribute Parameters Column Type Default Description $view_as_gif bool True if the video is a GIF file $play_on_hover bool True if playing video on hover $video_preview_sources array Array of preview sources, including URL, type and label Return string|false Location include/video_functions.

Read more...


render_resource_tools_size_download_options()

Description Render the resource tools for preview sizes Parameters Column Type Default Description $resource array Resource data - {@see get_resource_data()} $ctx: array false $resource['file_extension'] false; bool, array{'download_multisize': "sizes"?: array, 'urlparams': array} $ctx Contextual information.

Read more...


get_display_language()

Description Get the name of a language in your own language plus its native name. Used for language selection dropdowns. Parameters Column Type Default Description $language_key string Key of $languages array, e.

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


Video tracks

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

Read more...


KE EMu database integration

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

Read more...


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


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


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


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


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


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


 Site content

All text strings in ResourceSpace can be customised from the Manage content area.

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


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


Configuring Apache

The article provides instructions on how to configure Apache to ensure that the filestore is not browseable by disabling indexing. This can be done by either disabling the autoindex module or by setting the directory's options directive.

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


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


The System Configuration page

The System Configuration Page is a feature in Moodle that can be accessed via the administration menu System category. It allows users to configure many system-wide properties, such as the default system language, timezone, and the appearance of the system.

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


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


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


Fixed list metadata

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

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


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


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


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


Editing resource previews

Resource previews are an important aspect of ResourceSpace as they are the first contact users have with resources and help them decide which assets to use. If previews are missing, they should be remedied after upload.

Read more...


 Sharing resources

Resources and Resource Collections each offer a 'Share' option which allows them to be shared with other users, as well as with non-users of the system, to allow greater flexibility of use.

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


 Creating collections

The article explains how to create collections in ResourceSpace, a digital asset management system. Collections can be created in three ways: when uploading resources, from the collection bar, or from the "manage my collections" section.

Read more...


Editing a collection

This article explains how to edit a collection in a resource management system. The edit screen provides several options, including customising the name of the collection, adding a description, and attaching tags to help find the collection of resources.

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


Embed slideshow

This article provides instructions on how to generate HTML for embeddable collection slideshows on remote sites using a function. The process involves creating a dynamic collection, selecting 'Share' from the collection options, choosing the size, preview duration, and maximise option, and then generating the HTML.

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


 License manager

Adds the capability to manage resource licensing via the resource view page.

Read more...


 Video splice

The video splice plugin allows users to trim and merge videos within ResourceSpace to create new, separate files. The trim tool allows users to select portions of a video to be recreated as a new video file, which can then be added as a new resource or attached as an alternative to the original.

Read more...


 Creating dash tiles

Dash tiles are a great way of creating shortcuts to your favourite things in ResourceSpace.

Read more...


Managing dash tiles

This article explains how to manage dash tiles in ResourceSpace. Dash Administrators can create tiles for all users or selected user groups, and reorder the tiles for those users who cannot manage their own dash.

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 research requests

Research requests enable users to ask admins for help in sourcing resources. Users can fill out a form detailing what they need, and administrators can then help them to find suitable resources. This can be done by either providing them with a list of resources or by sending them links to searches or collections to help them get their search started.

Read more...


Batch replace

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

Read more...


Creating a resource type

This article provides instructions on how to create a new resource type in MODX. To create a new resource type, users need to browse to "Admin > System > Resource types", enter the name of the new resource type, click "Create", fill in the rest of the form as required, and click "Save".

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


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


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


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


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


 Smart featured collections

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

Read more...


Creating user groups

This article provides information on how to create user groups in ResourceSpace. The default user groups in ResourceSpace are Administrators, Archivist, General users, Restricted user, and Super Admin.

Read more...


User account requests

ResourceSpace offers the option for users to request accounts, which can be enabled or disabled in the system config file. There are four ways in which account requests can work, depending on how the installation is configured.

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


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


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


 Analytics

The analytics function allows detailed reporting on a variety of system actions which can be broken down by user group and filtered by a number of options.

Read more...


do_search

The article provides a description of the do_search function, which is used to perform a search and return matching resources. The function takes several variables, including the search string, resource type IDs, results order, archive status, maximum number of rows to return, sort order, and offset.

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


get_resource_path

The get_resource_path function returns a URL or file path for a resource file. It takes several parameters, including the ID of the resource or an array of resource IDs, a flag indicating whether a file path should be returned instead of a URL, the size of the requested file, and whether the path should be generated if it does not yet exist on disk.

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


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


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


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


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


search_get_previews

The article describes the search_get_previews function, which is used to perform a search and return matching resources including URLs for the requested preview sizes. The function takes several variables, including the search string, resource type IDs, results order, archive status, maximum number of rows to return, sort order, recent search day limit, preview sizes, and preview file extension.

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


Antivirus

The antivirus plugin for ResourceSpace allows the platform to check every file uploaded to see if it is a known virus. The plugin can be configured to work with any antivirus that has a command line interface, and has been tested with ClamAV and Sophos.

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


Winauth

Enables users to login to ResourceSpace using Windows Integrated Authentication

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


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


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


add_resource_nodes

The article provides a brief description of the add_resource_nodes function, which is used to add all node IDs in a list to a resource. The function takes two parameters: the ID of the resource to add nodes to and a list of node IDs to add.

Read more...


add_resource_nodes_multi

The article describes a function called "add_resource_nodes_multi" which adds all node IDs in a list to the specified resources. The function takes two parameters: $resourceid, which is a list of resource IDs to add nodes to, and $nodes, which is a list of node IDs to add.

Read more...


Resources not showing for a given user group

The article discusses the possible reasons why a resource may not be visible to some users, while it is visible to others. The reasons could be related to permissions, such as whether the user has access to the workflow state the resource is in or whether the user can see the resource type.

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


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


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


QuickTime reporting corrupt file when using H264 encoding

QuickTime can report that an MP4 file is corrupt when generating previews using H264 encoding. This can occur when using automated alternatives or normal previews, depending on the options used to generate the preview.

Read more...


Resource bot

The Resource Bot plugin is a new feature that integrates Chat Bot functionality from the main ResourceSpace website with your ResourceSpace installation. This plugin provides on-hand assistance for your users and offers support for those who are less confident.

Read more...


Resource usage

The Resource Usage plugin enables users to keep a log of how a resource has been used, along with the usage medium, such as print or TV. Once enabled, a new section is added to the bottom of the resource view page, where users can click "New usage" to create a new record of where the resource was used.

Read more...


Coding standards v2.0

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


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


Complete Guide to Crafting Effective Brand Guidelines

Discover the importance of brand guidelines to differentiate your business and ensure your products stand out from competitors.

Read more...


 Feedback

The Feedback plugin adds a user feedback function to the header for all users. Once enabled, users will be prompted to answer a configurable feedback form, and responses to these forms are stored in a CSV file inside the feedback plugin folder on the server.

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


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


Usage history

ResourceSpace, the open source digital asset management software, is logging every time a user downloads a resource from the system, even one of its available sizes. By default, this is not shown on the view page of a resource, but there are configuration options which can change this behaviour.

Read more...


Database schema

Database schema for ResourceSpace.

Read more...


Project structure

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

Read more...


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


ResourceSpace plugin for WordPress

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

Read more...


 Sensitive image blurring

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

Read more...


Managing offline jobs

The My Jobs page is a tool used to check the status of jobs, such as collection downloads and preview creation. Administrators can also use this page to check on the status of jobs systemwide. The page displays information about jobs in the queue, including job priority, job reference, job type, user that created the job (admins only), job status, and the earliest job start date.

Read more...


Managing external shares

The article provides guidance on managing external shares in ResourceSpace. Users can manage their external shares by clicking on the user menu and selecting 'My shares'. Administrators can manage all existing shares via the 'External shares' link under the admin menu.

Read more...


Resources slow to create previews

The article provides solutions to two common issues that can arise when creating previews for videos. The first issue is that preview creation can take too long, causing the system to time out. To solve this, the article suggests disabling automatic preview creation upon upload and setting up offline preview creation using a crontab entry or scheduled task.

Read more...


save_collection

The "save_collection" API binding allows users to save collection data. The API requires a POST request to avoid URL limits being reached. The API requires two variables: "$ref" and "$coldata". "$ref" is the ID of the collection, and "$coldata" is the JSON encoded collection data.

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


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


Consent manager

Adds the capability to manage resource licensing via the resource view page.

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


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


Automatic alternative video files

ResourceSpace can be configured to automatically generate a video file in a different size or format from the uploaded original. This can be useful where a smaller size is required for uploading to the web.

Read more...


Configuring Expiry date field

The article explains how to configure an expiry date field in a system to help users know when a particular resource has expired and should no longer be used. The expiry date field type can be set by selecting "Expiry date" in the field type option.

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


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


Signing all database PHP code

From version 10.0, any PHP code stored in the database and manipulated via the user interface must be signed using a command line utility. This is to prevent system compromise by a user that has gained administrator access.

Read more...


Sending user notifications

The article provides guidance on sending user notifications in ResourceSpace. Before version 10, developers had to make several checks before calling send_mail() or message_add() whenever required, resulting in duplicated code and inconsistency.

Read more...


Customising the font

The article provides instructions on how to customise the font in the user interface of a system. Users can navigate to Admin > System > Configuration and expand the User interface section to choose a preset font from the Font drop-down or upload a custom font file (extension woff2, woff, ttf or otf) with the Custom font file option.

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


Setting up scheduled tasks/cron

To ensure that ResourceSpace can send notifications and perform regular tasks, it is necessary to set up scheduled tasks or cron jobs. These tasks should be configured to run at least once daily, but may need to run more frequently depending on certain configuration options.

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


Configuring image alternatives

The article discusses configuring image alternatives using the "$image_alternatives" configuration option, similar to video file alternatives. This setting controls the options for ImageMagick utility to create alternative image formats/sizes.

Read more...


Minimal preview creation

From version 10.4 onwards, core preview sizes ('col', 'thm', and 'pre') will always be generated, regardless of certain enabled options like $offline_job_queue or $enable_thumbnail_creation_on_upload. Other previews such as image tiles, image alternatives, ffmpeg alternatives, and unoconv derivatives will be created later by relevant offline scripts.

Read more...


LinkrUI for Adobe

LinkrUI for Adobe is a Connector plugin that integrates ResourceSpace with Adobe software such as Photoshop, Illustrator, InDesign, Premiere Pro, and After Effects. This integration allows users to easily search, open, and place assets stored in ResourceSpace directly into their Adobe applications.

Read more...


toggle_active_state_for_nodes

The article discusses the function "toggle_active_state_for_nodes," available from version 10.4+ and requiring permission "k." It involves toggling nodes' active state, with a list of node IDs as input.

Read more...


How do I delete resources? Is there a batch delete option?

To delete resources, single resources can be deleted by selecting 'Delete' from the resource preview. For multiple resources, add them to a collection and choose 'Delete all resources' from the collection menu.

Read more...


CSP frame-ancestors

The article discusses the use of CSP frame-ancestors to specify which sites can embed a ResourceSpace page using certain HTML tags. To enable this feature, the configuration option $csp_frame_ancestors needs to be set as an array of valid parent URLs.

Read more...


SAML

Security Assertion Markup Language (SAML) is an open standard for exchanging authentication and authorisation data between parties, specifically between an identity provider and a service provider. In the context of Digital Asset Management (DAM) systems like ResourceSpace, SAML is often used to facilitate Single Sign-On (SSO) capabilities.

Read more...


Managing files with Microsoft SharePoint? You could do more with DAM

Is your organisation still using Microsoft SharePoint for digital asset management? You could do so much more with a dedicated DAM system.

Read more...


 OpenAI Image Editing

The OpenAI image editing plugin is integrated with DALL-E 2 to enable AI image editing within ResourceSpace. Users can access the editing option in the resource tools on the resource view page. The plugin requires the OpenAI GPT plugin to be enabled with a valid key.

Read more...


Table: report

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

Read more...


Table: request

The "request" table is a database table in ResourceSpace that tracks resource requests made by users with restricted access and fulfilled by admin users. The table has several columns, including "ref," which is an auto-incrementing index, "user," which refers to the user who made the request, and "collection," which refers to the collection the requested resource belongs to.

Read more...


Table: research_request

The article provides information about the "research_request" table, which is used in ResourceSpace, a digital asset management system. The table stores information related to research requests, which are requests for appropriate resources for a project.

Read more...


Table: resource_custom_access

The article provides information about the resource_custom_access table in ResourceSpace, which defines custom access for a resource. This table contains four columns, including resource, usergroup, user, access, and user_expires.

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: site_text

The site_text table is used to store any custom site text that the user has entered, replacing that stored in the language folder. The table has six columns: page, name, text, ref, language, and specific_to_group.

Read more...


Table: user

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

Read more...


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


get_smart_themes_nodes()

Developer reference for function get_smart_themes_nodes()

Read more...


perform_login()

Developer reference for function perform_login()

Read more...


plugin_activate_for_setup()

Developer reference for function plugin_activate_for_setup()

Read more...


display_field()

Developer reference for function display_field()

Read more...


render_selected_collection_actions()

Developer reference for function render_selected_collection_actions()

Read more...


display_field_data()

Developer reference for function display_field_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...


update_field()

Developer reference for function update_field()

Read more...


i18n_merge_translations()

Description Merge values for across multiple translation strings. Where a value is missing for a language used elsewhere i18n_get_translated will be used. If no value is provided and no English (en) string is found then blank will be returned.

Read more...


Configuring Cross-Site Request Forgery (CSRF)

The article explains how to configure Cross-Site Request Forgery (CSRF) and Cross-Origin Resource Sharing (CORS) to protect web applications from attacks. CSRF is an attack that forces an end user to execute unwanted actions on a web application in which they are currently authenticated.

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


prepareTags()

Developer reference for function prepareTags()

Read more...


add_resource_to_collection()

Developer reference for function add_resource_to_collection()

Read more...


edit_collection_external_access()

Developer reference for function edit_collection_external_access()

Read more...


compile_collection_actions()

Developer reference for function compile_collection_actions()

Read more...


update_collection_type()

Developer reference for function update_collection_type()

Read more...


set_config_option()

Developer reference for function set_config_option()

Read more...


config_single_select()

Developer reference for function config_single_select()

Read more...


config_add_single_select()

Developer reference for function config_add_single_select()

Read more...


config_boolean_select()

Developer reference for function config_boolean_select()

Read more...


config_add_boolean_select()

Developer reference for function config_add_boolean_select()

Read more...


config_add_checkbox_select()

Developer reference for function config_add_checkbox_select()

Read more...


config_single_ftype_select()

Developer reference for function config_single_ftype_select()

Read more...


config_generate_AutoSaveConfigOption_function()

Developer reference for function config_generate_AutoSaveConfigOption_function()

Read more...


generateResourcesMetadataCSV()

Developer reference for function generateResourcesMetadataCSV()

Read more...


generateNodesExport()

Developer reference for function generateNodesExport()

Read more...


get_user_dash()

Developer reference for function get_user_dash()

Read more...


render_delete_dialog_JS()

Developer reference for function render_delete_dialog_JS()

Read more...


generate_dash_tile_toolbar()

Developer reference for function generate_dash_tile_toolbar()

Read more...


rsEncrypt()

Developer reference for function rsEncrypt()

Read more...


rsDecrypt()

Developer reference for function rsDecrypt()

Read more...


get_site_text()

Developer reference for function get_site_text()

Read more...


check_site_text_custom()

Developer reference for function check_site_text_custom()

Read more...


save_site_text()

Developer reference for function save_site_text()

Read more...


pager()

Developer reference for function pager()

Read more...


get_temp_dir()

Developer reference for function get_temp_dir()

Read more...


job_queue_run_job()

Developer reference for function job_queue_run_job()

Read more...


text()

Developer reference for function text()

Read more...


lang_or_i18n_get_translated()

Developer reference for function lang_or_i18n_get_translated()

Read more...


i18n_get_translated()

Developer reference for function i18n_get_translated()

Read more...


i18n_get_collection_name()

Developer reference for function i18n_get_collection_name()

Read more...


i18n_get_indexable()

Developer reference for function i18n_get_indexable()

Read more...


i18n_get_translations()

Developer reference for function i18n_get_translations()

Read more...


str_replace_formatted_placeholder()

Developer reference for function str_replace_formatted_placeholder()

Read more...


ucfirstletter()

Developer reference for function ucfirstletter()

Read more...


ucfirstletter_callback()

Developer reference for function ucfirstletter_callback()

Read more...


normalize_keyword()

Developer reference for function normalize_keyword()

Read more...


remove_accents()

Developer reference for function remove_accents()

Read more...


seems_utf8()

Developer reference for function seems_utf8()

Read more...


set_login_cookies()

Developer reference for function set_login_cookies()

Read more...


message_get()

Developer reference for function message_get()

Read more...


message_add()

Developer reference for function message_add()

Read more...


message_send_unread_emails()

Developer reference for function message_send_unread_emails()

Read more...


getFitsMetadataFieldValue()

Developer reference for function getFitsMetadataFieldValue()

Read more...


migrate_resource_type_field_check()

Developer reference for function migrate_resource_type_field_check()

Read more...


migrate_category_tree_to_nodes()

Developer reference for function migrate_category_tree_to_nodes()

Read more...


migrate_filter()

Developer reference for function migrate_filter()

Read more...


get_node()

Developer reference for function get_node()

Read more...


get_nodes()

Developer reference for function get_nodes()

Read more...


reorder_nodes()

Developer reference for function reorder_nodes()

Read more...


render_new_node_record()

Developer reference for function render_new_node_record()

Read more...


draw_tree_node_table()

Developer reference for function draw_tree_node_table()

Read more...


add_resource_nodes()

Developer reference for function add_resource_nodes()

Read more...


get_resource_nodes()

Developer reference for function get_resource_nodes()

Read more...


generate_pdf()

Developer reference for function generate_pdf()

Read more...


get_plugin_yaml()

Developer reference for function get_plugin_yaml()

Read more...


config_multi_select()

Developer reference for function config_multi_select()

Read more...


config_add_multi_select()

Developer reference for function config_add_multi_select()

Read more...


config_multi_ftype_select()

Developer reference for function config_multi_ftype_select()

Read more...


config_single_rtype_select()

Developer reference for function config_single_rtype_select()

Read more...


config_db_single_select()

Developer reference for function config_db_single_select()

Read more...


config_db_multi_select()

Developer reference for function config_db_multi_select()

Read more...


get_plugin_css()

Developer reference for function get_plugin_css()

Read more...


register_plugin()

Developer reference for function register_plugin()

Read more...


render_search_field()

Developer reference for function render_search_field()

Read more...


render_sort_order()

Developer reference for function render_sort_order()

Read more...


render_actions()

Developer reference for function render_actions()

Read more...


render_user_group_multi_select()

Developer reference for function render_user_group_multi_select()

Read more...


render_dropdown_question()

Developer reference for function render_dropdown_question()

Read more...


display_multilingual_text_field()

Developer reference for function display_multilingual_text_field()

Read more...


render_custom_fields()

Developer reference for function render_custom_fields()

Read more...


get_reports()

Developer reference for function get_reports()

Read more...


send_periodic_report_emails()

Developer reference for function send_periodic_report_emails()

Read more...


get_translated_activity_type()

Developer reference for function get_translated_activity_type()

Read more...


get_valid_custom_fields()

Developer reference for function get_valid_custom_fields()

Read more...


gen_custom_fields_html_props()

Developer reference for function gen_custom_fields_html_props()

Read more...


process_custom_fields_submission()

Developer reference for function process_custom_fields_submission()

Read more...


get_research_requests()

Developer reference for function get_research_requests()

Read more...


get_resource_field_data_batch()

Developer reference for function get_resource_field_data_batch()

Read more...


resource_log()

Developer reference for function resource_log()

Read more...


get_exiftool_fields()

Developer reference for function get_exiftool_fields()

Read more...


autocomplete_blank_fields()

Developer reference for function autocomplete_blank_fields()

Read more...


resource_type_config_override()

Developer reference for function resource_type_config_override()

Read more...


get_nopreview_icon()

Developer reference for function get_nopreview_icon()

Read more...


canSeePreviewTools()

Developer reference for function canSeePreviewTools()

Read more...


checkPreviewToolsOptionUniqueness()

Developer reference for function checkPreviewToolsOptionUniqueness()

Read more...


tab_names()

Developer reference for function tab_names()

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


rebuild_specific_field_search_from_node()

Developer reference for function rebuild_specific_field_search_from_node()

Read more...


resolve_keyword()

Developer reference for function resolve_keyword()

Read more...


highlightkeywords()

Developer reference for function highlightkeywords()

Read more...


str_highlight()

Developer reference for function str_highlight()

Read more...


render_audio_download_link()

Developer reference for function render_audio_download_link()

Read more...


render_table()

Developer reference for function render_table()

Read more...


get_featured_collection_resources()

Developer reference for function get_featured_collection_resources()

Read more...


process_posted_featured_collection_categories()

Developer reference for function process_posted_featured_collection_categories()

Read more...


render_new_featured_collection_cta()

Developer reference for function render_new_featured_collection_cta()

Read more...


render_featured_collections()

Developer reference for function render_featured_collections()

Read more...


render_featured_collections_category_permissions()

Developer reference for function render_featured_collections_category_permissions()

Read more...


get_nodes_by_refs()

Description Find and return node details for a list of node IDs. Parameters Column Type Default Description $refs array List of node IDs Return array Location include/node_functions.

Read more...


save_usergroup()

Description Save or create usergroup Parameters Column Type Default Description $ref int Group ref.

Read more...


Frequently Asked Questions (FAQs)

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

Read more...


create_upload_link()

Description Creates an upload link for a collection that can be shared 'usergroup' Usergroup id to share as (must be in $upload_link_usergroups array) 'expires' Expiration date in 'YYYY-MM-DD' format 'password' Optional password for share access 'emails' Optional array of email addresses to generate keys for Parameters Column Type Default Description $collection int Collection ID $shareoptions array - values to set Return string Share access key Location include/collections_functions.

Read more...


upload_share_setup()

Description Set up external upload share "collection" - (int) collection ID "user" - (int) user ID of share creator "usergroup" - (int) usergroup ID used for share Parameters Column Type Default Description $key string access key $shareopts array array Array of share options Return void Location include/collections_functions.

Read more...


purge_expired_shares()

Description Purge all expired shares "share_group" - (int) Usergroup ref 'shared as' "share_user" - (int) user ID of share creator "share_type" - (int) 0=view, 1=upload "share_collection" - (int) Collection ID Parameters Column Type Default Description $filteropts array Array of options to filter shares purged Return string|int Location include/collections_functions.

Read more...


render_workflow_state_question()

Description Renders a dropdown for selecting the workflow state of a resource. This function generates a dropdown menu with various workflow states, allowing the user to select the current state of the resource.

Read more...


get_external_shares()

Description Get details of external shares "share_group" - (int) Usergroup ref 'shared as' "share_user" - (int) user ID of share creator "share_order_by" - (string) order by column "share_sort" - (string) sortorder (ASC or DESC) "share_type" - (int) 0=view, 1=upload "share_collection" - (int) Collection ID "share_resource" - (int) Resource ID "access_key" - (string) Access key "ignore_permissions"- (bool) Show all shares, irrespective of permissions Parameters Column Type Default Description $filteropts array Array of options to filter shares returned Return array Location include/resource_functions.

Read more...


emulate_user()

Description Used to emulate system users when accessing system anonymously or via external shares Sets global array such as $userpermissions, $username and sets any relevant config options Parameters Column Type Default Description $user int User ID $usergroup int "" usergroup ID Return void This article was last updated 26th December 2024 11:35 Europe/London time based on the source file dated 16th December 2024 15:35 Europe/London time.

Read more...


header_add_map_providers()

Description Adds map providers for Leaflet maps. This function generates a JavaScript snippet that defines various tile layer providers for use in Leaflet maps. It supports OpenStreetMap and ESRI basemaps, as well as custom providers defined in the global variable `$geo_leaflet_sources`.

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


radio_get_layout()

Parameters Column Type Default Description $options Location include/render_functions.

Read more...


render_radio_buttons_question()

Description render_radio_buttons_question - Used to display a question with radio buttons Parameters Column Type Default Description $label string Label of question $inputname string Name of input field $options array array Array of options (value and text pairs) (eg.

Read more...


rs_password_hash()

Description ResourceSpace password hashing Parameters Column Type Default Description $password string Password Return string|false Password hash or false on failure Location include/login_functions.

Read more...


get_password_hash_info()

Description Helper function to get the password hash information (algorithm and options) from the global scope. Parameters This function accepts no parameters. Return array Location include/login_functions.

Read more...


message_get_conversation()

Description Get all messages between the given user IDs "msgfind" - (string) Text to find "sort_desc" - (bool) Sort by message ID in descending order? False = Ascending "limit" - (int) Maximum number of messages to return Parameters Column Type Default Description $user int $msgusers array array Array of other user IDs $filteropts array array: array { array_map"is_int_loose" Array of extra options to filter and sort messages returned $msgusers; $users int User ID Return array Array of messages Location include/message_functions.

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


lang_load_site_text()

Description Load all site text for the given page and language into the global $lang array Parameters Column Type Default Description &$lang $pagename string Pagename $language string "" Language $lang array Passed by reference Return void Location include/language_functions.

Read more...


send_user_notification()

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

Read more...


get_cattree_nodes_ordered()

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

Read more...


get_cattree_node_strings()

Array ( [error] => Array ( [message] => This model's maximum context length is 4097 tokens. However, you requested 5040 tokens (4016 in the messages, 1024 in the completion). Please reduce the length of the messages or completion.

Read more...


get_resources_nodes_by_rtf()

The get_resources_nodes_by_rtf() function is a PHP function that retrieves all resource nodes associated with a specific resource type field. The function takes a single parameter, which is the resource type field ID.

Read more...


order_tree_nodes()

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

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


admin_resource_type_field_option()

Parameters Column Type Default Description $propertyname string $propertytitle string $helptext string $type $currentvalue $fieldtype int $system_date_field bool $resource_type_array; $lang $baseurl_short $FIXED_LIST_FIELD_TYPES $daterange_edtf_support $allfields $newfield $resource_type_array $existingrestypes $regexp_slash_replace Location include/render_functions.

Read more...


delete_config_option()

Description Delete entry from the user_preferences table completely (instead of setting to blank via set_config_option). Used by system preferences page when deleting a file to allow fallback to value (if set) in config.

Read more...


render_pie_graph()

Description Output the Javascript to build a pie chart in the canvas denoted by $id $data must be in the following format $data = array( "slice_a label" => "slice_a value", "slice_b label" => "slice_b value", ); a string can be used to denote the total value to pad the data to Parameters Column Type Default Description $id string identifier for the canvas to render the chart in $data array data to be rendered in the chart $total string|null null null will mean that the data is complete and an extra field is not required Return void Location include/reporting_functions.

Read more...


render_bar_graph()

Description Output the Javascript to build a bar chart in the canvas denoted by $id $data must be in the following format $data = array( "point_a x value" => "point_a y value", "point_b x value" => "point_b y value", Parameters Column Type Default Description $id string identifier for the canvas to render the chart in $data array data to be rendered in the chart Return void Location include/reporting_functions.

Read more...


i18n_get_all_translations()

Description Return an array of all available language strings for the given id, with the language code as the key Parameters Column Type Default Description $langid: string $langid string The identifier of the lang string Return array * Location include/language_functions.

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 do_search() Parameters Column Type Default Description $search string $order_by string $sort: string $sort string Return string * Location include/search_functions.

Read more...


setup_command_line_user()

Description Set up a dummy user with required permissions etc. to pass permission checks if running scripts from the command line e.g. ["username" => "My Application", "permissions" => "h,v,e0", "groupname => "My Application", "resource_defaults => "region=EMEA", ] Parameters Column Type Default Description $setoptions array can these t v e-2 e-1 e0 e1 e2 true; any plus columns_in"user" null columns_in"usergroup" $options[]] array Array of optional user options.

Read more...


register_group_access_plugins()

Description Load group specific plugins and reorder plugins list Parameters Column Type Default Description $usergroup int -1 Usergroup reference $plugins array Enabled Plugins enabled_groups config config_json FROM disable_group_select 0 ORDER BY priority" array "plugins"; Return array Location include/plugin_functions.

Read more...


check_removed_ui_config()

Description Check if there is a previously stored value for the given config option. Intended for options that were previously set in the UI but now need to be set in config. Parameters Column Type Default Description $option string $default mixed "": bool { if !isset$GLOBALS[$option] The default value to set for the config option if not set anywhere Return bool True if the config option is overridden with a stored value from user_preferences, false if not Location include/config_functions.

Read more...


RenderPlugin()

Description Render the plugin in the Plugin Manager with options to activate and configure. Parameters Column Type Default Description $plugin array An array containing the plugin data, loaded from the plugin table $active boolean true If true, display options to deactivate and allow group configuration Return void Location include/plugin_functions.

Read more...