Dataobjref field - Revision history

Drn@ecs.soton.ac.uk: Actually leave in as should become available

2024-07-09T09:50:34Z

Actually leave in as should become available

← Older revision		Revision as of 09:50, 9 July 2024
Line 31:		Line 31:
	Itemref fields are stored in the database as		Itemref fields are stored in the database as
	fieldname INT(11)		fieldname INT(11)

			== API ==
			See [[API:EPrints/MetaField/Dataobjref\|API page]].

	== Examples ==		== Examples ==

Drn@ecs.soton.ac.uk: Removed link to API page (just a redirect to this)

2024-07-09T09:42:32Z

Removed link to API page (just a redirect to this)

← Older revision		Revision as of 09:42, 9 July 2024
Line 31:		Line 31:
	Itemref fields are stored in the database as		Itemref fields are stored in the database as
	fieldname INT(11)		fieldname INT(11)

	~~== API ==~~
	~~See [[API:EPrints/MetaField/Itemref\|API page]].~~

	== Examples ==		== Examples ==

Drn@ecs.soton.ac.uk: /* Additional Properties */

2023-04-11T20:40:31Z

Additional Properties

← Older revision		Revision as of 20:40, 11 April 2023
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 \|\| The ID of the dataset that reference data object belongs. \|\|
	\|-		\|-
	\| '''input_lookup_url''' \|\| lookup/dataobjref \|\| ~~'''~~The CGI script path to use to lookup data objects.~~'''~~		\| '''input_lookup_url''' \|\| <tt>lookup/dataobjref</tt> \|\| NO \|\| The CGI script path to use to lookup data objects. \|\|
	\|-		\|-
			\| '''match''' \|\| <tt>IN</tt> \|\| NO \|\| How to match this fields values in searches. \|\| Different to parent default (<tt>EQ</tt>).
			\|-
			\| '''text_index''' \|\| <tt>1</tt> \|\| NO \|\| Whether the text for these fields should be indexed. \|\| Different to parent default (<tt>0</tt>).
	\|}		\|}

Drn@ecs.soton.ac.uk: Drn@ecs.soton.ac.uk moved page Dataobjref Field to Dataobjref field without leaving a redirect

2023-04-10T20:45:42Z

Drn@ecs.soton.ac.uk moved page Dataobjref Field to Dataobjref field without leaving a redirect

← Older revision	Revision as of 20:45, 10 April 2023
(No difference)

Drn@ecs.soton.ac.uk: Added dataobjref metadata field type

2023-04-10T20:45:17Z

Added dataobjref metadata field type

New page

{{fieldtypes}}

== Description ==
This field allows another data object, which belongs to a specified <tt>datasetid</tt> to be referenced. This is a bit like an [[Itemref field]] but allows multiple fields from another data object to be stored with the ID of the data object referenced.

== Inheritance ==
* [[Metadata]]
** [[Compound field]]
*** [[Dataobjref field]]

== Additional Properties ==
As for [[Compound field#Additional_Properties|Compound fields]] except for:

{| border="1" cellpadding="3" cellspacing="0"
| name || default || description
|-
| '''datasetid''' || n/a || '''This property is always required.'''
|-
| '''input_lookup_url''' || lookup/dataobjref || '''The CGI script path to use to lookup data objects.'''
|-
|}

== Required Phrases ==
No additional phrases beyond those required for [[Compound field#Required_Phrases|Compound fields]].

== Database ==
Itemref fields are stored in the database as
fieldname INT(11)

== API ==
See [[API:EPrints/MetaField/Itemref|API page]].

== Examples ==
Most basic example. (Captures an associated user title with its ID).
{
name => 'userid',
type => 'dataobjref',
datasetid => 'user',
fields => [
{
sub_name => 'title',
type => 'text',
}
],
}
Capture multiple data object references.
{
name => 'funders',
type => 'dataobjref,
datasetid => 'funder',
multiple => 1,
fields => [
{
sub_name => 'name',
type => 'text'
},
],
}
Use bespoke lookup URL.
{
name => 'eprintid',
type => 'dataobjref',
datasetid => 'eprint',
input_lookup_url => 'lookup/mydataobjref',
fields => [
{
sub_name => 'title',
type => 'text',
},
{
sub_name => 'date',
type => 'date',
} ,
],
}