System data types

Collection Pro uses several predefined system data types that 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

• User – Represents an individual account with access to the system.
• Group – A collection of users, typically used to manage permissions collectively.
• Pool – A resource container used for organizing and managing digital assets or metadata.
• File – Stores all files used in the system, including objects, plugins, logos, user pictures, and more. Files can be uploaded, linked, and enriched with metadata.

Additional system data types may be used depending on your configuration and use case.

user

The user system 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.

User fields

Field	Type	Description
_generated_displayname	string	Automatically generated display name, typically derived from the user’s login and email.
_id	int64	Unique identifier for the user, assigned automatically by the system.

file

The file system data type in Collection Pro stores all files used throughout the system. These include:

• Objects
• Plugins
• Logos, backgrounds, XSLT files (from base configuration)
• User pictures and custom data
• Pool watermarks and custom data
• Object type custom data

Uploading files

• Direct upload via /api/eas/put
• Remote URL copy via /api/eas/rput
• WebDAV
• Plugin upload via /api/plugin/manage (for plugins of type url)

Collection Pro supports storage in configurable backends such as S3 or local disk. It can also manage purely remote files, storing only the URL.

Metadata extraction

Collection Pro automatically runs programs to extract metadata from each file. This process is extensible via plugins, allowing custom metadata extraction workflows.

File fields

Field	Type	Description
_duplicates	array	List of duplicate files, if any.
_id	int64	Unique ID assigned when the file is uploaded.
_linked_objects	array	Objects created from this file, based on collection upload settings.
_mapped_metadata	object	Rendered object data mapped from file metadata.
best_date	timestamp	Best available date from metadata: date_time_original, create_date, or date_uploaded.
children	array	Pages of page able formats (e.g., PDF), formatted as file_id/page_number.
class	string	File class (e.g., image, audio, video), determined by recipe.
class_extension	string	Concatenation of class and version (e.g., image.v1).
class_version_status	string	Concatenation of class, version, and status.
compiled	string	Human-readable summary (e.g., JPG, 1920x1285 px, 569.5 kB).
compiled_props	object	Structured version of compiled for front end display.
dimensions	string	Rendered dimensions, may include units (e.g., A4).
duration	string	Runtime for audio/video files.
extension	string	Uppercase file extension.
pages	string	Number of pages (e.g., 12p).
date_uploaded	timestamp	Upload timestamp (UTC).
eas_parent_id	int64	ID of the parent file (e.g., for renditions).
filesize	int64	File size in bytes.
frontend_prefs	object	Custom front end attributes (object-specific).
hash	string	File hash (SHA-256 for local, MD5 for remote). Used for duplicate detection.
is_original	boolean	true if original; false if rendition.
last_status_at	timestamp	Last status update timestamp.
lookup:_id	object	Lookup reference.
metadata	object	Metadata groups and values.
name	string	Custom file name (object-specific).
original_filename	string	Filename without path.
original_filename_basename	string	Filename without path or extension.
original_filepath	string	Full path as uploaded (may include drive letters).
pages_allowed	boolean	Indicates if file supports pages.
preferred	boolean	Marks this file as preferred among versions.
reference	string	Unique reference string (e.g., sha256:<hash>).
status	string	File status: pending, processing, sync, done, failed.

Technical metadata

Field	Type	Description
aspect_ratio	float64	Aspect ratio of the file.
audio_codec	array	Audio codecs used.
blurhash	string	Blurhash representation.
camera_scanner	string	Camera or scanner used.
colordepth	int	Color depth.
colorprofile	string	Color profile.
colorspace	string	Color space.
create_date	string	Creation date.
date_time_original	string	Original date/time from metadata.
dimensions	object	Includes height, width, unit.
dpi	int	Dots per inch.
duration	int	Duration in seconds.
file_type_extension	string	File type extension.
filesize	int64	File size in bytes.
format	string	Format: landscape, portrait, or square.
gps_location	object	Includes latitude, longitude, altitude.
has_clipping_path	boolean	Indicates presence of clipping path.
height	int	Height in pixels.
max_dimension	int	Maximum dimension.
mime_type	string	MIME type.
num_glyphs	int	Number of glyphs (for fonts).
orientation	string	Orientation of the file.
pages	int	Number of pages.
sha256_hash	string	SHA-256 hash of the file.
video_codec	array	Video codecs used.
width	int	Width in pixels.

File versions

Field	Type	Description
_download_allowed	string	Indicates whether the version is available for download.
_id	string	Unique identifier for the file version.
aspect_ratio	string	Aspect ratio of the version (e.g., 16:9).
blurhash	string	Blur hash representation for quick previews.
class	string	File class (e.g., image, video, audio).
class_extension	string	Concatenation of class and version (e.g., image.v1).
date_created	string	Timestamp when this version was created.
deep_link_url	string	Direct URL to access this version.
delete_url	string	URL to delete this version.
dpi	string	Dots per inch for this version.
extension	string	File extension (e.g., JPG, MP4).
filesize	string	Size of the file version in bytes.
hash	string	Hash of the file version (used for integrity checks).
height	string	Height in pixels.
iiif_url	string	IIIF-compatible URL for image delivery.
last_status_at	string	Last time the version’s status was updated.
orientation	string	Orientation of the file (e.g., portrait, landscape).
path	string	Internal path to the file version.