{"id":2836,"date":"2025-06-12T13:13:23","date_gmt":"2025-06-12T10:13:23","guid":{"rendered":"https:\/\/www.collectionpro.fi\/?post_type=ht_kb&#038;p=2836"},"modified":"2025-06-12T13:22:52","modified_gmt":"2025-06-12T10:22:52","slug":"system-data-types","status":"publish","type":"ht_kb","link":"https:\/\/www.collectionpro.fi\/en\/help\/system-data-types\/","title":{"rendered":"System data types"},"content":{"rendered":"\n<p>Collection Pro uses several predefined\u00a0<strong>system data types<\/strong>\u00a0that are essential for managing and organizing core functionality. These data types serve as the foundation for user management, access control, and resource allocation.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Common system data types<\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>User<\/strong>\u00a0\u2013 Represents an individual account with access to the system.<\/li>\n\n\n\n<li><strong>Group<\/strong>\u00a0\u2013 A collection of users, typically used to manage permissions collectively.<\/li>\n\n\n\n<li><strong>Pool<\/strong>\u00a0\u2013 A resource container used for organizing and managing digital assets or metadata.<\/li>\n\n\n\n<li><strong>File<\/strong>\u00a0\u2013 Stores all files used in the system, including objects, plugins, logos, user pictures, and more. Files can be uploaded, linked, and enriched with metadata.<\/li>\n<\/ul>\n\n\n\n<p>Additional system data types may be used depending on your configuration and use case.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">user<\/h2>\n\n\n\n<p>The\u00a0<code>user<\/code>\u00a0system data type stores information about individuals who have access to the Collection Pro system. Each user is uniquely identified and may have associated metadata used for authentication, display, and permissions.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">User fields<\/h3>\n\n\n\n<figure class=\"wp-block-table is-style-stripes\"><table><thead><tr><th><strong>Field<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>_generated_displayname<\/code><\/td><td>string<\/td><td>Automatically generated display name, typically derived from the user&#8217;s login and email.<\/td><\/tr><tr><td><code>_id<\/code><\/td><td>int64<\/td><td>Unique identifier for the user, assigned automatically by the system.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\">file<\/h2>\n\n\n\n<p>The\u00a0<code>file<\/code>\u00a0system data type in Collection Pro stores all files used throughout the system. These include:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Objects<\/strong><\/li>\n\n\n\n<li><strong>Plugins<\/strong><\/li>\n\n\n\n<li><strong>Logos, backgrounds, XSLT files<\/strong>\u00a0(from base configuration)<\/li>\n\n\n\n<li><strong>User pictures and custom data<\/strong><\/li>\n\n\n\n<li><strong>Pool watermarks and custom data<\/strong><\/li>\n\n\n\n<li><strong>Object type custom data<\/strong><\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\">Uploading files<\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Direct upload<\/strong>\u00a0via\u00a0<code>\/api\/eas\/put<\/code><\/li>\n\n\n\n<li><strong>Remote URL copy<\/strong>\u00a0via\u00a0<code>\/api\/eas\/rput<\/code><\/li>\n\n\n\n<li><strong>WebDAV<\/strong><\/li>\n\n\n\n<li><strong>Plugin upload<\/strong>\u00a0via\u00a0<code>\/api\/plugin\/manage<\/code>\u00a0(for plugins of type\u00a0<code>url<\/code>)<\/li>\n<\/ul>\n\n\n\n<p>Collection Pro supports storage in configurable backends such as\u00a0<strong>S3<\/strong>\u00a0or\u00a0<strong>local disk<\/strong>. It can also manage\u00a0<strong>purely remote files<\/strong>, storing only the URL.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Metadata extraction<\/h3>\n\n\n\n<p>Collection Pro automatically runs programs to extract metadata from each file. This process is extensible via plugins, allowing custom metadata extraction workflows.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">File fields<\/h3>\n\n\n\n<figure class=\"wp-block-table is-style-stripes\"><table><thead><tr><th><strong>Field<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>_duplicates<\/code><\/td><td>array<\/td><td>List of duplicate files, if any.<\/td><\/tr><tr><td><code>_id<\/code><\/td><td>int64<\/td><td>Unique ID assigned when the file is uploaded.<\/td><\/tr><tr><td><code>_linked_objects<\/code><\/td><td>array<\/td><td>Objects created from this file, based on collection upload settings.<\/td><\/tr><tr><td><code>_mapped_metadata<\/code><\/td><td>object<\/td><td>Rendered object data mapped from file metadata.<\/td><\/tr><tr><td><code>best_date<\/code><\/td><td>timestamp<\/td><td>Best available date from metadata: <code>date_time_original<\/code>, <code>create_date<\/code>, or <code>date_uploaded<\/code>.<\/td><\/tr><tr><td><code>children<\/code><\/td><td>array<\/td><td>Pages of page able formats (e.g., PDF), formatted as <code>file_id\/page_number<\/code>.<\/td><\/tr><tr><td><code>class<\/code><\/td><td>string<\/td><td>File class (e.g., image, audio, video), determined by recipe.<\/td><\/tr><tr><td><code>class_extension<\/code><\/td><td>string<\/td><td>Concatenation of class and version (e.g., <code>image.v1<\/code>).<\/td><\/tr><tr><td><code>class_version_status<\/code><\/td><td>string<\/td><td>Concatenation of class, version, and status.<\/td><\/tr><tr><td><code>compiled<\/code><\/td><td>string<\/td><td>Human-readable summary (e.g., <code>JPG, 1920x1285 px, 569.5 kB<\/code>).<\/td><\/tr><tr><td><code>compiled_props<\/code><\/td><td>object<\/td><td>Structured version of <code>compiled<\/code> for front end display.<\/td><\/tr><tr><td><code>dimensions<\/code><\/td><td>string<\/td><td>Rendered dimensions, may include units (e.g., A4).<\/td><\/tr><tr><td><code>duration<\/code><\/td><td>string<\/td><td>Runtime for audio\/video files.<\/td><\/tr><tr><td><code>extension<\/code><\/td><td>string<\/td><td>Uppercase file extension.<\/td><\/tr><tr><td><code>pages<\/code><\/td><td>string<\/td><td>Number of pages (e.g., <code>12p<\/code>).<\/td><\/tr><tr><td><code>date_uploaded<\/code><\/td><td>timestamp<\/td><td>Upload timestamp (UTC).<\/td><\/tr><tr><td><code>eas_parent_id<\/code><\/td><td>int64<\/td><td>ID of the parent file (e.g., for renditions).<\/td><\/tr><tr><td><code>filesize<\/code><\/td><td>int64<\/td><td>File size in bytes.<\/td><\/tr><tr><td><code>frontend_prefs<\/code><\/td><td>object<\/td><td>Custom front end attributes (object-specific).<\/td><\/tr><tr><td><code>hash<\/code><\/td><td>string<\/td><td>File hash (SHA-256 for local, MD5 for remote). Used for duplicate detection.<\/td><\/tr><tr><td><code>is_original<\/code><\/td><td>boolean<\/td><td><code>true<\/code> if original; <code>false<\/code> if rendition.<\/td><\/tr><tr><td><code>last_status_at<\/code><\/td><td>timestamp<\/td><td>Last status update timestamp.<\/td><\/tr><tr><td><code>lookup:_id<\/code><\/td><td>object<\/td><td>Lookup reference.<\/td><\/tr><tr><td><code>metadata<\/code><\/td><td>object<\/td><td>Metadata groups and values.<\/td><\/tr><tr><td><code>name<\/code><\/td><td>string<\/td><td>Custom file name (object-specific).<\/td><\/tr><tr><td><code>original_filename<\/code><\/td><td>string<\/td><td>Filename without path.<\/td><\/tr><tr><td><code>original_filename_basename<\/code><\/td><td>string<\/td><td>Filename without path or extension.<\/td><\/tr><tr><td><code>original_filepath<\/code><\/td><td>string<\/td><td>Full path as uploaded (may include drive letters).<\/td><\/tr><tr><td><code>pages_allowed<\/code><\/td><td>boolean<\/td><td>Indicates if file supports pages.<\/td><\/tr><tr><td><code>preferred<\/code><\/td><td>boolean<\/td><td>Marks this file as preferred among versions.<\/td><\/tr><tr><td><code>reference<\/code><\/td><td>string<\/td><td>Unique reference string (e.g., <code>sha256:&lt;hash&gt;<\/code>).<\/td><\/tr><tr><td><code>status<\/code><\/td><td>string<\/td><td>File status: <code>pending<\/code>, <code>processing<\/code>, <code>sync<\/code>, <code>done<\/code>, <code>failed<\/code>.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Technical metadata<\/h3>\n\n\n\n<figure class=\"wp-block-table is-style-stripes\"><table><thead><tr><th><strong>Field<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>aspect_ratio<\/code><\/td><td>float64<\/td><td>Aspect ratio of the file.<\/td><\/tr><tr><td><code>audio_codec<\/code><\/td><td>array<\/td><td>Audio codecs used.<\/td><\/tr><tr><td><code>blurhash<\/code><\/td><td>string<\/td><td>Blurhash representation.<\/td><\/tr><tr><td><code>camera_scanner<\/code><\/td><td>string<\/td><td>Camera or scanner used.<\/td><\/tr><tr><td><code>colordepth<\/code><\/td><td>int<\/td><td>Color depth.<\/td><\/tr><tr><td><code>colorprofile<\/code><\/td><td>string<\/td><td>Color profile.<\/td><\/tr><tr><td><code>colorspace<\/code><\/td><td>string<\/td><td>Color space.<\/td><\/tr><tr><td><code>create_date<\/code><\/td><td>string<\/td><td>Creation date.<\/td><\/tr><tr><td><code>date_time_original<\/code><\/td><td>string<\/td><td>Original date\/time from metadata.<\/td><\/tr><tr><td><code>dimensions<\/code><\/td><td>object<\/td><td>Includes <code>height<\/code>, <code>width<\/code>, <code>unit<\/code>.<\/td><\/tr><tr><td><code>dpi<\/code><\/td><td>int<\/td><td>Dots per inch.<\/td><\/tr><tr><td><code>duration<\/code><\/td><td>int<\/td><td>Duration in seconds.<\/td><\/tr><tr><td><code>file_type_extension<\/code><\/td><td>string<\/td><td>File type extension.<\/td><\/tr><tr><td><code>filesize<\/code><\/td><td>int64<\/td><td>File size in bytes.<\/td><\/tr><tr><td><code>format<\/code><\/td><td>string<\/td><td>Format: <code>landscape<\/code>, <code>portrait<\/code>, or <code>square<\/code>.<\/td><\/tr><tr><td><code>gps_location<\/code><\/td><td>object<\/td><td>Includes <code>latitude<\/code>, <code>longitude<\/code>, <code>altitude<\/code>.<\/td><\/tr><tr><td><code>has_clipping_path<\/code><\/td><td>boolean<\/td><td>Indicates presence of clipping path.<\/td><\/tr><tr><td><code>height<\/code><\/td><td>int<\/td><td>Height in pixels.<\/td><\/tr><tr><td><code>max_dimension<\/code><\/td><td>int<\/td><td>Maximum dimension.<\/td><\/tr><tr><td><code>mime_type<\/code><\/td><td>string<\/td><td>MIME type.<\/td><\/tr><tr><td><code>num_glyphs<\/code><\/td><td>int<\/td><td>Number of glyphs (for fonts).<\/td><\/tr><tr><td><code>orientation<\/code><\/td><td>string<\/td><td>Orientation of the file.<\/td><\/tr><tr><td><code>pages<\/code><\/td><td>int<\/td><td>Number of pages.<\/td><\/tr><tr><td><code>sha256_hash<\/code><\/td><td>string<\/td><td>SHA-256 hash of the file.<\/td><\/tr><tr><td><code>video_codec<\/code><\/td><td>array<\/td><td>Video codecs used.<\/td><\/tr><tr><td><code>width<\/code><\/td><td>int<\/td><td>Width in pixels.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">File versions<\/h3>\n\n\n\n<figure class=\"wp-block-table is-style-stripes\"><table><thead><tr><th><strong>Field<\/strong><\/th><th><strong>Type<\/strong><\/th><th><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td><code>_download_allowed<\/code><\/td><td>string<\/td><td>Indicates whether the version is available for download.<\/td><\/tr><tr><td><code>_id<\/code><\/td><td>string<\/td><td>Unique identifier for the file version.<\/td><\/tr><tr><td><code>aspect_ratio<\/code><\/td><td>string<\/td><td>Aspect ratio of the version (e.g., <code>16:9<\/code>).<\/td><\/tr><tr><td><code>blurhash<\/code><\/td><td>string<\/td><td>Blur hash representation for quick previews.<\/td><\/tr><tr><td><code>class<\/code><\/td><td>string<\/td><td>File class (e.g., image, video, audio).<\/td><\/tr><tr><td><code>class_extension<\/code><\/td><td>string<\/td><td>Concatenation of class and version (e.g., <code>image.v1<\/code>).<\/td><\/tr><tr><td><code>date_created<\/code><\/td><td>string<\/td><td>Timestamp when this version was created.<\/td><\/tr><tr><td><code>deep_link_url<\/code><\/td><td>string<\/td><td>Direct URL to access this version.<\/td><\/tr><tr><td><code>delete_url<\/code><\/td><td>string<\/td><td>URL to delete this version.<\/td><\/tr><tr><td><code>dpi<\/code><\/td><td>string<\/td><td>Dots per inch for this version.<\/td><\/tr><tr><td><code>extension<\/code><\/td><td>string<\/td><td>File extension (e.g., <code>JPG<\/code>, <code>MP4<\/code>).<\/td><\/tr><tr><td><code>filesize<\/code><\/td><td>string<\/td><td>Size of the file version in bytes.<\/td><\/tr><tr><td><code>hash<\/code><\/td><td>string<\/td><td>Hash of the file version (used for integrity checks).<\/td><\/tr><tr><td><code>height<\/code><\/td><td>string<\/td><td>Height in pixels.<\/td><\/tr><tr><td><code>iiif_url<\/code><\/td><td>string<\/td><td>IIIF-compatible URL for image delivery.<\/td><\/tr><tr><td><code>last_status_at<\/code><\/td><td>string<\/td><td>Last time the version&#8217;s status was updated.<\/td><\/tr><tr><td><code>orientation<\/code><\/td><td>string<\/td><td>Orientation of the file (e.g., <code>portrait<\/code>, <code>landscape<\/code>).<\/td><\/tr><tr><td><code>path<\/code><\/td><td>string<\/td><td>Internal path to the file version.<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"<p>Collection Pro uses several predefined\u00a0system data types\u00a0that are essential for managing and organizing core functionality. These data types serve as the foundation for user management, access control, and resource allocation. Common system data types Additional system data types may be used depending on your configuration and use case. user The\u00a0user\u00a0system data type stores information about&#8230;<\/p>\n","protected":false},"author":2,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":{"footnotes":""},"ht-kb-category":[82],"ht-kb-tag":[],"class_list":["post-2836","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-for-developers"],"_links":{"self":[{"href":"https:\/\/www.collectionpro.fi\/en\/wp-json\/wp\/v2\/ht-kb\/2836","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.collectionpro.fi\/en\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/www.collectionpro.fi\/en\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/www.collectionpro.fi\/en\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.collectionpro.fi\/en\/wp-json\/wp\/v2\/comments?post=2836"}],"version-history":[{"count":3,"href":"https:\/\/www.collectionpro.fi\/en\/wp-json\/wp\/v2\/ht-kb\/2836\/revisions"}],"predecessor-version":[{"id":2841,"href":"https:\/\/www.collectionpro.fi\/en\/wp-json\/wp\/v2\/ht-kb\/2836\/revisions\/2841"}],"wp:attachment":[{"href":"https:\/\/www.collectionpro.fi\/en\/wp-json\/wp\/v2\/media?parent=2836"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/www.collectionpro.fi\/en\/wp-json\/wp\/v2\/ht-kb-category?post=2836"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/www.collectionpro.fi\/en\/wp-json\/wp\/v2\/ht-kb-tag?post=2836"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}