Jump to content

Fields field: Difference between revisions

From EPrints Documentation
Amended structure to standardise for metadata field type.
 
Line 14: Line 14:


{| border="1" cellpadding="3" cellspacing="0"
{| border="1" cellpadding="3" cellspacing="0"
| name || default || description
! Name !! Default Value !! Required !! Description !! Notes
|-
|-
| datasetid || n/a || '''This property is always required.'''
| '''datasetid''' || n/a || YES || ID of dataset from which to list fields. ||
|-
|-
| '''options''' || n/a || '''This property is ''not'' inherited from [[set field]].'''
| '''options''' || n/a || NO || Options from which to choose. || NOT inherited from [[Set field]]. Options provided automatically.
|}
|}



Latest revision as of 21:33, 11 April 2023


Description[edit]

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[edit]

Additional Properties[edit]

As for Set fields except for

Name Default Value Required Description Notes
datasetid n/a YES ID of dataset from which to list fields.
options n/a NO Options from which to choose. NOT inherited from Set field. Options provided automatically.

Required Phrases[edit]

No additional phrases beyond those required for Set fields.

Database[edit]

Namedset fields are stored in the database as

fieldname VARCHAR(255)

API[edit]

See API page.

Examples[edit]

Most basic example.

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

Store mulltiple field values

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