Skip to content
  • There are no suggestions because the search field is empty.

Field Types and Record SchemaΒ πŸ“•Β 

Read on to learn how record data can be configured. With a variety of field types to choose from, these fields are used to construct your record schema.

Field attributes

First, let's take a look at what makes up a field. Each field will be created with the following attributes:Β Β 

Field Name

The name of the field.Β (Field Name can be the same value as the primary language Display Name.)

Display Name

The name of the field, as it will be displayed to users. (Display Name translations for multiple languages can be added.)

Type

Field type determines what sort of data can be stored in this field.

Class

Field class determines which class this field belongs to.

Placeholder

This is the placeholder text, as it will be displayed to users.

Inline Help

The help text shown for this field.

Content Language

The language of this field.

Default Value

This is the default value for the field if no data is entered when the record is created. For numerical fields, ensure this is a number.

Parent Field

This is the parent field that controls how this field is displayed when a record is edited.

Details

Read-only This field cannot be changed when creating records
Mandatory This field is required to create a record
Multiline This field will allow for multiline text input
Unique The value of this field must not match any existing records. This could be used for an external GUID

Β 

Field Types

Now that we understand the underlying attributes that constitute each field, let's take a look at the different field types that are available:

Text

This field is a free-text field, that can hold any Text or Numbers

Date

This is a standard Date field, that will be recorded in the database as [yyyy-mm-dd]

DatetimeΒ 

This is a standard Datetime field, that will be recorded in the database as [yyyy-mm-dd hh:mm:ss]

Single Select

With this field, you can choose one unique value from a list of predefined terms

Multi Select

With this field, you can choose multiple unique value from a list of predefined terms

CSV

Unlike the single and multi-select fields, the CSV (comma separated values) field can accept new values to populate the database.Β 

Time

This is a standard Time field, that will be recorded in the database as [hh:mm:ss]

Number

This field will hold numerical values only

GUID

This field holds unique values, where no two records can hold the same value. This could be used to integrate legacy GUID data

Imagen record classes

Title The title field is shown on each page, in the same place, and with the same styling.
Date The master date field will be shown on each page in the same way as the Title class. This can be very useful for searching and sorting.
Summary This field details the record, which can be very useful when searching, as this could provide a brief description of the media to a user whilst they browse your collectionΒ 

Β 

Record schema example

Here is a fully functional record schema example. This information could be passed to your Imagen contact to build the schema to your requirements.

If you could like to see how your data will translate to Imagen field types and classes please download Imagen'sΒ field mapping template

Β 

Field NameΒ 

Display NameΒ 

Field TypeΒ Β 

ClassΒ 

NotesΒ 

film_titleΒ 

Film TitleΒ 

TextΒ 

TitleΒ 

This is the main text field, used to quickly identify your media information

film_synopsisΒ 

Film SynopsisΒ 

TextΒ 

SummaryΒ 

This is a text field that could be useful for shorter descriptions (but with no imposed character limits)Β 

full_summaryΒ 

Full SummaryΒ 

TextΒ 

-Β 

This is a text field that could be used to include the full version of the description

release_dateΒ 

Release DateΒ 

DatetimeΒ 

DateΒ 

This is a Date-time field that is often helpful when sorting and ordering recordsΒ 

production_dateΒ 

Production dateΒ 

dateΒ 

-Β 

You can add as many date or Date-time fields as required, even without a classΒ 

film_genreΒ 

Film GenreΒ 

Single SelectΒ 

-Β 

Single-select field (e.g., select one unique value from a predefined list)Β 

film_tagsΒ 

Film tagsΒ 

CSVΒ 

-Β 

This field allows multiple selections from a predefined listΒ 

cast_membersΒ 

Cast MembersΒ 

Multi SelectΒ 

-

This field also allows multiple selections which are not limited to a predefined list (i.e., new values can be added by users as free text).Β 

Custom_field_1Β 

Custom field 1Β 

AnyΒ 

-Β 

This is where you would place custom metadata. You can add as many as you need.Β 

Custom_field_2Β 

Custom field 2Β 

AnyΒ 

-Β 

Β 

πŸ‘©β€πŸŽ“ Now you understand the Imagen Record Schema, follow this link to see how XML can be used to create records: Mapping Files & the Imagen XML Schema

Accessibility πŸ‘Welcome to Imagen!Automated transcription (Speech-to-Text) πŸ‘¨β€πŸŽ“Welcome to Imagen!Developers' Guide πŸ“• πŸ”’Welcome to Imagen!How We Can Help You Onboard Your Content πŸ“•Welcome to Imagen!Introduction to Imagen πŸ“•Welcome to Imagen!Onboarding Guide πŸ“•Welcome to Imagen!The Imagen Transcoder Farm πŸ“•Welcome to Imagen!The Imagen Video Player πŸ“•Welcome to Imagen!Storage Availability πŸ€”Welcome to Imagen!Storage Options πŸ€”Welcome to Imagen!Storage Security πŸ€”Welcome to Imagen!Which Theme Is Right for Me πŸ€”Welcome to Imagen!Why Is User Experience So Important? πŸ€”Welcome to Imagen!Imagen Term Glossary πŸ“°Welcome to Imagen!Supported Browsers πŸ“°Welcome to Imagen!Video Player Keyboard Shortcuts πŸ“°Welcome to Imagen!What is a Media Object Timeline πŸ‘©β€πŸŽ“Welcome to Imagen!Newbie Checklist πŸ‘‹Welcome to Imagen!Activity History ⚑FindGoogle Analytics πŸ‘©β€πŸŽ“FindAdding Annotations to Your Video Content ⚑FindAnnotation Layers πŸ“•FindAnnotations GuideπŸ“•FindExporting Annotations ⚑FindGenerate Subtitles for Audio Content ⚑FindGenerate subtitles for video content ⚑FindGrouping Annotations on Export ⚑FindImagen Subtitle Guide πŸ“•FindReordering Objects Within a Collection πŸ“•FindCustom ReportingFindHow can I see the Open-Source Programming Languages used by Imagen? πŸ€”FindIf I search on the homepage, I get one type of search URL. But I get a different kind of URL on the "Search Results Page" πŸ€”FindMy search results seem out of date ⚠️FindWhat metadata does Imagen extract from my video content? πŸ€”FindImagen Query Language - Media Viewer Widget ⚑FindImagen Query Language Reference πŸ“°FindUnderstanding Imagen Query Language πŸ‘¨β€πŸ«FindArtificial Intelligence ServicesFindDescriptive Metadata Fields πŸ“•FindExtracting Image Metadata on Import ⚑FindField Types and Record SchemaΒ πŸ“•FindImagen Query Language - Related Records View ⚑FindImagen Query Language Guide πŸ“•FindImagen XML Schema Mapping (XSLT) πŸ“•FindSingle/multi-select fields - remote validationFindActivate a Language license ⚑FindChange My Default Language ⚑FindDisplay Multilanguage Annotations ⚑FindHow to configure multilanguage logos ⚑Findlanguage packs πŸ“•FindCreating Parent/Child Field DependenciesFindDeleting RecordsFindRecords & Media Objects πŸ“•FindUpdating Records ⚑FindAdd Fields to the Search Index ⚑FindAdding a filter to the search page ⚑FindAdvanced Search Reference πŸ“°FindSaved Searches πŸ“•FindSearch Index Guide πŸ“•FindUpdating the Imagen Search Index ⚑FindBespoke Ingestion πŸ“•StoreWhat is a 'Watchfolder'? πŸ“•StoreImport from Dropbox ⚑StoreImport from OneDrive ⚑StoreUsing the Record (XML) Import Widget ⚑StoreCan non-media file types still be uploaded to Imagen?πŸ€”StoreCreate a record with media ⚑StoreCreate an empty record with metadata ⚑StoreCreate Imagen XML in Excel πŸ‘©β€πŸŽ“StoreCreateΒ multiple records, each with a single piece of media ⚑StoreImagen Media Workflows πŸ“•StoreImport Media from a URL ⚑StoreMedia Import and Ingestion πŸ“•StoreOptions for Onboarding your Metadata and Media πŸ€”StorePFR (Partial File Restore) and Segments πŸ“•StoreWhat information do you store about my video during ingest? πŸ€”StoreBurnt-in Timecodes (BITC) πŸ“•StoreThe Imagen Image Editor ⚑StoreWatermarking ⚑Store.PDF ViewerStoreAdd a Document Viewer ⚑StoreConfiguring Amazon S3 Intelligent-TieringStoreStorage Costs πŸ“•StoreStorage Profile Reference πŸ“„StoreStorage Replication 🌐StoreSupported File Types πŸ“°StoreConfiguring Amazon S3 Storage TutorialStoreConfiguring Wasabi Storage TutorialStoreStorage LocationsStoreWhy Has My Media Failed to Ingest to Wasabi? πŸ€”StoreConfiguring "Download Profiles" ⚑DistributeInstalling and Using Imagen Accelerated File Delivery (AFD) ⚑DistributeOrdering Clips on Behalf of Other Users πŸ“•DistributeEdit Live Stream Notification Emails ⚑DistributeImagen Live Connect API πŸ“°DistributeAd-hoc PaymentsDistributeIntroduction to Content Licensing πŸ“•DistributePrep: Imagen License and Stripe Accounts ⚑DistributeShopping Basket ConfigurationπŸ“„DistributeShopping BasketsΒ πŸ“•DistributeSubscription Configuration ⚑DistributeSubscription Overview πŸ“•DistributePOST /iweb/v1/notification πŸ“°DistributeAnonymous Sharing Links to Collections (Septeber Release)DistributeCollections πŸ“•DistributeEmbedding Media on External SitesDistributeShare media with unregistered usersDistributeSocial Media PublishingDistributeSunrise/Sunset Dates for Open Access Links ⚑DistributeCreate an MRSS Feed ⚑DistributeImagen Live Connect πŸ“•DistributeImagen MRSS Feed Response πŸ“°DistributeOver the top (OTT) Delivery πŸ“•DistributeBatch Editing Record & Media ACLManageCustom ACLsManageSet When Your Users Can Access Your Content ⚑ManageSetting Default Access Control Lists (ACL) for Records, Media, and Collections ⚑ManageSetting Record & Media Access Control Lists (ACL)ManageWhat are "ACLs"? πŸ€”ManageChanging Your Theme ⚑ManageDisplay banners on your site πŸ‘©β€πŸŽ“ManageI want to add a theme, which is right for me πŸ€”ManagePreview a theme before you commit ⚑ManageAdding Users to Groups ⚑ManageSet Permissions for a Group of Users ⚑ManageDynamic form ⚑ManageImagen Query Language - The Carousel Widget ⚑ManageMap Viewer Widget ⚑ManageWidgets πŸ“•ManageAdobe Premiere Pro IntegrationManageCache Page πŸ“„ManageCookies Page πŸ“°ManageDisplay Fields πŸ“„ManageEmail πŸ“„ManageEnvironment PageπŸ“°ManageFederations πŸ“°ManageGeolocation database πŸ“°ManageGlobal Settings Page πŸ“„ManageHealth Check Page πŸ“°ManageMailing List πŸ“„ManageMaintenance Mode πŸ“„ManageThe Imagen Admin Interface Directory πŸ“‹ (Private)ManageUpdate Page πŸ“°ManageUser Intelligence πŸ“•ManageCreate an OrganisationManageAdding users to user groups through organisations ⚑ManageConfiguring Federated SSO ⚑ManageConfiguring your SSO service provider ⚑ManageGuide to SSO πŸ‘©β€πŸ«ManageI'm being sent back to ImagenWeb from the IDP but I can't get any further πŸ€”ManageCustom Cookie Policy (Javascript) TutorialManageImagen Event ServiceManageBanning a User from Site Access ⚑ManageClear Users That Have Not Been ValidatedManageCreate a Custom Registration ProcessManageCreating Custom Registration FieldsManageCreating request/approval relationships ⚑ManageCustomizing your Login Page ⚑ManageGrant a User Administrator PermissionsManageGrant a User Developer PermissionsManageGranting Site Permissions to an Individual User ⚑ManageGuide to Building Access Control πŸ“•ManageIntroduction to Users, Groups, and Organisations πŸ“•ManageManage Permissions with Imagen πŸ“•ManagePreview Only AccessManageRestrict user sign-ups by geographyManageSetting User Signup RulesManageUser Permissions πŸ“°ManageHow do I add reCAPTCHA to my Imagen siteManageCore REST Interface πŸ“°DevelopersGET /api/v1/endpoints πŸ“°DevelopersGet /core/v1/application πŸ“°DevelopersGET /imcc/v1/job/list πŸ“°DevelopersGET /licenceStatus/πŸ“° WIPDevelopersGET /user/ πŸ“°DevelopersGET history πŸ“°DevelopersGET imcc/v1/job/count πŸ“°DevelopersGET job/searchπŸ“°DevelopersGET rights πŸ“°DevelopersPut /imcc/v1/job πŸ“°DevelopersAuthentication via Signed StringπŸ“°DevelopersHow to authenticate API calls with a Bearer token πŸ“°DevelopersCreating an Application in Imagen ⚑DevelopersGaining a Bearer Token ⚑DevelopersGET /iweb/v1/search πŸ“°DevelopersImagen API Documentation πŸ“• πŸ”’DevelopersGET /iweb/v1/notifications πŸ“°DevelopersGET Profiles πŸ“°DevelopersExample MRSS Reader (Powershell) πŸ“„DevelopersImagen XML Reference πŸ“°DevelopersNew metadata-only record with no media πŸ“°DevelopersNew record with a single piece of media πŸ“°DevelopersNew record with multiple pieces of mediaπŸ“°DevelopersRecord update adding new mediaπŸ“°DevelopersRecord update with metadata only πŸ“°DevelopersSet ACL by XML πŸ“°DevelopersGET /import/record πŸ“°DevelopersGET /iweb/v1/download πŸ“°DevelopersPUT /import/record/ πŸ“°DevelopersCreating a Video Record with the Imagen API πŸ‘©β€πŸ«DevelopersFind the UMID of a media file πŸ‘©β€πŸ«DevelopersHow to find an Import Record (job) GUID πŸ‘©β€πŸ«DevelopersHow to find your Media Control Centre FQDN ⚑ πŸ”’DevelopersHow to find your media ID πŸ‘©β€πŸ«DevelopersHow to Find Your Resource Group Name πŸ‘©β€πŸ«DevelopersProgrammatic API Call Examples πŸ“°DevelopersScopes πŸ“°DevelopersStandard Failure Response πŸ“°DevelopersWhat is a job priority? πŸ‘©β€πŸ«DevelopersDELETE /import/record/ πŸ“°DevelopersDELETE /media πŸ“°DevelopersGET /iweb/v1/users πŸ“°DevelopersWebhooksDevelopersXML Watch Folder Tutorial (Lambda) πŸ”’Partners & InternalDELETE /imcc/v1/media/ πŸ“° πŸ”’Partners & InternalDELETE /imcc/v1/record/ πŸ“° πŸ”’Partners & InternalDELETE imcc/v1/import/record/ πŸ“° πŸ”’Partners & InternalGET imcc/v1/import/record/ πŸ“° πŸ”’Partners & InternalGET imcc/v1/record/search πŸ“° πŸ”’Partners & InternalGET record/validateSearch πŸ“° πŸ”’Partners & InternalPUT imcc/v1/import/record/ πŸ“° πŸ”’Partners & InternalAdd a Video Player ⚑ πŸ”’Partners & InternalAdd an Audio Player ⚑ πŸ”’Partners & InternalAdd an Image Viewer ⚑ πŸ”’Partners & InternalMake a clip from a live feed in progress ⚑ πŸ”’Partners & InternalImagen Deployment Tutorial πŸ”’Partners & InternalWatchfolder Tutorial (Azure Function Media Uploaded Trigger) πŸ”’Partners & InternalWatchfolder Tutorial (Azure Function XML Uploaded Trigger) πŸ”’Partners & InternalOnboarding Playbook πŸ”’Partners & InternalJob and File Status Codes πŸ“„ πŸ”’Partners & InternalAdd a subtitles workflow to Imagen ⚑ πŸ”’Partners & InternalCreate a New Empty Workflow ⚑ πŸ”’Partners & InternalRest Plugin Setup for Vantage Integration πŸ‘©β€πŸ”¬ πŸ”’Partners & InternalWatch Folder With FTPS Tutorial πŸ‘¨β€πŸ« πŸ”’Partners & InternalXML Watch Folder Tutorial (Windows) πŸ”’Partners & Internal