Difference between revisions of "Intrinsic Bundles"

From CollectiveAccess Documentation
Jump to: navigation, search
(For Object (ca_objects))
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
Intrinsic bundles are hardcoded fields in the CollectiveAccess database. No matter what installation profile and configuration you use these intrinsic fields are always defined and available. Some exist to support basic application functionality. Examples include ''idno'' (the identifier for a record), ''locale_id'' (the locale/language of the record, label, etc.) and ''access'' (indicates whether a record should be accessible to the public or not). Others support optional, and in some cases legacy, functionality. An example is the ''item_status_id'' on objects, while contains an "item status" value that was widely used in pre 1.0 installations but is rarely used now.
 +
 +
Intrinsics are simple, non-repeating values with no associated locale. When using a intrinsic, what you see is what you get – there is no translation or multiple values.
 +
 
The bundle names for various intrinsic database fields are the field names themselves. Bundle names for other user interface elements are listed in the following tables.
 
The bundle names for various intrinsic database fields are the field names themselves. Bundle names for other user interface elements are listed in the following tables.
  
Line 5: Line 9:
 
|-
 
|-
 
||'''Bundle Name'''||'''Description'''
 
||'''Bundle Name'''||'''Description'''
|-
 
||preferred_labels||Fields for setting object preferred title
 
|-
 
||non_preferred_labels||Fields for setting object non-preferred (alternate) titles
 
 
|-
 
|-
 
||idno||Object identifier field (often used for current accession number).
 
||idno||Object identifier field (often used for current accession number).
Line 27: Line 27:
 
|-
 
|-
 
||status||Indication of current workflow status as defined in the workflow_statuses list
 
||status||Indication of current workflow status as defined in the workflow_statuses list
|-
 
||ca_object_representations||Adds controls for adding, updating removing and viewing linked media
 
|-
 
||ca_objects||Adds controls for linking to other objects
 
|-
 
||ca_entities||Adds controls for linking objects to entities
 
|-
 
||ca_places||Adds controls for linking objects to places
 
|-
 
||ca_occurrences||Adds controls for linking objects to occurrences
 
|-
 
||ca_collections||Adds controls for linking objects to collections
 
|-
 
||ca_storage_locations||Adds controls for linking objects to storage location hierarchy
 
|-
 
||ca_object_lots||Adds controls for linking object to lot
 
|-
 
||ca_object_events||Adds controls for creating and managing object event records
 
|-
 
||ca_list_items||Adds controls for linking terms in controlled vocabulary lists to objects
 
|-
 
||ca_sets||Adds controls for adding and removing object from sets
 
|-
 
||hierarchy_navigation||Adds user  interface display for hierarchy object is part of
 
|-
 
||hierarchy_location||Adds user interface to change location of object in a hierarchy of objects.
 
|-
 
||ca_objects_history||Manages the location and use history of an object.
 
 
|-
 
|-
 
||ca_objects_deaccession||Deaccession status of an object.
 
||ca_objects_deaccession||Deaccession status of an object.
Line 64: Line 36:
 
|-
 
|-
 
||'''Bundle Name'''||'''Description'''
 
||'''Bundle Name'''||'''Description'''
|-
 
||preferred_labels||Fields for setting object preferred title
 
|-
 
||non_preferred_labels||Fields for setting object non-preferred (alternate) titles
 
 
|-
 
|-
 
||Idno_stub||Lot identifier field (often used for current accession number).
 
||Idno_stub||Lot identifier field (often used for current accession number).
Line 80: Line 48:
 
|-
 
|-
 
||status||Indication of current workflow status as defined in the workflow_statuses list
 
||status||Indication of current workflow status as defined in the workflow_statuses list
|-
 
||ca_objects||Adds controls for linking to other objects
 
|-
 
||ca_entities||Adds controls for linking objects to entities
 
|-
 
||ca_places||Adds controls for linking objects to places
 
|-
 
||ca_occurrences||Adds controls for linking objects to occurrences
 
|-
 
||ca_collections||Adds controls for linking objects to collections
 
|-
 
||ca_storage_locations||Adds controls for linking objects to storage location hierarchy
 
|-
 
||ca_object_lot_events||Adds controls for creating and managing object event records
 
|-
 
||ca_list_items||Adds controls for linking terms in controlled vocabulary lists to objects
 
|-
 
 
|}
 
|}
  
Line 103: Line 54:
 
|-
 
|-
 
||'''Bundle Name'''||'''Description'''
 
||'''Bundle Name'''||'''Description'''
|-
 
||preferred_labels||Fields for setting object preferred title
 
|-
 
||non_preferred_labels||Fields for setting object non-preferred (alternate) titles
 
 
|-
 
|-
 
||idno||Entity identifier field
 
||idno||Entity identifier field
Line 117: Line 64:
 
|-
 
|-
 
||status||Indication of current workflow status as defined in the workflow_statuses list
 
||status||Indication of current workflow status as defined in the workflow_statuses list
|-
 
||ca_objects||Adds controls for linking to other objects
 
|-
 
||ca_entities||Adds controls for linking objects to entities
 
|-
 
||ca_places||Adds controls for linking objects to places
 
|-
 
||ca_occurrences||Adds controls for linking objects to occurrences
 
|-
 
||ca_collections||Adds controls for linking objects to collections
 
|-
 
||ca_storage_locations||Adds controls for linking objects to storage location hierarchy
 
|-
 
||ca_list_items||Adds controls for linking terms in controlled vocabulary lists to objects
 
|-
 
 
|}
 
|}
  
Line 138: Line 70:
 
|-
 
|-
 
||'''Bundle Name'''||'''Description'''
 
||'''Bundle Name'''||'''Description'''
|-
 
||preferred_labels||Fields for setting object preferred title
 
|-
 
||non_preferred_labels||Fields for setting object non-preferred (alternate) titles
 
 
|-
 
|-
 
||idno||Entity identifier field
 
||idno||Entity identifier field
Line 152: Line 80:
 
|-
 
|-
 
||status||Indication of current workflow status as defined in the workflow_statuses list
 
||status||Indication of current workflow status as defined in the workflow_statuses list
|-
 
||ca_objects||Adds controls for linking to other objects
 
|-
 
||ca_entities||Adds controls for linking objects to entities
 
|-
 
||ca_places||Adds controls for linking objects to places
 
|-
 
||ca_occurrences||Adds controls for linking objects to occurrences
 
|-
 
||ca_collections||Adds controls for linking objects to collections
 
|-
 
||ca_storage_locations||Adds controls for linking objects to storage location hierarchy
 
|-
 
||ca_list_items||Adds controls for linking terms in controlled vocabulary lists to objects
 
|-
 
||hierarchy_navigation||Adds user interface display for place hierarchy
 
|-
 
||hierarchy_location||Adds user interface to change location of place in hierarchy
 
|-
 
 
|}
 
|}
  
Line 177: Line 86:
 
|-
 
|-
 
||'''Bundle Name'''||'''Description'''
 
||'''Bundle Name'''||'''Description'''
|-
 
||preferred_labels||Fields for setting object preferred title
 
|-
 
||non_preferred_labels||Fields for setting object non-preferred (alternate) titles
 
 
|-
 
|-
 
||idno||Entity identifier field
 
||idno||Entity identifier field
Line 191: Line 96:
 
|-
 
|-
 
||status||Indication of current workflow status as defined in the workflow_statuses list
 
||status||Indication of current workflow status as defined in the workflow_statuses list
|-
 
||ca_objects||Adds controls for linking to other objects
 
|-
 
||ca_entities||Adds controls for linking objects to entities
 
|-
 
||ca_places||Adds controls for linking objects to places
 
|-
 
||ca_occurrences||Adds controls for linking objects to occurrences
 
|-
 
||ca_collections||Adds controls for linking objects to collections
 
|-
 
||ca_storage_locations||Adds controls for linking objects to storage location hierarchy
 
|-
 
||ca_list_items||Adds controls for linking terms in controlled vocabulary lists to objects
 
|-
 
 
|}
 
|}
  
Line 212: Line 102:
 
|-
 
|-
 
||'''Bundle Name'''||'''Description'''
 
||'''Bundle Name'''||'''Description'''
|-
 
||preferred_labels||Fields for setting object preferred title
 
|-
 
||non_preferred_labels||Fields for setting object non-preferred (alternate) titles
 
 
|-
 
|-
 
||idno||Entity identifier field
 
||idno||Entity identifier field
Line 226: Line 112:
 
|-
 
|-
 
||status||Indication of current workflow status as defined in the workflow_statuses list
 
||status||Indication of current workflow status as defined in the workflow_statuses list
|-
 
||ca_objects||Adds controls for linking to other objects
 
|-
 
||ca_entities||Adds controls for linking objects to entities
 
|-
 
||ca_places||Adds controls for linking objects to places
 
|-
 
||ca_occurrences||Adds controls for linking objects to occurrences
 
|-
 
||ca_collections||Adds controls for linking objects to collections
 
|-
 
||ca_storage_locations||Adds controls for linking objects to storage location hierarchy
 
|-
 
||ca_list_items||Adds controls for linking terms in controlled vocabulary lists to objects
 
|-
 
||hierarchy_navigation||Adds user interface display for place hierarchy
 
|-
 
||hierarchy_location||Adds user interface to change location of place in hierarchy
 
|-
 
 
|}
 
|}
  
Line 251: Line 118:
 
|-
 
|-
 
||'''Bundle Name'''||'''Description'''
 
||'''Bundle Name'''||'''Description'''
|-
 
||preferred_labels||Fields for setting object preferred title
 
|-
 
||non_preferred_labels||Fields for setting object non-preferred (alternate) titles
 
 
|-
 
|-
 
||status||Indication of current workflow status as defined in the workflow_statuses list
 
||status||Indication of current workflow status as defined in the workflow_statuses list
 
|-
 
|-
||ca_objects||Adds controls for linking objects to storage locations
+
||is_enabled||Indicates if the location is available for use or not
|-
 
||hierarchy_navigation||Adds user interface display for place hierarchy
 
|-
 
||hierarchy_location||Adds user interface to change location of place in hierarchy
 
|-
 
 
|}
 
|}
  
Line 270: Line 128:
 
|-
 
|-
 
||'''Bundle Name'''||'''Description'''
 
||'''Bundle Name'''||'''Description'''
|-
 
||preferred_labels||Fields for setting object preferred title
 
|-
 
||non_preferred_labels||Fields for setting object non-preferred (alternate) titles
 
 
|-
 
|-
 
||locale_id||Entity record locale drop-down
 
||locale_id||Entity record locale drop-down
Line 282: Line 136:
 
|-
 
|-
 
||status||Indication of current workflow status as defined in the workflow_statuses list
 
||status||Indication of current workflow status as defined in the workflow_statuses list
|-
 
||ca_objects||Adds controls for linking to other objects
 
|-
 
||ca_entities||Adds controls for linking objects to entities
 
|-
 
||ca_places||Adds controls for linking objects to places
 
|-
 
||ca_occurrences||Adds controls for linking objects to occurrences
 
|-
 
||ca_representation_annotations||Adds controls for adding annotations to a representation. The type of annotation depends upon the type of media. For example, if the media was time-based (audio or video) then the time-based cataloguing UI would be included in the editing by using this bundle.
 
|-
 
 
|}
 
|}
  
Line 299: Line 142:
 
|-
 
|-
 
||'''Bundle Name'''||'''Description'''
 
||'''Bundle Name'''||'''Description'''
|-
 
||preferred_labels||Fields for setting object preferred title
 
|-
 
||non_preferred_labels||Fields for setting object non-preferred (alternate) titles
 
 
|-
 
|-
 
||list_code||Field for unique list code
 
||list_code||Field for unique list code
Line 318: Line 157:
 
|-
 
|-
 
||'''Bundle Name'''||'''Description'''
 
||'''Bundle Name'''||'''Description'''
|-
 
||preferred_labels||Fields for setting object preferred title
 
|-
 
||non_preferred_labels||Fields for setting object non-preferred (alternate) titles
 
 
|-
 
|-
 
||idno||Entity identifier field
 
||idno||Entity identifier field
Line 336: Line 171:
 
|-
 
|-
 
||status||Indication of current workflow status as defined in the workflow_statuses list
 
||status||Indication of current workflow status as defined in the workflow_statuses list
|-
 
||ca_objects||Adds controls for linking to other objects
 
|-
 
||ca_entities||Adds controls for linking objects to entities
 
|-
 
||ca_places||Adds controls for linking objects to places
 
|-
 
||ca_occurrences||Adds controls for linking objects to occurrences
 
|-
 
||ca_collections||Adds controls for linking objects to collections
 
|-
 
||ca_list_items||Adds controls for linking terms in controlled vocabulary lists to objects
 
|-
 
||hierarchy_navigation||Adds user interface display for place hierarchy
 
|-
 
||hierarchy_location||Adds user interface to change location of place in hierarchy
 
|-
 
 
|}
 
|}
  
Line 359: Line 177:
 
|-
 
|-
 
||'''Bundle Name'''||'''Description'''
 
||'''Bundle Name'''||'''Description'''
|-
 
||preferred_labels||Fields for setting object preferred title
 
 
|-
 
|-
 
||table_num||Control for setting what kind of items (objects, entities, places, etc.) the set contains  
 
||table_num||Control for setting what kind of items (objects, entities, places, etc.) the set contains  
Line 367: Line 183:
 
|-
 
|-
 
||access||Control of public access using values defined in the access_statuses list
 
||access||Control of public access using values defined in the access_statuses list
|-
 
||ca_set_items||Adds controls for adding of items to a set
 
|-
 
 
|}
 
|}
  
Line 377: Line 190:
 
||'''Bundle Name'''||'''Description'''
 
||'''Bundle Name'''||'''Description'''
 
|-
 
|-
||preferred_labels||Fields for setting object preferred title
+
||table_num||Control for setting what kind of items (objects, entities, places, etc.) the set contains
|-
 
|}
 
 
 
 
 
==For object events (ca_object_events)==
 
{|border="1" cellspacing="0" cellpadding="5"
 
|-
 
||'''Bundle Name'''||'''Description'''
 
|-
 
||preferred_labels||Fields for setting object preferred title
 
|-
 
||planned_datetime||Field for date range value indicating when event is planned to occur
 
|-
 
||event_datetime||Field for date range value indicating when event actually occurred
 
|-
 
||ca_entities||Adds controls for linking objects to entities
 
|-
 
||ca_places||Adds controls for linking objects to places
 
|-
 
||ca_occurrences||Adds controls for linking objects to occurrences
 
 
|-
 
|-
||ca_storage_locations||Adds controls for linking object events to storage locations
+
||rank||Relative position of item within set
 
|-
 
|-
 
|}
 
|}
  
==For lot events (ca_object_lot_events)==
 
{|border="1" cellspacing="0" cellpadding="5"
 
|-
 
||'''Bundle Name'''||'''Description'''
 
|-
 
||preferred_labels||Fields for setting object preferred title
 
|-
 
||planned_datetime||Field for date range value indicating when event is planned to occur
 
|-
 
||event_datetime||Field for date range value indicating when event actually occurred
 
|-
 
||ca_entities||Adds controls for linking objects to entities
 
|-
 
||ca_places||Adds controls for linking objects to places
 
|-
 
||ca_occurrences||Adds controls for linking objects to occurrences
 
|-
 
||ca_storage_locations||Adds controls for linking object events to storage locations
 
|-
 
|}
 
  
 
[[Category:Setup_and_Configuration]]
 
[[Category:Setup_and_Configuration]]
 +
 +
sphinx

Latest revision as of 19:10, 2 May 2017

Intrinsic bundles are hardcoded fields in the CollectiveAccess database. No matter what installation profile and configuration you use these intrinsic fields are always defined and available. Some exist to support basic application functionality. Examples include idno (the identifier for a record), locale_id (the locale/language of the record, label, etc.) and access (indicates whether a record should be accessible to the public or not). Others support optional, and in some cases legacy, functionality. An example is the item_status_id on objects, while contains an "item status" value that was widely used in pre 1.0 installations but is rarely used now.

Intrinsics are simple, non-repeating values with no associated locale. When using a intrinsic, what you see is what you get – there is no translation or multiple values.

The bundle names for various intrinsic database fields are the field names themselves. Bundle names for other user interface elements are listed in the following tables.

For Object (ca_objects)

Bundle Name Description
idno Object identifier field (often used for current accession number).
locale_id Object record locale drop-down
item_status_id Object status value based upon values in object_statuses list
acquisition_type_id Object acquisition value based upon values object_acq_types list
source_id Object source value based upon values object_sources list
extent Numeric extent
extent_units Units of extent
access Control of public access using values defined in the access_statuses list
status Indication of current workflow status as defined in the workflow_statuses list
ca_objects_deaccession Deaccession status of an object.

For lots (ca_object_lots)

Bundle Name Description
Idno_stub Lot identifier field (often used for current accession number).
lot_status_id Lot status value based upon values in object_lot_statuses list
extent Numeric extent
extent_units Units of extent
access Control of public access using values defined in the access_statuses list
status Indication of current workflow status as defined in the workflow_statuses list

For entities (ca_entities)

Bundle Name Description
idno Entity identifier field
locale_id Entity record locale drop-down
source_id Entity source value based upon values entity_sources list
access Control of public access using values defined in the access_statuses list
status Indication of current workflow status as defined in the workflow_statuses list

For places (ca_places)

Bundle Name Description
idno Entity identifier field
locale_id Entity record locale drop-down
source_id Entity source value based upon values entity_sources list
access Control of public access using values defined in the access_statuses list
status Indication of current workflow status as defined in the workflow_statuses list

For occurrences (ca_occurrences)

Bundle Name Description
idno Entity identifier field
locale_id Entity record locale drop-down
source_id Entity source value based upon values entity_sources list
access Control of public access using values defined in the access_statuses list
status Indication of current workflow status as defined in the workflow_statuses list

For collections (ca_collections)

Bundle Name Description
idno Entity identifier field
locale_id Entity record locale drop-down
source_id Entity source value based upon values entity_sources list
access Control of public access using values defined in the access_statuses list
status Indication of current workflow status as defined in the workflow_statuses list

For storage locations (ca_storage_locations)

Bundle Name Description
status Indication of current workflow status as defined in the workflow_statuses list
is_enabled Indicates if the location is available for use or not

For object representations (ca_object_representations)

Bundle Name Description
locale_id Entity record locale drop-down
source_id Entity source value based upon values entity_sources list
access Control of public access using values defined in the access_statuses list
status Indication of current workflow status as defined in the workflow_statuses list

For lists (ca_lists)

Bundle Name Description
list_code Field for unique list code
is_system_list Check box to determine if list is a “system” list or not.
is_hierarchical Check box to determine if list is hierarchical or not.
use_as_vocabulary Check box to determine if list can be used as a vocabulary.

For list items (ca_list_items)

Bundle Name Description
idno Entity identifier field
item_value Underlying value of item (independent from the label that is displayed to the user)
is_enabled Checkbox to determine if list item is selectable or not
is_default Checkbox to set default item for list
source_id Entity source value based upon values entity_sources list
access Control of public access using values defined in the access_statuses list
status Indication of current workflow status as defined in the workflow_statuses list

For sets (ca_sets)

Bundle Name Description
table_num Control for setting what kind of items (objects, entities, places, etc.) the set contains
source_id Entity source value based upon values entity_sources list
access Control of public access using values defined in the access_statuses list

For set items (ca_set_items)

Bundle Name Description
table_num Control for setting what kind of items (objects, entities, places, etc.) the set contains
rank Relative position of item within set

sphinx

Namespaces

Variants
Actions
Navigation
Tools
User
Personal tools