Difference between revisions of "Location tracking"

From CollectiveAccess Documentation
Jump to: navigation, search
m
(Configuring Use History in the installation profile)
Line 22: Line 22:
  
 
===Configuring Use History in the installation profile===
 
===Configuring Use History in the installation profile===
 +
To add the Use History bundle to the installation profile, simply include the bundle placement on the appropriate UI screen.
 +
 +
<code><pre>
 +
            <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>
 +
 +
</pre></code>
 +
 +
The chart below includes each setting per table.  Be use to replace #type# with the custom type configured in your system.  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.
 +
 +
{|border="1" cellspacing="0" cellpadding="5"
 +
|-
 +
||'''Setting Name'''||'''Description'''
 +
|-
 +
||ca_object_lots_#type#_dateElement||Sets the date field that is used to sort object lots in the use history stream.
 +
|-
 +
||ca_object_lots_#type#_color||Sets the color for this type of object lots.
 +
|-
 +
||ca_object_lots_#type#_displayTemplate||Sets the template for metadata displayed for this type of object lot in the use history stream
 +
|-
 +
|}

Revision as of 17:02, 15 May 2014

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.

Configuring Use History in 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>

Configuring Use History in the installation profile

To add the Use History bundle to the installation profile, simply include the bundle placement 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 each setting per table. Be use to replace #type# with the custom type configured in your system. 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.

Setting Name Description
ca_object_lots_#type#_dateElement Sets the date field that is used to sort object lots in the use history stream.
ca_object_lots_#type#_color Sets the color for this type of object lots.
ca_object_lots_#type#_displayTemplate Sets the template for metadata displayed for this type of object lot in the use history stream
Namespaces

Variants
Actions
Navigation
Tools
User
Personal tools