Template:EPrints Metadata Fields Content - Revision history

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

2024-07-31T10:53:08Z

Internal Properties

← Older revision		Revision as of 10:53, 31 July 2024
Line 232:		Line 232:
	\| '''parent_name''' \|\| <tt>undef</tt> \|\| NO \|\| The name of the parent [[Compound field]] to which a sub-field belongs. \|\| This is set automatically to be the name of the parent field.		\| '''parent_name''' \|\| <tt>undef</tt> \|\| NO \|\| The name of the parent [[Compound field]] to which a sub-field belongs. \|\| This is set automatically to be the name of the parent field.
	\|-		\|-
	\| '''provenance''' \|\| <tt>undef</tt> \|\| NO \|\| Where this field configuration was generated. \|\| Typically any field configuration either defined within a [[Data object]] or in a configuration file (in a <tt>cfg.d</tt> directory will leave this as <tt>undef</tt> by not specifying this property. However, fields created using [[Admin/Config._Tools/Manage_Metadata_Fields\|Manage Metadata Fields]] will set this to <tt>user</tt> so it is clear from where this field was created.		\| '''provenance''' \|\| <tt>undef</tt> \|\| NO \|\| Where this field configuration was generated. \|\| Typically any field configuration either defined within a [[Data Object\|Data object]] or in a configuration file (in a <tt>cfg.d</tt> directory will leave this as <tt>undef</tt> by not specifying this property. However, fields created using [[Admin/Config._Tools/Manage_Metadata_Fields\|Manage Metadata Fields]] will set this to <tt>user</tt> so it is clear from where this field was created.
	\|}		\|}

Drn@ecs.soton.ac.uk: Fixes some typos

2024-07-09T09:38:22Z

Fixes some typos

← Older revision		Revision as of 09:38, 9 July 2024
Line 48:		Line 48:
	*** '''[[Uuid field\|Uuid]]''' - stores a UUID.		*** '''[[Uuid field\|Uuid]]''' - stores a UUID.
	** '''[[Int field\|Int]]''' - an integer value		** '''[[Int field\|Int]]''' - an integer value
	*** '''[[Bigint field\|Bigint]]'''' - a large integer value (can be greater than 2,147,483,647 or less than -2,147,483.647).		*** '''[[Bigint field\|Bigint]]''' - a large integer value (can be greater than 2,147,483,647 or less than -2,147,483.647).
	*** '''[[Counter field\|Counter]]'''' - an auto-incrementing integer value.		*** '''[[Counter field\|Counter]]''' - an auto-incrementing integer value.
	*** '''[[Itemref field\|Itemref]]''' - a reference to another [[Data Object]] (e.g. a user or other eprint)		*** '''[[Itemref field\|Itemref]]''' - a reference to another [[Data Object]] (e.g. a user or other eprint)
	*** '''[[Pagerange field\|Pagerange]]''' - a pagerange, e.g. 122-130		*** '''[[Pagerange field\|Pagerange]]''' - a pagerange, e.g. 122-130

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

2023-10-05T14:19:32Z

Internal Properties

← Older revision		Revision as of 14:19, 5 October 2023
Line 226:		Line 226:
	\| '''confid''' \|\| n/a \|\| YES \|\| The ID of the dataset to which this field belongs. \|\| The value for this property is automatically set when the field is loaded. It is used to work out what phrase ids etc. it uses.		\| '''confid''' \|\| n/a \|\| YES \|\| The ID of the dataset to which this field belongs. \|\| The value for this property is automatically set when the field is loaded. It is used to work out what phrase ids etc. it uses.
	\|-		\|-
	\| '''join_path''' \|\| <tt>undef</tt> \|\| NO \|\| How to join a field that references a different [[Data ~~object~~]]. \|\| This should never be defined within a field's configuration. This is built by search to support building a database query to perform a user's search.		\| '''join_path''' \|\| <tt>undef</tt> \|\| NO \|\| How to join a field that references a different [[Data Object]]. \|\| This should never be defined within a field's configuration. This is built by search to support building a database query to perform a user's search.
	\|-		\|-
	\| '''parent''' \|\| <tt>undef</tt> \|\| NO \|\| A reference to the actual parent [[Compound field]] object. \|\| This is set automatically as a reference to the parent field object.		\| '''parent''' \|\| <tt>undef</tt> \|\| NO \|\| A reference to the actual parent [[Compound field]] object. \|\| This is set automatically as a reference to the parent field object.

Drn@ecs.soton.ac.uk: /* Deprecated or Buggy Properties */

2023-04-21T08:08:59Z

Deprecated or Buggy Properties

← Older revision		Revision as of 08:08, 21 April 2023
Line 235:		Line 235:
	\|}		\|}

	=== Deprecated ~~or Buggy~~ Properties ===		=== Deprecated Properties ===

	~~Don't~~ use these!		Do not use these!

	{\| cellpadding="3" cellspacing="0" border="1"		{\| cellpadding="3" cellspacing="0" border="1"
Line 250:		Line 250:
	\| '''requiredlangs''' \|\| <tt>[]</tt> \|\| NO \|\| The natural languages that should be used in the value(s) for this field \|\| Deprecated. Defined but no longer functional.		\| '''requiredlangs''' \|\| <tt>[]</tt> \|\| NO \|\| The natural languages that should be used in the value(s) for this field \|\| Deprecated. Defined but no longer functional.
	\|-		\|-
	\| '''sql_langid''' \|\| <tt>undef</tt> \|\| NO \|\| \|\|		\| '''sql_langid''' \|\| <tt>undef</tt> \|\| NO \|\| The language ID for SQL. \|\| Deprecated. Defined but no longer functional.
	\|-		\|-
	\| '''sql_sorted''' \|\| <tt>0</tt> \|\| NO \|\| \|\|		\| '''sql_sorted''' \|\| <tt>0</tt> \|\| NO \|\| Whether SQL should be sorted. \|\| Deprecated. Defined but no longer functional.
	\|}		\|}

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

2023-04-21T08:07:20Z

Internal Properties

← Older revision		Revision as of 08:07, 21 April 2023
Line 226:		Line 226:
	\| '''confid''' \|\| n/a \|\| YES \|\| The ID of the dataset to which this field belongs. \|\| The value for this property is automatically set when the field is loaded. It is used to work out what phrase ids etc. it uses.		\| '''confid''' \|\| n/a \|\| YES \|\| The ID of the dataset to which this field belongs. \|\| The value for this property is automatically set when the field is loaded. It is used to work out what phrase ids etc. it uses.
	\|-		\|-
	\| '''join_path''' \|\| <tt>undef</tt> \|\| NO \|\| \|\|		\| '''join_path''' \|\| <tt>undef</tt> \|\| NO \|\| How to join a field that references a different [[Data object]]. \|\| This should never be defined within a field's configuration. This is built by search to support building a database query to perform a user's search.
	\|-		\|-
	\| '''parent''' \|\| <tt>undef</tt> \|\| NO \|\| \|\|		\| '''parent''' \|\| <tt>undef</tt> \|\| NO \|\| A reference to the actual parent [[Compound field]] object. \|\| This is set automatically as a reference to the parent field object.
	\|-		\|-
	\| '''parent_name''' \|\| <tt>undef</tt> \|\| NO \|\| The parent [[Compound field]] to which a sub-field belongs. \|\| This is set automatically to be the name of the parent field.		\| '''parent_name''' \|\| <tt>undef</tt> \|\| NO \|\| The name of the parent [[Compound field]] to which a sub-field belongs. \|\| This is set automatically to be the name of the parent field.
	\|-		\|-
	\| '''provenance''' \|\| <tt>undef</tt> \|\| NO \|\|		\| '''provenance''' \|\| <tt>undef</tt> \|\| NO \|\| Where this field configuration was generated. \|\| Typically any field configuration either defined within a [[Data object]] or in a configuration file (in a <tt>cfg.d</tt> directory will leave this as <tt>undef</tt> by not specifying this property. However, fields created using [[Admin/Config._Tools/Manage_Metadata_Fields\|Manage Metadata Fields]] will set this to <tt>user</tt> so it is clear from where this field was created.
	\|}		\|}

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

2023-04-21T07:40:51Z

Other Properties

← Older revision		Revision as of 07:40, 21 April 2023
Line 210:		Line 210:
	\| '''import''' \|\| <tt>1</tt> \|\| NO \|\| Whether new data objects create from an import can set values for the field. \|\| E.g. <tt>eprintid</tt>, <tt>dir<tt> are determined when the eprint record is created. Imported metadata would not choose an appropriate value for such fields.		\| '''import''' \|\| <tt>1</tt> \|\| NO \|\| Whether new data objects create from an import can set values for the field. \|\| E.g. <tt>eprintid</tt>, <tt>dir<tt> are determined when the eprint record is created. Imported metadata would not choose an appropriate value for such fields.
	\|-		\|-
	\| '''replace_core''' \|\|\| <tt>0</tt> \|\| NO \|\| Whether the field configuration should replace the exisiting [[~~Eprints~~ Glossary#Core_field\|core (system) field]] with the same <tt>name</tt> \|\| This is useful for particularly bespoke requirements. It should be used with great care, as system fields are usually hard-coded because they should not be changed.		\| '''replace_core''' \|\|\| <tt>0</tt> \|\| NO \|\| Whether the field configuration should replace the exisiting [[EPrints Glossary#Core_field\|core (system) field]] with the same <tt>name</tt> \|\| This is useful for particularly bespoke requirements. It should be used with great care, as system fields are usually hard-coded because they should not be changed.
	\|-		\|-
	\| '''show_in_fieldlist''' \|\| <tt>1</tt> \|\| NO \|\| Whether to allow this field to appear in fields lists. \|\| If set to <tt>0</tt> will prevent this field appearing in [[Fields field]] lists. This is primarily to allow you to remove it from the list of fields in the user configuration which are used to control which fields appear as columns in the Items and Review screens.		\| '''show_in_fieldlist''' \|\| <tt>1</tt> \|\| NO \|\| Whether to allow this field to appear in fields lists. \|\| If set to <tt>0</tt> will prevent this field appearing in [[Fields field]] lists. This is primarily to allow you to remove it from the list of fields in the user configuration which are used to control which fields appear as columns in the Items and Review screens.

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

2023-04-21T07:40:20Z

Other Properties

← Older revision		Revision as of 07:40, 21 April 2023
Line 210:		Line 210:
	\| '''import''' \|\| <tt>1</tt> \|\| NO \|\| Whether new data objects create from an import can set values for the field. \|\| E.g. <tt>eprintid</tt>, <tt>dir<tt> are determined when the eprint record is created. Imported metadata would not choose an appropriate value for such fields.		\| '''import''' \|\| <tt>1</tt> \|\| NO \|\| Whether new data objects create from an import can set values for the field. \|\| E.g. <tt>eprintid</tt>, <tt>dir<tt> are determined when the eprint record is created. Imported metadata would not choose an appropriate value for such fields.
	\|-		\|-
	\| '''replace_core''' \|\|\| <tt>0</tt> \|\| NO \|\| \|\|		\| '''replace_core''' \|\|\| <tt>0</tt> \|\| NO \|\| Whether the field configuration should replace the exisiting [[Eprints Glossary#Core_field\|core (system) field]] with the same <tt>name</tt> \|\| This is useful for particularly bespoke requirements. It should be used with great care, as system fields are usually hard-coded because they should not be changed.
	\|-		\|-
	\| '''show_in_fieldlist''' \|\| <tt>1</tt> \|\| NO \|\| Whether to allow this field to appear in fields lists. \|\| If set to <tt>0</tt> will prevent this field appearing in [[Fields field]] lists. This is primarily to allow you to remove it from the list of fields in the user configuration which are used to control which fields appear as columns in the Items and Review screens.		\| '''show_in_fieldlist''' \|\| <tt>1</tt> \|\| NO \|\| Whether to allow this field to appear in fields lists. \|\| If set to <tt>0</tt> will prevent this field appearing in [[Fields field]] lists. This is primarily to allow you to remove it from the list of fields in the user configuration which are used to control which fields appear as columns in the Items and Review screens.

Drn@ecs.soton.ac.uk: /* Ordering, Indexing and Searching */

2023-04-21T07:36:20Z

Ordering, Indexing and Searching

← Older revision		Revision as of 07:36, 21 April 2023
Line 188:		Line 188:
	\| '''make_value_orderkey''' \|\| <tt>undef</tt> \|\| NO \|\| Like <tt>make_single_value_orderkey</tt> but this is passed the array reference for a multiple field rather than just single values. \|\| It should return the <tt>orderkey</tt> string for the entire value. It is passed: <code>$field, $value, $session, $langid, $dataset</code>.		\| '''make_value_orderkey''' \|\| <tt>undef</tt> \|\| NO \|\| Like <tt>make_single_value_orderkey</tt> but this is passed the array reference for a multiple field rather than just single values. \|\| It should return the <tt>orderkey</tt> string for the entire value. It is passed: <code>$field, $value, $session, $langid, $dataset</code>.
	\|-		\|-
	\| '''match''' \|\| <tt>EQ</tt> \|\| NO \|\| How to match the value(s) of this field against search terms. \|\| This property can be <tt>EQ</tt>, <tt>EX</tt>, <tt>IN</tt> or <tt>SET</tt>. Default <tt>EQ</tt> means treat the search term as a single string. Match only whole search term matches the field value (or one of its values if <code>multiple => 1</code>).		\| '''match''' \|\| <tt>EQ</tt> \|\| NO \|\| How to match the value(s) of this field against search terms. \|\| This property can be <tt>EQ</tt>, <tt>EX</tt>, <tt>IN</tt> or <tt>SET</tt>. Default <tt>EQ</tt> means treat the search term as a single string. Match only whole search term matches the field value (or one of its values if <code>multiple => 1</code>). This can be modified for the [[API:EPrints/Search/Field\|field in the search form configuration]].
	\|-		\|-
	\| '''merge''' \|\| <tt>ALL</tt> \|\| NO \|\| Whether this field's values(s) has to match any or all of the search terms \|\| This property can be <tt>ALL</tt> or <tt>ANY</tt>, Default <tt>ALL</tt> means all search terms have to match the values(s) in this field.		\| '''merge''' \|\| <tt>ALL</tt> \|\| NO \|\| Whether this field's values(s) has to match any or all of the search terms \|\| This property can be <tt>ALL</tt> or <tt>ANY</tt>, Default <tt>ALL</tt> means all search terms have to match the values(s) in this field. This can be modified for the [[API:EPrints/Search/Field\|field in the search form configuration]]. For certain values of <tt>match</tt> this can also be changed by the user in the search form itself.
	\|-		\|-
	\| '''text_index''' \|\| <tt>0</tt> \|\| NO \|\| Whether the indexer considers this field for full-text indexing. \|\| Some types of metadata field have a default of <tt>1</tt>, e.g. [[Text field]]s and [[Longtext field]]s.		\| '''text_index''' \|\| <tt>0</tt> \|\| NO \|\| Whether the indexer considers this field for full-text indexing. \|\| Some types of metadata field have a default of <tt>1</tt>, e.g. [[Text field]]s and [[Longtext field]]s.

Drn@ecs.soton.ac.uk: /* Ordering, Indexing and Searching */

2023-04-20T18:13:06Z

Ordering, Indexing and Searching

← Older revision		Revision as of 18:13, 20 April 2023
Line 188:		Line 188:
	\| '''make_value_orderkey''' \|\| <tt>undef</tt> \|\| NO \|\| Like <tt>make_single_value_orderkey</tt> but this is passed the array reference for a multiple field rather than just single values. \|\| It should return the <tt>orderkey</tt> string for the entire value. It is passed: <code>$field, $value, $session, $langid, $dataset</code>.		\| '''make_value_orderkey''' \|\| <tt>undef</tt> \|\| NO \|\| Like <tt>make_single_value_orderkey</tt> but this is passed the array reference for a multiple field rather than just single values. \|\| It should return the <tt>orderkey</tt> string for the entire value. It is passed: <code>$field, $value, $session, $langid, $dataset</code>.
	\|-		\|-
	\| '''match''' \|\| <tt>EQ</tt> \|\| NO \|\| \|\|		\| '''match''' \|\| <tt>EQ</tt> \|\| NO \|\| How to match the value(s) of this field against search terms. \|\| This property can be <tt>EQ</tt>, <tt>EX</tt>, <tt>IN</tt> or <tt>SET</tt>. Default <tt>EQ</tt> means treat the search term as a single string. Match only whole search term matches the field value (or one of its values if <code>multiple => 1</code>).
	\|-		\|-
	\| '''merge''' \|\| <tt>ALL</tt> \|\| NO \|\| \|\|		\| '''merge''' \|\| <tt>ALL</tt> \|\| NO \|\| Whether this field's values(s) has to match any or all of the search terms \|\| This property can be <tt>ALL</tt> or <tt>ANY</tt>, Default <tt>ALL</tt> means all search terms have to match the values(s) in this field.
	\|-		\|-
	\| '''text_index''' \|\| <tt>0</tt> \|\| NO \|\| Whether the indexer considers this field for full-text indexing. \|\| Some types of metadata field have a default of <tt>1</tt>, e.g. [[Text field]]s and [[Longtext field]]s.		\| '''text_index''' \|\| <tt>0</tt> \|\| NO \|\| Whether the indexer considers this field for full-text indexing. \|\| Some types of metadata field have a default of <tt>1</tt>, e.g. [[Text field]]s and [[Longtext field]]s.
Line 196:		Line 196:
	\| '''search_cols''' \|\| <tt>40</tt> \|\| NO \|\| How many characters (columns) wide the input field for searching this field. \|\| The default value for this property is taken from <tt>cfg.d/[[field_property_defaults.pl]]</tt>. If one search field searches more than one field, then the properties from the first field listed are used.		\| '''search_cols''' \|\| <tt>40</tt> \|\| NO \|\| How many characters (columns) wide the input field for searching this field. \|\| The default value for this property is taken from <tt>cfg.d/[[field_property_defaults.pl]]</tt>. If one search field searches more than one field, then the properties from the first field listed are used.
	\|}		\|}


	=== Other Properties ===		=== Other Properties ===

Drn@ecs.soton.ac.uk: /* Input and Validation Properties */

2023-04-20T17:29:52Z

Input and Validation Properties

← Older revision		Revision as of 17:29, 20 April 2023
Line 170:		Line 170:
	\| '''required''' \|\| <tt>0</tt> \|\| NO \|\| Whether the field must have a value set. \|\| If this is set to <tt>1</tt> then the field is always marked as required, no matter what the [[Workflow Format]] configuration says.		\| '''required''' \|\| <tt>0</tt> \|\| NO \|\| Whether the field must have a value set. \|\| If this is set to <tt>1</tt> then the field is always marked as required, no matter what the [[Workflow Format]] configuration says.
	\|-		\|-
	\| '''separator''' \|\| <tt>undef</tt> \|\| NO \|\| What character to use to separate elements of the value for the field for purposes of search \|\| Only used by default for [[Keywords field]]s .		\| '''separator''' \|\| <tt>undef</tt> \|\| NO \|\| What character to use to separate elements of the value for the field for purposes of search \|\| Only used by default for [[Keywords field]]s.
	\|-		\|-
	\| '''show_help''' \|\| <tt>undef</tt> \|\| NO \|\| How to display the help text for this field in the input form. \|\| Can be one of three values: <tt>always</tt>, <tt>never</tt> or <tt>toggle</tt>. Toggle (allow to expand or collapse) is used if not explicitly defined. This can only be overridden in [[Workflow Format]] configuration.		\| '''show_help''' \|\| <tt>undef</tt> \|\| NO \|\| How to display the help text for this field in the input form. \|\| Can be one of three values: <tt>always</tt>, <tt>never</tt> or <tt>toggle</tt>. Toggle (allow to expand or collapse) is used if not explicitly defined. This can only be overridden in [[Workflow Format]] configuration.

← Older revision		Revision as of 09:38, 9 July 2024
Line 48:		Line 48:
	*** '''[[Uuid field\|Uuid]]''' - stores a UUID.		*** '''[[Uuid field\|Uuid]]''' - stores a UUID.
	** '''[[Int field\|Int]]''' - an integer value		** '''[[Int field\|Int]]''' - an integer value
	*** '''[[Bigint field\|Bigint]]'''' - a large integer value (can be greater than 2,147,483,647 or less than -2,147,483.647).		*** '''[[Bigint field\|Bigint]]''' - a large integer value (can be greater than 2,147,483,647 or less than -2,147,483.647).
	*** '''[[Counter field\|Counter]]'''' - an auto-incrementing integer value.		*** '''[[Counter field\|Counter]]''' - an auto-incrementing integer value.
	*** '''[[Itemref field\|Itemref]]''' - a reference to another [[Data Object]] (e.g. a user or other eprint)		*** '''[[Itemref field\|Itemref]]''' - a reference to another [[Data Object]] (e.g. a user or other eprint)
	*** '''[[Pagerange field\|Pagerange]]''' - a pagerange, e.g. 122-130		*** '''[[Pagerange field\|Pagerange]]''' - a pagerange, e.g. 122-130