Displays

From CollectiveAccess Documentation
Jump to: navigation, search

[Valid from v1.4]

Configuring Displays

Displays, also known as bundle displays, allow you to select exactly which fields from a record you wish to see in search results or a Summary page. Once you create custom displays and configure the search results or record summaries, you may batch-edit data in spreadsheet format, export the data tab or comma delimited files, or generate a PDF. Displays are essentially synonymous with reports. Please visit Creating Reports for more information on exporting display-structured data. To see how Displays are configured in xml, click here.

Creating a Display Open “My Displays” from the Manage tab in the Global Navigation bar. To create a new display, select a record type from the “New display for” drop-down menu.

Creating a New Display

Create display.png

Then, enter some basic information about your new Display: Enter a unique Display list name for the new Display. Enter a unique alpha-numeric identifier in the Display code text box. By selecting Yes under System Form, you can make this search accessible to all users in the system. If you want to limit access to the form, select No. If the new form is not system wide, you may assign read-only or edit access to specific users or groups using the User Access and Group Access elements. If you would like display list values to show even when they are null, make sure the Display Setting box is checked.

Portion of Display Screen

Display form.png

To add contents to your display, scroll down to the bottom of the Display Basic Info Screen, where you will find two columns. The left column contains all available display items – elements that can potentially be shown in search results and summaries. The right column will contain specific elements chosen for the Display. Using your mouse, drag elements from the left column to the right to configure a Display.

Display Contents

Display contents.png

Display Options

When you are conducting a search from the Find menu, you can utilize Display Options to not only switch between the default and custom displays, but also change the sort value, results per page, and layout.

Sort: The sort value defaults to ‘relevance.’ By selecting another term from the drop-down, you can sort the search results by other data elements – such as ID number, title, type and so on.

Number per Page: Up to 48 records can be displayed on a single page at one time. The minimum results per page is 12.

Layout: There are 3 layout options – Full, List, and Thumbnail. The List view displays the data values from the selected display in a tabled format. Full, on the other hand, displays a thumbnail as well as the data values from the selected display. Thumbnail view displays a thumbnail image of the record, along with Title and Identifier. </translate>

<translate>

Advanced Displays

[Valid for v1.4]

New extra features for displays allow users to powerfully control what data is shown and analyzed in reports, results and summaries. In addition to the tools listed below, there is also a powerful syntax used in CollectiveAccess to control how data is output in displays. This covers cases such as formatting repeating containers, conditionally hiding and showing data and many more use cases. More info on that here.

Filter using expression

It's possible to use expressions to control when you see displayed data. To do so, use the if rule. Here's an example. Let's say you want to only output the display if "current" is selected from the type drop-down in a repeating credit line container. Your display template would look like this (with your correct codes of course):

        <unit relativeTo="ca_objects.credit_line"><if rule="^credit_type =~ /current/">^ca_objects.credit_line.credit_text 
        (^ca_objects.credit_line.credit_type)</if></unit>

Bottom line format

The "Bottom line format" essentially allows users to display functions at the bottom of list views for search and browse results. Only certain metadata elements accept functions, for obvious reasons (you can't determine the sum of two free text fields!). The following attribute types support bottom line formats: DateRange, Currency, Length, Weight, TimeCode, Integer, and Numeric.

Several functions are accepted:

Function Description
^SUM The values in the column for the entire result set will be added together.
^PAGESUM The values in the column for the current result page will be added together.
^AVG The values in the column for the entire result set will be averaged.
^PAGEAVG The values in the column for the current result page will be averaged.
^MIN The lowest value in the column for the entire result set will be displayed.
^PAGEMIN The lowest value in the column for the current result page will be displayed.
^MAX The highest value in the column for the entire result set will be displayed.
^PAGEMIN The highest value in the column for the current result page will be displayed.

Currently bottom lines are not displayed on single record Summaries, nor are they included in report downloads (PDF, Excel).

To include a bottom line function in a display, navigate to Manage > My displays. Edit the specific bundle that will be the target of the function. Include the function code(s) (i.e ^MIN) in the Bottom line format box.

Functions within containers

How do you include bottom line formatting when a to-be-functioned value is within a metadata element container? It's simple: you must include the specific subfield within your bottom-line function.

Let's say you had a dimensions container that included Length, Width and Height subfields. If you wanted to determine the combined Height you'd simply target the subfield code:

^SUM:height

NOTE: there is no need to specify the full container path (i.e. ca_objects.dimensions.height) because it's implied by the bundle.

Currency Conversion

Under Preferences > Units of measurement a user can set a default currency for displays. Using daily data from the European Central Bank, CollectiveAccess auto-converts values between currencies. With this tool it is possible to include in a single function values entered with different currency units, resulting in a single value in the desired target currency. Note that the Attribute Type Currency must be used for relevant metadata elements in order for this feature to function.

Let's say for example CAD (or Canadian Dollar) is selected in a user's preferences. If a Current Insurance Value field is added with the ^PAGESUM function you'd see this in a search result set:

CurrencySum.png

The display bundle for the above image looks like this:

CurrencyDisplay.png

If the "Display currency conversion" checkbox is unchecked the parenthetical conversions will disappear, but the bottom line total conversion will remain.

NOTE: the auto-conversion feature is currently supported for displays but not UI editor screens.

Using bottom line functions with multiple metadata elements

From version 1.7 you can display bottom line values calculated using more than one metadata element in a display. This is useful when you need to, for instance, display the total value of several currency fields in a display; or display the maximum value from ANY numeric field in a display.

Multi-element bottom line templates are attached to the display itself rather than a specific element, using the Bottom line format display setting. The template works similarly to those for a single element, save that you must specify a semicolon-delimited list of elements to operate over following the function tag and separated using a "%" character. For example:

 Total for all funds:    ^SUM%fields=ca_object_lots.breslauer_fund;ca_object_lots.tbff_fund;ca_object_lots.akc_fund;ca_object_lots.sue_allen_fund;ca_object_lots.pine_tree_fund;ca_object_lots.general_fund;ca_object_lots.idno_stub

All bottom line functions are supported. Note that all of the elements listed after a function must be of the same type. Unexpected results may occur if elements of differing types are included in a list. You can specify as many functions as needed in a single template, and each function may have its own list of elements to operate on.

sphinx

Namespaces

Variants
Actions
Navigation
Tools
User
Personal tools