Location tracking

From CollectiveAccess Documentation
Revision as of 16:05, 20 April 2015 by Julia (talk | contribs)
Jump to: navigation, search

Valid for v1.5

Overview

Location tracking, or object use history, is a new tool in CollectiveAccess 1.5 that allows cataloguers to easily manage the activity of a collection object.

For those wishing to track a wide array of relationships in a single "use history stream" there is a new intrinsic bundle with robust settings called ca_objects_history or Object Use History. To use the bundle, simply place it on a user interface screen and adjust the settings, or include it in your installation profile.

For users who want a more minimal location tracking tool a second bundle, ca_objects_location, integrates only storage locations and movements.

Configuring Use History

Through the user interface

The Object Use History bundle has a variety of settings that customize the layout and contents of the location stream. Let's take a look at an example:

UseHistory.png

In the bundle seen above the cataloguer has configured different colors and templates to showcase Accession, Loan, and Storage Location activity and data. Each block is automatically sorted by the date chosen through the bundle settings for that table. For example, Artwork loans are sorted on the "Loan Period" as seen via the dates on the far right-hand side. When a new relationship is created to any of the three configured tables a new segment will appear in the stream in the appropriate order based on date. In addition to the tables shown in the example, Occurrences, Movements, and Deaccessions can also be configured.

The contents of each block in the stream are entirely configurable using metadata display templates. With this powerful syntax any metadata from the related record, or from those records related to the related record, can be displayed in the Use History bundle. An example of that relationship traversing can be seen above in the Artwork loan blocks. There, the "Borrower" is displayed using the below syntax which pulls entities related to the related loan:

<l>^ca_loans.preferred_labels</l><br>
<ifdef code="ca_loans.loan_period">Loan Period:</ifdef> ^ca_loans.loan_period<br>
Borrower: <unit relativeTo="ca_loans">
<unit relativeTo="ca_entities" delimiter=", " restrictToRelationshipTypes="borrower">^ca_entities.preferred_labels</unit></unit>

Through the installation profile

To add the Use History bundle to the installation profile, simply include the bundle placement and relevant settings on the appropriate UI screen.

            <placement code="ca_objects_history">
              <bundle>ca_objects_history</bundle>
              <settings>
                <setting name="ca_object_lots_purchase_dateElement">accession_date</setting>
                <setting name="ca_object_lots_purchase_color">#663A8C</setting>
              </settings>
            </placement>

The chart below includes settings per table. Be sure to replace #type# with the custom type configured in your profile. For example, if "purchase" was the item idno in your list ca_object_lot_types, then your setting would be: ca_object_lots_purchase_dateElement.

Note that there is no dateElement setting for storage locations. Storage locations are sorted on the date cataloged.

Setting Name Description
ca_object_lots_showTypes Sets which object lots types appear in the use history stream.

For all showTypes settings, repeat once for each type that should be included. Use the item idno i.e. <setting name="ca_object_lots_showTypes">purchase</setting>

ca_object_lots_#type#_dateElement Sets the date field that is used to sort object lots of this type in the use history stream.
ca_object_lots_#type#_color Sets the color for this type of object lot. Use hex colors with no pound sign, i.e. "B1AAF2"
ca_object_lots_#type#_displayTemplate Sets the template for metadata displayed for this type of object lot in the use history stream.
ca_occurrences_showTypes Sets which occurrence types appear in the use history stream.
ca_occurrences_#type#_dateElement Sets the date field that is used to sort this type of occurrence in the use history stream.
ca_occurrences_#type#_color Sets the color for this type of occurrence. Use hex colors with no pound sign, i.e. "B1AAF2"
ca_occurrences_#type#_displayTemplate Sets the template for metadata displayed for this type of occurrence in the use history stream
ca_movements_showTypes Sets which movement types appear in the use history stream.
ca_movements_#type#_dateElement Sets the date field that is used to sort this type of movement in the use history stream.
ca_movements_#type#_color Sets the color for this type of movement. Use hex colors with no pound sign, i.e. "B1AAF2"
ca_movements_#type#_displayTemplate Sets the template for metadata displayed for this type of movement in the use history stream
ca_loans_showTypes Sets which loan types appear in the use history stream.
ca_loans_#type#_dateElement Sets the date field that is used to sort this type of loan in the use history stream.
ca_loans_#type#_color Sets the color for this type of loan. Use hex colors with no pound sign, i.e. "B1AAF2"
ca_loans_#type#_displayTemplate Sets the template for metadata displayed for this type of loan in the use history stream
ca_storage_locations_showRelationshipTypes Sets which related storage locations will appear.
ca_storage_locations_color Sets the color for all storage locations types. Use hex colors with no pound sign, i.e. "B1AAF2"
ca_storage_locations_displayTemplate Sets the template for metadata displayed for storage locations of all types.
showDeaccessionInformation Sets whether or not Deaccessions are included in the stream. 1 = yes; 0 = no.
deaccession_color Sets the color for deaccessions. Use hex colors with no pound sign, i.e. "B1AAF2"
deaccession_displayTemplate Sets the template for deaccessions.
hide_add_to_loan_controls Set to 1 if you want to to hide the "Add to loan" controls in this bundle placement. Defaults to 0
hide_update_location_controls Set to 1 if you want to to hide the "Update Location" controls in this bundle placement. Defaults to 0

Browsing by Current Location

See here.

Configuring Location History

TK

Through the user interface

TK

Through the installation profile

TK

Namespaces

Variants
Actions
Navigation
Tools
User
Personal tools