Difference between revisions of "Search fields"

From ICA-AtoM
Jump to navigation Jump to search
 
(51 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
[[Main Page]] > [[User manual]] > [[Access content]] > [[Advanced search]] > Field names for advanced searching
 
[[Main Page]] > [[User manual]] > [[Access content]] > [[Advanced search]] > Field names for advanced searching
  
−
 
+
To search on particular [[Glossary#Field|fields]], enter in the [[Glossary#Search box|search box]] the [[Glossary#Field|field]] name followed by a colon followed by the search term (e.g. exampleField:exampleTerm). Search field names must be entered exactly as shown in order for the search to work.
−
To search on particular [[Glossary#Field|fields]], enter in the [[Glossary#Search box|search box]] the [[Glossary#Field|field]] name followed by a colon followed by the search term (e.g. exampleField:exampleTerm).
 
−
 
 
−
Fields are grouped by their [[Glossary#Information area|information area]] on the [[Glossary#Edit page|edit page]].
 
−
 
 
−
<div class="note">
 
−
 
 
−
Fields names must be entered exactly as shown in order for the search to work.
 
  
 
[[Glossary#Field label|Field labels]] are listed as they appear on the pages shipped with ICA-AtoM. If your [[Glossary#Administrator|administrator]] has customized the [[Glossary#Field label|field labels]] in your ICA-AtoM application, these may be different from what appears on your page.
 
[[Glossary#Field label|Field labels]] are listed as they appear on the pages shipped with ICA-AtoM. If your [[Glossary#Administrator|administrator]] has customized the [[Glossary#Field label|field labels]] in your ICA-AtoM application, these may be different from what appears on your page.
  
−
</div>
 
  
 
== Archival description ==
 
== Archival description ==
  
−
The following is a list of the fields in [[Glossary#Archival description|archival description]] records that can be searched. The [[Glossary#Field label|field label]] is presented as it is displayed, followed by its field name for search purposes. The weight of the field has been included where applicable.
+
The following is a list of the fields in [[Glossary#Archival description|archival description]] records that can be searched.
 +
* The '''Search field''' is used to limit the scope of search terms, e.g. "levelOfDescription:fonds"
 +
* The '''ISAD label''' and '''RAD label''' list the [[Glossary#Field label|field label]] as displayed in AtoM
 +
* Some fields are weighted more heavily (the baseline being 1x) when scoring search results - this has been noted as e.g. "'''5x weight'''"
  
−
<div style="columns: 24em; -webkit-columns: 24em; -moz-column-width: 24em;">
+
<br />
  
−
=== Identity area ===
+
{|
 +
!Search field!!ISAD label!!RAD label!!Notes
 +
|-
 +
|accessConditions||Conditions governing access||Restrictions on access||
 +
|-
 +
|accruals||Accruals||Accruals||
 +
|-
 +
|acquisition||Immediate source of acquisition||Immediate source of acquisition||
 +
|-
 +
|appraisal||Appraisal, destruction and scheduling||''N/A''||Not part of RAD specification
 +
|-
 +
|archivalHistory||Archival history||Custodial history||
 +
|-
 +
|arrangement||System of arrangement||Arrangement||
 +
|-
 +
|creator||Name of creator||Name of creator||'''8x weight'''
 +
|-
 +
|creatorHistory||Administrative/biographical history||Administrative/biographical history||
 +
|-
 +
|date||Dates(s)||Date(s)||Full textual date, e.g. c.1970-1983
 +
|-
 +
|endDate||Date(s)||Date(s)||End of date range, in YYYYMMDD format
 +
|-
 +
|extentAndMedium||Extent and medium||Physical description||
 +
|-
 +
|filename||filename||filename||Not part of RAD or ISAD. Digital object filename
 +
|-
 +
|findingAids||Finding aids||Finding aids||
 +
|-
 +
|hasDigitalObject||''N/A''||''N/A''||Not part of RAD or ISAD. Does the description have a linked digital object? Value is "true" or "false"
 +
|-
 +
|identifier||Identifier||Identifier||'''5x weight'''
 +
|-
 +
|language||Language of material||Language of material||
 +
|-
 +
|levelOfDescription||Level of description||Level of description||
 +
|-
 +
|locationOfCopies||Location of copies||Availability of other formats||
 +
|-
 +
|locationOfOriginals||Location of originals||Location of originals||
 +
|-
 +
|mediaType||Media type||Media type||Not part of RAD or ISAD. Digital object media type
 +
|-
 +
|name||Name access points||Name access point||Not part of RAD or ISAD. '''3x weight'''
 +
|-
 +
|notes||*||*||* includes all "note" fields
 +
|-
 +
|partOf||''N/A''||''N/A''||Not part of RAD or ISAD. Title of top-level description
 +
|-
 +
|physicalCharacteristics||Physical characteristics||Physical condition||
 +
|-
 +
|physicalStorage||''N/A''||''N/A''||Physical storage container name
 +
|-
 +
|place||Place access points||Place access points||Not part of RAD or ISAD. '''3x weight'''
 +
|-
 +
|referenceCode||Reference code||Reference code||
 +
|-
 +
|relatedUnitsOfDescription||Related units of description||Associated/related material||
 +
|-
 +
|repository||Repository||Associated/related material||
 +
|-
 +
|reproductionConditions||Conditions governing reproduction||Terms governing use, reproduction, and publication||
 +
|-
 +
|scopeAndContent||Scope and content||Scope and content||
 +
|-
 +
|script||Script of material||Script of material||
 +
|-
 +
|sources||Sources||Sources||
 +
|-
 +
|startDate||Date(s)||Date(s)||Start of date range, in YYYYMMDD format
 +
|-
 +
|subject||Subject access points||Subject access points||Not part of RAD or ISAD. '''5x weight'''
 +
|-
 +
|title||Title||Title proper||'''10x weight'''
 +
|}
  
−
* Identifier: identifier (5x weight)
+
== Authority record ==
−
* Reference code: referenceCode
 
−
* Title: title  (10x weight)
 
−
* Date(s) of creation - start: startDate (YYYYMMDD format)
 
−
* Date(s) of creation - end: endDate (YYYYMMDD format)
 
−
* Level of description: levelOfDescription
 
−
* Extent and medium: extentandmedium
 
−
 
 
−
=== Context area ===
 
−
 
 
−
* Creator: creators (8x weight)
 
−
* Administrative/biographical history: creatorHistory
 
−
* Repository: repositoryName
 
−
* Immediate source of acquisition: acquisition
 
−
* Archival history: archivalhistory
 
−
* Top-level description: partOf
 
−
 
 
−
=== Content and structure area ===
 
−
 
 
−
* Scope and content: scopeAndContent
 
−
* Appraisal, destruction and scheduling: appraisal
 
−
* Accruals: accruals
 
−
* System of arrangement: arrangement
 
−
 
 
−
=== Conditions of access and use area ===
 
−
 
 
−
* Conditions governing access: accessconditions
 
−
* Conditions governing reproduction: reproductionconditions
 
−
* Language of material: language
 
−
* Script of material: script
 
−
* Physical characteristics: physicalcharacteristics
 
−
* Finding aids: findingaids
 
−
 
 
−
=== Allied materials area ===
 
−
 
 
−
* Location of originals: locationoforiginals
 
−
* Location of copies: locationofcopies
 
−
* Related units of description: relatedunitsofdescription
 
−
 
 
−
=== Notes area ===
 
−
 
 
−
* Note: notes (includes all note fields)
 
−
 
 
−
=== Access points ===
 
−
 
 
−
* Subject access points: subject (5x weight)
 
−
* Place access points: place (3x weight)
 
−
* Name access points: name (3x weight)
 
−
 
 
−
=== Control area ===
 
−
 
 
−
* Sources: sources
 
−
 
 
−
=== Digital objects ===
 
−
 
 
−
* Has a digital object (true or false): hasDigitalObject
 
−
* Media type: mediatype
 
−
 
 
−
=== Internal fields ===
 
−
 
 
−
The following fields are intended for internal use by the application, but are available through the regular search interface as well.
 
−
 
 
−
* Permalink "slug": slug
 
−
* Slug of parent: parent
 
−
* Search document language (ISO 639-1 code; e.g. 'en'): culture
 
−
* Level of description ID: levelOfDescriptionId
 
−
* Digital object media type ID: do_mediaTypeId
 
−
* Publication status ID: publicationStatusId
 
−
* Repository ID: repositoryId
 
−
* Repository "slug": repositorySlug
 
  
−
</div>
+
The following is a list of the fields in [[Glossary#Authority record|authority records]] that can be searched.
 +
* The '''Search field''' is used to limit the scope of search terms, e.g. "datesOfExistence:[1970-2000]"
 +
* The ISAAR [[Glossary#Field label|field label]] is presented as it is displayed in AtoM
  
 +
<br />
  
−
<div class="note">
+
{|
−
== Searching Dates ==
+
!Search field!!ISAAR label!!Notes
−
*startDate:[YYYYMMDD TO YYYYMMDD]
+
|-
−
**This will search for start dates between the two dates listed, inclusive.
+
|authorizedFormOfName||Authorized form of name||'''10x weight'''
−
*endDate:{YYYYMMDD TO YYYYMMDD}
+
|-
−
**This will search for end dates between the two dates listed, exclusive.
+
|datesOfExistence||Dates of Existence||'''5x weight'''
−
 
+
|-
−
</div>
+
|functions||Functions, occupations and activities||
−
 
+
|-
−
 
+
|generalContext||General context||
−
== Authority record ==
+
|-
 +
|history||History||'''3x weight'''
 +
|-
 +
|identifier||Description identifier||
 +
|-
 +
|internalStructures||Internal Structures||
 +
|-
 +
|legalStatus||Legal Status||
 +
|-
 +
|mandates||Mandates||
 +
|-
 +
|places||Places||
 +
|-
 +
|otherFormsOfName||Standardized form(s) of name according to other rules<br>Other form(s) of name<br>Parallel form(s) of name||'''8x weight'''
 +
|}
  
−
The following is a list of the fields in [[Glossary#Authority record|authority records]] that can be searched. The [[Glossary#Field label|field label]] is presented as it is displayed, followed by its field name for search purposes.
+
* '''Note:''' repositories inherit the authority record entity. When indexing repository records, two specific properties are added: holdings (Holdings) and collectionPolicies (Records management and collecting policies).
  
−
<div style="columns: 24em; -webkit-columns: 24em; -moz-column-width: 24em;">
+
== Accession record ==
  
−
=== Identity area ===
+
The following is a list of the fields in [[Glossary#Accessions|accessions]] that can be searched.
 +
* The '''Search field''' is used to limit the scope of search terms, e.g. "title:Peanut"
  
−
* Authorized form of name: authorizedFormOfName
+
<br />
  
−
=== Description area ===
+
{|
 +
!Search field!!Accession label!!Notes
 +
|-
 +
|date||Date||
 +
|-
 +
|appraisal||Appraisal||
 +
|-
 +
|identifier||Identifier||
 +
|-
 +
|archivalHistory||Archival history||
 +
|-
 +
|locationInformation||Location information||
 +
|-
 +
|physicalCharacteristics||Physical characteristics||
 +
|-
 +
|processingNotes||Processing notes||
 +
|-
 +
|receivedExtentUnits||Received extent units||
 +
|-
 +
|scopeAndContent||Scope and content||
 +
|-
 +
|sourceOfAcquisition||Source of acquisition||
 +
|-
 +
|title||Title||
 +
|-
 +
|donors||Donors (authorized form of name)||
 +
|-
 +
|deaccessions||Deaccessions (deaccession number)||
 +
|-
 +
|}
  
−
* Dates of Existence: datesOfExistence
+
== Searching date ranges ==
−
* History: history
 
−
* Places: places
 
−
* Legal Status: legalStatus
 
−
* Mandates: mandates
 
−
* Internal Structures: internalStructures
 
−
* General context: generalContext
 
  
−
=== Control area ===
+
* startDate:[YYYYMMDD TO YYYYMMDD]
 +
** This will search for start dates between the two dates listed, inclusive.
 +
* endDate:{YYYYMMDD TO YYYYMMDD}
 +
** This will search for end dates between the two dates listed, exclusive.
 +
* date:[1974 TO 1984]
 +
** This will search for textual dates (including uncertain dates) between 1974 and 1984, inclusive.  Note: because this date data is not structured, the results may be vary due to inconsistencies in formatting.
  
−
* Description identifier: identifier
+
<b>In ICA-AtoM 1.4 </b> the "date:" selector only searches on the textual "date" field, not the ISO formatted start/end date fields, so:
  
−
</div>
+
*date:[1995-01-01 TO 1997-12-31] - "Range query boundary terms must be non-multiple word terms"
 +
**<i>The hyphen is messing Zend Search Lucene, this type of date search will NOT work.</i>
 +
*date:[19950101 TO 19971231]
 +
** <i>This is searching for string values between 19950101 and 19971231 in the date field only. This query format is best suited to searching the start/end date fields which are formatted as YYYYMMDD in the search index.</i>
 +
*date: [200-?]
 +
** This type of searching will be problematic, as the search index cannot determine non-specific dates.  If the search needs to be exact, Users are encouraged to search using start date and end date with consistent formatting.
  
 
[[Category:User manual]]
 
[[Category:User manual]]
  
 
__NOTOC__
 
__NOTOC__

Latest revision as of 16:10, 16 August 2013

Please note that ICA-AtoM is no longer actively supported by Artefactual Systems.
Visit https://www.accesstomemory.org for information about AtoM, the currently supported version.

Main Page > User manual > Access content > Advanced search > Field names for advanced searching

To search on particular fields, enter in the search box the field name followed by a colon followed by the search term (e.g. exampleField:exampleTerm). Search field names must be entered exactly as shown in order for the search to work.

Field labels are listed as they appear on the pages shipped with ICA-AtoM. If your administrator has customized the field labels in your ICA-AtoM application, these may be different from what appears on your page.


Archival description

The following is a list of the fields in archival description records that can be searched.

  • The Search field is used to limit the scope of search terms, e.g. "levelOfDescription:fonds"
  • The ISAD label and RAD label list the field label as displayed in AtoM
  • Some fields are weighted more heavily (the baseline being 1x) when scoring search results - this has been noted as e.g. "5x weight"


Search field ISAD label RAD label Notes
accessConditions Conditions governing access Restrictions on access
accruals Accruals Accruals
acquisition Immediate source of acquisition Immediate source of acquisition
appraisal Appraisal, destruction and scheduling N/A Not part of RAD specification
archivalHistory Archival history Custodial history
arrangement System of arrangement Arrangement
creator Name of creator Name of creator 8x weight
creatorHistory Administrative/biographical history Administrative/biographical history
date Dates(s) Date(s) Full textual date, e.g. c.1970-1983
endDate Date(s) Date(s) End of date range, in YYYYMMDD format
extentAndMedium Extent and medium Physical description
filename filename filename Not part of RAD or ISAD. Digital object filename
findingAids Finding aids Finding aids
hasDigitalObject N/A N/A Not part of RAD or ISAD. Does the description have a linked digital object? Value is "true" or "false"
identifier Identifier Identifier 5x weight
language Language of material Language of material
levelOfDescription Level of description Level of description
locationOfCopies Location of copies Availability of other formats
locationOfOriginals Location of originals Location of originals
mediaType Media type Media type Not part of RAD or ISAD. Digital object media type
name Name access points Name access point Not part of RAD or ISAD. 3x weight
notes * * * includes all "note" fields
partOf N/A N/A Not part of RAD or ISAD. Title of top-level description
physicalCharacteristics Physical characteristics Physical condition
physicalStorage N/A N/A Physical storage container name
place Place access points Place access points Not part of RAD or ISAD. 3x weight
referenceCode Reference code Reference code
relatedUnitsOfDescription Related units of description Associated/related material
repository Repository Associated/related material
reproductionConditions Conditions governing reproduction Terms governing use, reproduction, and publication
scopeAndContent Scope and content Scope and content
script Script of material Script of material
sources Sources Sources
startDate Date(s) Date(s) Start of date range, in YYYYMMDD format
subject Subject access points Subject access points Not part of RAD or ISAD. 5x weight
title Title Title proper 10x weight

Authority record

The following is a list of the fields in authority records that can be searched.

  • The Search field is used to limit the scope of search terms, e.g. "datesOfExistence:[1970-2000]"
  • The ISAAR field label is presented as it is displayed in AtoM


Search field ISAAR label Notes
authorizedFormOfName Authorized form of name 10x weight
datesOfExistence Dates of Existence 5x weight
functions Functions, occupations and activities
generalContext General context
history History 3x weight
identifier Description identifier
internalStructures Internal Structures
legalStatus Legal Status
mandates Mandates
places Places
otherFormsOfName Standardized form(s) of name according to other rules
Other form(s) of name
Parallel form(s) of name		 8x weight
  • Note: repositories inherit the authority record entity. When indexing repository records, two specific properties are added: holdings (Holdings) and collectionPolicies (Records management and collecting policies).

Accession record

The following is a list of the fields in accessions that can be searched.

  • The Search field is used to limit the scope of search terms, e.g. "title:Peanut"


Search field Accession label Notes
date Date
appraisal Appraisal
identifier Identifier
archivalHistory Archival history
locationInformation Location information
physicalCharacteristics Physical characteristics
processingNotes Processing notes
receivedExtentUnits Received extent units
scopeAndContent Scope and content
sourceOfAcquisition Source of acquisition
title Title
donors Donors (authorized form of name)
deaccessions Deaccessions (deaccession number)

Searching date ranges

  • startDate:[YYYYMMDD TO YYYYMMDD]
    • This will search for start dates between the two dates listed, inclusive.
  • endDate:{YYYYMMDD TO YYYYMMDD}
    • This will search for end dates between the two dates listed, exclusive.
  • date:[1974 TO 1984]
    • This will search for textual dates (including uncertain dates) between 1974 and 1984, inclusive. Note: because this date data is not structured, the results may be vary due to inconsistencies in formatting.

In ICA-AtoM 1.4 the "date:" selector only searches on the textual "date" field, not the ISO formatted start/end date fields, so:

  • date:[1995-01-01 TO 1997-12-31] - "Range query boundary terms must be non-multiple word terms"
    • The hyphen is messing Zend Search Lucene, this type of date search will NOT work.
  • date:[19950101 TO 19971231]
    • This is searching for string values between 19950101 and 19971231 in the date field only. This query format is best suited to searching the start/end date fields which are formatted as YYYYMMDD in the search index.
  • date: [200-?]
    • This type of searching will be problematic, as the search index cannot determine non-specific dates. If the search needs to be exact, Users are encouraged to search using start date and end date with consistent formatting.


Retrieved from "https://wiki.ica-atom.org/index.php?title=Search_fields&oldid=13683"