Difference between revisions of "Fields field"

From EPrints Documentation
Jump to: navigation, search
(Amended structure to standardise for metadata field type.)
Line 1: Line 1:
 
{{fieldtypes}}
 
{{fieldtypes}}
  
== Inherritance ==
 
  
 +
== Description ==
 +
This field allows the selection of field (names) from a specified dataset.  This is useful if you want to capture what particular field should be used for a specific purpose.
 +
 +
== Inheritance ==
 
* [[Metadata]]
 
* [[Metadata]]
 
** [[Set field]]
 
** [[Set field]]
 
*** [[Fields field]]
 
*** [[Fields field]]
== Description ==
 
  
== Properties ==
+
== Additional Properties ==
 
+
As for [[Set field#Additional Properties|Set fields]] except for
As for [[set field]]s with the following differences...
 
  
 
{| border="1" cellpadding="3" cellspacing="0"
 
{| border="1" cellpadding="3" cellspacing="0"
Line 21: Line 22:
  
 
== Required Phrases ==
 
== Required Phrases ==
 +
No additional phrases beyond those required for [[Set field#Required_Phrases|Set fields]].
 +
 +
== Database ==
 +
Namedset fields are stored in the database as
 +
fieldname VARCHAR(255)
 +
 +
== API ==
 +
See [[API:EPrints/MetaField/Namedset|API page]].
 +
 +
== Examples ==
 +
Most basic example.
 +
{
 +
    name => 'id_field',
 +
    type => 'fields',
 +
    datasetid => 'eprint',
 +
}   
 +
Store mulltiple field values
 +
{
 +
    name => 'review_fields',
 +
    type => 'fields',
 +
    multiple => 1,
 +
    datasetid => 'eprint',
 +
}

Revision as of 21:43, 10 April 2023

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


Metadata Fields: Arclanguage - Base64 - Bigint - Boolean - Compound - Counter - Dataobjref - Date - Decimal - Email - Fields - Float - Id - Idci - Image - Int - Itemref - Keywords - Langid - Longtext - Longtext_counter - Multilang - Multipart - Name - Namedset - Pagerange - Recaptcha - Recaptcha3 - Relation - Search - Secret - Set - Storable - Subject - Subobject - Text - Time - Timestamp - Url - Uuid


Description

This field allows the selection of field (names) from a specified dataset. This is useful if you want to capture what particular field should be used for a specific purpose.

Inheritance

Additional Properties

As for Set fields except for

name default description
datasetid n/a This property is always required.
options n/a This property is not inherited from set field.

Required Phrases

No additional phrases beyond those required for Set fields.

Database

Namedset fields are stored in the database as

fieldname VARCHAR(255)

API

See API page.

Examples

Most basic example.

{
    name => 'id_field',
    type => 'fields',
    datasetid => 'eprint',
}    

Store mulltiple field values

{
    name => 'review_fields',
    type => 'fields',
    multiple => 1,
    datasetid => 'eprint',
}