Knowledge Base

Search results

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.

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.

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.

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.

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.

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.

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.

Metadata

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

Fixed list metadata

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

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.

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.

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.

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

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.

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.

Advanced workflow

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

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.

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.

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.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Table: resource_type_field_resource_type

Links resource_type_field records to resource_type. Used when the global column in resource_type_field is set to 0; Column Type Note resource_type_field int(11) See table resource_type_field resource_type int(11) See table resource_type Default contents are as follows.

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.

update_resource_type_field_order()

Developer reference for function update_resource_type_field_order()

collection_download_process_csv_metadata_file()

Developer reference for function collection_download_process_csv_metadata_file()

validate_field()

Developer reference for function validate_field()

config_register_core_fieldvars()

Developer reference for function config_register_core_fieldvars()

generateResourcesMetadataCSV()

Developer reference for function generateResourcesMetadataCSV()

format_display_field()

Developer reference for function format_display_field()

getFitsMetadataFieldValue()

Developer reference for function getFitsMetadataFieldValue()

extractFitsMetadata()

Developer reference for function extractFitsMetadata()

migrate_resource_type_field_check()

Developer reference for function migrate_resource_type_field_check()

delete_nodes_for_resource_type_field()

Developer reference for function delete_nodes_for_resource_type_field()

node_field_options_override()

Developer reference for function node_field_options_override()

copy_resource_type_field_nodes()

Developer reference for function copy_resource_type_field_nodes()

config_text_field()

Developer reference for function config_text_field()

config_userselect_field()

Developer reference for function config_userselect_field()

config_field_select()

Developer reference for function config_field_select()

config_boolean_field()

Developer reference for function config_boolean_field()

render_search_field()

Developer reference for function render_search_field()

is_field_displayed()

Developer reference for function is_field_displayed()

display_multilingual_text_field()

Developer reference for function display_multilingual_text_field()

display_field()

Developer reference for function display_field()

render_date_range_field()

Developer reference for function render_date_range_field()

render_field_selector_question()

Developer reference for function render_field_selector_question()

render_custom_fields()

Developer reference for function render_custom_fields()

display_field_data()

Developer reference for function display_field_data()

get_valid_custom_fields()

Developer reference for function get_valid_custom_fields()

gen_custom_fields_html_props()

Developer reference for function gen_custom_fields_html_props()

process_custom_fields_submission()

Developer reference for function process_custom_fields_submission()

append_field_value()

Developer reference for function append_field_value()

remove_all_keyword_mappings_for_field()

Developer reference for function remove_all_keyword_mappings_for_field()

update_field()

Developer reference for function update_field()

get_resource_type_field()

Developer reference for function get_resource_type_field()

get_resource_field_data()

Developer reference for function get_resource_field_data()

get_resource_field_data_batch()

Developer reference for function get_resource_field_data_batch()

get_exiftool_fields()

Developer reference for function get_exiftool_fields()

stripMetadata()

Developer reference for function stripMetadata()

write_metadata()

Developer reference for function write_metadata()

get_field()

Developer reference for function get_field()

get_field_options_with_stats()

Developer reference for function get_field_options_with_stats()

save_field_options()

Developer reference for function save_field_options()

add_field_option()

Developer reference for function add_field_option()

get_metadata_templates()

Developer reference for function get_metadata_templates()

autocomplete_blank_fields()

Developer reference for function autocomplete_blank_fields()

truncate_join_field_value()

Developer reference for function truncate_join_field_value()

copy_locked_fields()

Developer reference for function copy_locked_fields()

sanitize_date_field_input()

Developer reference for function sanitize_date_field_input()

get_field_options()

Developer reference for function get_field_options()

get_data_by_field()

Developer reference for function get_data_by_field()

get_fields()

Developer reference for function get_fields()

get_hidden_indexed_fields()

Developer reference for function get_hidden_indexed_fields()

get_category_tree_fields()

Developer reference for function get_category_tree_fields()

get_OR_fields()

Developer reference for function get_OR_fields()

get_indexed_resource_type_fields()

Developer reference for function get_indexed_resource_type_fields()

get_resource_type_fields()

Developer reference for function get_resource_type_fields()

metadata_field_edit_access()

Developer reference for function metadata_field_edit_access()

create_resource_type_field()

Developer reference for function create_resource_type_field()

metadata_field_view_access()

Developer reference for function metadata_field_view_access()

delete_resource_type_field()

Developer reference for function delete_resource_type_field()

get_advanced_search_fields()

Developer reference for function get_advanced_search_fields()

get_advanced_search_collection_fields()

Developer reference for function get_advanced_search_collection_fields()

rebuild_specific_field_search_from_node()

Developer reference for function rebuild_specific_field_search_from_node()

get_simple_search_fields()

Developer reference for function get_simple_search_fields()

get_fields_for_search_display()

Developer reference for function get_fields_for_search_display()

render_advanced_search_buttons()

Developer reference for function render_advanced_search_buttons()

update_fieldx()

Parameters Column Type Default Description $metadata_field_ref: int get_resource_table_joins Location include/metadata_functions.

config_register_core_field_refs()

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

remove_field_keywords()

The remove_field_keywords() function is a PHP function used in ResourceSpace, an open-source digital asset management system. The function deletes all keywords associated with a specified field ID for all nodes.

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.

sort_tabs_as_configured()

The article describes a PHP function called "sort_tabs_as_configured()" that sorts a list of tab names while preserving their key ID. The function takes an array of tab ID and translated name pairs as input and returns the sorted array.

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.

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.

data_joins_field_value_translate_and_csv()

The function `data_joins_field_value_translate_and_csv()` is used to convert `$data_joins` value to a user-friendly version. The text value is split by the configured separator and all parts are translated.

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.

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.

get_resource_type_field_resource_types()

Description Get all resource_type->resource-type_field associations Parameters Column Type Default Description $fields array [] Optional array of resource_type_field data returned by get_resource_type_fields() Return array Array with resource_type_field ID as keys and arrays of resource_type IDs as values Location include/config_functions.

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.

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.

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.

get_resource_type_field_columns()

Description Get the definitions for resource_type_field columns, including properties and display configurations. Parameters This function accepts no parameters. Return array An associative array of resource type field column definitions.

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 23rd December 2024 20:35 Europe/London time based on the source file dated 11th December 2024 17:45 Europe/London time.

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.

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.

Admin overview

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

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.

Simple SAML

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

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.

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.

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.

ResourceSpace Plugins

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

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.

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.

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.

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.

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.

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.

Resources and structure

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Deleting resources

The article provides instructions on how to delete resources in ResourceSpace, a digital asset management system. There are two methods described: deleting resources individually and batch deleting resources.

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.

Creating featured collections

This article explains how to create a featured collection in ResourceSpace, which is a collection of resources that is highlighted on the platform's homepage. The process is similar to creating a public collection, but with an additional step to turn it into a featured collection.

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.

Keyboard controls

ResourceSpace offers keyboard controls to help advanced users speed up their use of the platform. These controls can be customised system-wide but are not currently available for per-user customisation.

Special search terms

Special search terms help users to find content in a much more specific and controlled manner, either through giving them extra tools or using a prebuilt search.

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.

Embed document

The article explains how to embed document resource previews on another website using a short HTML script. The process involves browsing to the resource with the configured resource type, selecting "Embed" next to the document resource, and copying the HTML code to paste into the other site's source.

Embed video

This article provides instructions on how to embed a video in an external site using an HTML script. The process involves browsing to the configured resource type, selecting "Embed" next to the video resource, and copying the HTML code to paste into the other site's source.

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.

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.

Refine results

The article discusses the addition of a filter bar above search results to allow for further filtering within the result set. This feature allows users to type in more relevant keywords and extra information into the "further results" field to keep filtering results.

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.

Youtube publish

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

Creating dash tiles

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

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.

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.

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.

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.

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.

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.

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.

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.

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

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.

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.

Smart featured collections

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

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.

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.

Useful user tools

ResourceSpace provides several user management tools to help with the user configuration process. The first tool is resetting passwords, which can be done by browsing to Admin > Users, editing the user, entering a password into the password field or clicking "Suggest" to generate one, and clicking Save.

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.

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.

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.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Customising the top level navigation

This article provides instructions on how to customise the top-level navigation in ResourceSpace. To add additional top navigation links, users can enter the code in the config.php file or in "Config Override" if setting this on a per-group basis.

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.

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.

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.

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.

Watermarks

ResourceSpace allows users to enable watermarks on preview images generated for each resource. To enable watermark preview generation, users need to add the following to their config.php: $watermark = "gfx/watermark.

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.

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.

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.

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.

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.

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.

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.

How to back up your ResourceSpace installation

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

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.

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.

Winauth

Enables users to login to ResourceSpace using Windows Integrated Authentication

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.

Geolocation

This article provides instructions on how to add location data to a resource on a website. Users can add a location to a resource by clicking on the 'Add location' button on the resource view page and setting the marker for the location on the map that appears.

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.

resource_log_last_rows

adding information on the log codes recorded in the type field

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.

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.

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.

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.

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

Cookies notification

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

Security settings

ResourceSpace allows users to customise the security settings of their accounts. The length, complexity and frequency of password expiry can be configured, as can a failed login protocol, which determines when a ban is placed on a user account or IP address.

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.

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.

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.

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

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.

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.

TMS link

Help for setting up the tms_link plugin.

Manage image sizes

ResourceSpace allows users to upload files in their original form, but also creates derivative files in other resolutions that are stored alongside the resource. The default sizes of these derivative files are appropriate for most uses, but users may require a specific size to be available.

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.

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.

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.

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.

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.

Adobe link

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

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.

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.

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.

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.

Meta append

The Meta Append plugin allows users to add a timestamp and daily upload number to each resource they contribute. The plugin automatically applies the user-defined timestamp and upload number to the selected field, which can be configured in the plugin settings.

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.

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.

1. Finding your way around

An overview of the ResourceSpace user interface.

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.

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.

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.

7. Reporting

ResourceSpace include comprehensive reporting and analytics capabilities.

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.

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.

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.

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.

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.

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.

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.

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.

Access control

The article discusses access control and how it enforces policies to prevent users from acting outside of their intended permissions. Failures in access control can lead to unauthorized information disclosure, modification or destruction of data, or performing a business function outside of the limits of the user.

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.

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.

Creating public collections

The article explains how to create public collections, which are a simple way to share groups of resources with other users in the system. Public collections can be used to highlight the best of a user's uploads so that administrators can promote them as featured collections.

Creating and editing filters

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

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.

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.

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.

Edit access for contributors

ResourceSpace administrators can configure the system to grant contributors edit access to the resources they have uploaded. To enable this, the configuration option $edit_access_for_contributor should be set to true.

Database schema

Database schema for ResourceSpace.

Project structure

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Image preview zoom

The article discusses the image preview zoom feature in ResourceSpace, a digital asset management system. If the system is configured with zoomable previews, users can enable the OpenSeadragon viewer on the view page by toggling the image preview zoom tool available in the image preview toolbar.

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.

User IP restriction

ResourceSpace allows users to limit the locations from which their users access the platform by applying an IP restriction to user accounts. This is done on a per-user basis, allowing tighter controls on certain accounts where necessary.

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.

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.

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.

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.

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.

Subtitles for Video Preview

ResourceSpace has added a new feature that allows subtitles to be included when previewing video resources. Once configured, users can select the subtitle track from the player controls when playing a video resource preview.

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.

Integrating with BrandStencil

Instantly create marketing materials from templates using your DAM images thanks to ResourceSpace's integration with BrandStencil.

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.

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.

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.

Upgrading PHP versions

ResourceSpace has updated its PHP requirement to version 7.4 for its version 10.0 to maintain compatibility with the third-party file uploader library (Uppy) and to maintain security. The company has warned that PHP 7.

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.

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.

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.

Integrating with Uppy Companion

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

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.

The Beginner's Guide to Managing Consent for Charities & Non-Profits

The article provides a beginner's guide to managing consent for charities and non-profits. It covers different types of consent and how they can be obtained, as well as looking at the intricacies of specific use cases and best practices when consent is in place.

What is Digital Asset Management?

A Digital Asset Management system is critical component of your organisation's tech stack. Explore the benefits of DAM, its use cases, and how it streamlines asset management.

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.

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.

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.

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.

A Comprehensive Guide to Digital Curation: Tools and Techniques

Explore digital curation: key tools and techniques for preserving significant cultural assets.

How do I create a new user group?

The article provides instructions on how to create a new user group. To do this, the user needs to go to the Admin section, then navigate to System and User groups. In the "Create user group called..." field, the user can enter the name of the new group and click "Create".

How do I delete a user?

To delete a user, go to the Admin section and click on the username of the user you want to remove. Scroll down and change the status to "Disabled" if you want to prevent the user from accessing their account but retain all data.

Why am I not receiving email notifications?

If you are not receiving email notifications, there are a few things you can check. First, make sure your email preferences are configured correctly. You can do this by going to the personal menu in the top right corner of the screen, selecting "Preferences," and scrolling down to "Email.

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.

How do I check for duplicates?

The article discusses how to check for duplicates in ResourceSpace, a digital asset management system. It explains that ResourceSpace uses checksums, which are unique "fingerprint" ID sequences, to identify duplicates.

How do I delete resources from the system permanently?

To permanently delete resources from ResourceSpace, follow these steps: 1. Add the resources you want to remove to your collection. 2. From the "Actions" menu, choose "Delete all resources". 3. This action will move the resources to the "Deleted" workflow state.

Navigating Consent and Digital Asset Management

Discover how your organisation can navigate consent and Digital Asset Management (DAM), including ensuring legal compliance and protecting user privacy.

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.

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.

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.

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.

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.

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.

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.

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.

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.

StencilVG

StencilVG is a plugin that allows users to generate new documents using SVG template files with placeholder values. Users can create template SVG files by adding text placeholders surrounded by square brackets.

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.

resource_file_readonly

The article discusses checking if a resource file is read-only due to being part of the filestore template threshold. This check is available from version 10.5 onwards. The process involves submitting a resource ID, and the response will be a 200 HTTP status for success or a 400 status for failure.

Table: annotation

This article provides a table called "annotation" that is used for resource annotations. The table contains columns such as "ref", "resource", "resource_type_field", "user", "x", "y", "width", "height", and "page".

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

Table: dynamic_tree_node

The dynamic_tree_node table is a list of nodes used for category trees. It has four columns: ref, resource_type_field, parent, and name. The ref column is an auto-incrementing index, while the resource_type_field column refers to the resource_type_field table.

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.

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.

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.

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.

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.

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.

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.

Table: resource_log

The resource_log table is used to log all activity related to a resource in ResourceSpace. It contains an auto-incrementing index, the date the log was recorded, the user who performed the action, the resource that was affected, the type of log, and any notes related to the log.

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.

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.

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.

Table: usergroup_dash_tile

The usergroup_dash_tile table is a configuration table in ResourceSpace that stores dash tiles for user groups. It has five columns, including an auto-incrementing index, usergroup, dash_tile, default_order_by, and order_by.

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.

OpenCV (facial recognition)

OpenCV is a library used by ResourceSpace for facial recognition capability. The article provides instructions on how to install OpenCV on Ubuntu and how to check the Python and OpenCV versions. The facial recognition feature in ResourceSpace can be configured by setting the path to Python, the field used to store the name of the person suggested/detected, the location for the face recognizer model state(s) and data, and enabling facial recognition.

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.

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.

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.

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.

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.

get_user_actions()

Developer reference for function get_user_actions()

get_editable_resource_sql()

Developer reference for function get_editable_resource_sql()

update_resource_type_order()

Developer reference for function update_resource_type_order()

getAnnotations()

Developer reference for function getAnnotations()

getAnnotoriousResourceAnnotations()

Developer reference for function getAnnotoriousResourceAnnotations()

annotationEditable()

Developer reference for function annotationEditable()

createAnnotation()

Developer reference for function createAnnotation()

updateAnnotation()

Developer reference for function updateAnnotation()

prepareTags()

Developer reference for function prepareTags()

iiif_get_canvases()

Developer reference for function iiif_get_canvases()

iiif_get_thumbnail()

Developer reference for function iiif_get_thumbnail()

iiif_get_image()

Developer reference for function iiif_get_image()

search_public_collections()

Developer reference for function search_public_collections()

index_collection()

Developer reference for function index_collection()

get_max_theme_levels()

Developer reference for function get_max_theme_levels()

get_smart_theme_headers()

Developer reference for function get_smart_theme_headers()

get_smart_themes_nodes()

Developer reference for function get_smart_themes_nodes()

add_saved_search_items()

Developer reference for function add_saved_search_items()

send_collection_feedback()

Developer reference for function send_collection_feedback()

add_to_collection_link()

Developer reference for function add_to_collection_link()

get_collection_log()

Developer reference for function get_collection_log()

get_home_page_promoted_collections()

Developer reference for function get_home_page_promoted_collections()

compile_collection_actions()

Developer reference for function compile_collection_actions()

collection_download_process_text_file()

Developer reference for function collection_download_process_text_file()

collection_download_process_data_only_types()

Developer reference for function collection_download_process_data_only_types()

collection_download_process_collection_download_name()

Developer reference for function collection_download_process_collection_download_name()

collection_download_clean_temp_files()

Developer reference for function collection_download_clean_temp_files()

comments_submit()

Developer reference for function comments_submit()

comments_show()

Developer reference for function comments_show()

render_select_option()

Developer reference for function render_select_option()

render_bool_option()

Developer reference for function render_bool_option()

render_text_option()

Developer reference for function render_text_option()

config_text_input()

Developer reference for function config_text_input()

config_add_text_input()

Developer reference for function config_add_text_input()

config_add_file_input()

Developer reference for function config_add_file_input()

config_single_select()

Developer reference for function config_single_select()

config_add_single_select()

Developer reference for function config_add_single_select()

config_boolean_select()

Developer reference for function config_boolean_select()

config_add_boolean_select()

Developer reference for function config_add_boolean_select()

config_add_checkbox_select()

Developer reference for function config_add_checkbox_select()

config_single_ftype_select()

Developer reference for function config_single_ftype_select()

generateNodesExport()

Developer reference for function generateNodesExport()

db_use_multiple_connection_modes()

Developer reference for function db_use_multiple_connection_modes()

sql_connect()

Developer reference for function sql_connect()

sql_query_prepared()

Developer reference for function sql_query_prepared()

rsDecrypt()

Developer reference for function rsDecrypt()

initFacialRecognition()

Developer reference for function initFacialRecognition()

tidylist()

Developer reference for function tidylist()

get_all_site_text()

Developer reference for function get_all_site_text()

send_statistics()

Developer reference for function send_statistics()

job_queue_run_job()

Developer reference for function job_queue_run_job()

lang_or_i18n_get_translated()

Developer reference for function lang_or_i18n_get_translated()

i18n_get_translated()

Developer reference for function i18n_get_translated()

i18n_get_indexable()

Developer reference for function i18n_get_indexable()

resource_log_last_rows()

Developer reference for function resource_log_last_rows()

perform_login()

Developer reference for function perform_login()

runFitsForFile()

Developer reference for function runFitsForFile()

check_date_format()

Developer reference for function check_date_format()

check_date_parts()

Developer reference for function check_date_parts()

check_view_display_condition()

Developer reference for function check_view_display_condition()

migrate_category_tree_to_nodes()

Developer reference for function migrate_category_tree_to_nodes()

populate_resource_nodes()

Developer reference for function populate_resource_nodes()

migrate_filter()

Developer reference for function migrate_filter()

get_export_tables()

Developer reference for function get_export_tables()

set_node()

Developer reference for function set_node()

delete_node()

Developer reference for function delete_node()

get_nodes()

Developer reference for function get_nodes()

render_new_node_record()

Developer reference for function render_new_node_record()

get_node_order_by()

Developer reference for function get_node_order_by()

draw_tree_node_table()

Developer reference for function draw_tree_node_table()

check_node_indexed()

Developer reference for function check_node_indexed()

add_node_keyword_mappings()

Developer reference for function add_node_keyword_mappings()

remove_node_keyword_mappings()

Developer reference for function remove_node_keyword_mappings()

add_resource_nodes()

Developer reference for function add_resource_nodes()

get_resource_nodes()

Developer reference for function get_resource_nodes()

delete_resource_nodes()

Developer reference for function delete_resource_nodes()

copy_resource_nodes()

Developer reference for function copy_resource_nodes()

get_parent_nodes()

Developer reference for function get_parent_nodes()

get_nodes_count()

Developer reference for function get_nodes_count()

get_node_id()

Developer reference for function get_node_id()

node_orderby_comparator()

Developer reference for function node_orderby_comparator()

get_node_elements()

Developer reference for function get_node_elements()

get_node_tree()

Developer reference for function get_node_tree()

activate_plugin()

Developer reference for function activate_plugin()

deactivate_plugin()

Developer reference for function deactivate_plugin()

config_add_text_list_input()

Developer reference for function config_add_text_list_input()

config_multi_select()

Developer reference for function config_multi_select()

config_add_multi_select()

Developer reference for function config_add_multi_select()

config_single_user_select()

Developer reference for function config_single_user_select()

config_add_single_user_select()

Developer reference for function config_add_single_user_select()

config_multi_user_select()

Developer reference for function config_multi_user_select()

config_add_multi_user_select()

Developer reference for function config_add_multi_user_select()

config_single_group_select()

Developer reference for function config_single_group_select()

config_add_single_group_select()

Developer reference for function config_add_single_group_select()

config_multi_group_select()

Developer reference for function config_multi_group_select()

config_add_multi_group_select()

Developer reference for function config_add_multi_group_select()

config_multi_ftype_select()

Developer reference for function config_multi_ftype_select()

config_add_multi_ftype_select()

Developer reference for function config_add_multi_ftype_select()

config_single_rtype_select()

Developer reference for function config_single_rtype_select()

config_add_single_rtype_select()

Developer reference for function config_add_single_rtype_select()

config_multi_rtype_select()

Developer reference for function config_multi_rtype_select()

config_add_multi_rtype_select()

Developer reference for function config_add_multi_rtype_select()

config_db_single_select()

Developer reference for function config_db_single_select()

config_add_db_single_select()

Developer reference for function config_add_db_single_select()

config_db_multi_select()

Developer reference for function config_db_multi_select()

config_add_db_multi_select()

Developer reference for function config_add_db_multi_select()

render_sort_order()

Developer reference for function render_sort_order()

render_text_question()

Developer reference for function render_text_question()

render_dropdown_question()

Developer reference for function render_dropdown_question()

renderLockButton()

Developer reference for function renderLockButton()

render_resource_image()

Developer reference for function render_resource_image()

render_upload_here_button()

Developer reference for function render_upload_here_button()

render_selected_collection_actions()

Developer reference for function render_selected_collection_actions()

check_display_condition()

Developer reference for function check_display_condition()

display_upload_options()

Developer reference for function display_upload_options()

SaveAndClearButtons()

Developer reference for function SaveAndClearButtons()

get_reports()

Developer reference for function get_reports()

do_report()

Developer reference for function do_report()

send_periodic_report_emails()

Developer reference for function send_periodic_report_emails()

email_collection_request()

Developer reference for function email_collection_request()

managed_collection_request()

Developer reference for function managed_collection_request()

email_resource_request()

Developer reference for function email_resource_request()

send_research_request()

Developer reference for function send_research_request()

get_research_requests()

Developer reference for function get_research_requests()

get_research_request()

Developer reference for function get_research_request()

get_resource_data()

Developer reference for function get_resource_data()

put_resource_data()

Developer reference for function put_resource_data()

create_resource()

Developer reference for function create_resource()

save_resource_data()

Developer reference for function save_resource_data()

set_resource_defaults()

Developer reference for function set_resource_defaults()

save_resource_data_multi()

Developer reference for function save_resource_data_multi()

remove_keyword_mappings()

Developer reference for function remove_keyword_mappings()

remove_keyword_from_resource()

Developer reference for function remove_keyword_from_resource()

add_keyword_mappings()

Developer reference for function add_keyword_mappings()

add_keyword_to_resource()

Developer reference for function add_keyword_to_resource()

get_resource_types()

Developer reference for function get_resource_types()

get_resource_top_keywords()

Developer reference for function get_resource_top_keywords()

clear_resource_data()

Developer reference for function clear_resource_data()

copy_resource()

Developer reference for function copy_resource()

resource_log()

Developer reference for function resource_log()

get_resource_log()

Developer reference for function get_resource_log()

update_resource_type()

Developer reference for function update_resource_type()

update_resource()

Developer reference for function update_resource()

get_alternative_files()

Developer reference for function get_alternative_files()

notify_user_contributed_submitted()

Developer reference for function notify_user_contributed_submitted()

notify_user_contributed_unsubmitted()

Developer reference for function notify_user_contributed_unsubmitted()

get_resources_matching_keyword()

Developer reference for function get_resources_matching_keyword()

get_keyword_from_option()

Developer reference for function get_keyword_from_option()

get_edit_access()

Developer reference for function get_edit_access()

log_diff()

Developer reference for function log_diff()

reindex_resource()

Developer reference for function reindex_resource()

update_disk_usage()

Developer reference for function update_disk_usage()

copyAllDataToResource()

Developer reference for function copyAllDataToResource()

copyResourceDataValues()

Developer reference for function copyResourceDataValues()

copy_locked_data()

Developer reference for function copy_locked_data()

process_edit_form()

Developer reference for function process_edit_form()

save_original_file_as_alternative()

Developer reference for function save_original_file_as_alternative()

get_resources_by_resource_data_value()

Developer reference for function get_resources_by_resource_data_value()

get_nopreview_icon()

Developer reference for function get_nopreview_icon()

add_verbatim_keywords()

Developer reference for function add_verbatim_keywords()

get_download_filename()

Developer reference for function get_download_filename()

canSeePreviewTools()

Developer reference for function canSeePreviewTools()

tab_names()

Developer reference for function tab_names()

get_resource_table_joins()

Developer reference for function get_resource_table_joins()

search_form_to_search_query()

Developer reference for function search_form_to_search_query()

refine_searchstring()

Developer reference for function refine_searchstring()

compile_search_actions()

Developer reference for function compile_search_actions()

search_filter()

Developer reference for function search_filter()

search_special()

Developer reference for function search_special()

split_keywords()

Developer reference for function split_keywords()

cleanse_string()

Developer reference for function cleanse_string()

add_partial_index()

Developer reference for function add_partial_index()

highlightkeywords()

Developer reference for function highlightkeywords()

get_suggested_keywords()

Developer reference for function get_suggested_keywords()

get_filters()

Developer reference for function get_filters()

get_filter_rule()

Developer reference for function get_filter_rule()

update_search_from_request()

Developer reference for function update_search_from_request()

getThemePathPerms()

Developer reference for function getThemePathPerms()

make_password()

Developer reference for function make_password()

get_user_log()

Developer reference for function get_user_log()

get_selectedtypes()

Developer reference for function get_selectedtypes()

check_order_by_in_table_joins()

Developer reference for function check_order_by_in_table_joins()

config_multi_archive_select()

Developer reference for function config_multi_archive_select()

config_add_multi_archive_select()

Developer reference for function config_add_multi_archive_select()

render_featured_collections()

Developer reference for function render_featured_collections()

render_featured_collection()

Developer reference for function render_featured_collection()

dash_tile_featured_collection_get_resources()

Developer reference for function dash_tile_featured_collection_get_resources()

get_resource_nodes_batch()

Developer reference for function get_resource_nodes_batch()

get_resource_data_batch()

Developer reference for function get_resource_data_batch()

compute_featured_collections_access_control()

Description Compute the featured collections allowed based on current access control TRUE if user has access to all featured collections. If some access control is in place, then the return will be an array with all the allowed featured collections Parameters This function accepts no parameters.

Frequently Asked Questions (FAQs)

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

render_share_password_question()

Description Renders a question field for setting a share password. This function generates an HTML input field where users can set or change the password for shared access to a resource.

leaflet_polygon_parsing()

Description Parses the resource polygon string to extract latitude and longitude bounds and formats the polygon string. as well as the formatted polygon string for Leaflet display.

leaflet_markers_legend()

Description Creates a map color markers legend for Leaflet maps. This function generates HTML for a legend that displays markers with colors corresponding to resource types or custom metadata field values.

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.

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.

search_title_node_processing()

Description Convert node searches into a friendly syntax. Used by search_title_processing.php Parameters Column Type Default Description $string string Search string Return string Location include/search_functions.

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.

exiftool_resolution_calc()

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

get_dash_search_data()

Description Get images and resource count for search dash tile. This has to work on a string because the dash tile does not yet exist when on dash creation page For performance this function will return a maximum of 4 images Parameters Column Type Default Description $link string '' Tile link URL $promimg int 0 Promoted image ref Return array $searchdata Array containing the count of resources and details of preview images.

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.

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.

check_delete_nodes()

The check_delete_nodes() function is used to check an array of node IDs and delete any that relate to non-fixed list fields and are unused. The function takes an array of node IDs as a parameter and checks each node to see if it is related to a non-fixed list field.

get_tabs_with_usage_count()

The get_tabs_with_usage_count() function is used to retrieve tabs based on certain criteria, such as order by and limit. The function takes an array of criteria information as a parameter, including the order by and limit values.

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.

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.

cattree_node_creator()

The cattree_node_creator() function is a helper function used to build node entry arrays for ordering. It takes in several parameters, including the node ID, category tree field ID, node name, parent node ID, node order by, resource ID, and an array of child node IDs.

cattree_node_flatten()

The cattree_node_flatten() function is a helper function that adds child nodes after each flattened parent node. It takes an array of nodes, each with a child node array, as a parameter and returns an array of nodes with child nodes flattened out after their respective parents.

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.

get_all_resource_types()

The get_all_resource_types() function returns an array of all resource types ordered by 'order_by' then 'ref'. This function does not check or apply any permissions, so it should not be exposed to the API.

report_process_query_placeholders()

The report_process_query_placeholders() function is used to find and replace a report's query placeholders with their values. It takes two parameters: $query, which is the report's SQL query, and $placeholders, which is an array that maps between a placeholder and its actual value.

process_resource_data_joins_values()

The function "process_resource_data_joins_values()" is used to process resource data_joins array and update the values in the returned resource. The function takes two parameters, the first being the resource table record, and the second being the list of refs for the resource table data_joins.

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.

prefix_value()

Description Helper function to quickly build a list of values, all prefixed the same way. Example use: $fieldXs = array_map(prefix_value('field'), [3, 88]); Parameters Column Type Default Description $prefix: string $format string $datetime; $needle $prefix string Prefix value to prepend.

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.

migrate_fixed_to_text()

Description Migrate fixed list field data to text field data for a given resource reference. Useful when changing resource type field from a data type that can contain multiple values such as a dynamic keywords field.

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.

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.

render_resource_type_selector_question()

Parameters Column Type Default Description $label string $name string $class string "stdwidth" $hidden bool false $current true false true; Location include/render_functions.

apply_resource_default()

Description When changing resource type, new resource type specific fields may become available. This function will apply any resource default values for resource type specific fields that were not previously available (i.

get_user_actions_recent()

Description Get recent user actions, optionally for all users. For use by action notifications cron job. the 'a' permission and the current script is not running from CLI then only the currently logged on user's actions will be returned Included columns are as per get_user_actions() - resourcerequest - array of resource requests - userrequest - array of user requests - resourcereview - array of resources to reviewdescription) Parameters Column Type Default Description $minutes int Return actions that were created in the last $minutes minutes $allusers bool Return actions for all users? If false, or if the current user does not have $userref; []; // Find all resources that have changed archive state in the given number of minutes ifis_int_loose$view_title_field Return array An array with the user id as the index and the following arrays of sub elements.

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.

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.

related_resource_pull()

Description Get a related resource to pull images from Parameters Column Type Default Description $resource array Array of resource data from do_search() Return array|bool $resdata Array of alternative resource data to use, or false if not configured or no resource image found Location include/resource_functions.

get_resource_preview()

Description Get the largest available preview URL for the given resource and the given array of sizes Parameters Column Type Default Description $resource array Array of resource data from get_resource_data() or search results $sizes array [] Array of size IDs to look through, in order of size.

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.

update_node_active_state()

Description Batch update nodes' active state to the database. The same state will apply to all nodes in the list. For logic on which nodes to toggle {@see toggle_active_state_for_nodes()} Parameters Column Type Default Description $refs list Node IDs $active: bool $active bool Should nodes be active or not? Location include/node_functions.

toggle_active_state_for_nodes()

Description Toggle nodes' active state Parameters Column Type Default Description $refs: array 'ref' 'asc' '' [FIELD_TYPE_CATEGORY_TREE] 'ref'; $refs list Node IDs Return array<int, 0|1> Location include/node_functions.

toggle_category_tree_nodes_active_state()

Description Toggle category tree nodes' active state Parameters Column Type Default Description $rtf int Resource type field ID $node_refs: array null array_flip$node_refs; $node_refs list Return array<int, 0|1> Location include/node_functions.

Brand Guidelines (v10.5+)

The article outlines the brand guidelines for version 10.5 and above. It covers essential information such as logo usage, color palette, typography, and design elements to maintain brand consistency. The guidelines emphasize the correct application of the logo in various formats and backgrounds, specifying clear space requirements and prohibited alterations.

get_nopreview_html()

Description Returns the HTML necessary to represent a resource with the given extension when no image preview exists. Parameters Column Type Default Description $extension string File extension for optionally is default "" $field_order_by "ref" $field_sort "asc" $find "" $fieldtypes array $include_inactive false Return string Location include/resource_functions.

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.

This site uses cookies for interactivity and analytics Reject cookies Accept cookies

Start Free Trial or check out the Service Pricing