Difference between revisions of "Cookbook Chapter 6: User Interface"

From CollectiveAccess Documentation
Jump to: navigation, search
(Match a Batch Media Import through a Relationship)
Line 51: Line 51:
 
See also:
 
See also:
 
:[[Batch_Import|Batch Media Import]]
 
:[[Batch_Import|Batch Media Import]]
 +
 +
 +
===Batch Deleting Records===
 +
 +
:'''Problem:'''<br>
 +
:You want to batch delete a set of records.
 +
 +
'''Solution:'''<br>
 +
:The easiest way to batch delete records is to add the target records to a set via search results.  Opening the "sets" menu in the search results tool bar will give you controls to add multiple or single records at a time.  Once your to-be-deleted set is complete you can open the batch under Manage > My sets.  Click the multi-record icon and then chose "More options" in the record inspector on the upper left hand corner of the screen.  There you will see options for batch delete.
 +
 +
See also:
 +
:[[Batch_Delete|Batch_Editing#Batch_Delete]]
  
 
===Searching on a Specific Metadata Element===
 
===Searching on a Specific Metadata Element===

Revision as of 20:49, 17 December 2013

User Interface

Auto-generated ID numbers are stuck

Problem:
Your auto-generated ID numbering system is stuck on a value that is already in use, or the numbers are not sorting or being generated properly.
Solution:
If you notice values such as titles and identifiers are sorting incorrectly, you may need to reload sort values from your data. The internal format of sort values can vary between versions of CollectiveAccess causing erroneous sorting behavior after an upgrade. To rebuild sort values, navigate to Manage -> Administration -> Maintenance -> Rebuild Sort Values from the Global Navigation.
Note that depending upon the size of your database reloading sort values can take from a few minutes to an hour or more.

Using Summaries

Problem:
You want to use the "Summary" screen to view a record, but it seems to be blank.
Solution:
You must configure a display that includes all of the metadata you want to see summarized. To do this through the UI, navigate to Manage -> My Displays. Then, to create a new display, choose the table for which the display is relevant, go to "Display List" and then drag and format the elements you wish to include. For tips on formatting, see Bundle Display Templates. Then, when you are in the Summary screen, you can choose the appropriate Display from the drop-down in the top-right corner.

Adding WYSIWYG Editor to Text Fields

Problem:
You realized that you wanted a certain "description" field to have a rich-text editor after your installation profile was fully installed.
Solution:
Go to Manage -> Administration -> Metadata Elements and find the field in question. As long as it is a text field, there will be a checkbox entitled "use rich text editor." Check this and save.

See also:

User Interface Administration

Keeping Track of an Item's Changes

Problem:
You're not finished working on an Object record, but you need to do some other work before you can return to it.
Solution:
Add the record to the "My Watched Items" list. In the Inspector Window (in the top right of your screen) click on a small icon that looks like an eye:

Watcheditems.png

The record will then be stored in the "My Watched Items" list, which is accessible through Manage -> My Watched Items. Changed to the record will be tracked here.

Match a Batch Media Import through a Relationship

Problem:
You want to import a large set of images relating to an already-catalogued event, but you want them to have their own records.

Solution:

From Import -> Media, you can upload the batch of media and set it to create relationships with a given record type by using the "Relationships" media import tool. You can select the type (in this case "Occurrence") and relationship type (i.e. "depicts"). The relationship will be created based on matching the media file name with the event record identifier, so make sure the files are properly named.

See also:

Batch Media Import


Batch Deleting Records

Problem:
You want to batch delete a set of records.

Solution:

The easiest way to batch delete records is to add the target records to a set via search results. Opening the "sets" menu in the search results tool bar will give you controls to add multiple or single records at a time. Once your to-be-deleted set is complete you can open the batch under Manage > My sets. Click the multi-record icon and then chose "More options" in the record inspector on the upper left hand corner of the screen. There you will see options for batch delete.

See also:

Batch_Editing#Batch_Delete

Searching on a Specific Metadata Element

Problem:
You want to restrict a search to a date in a specific date field.
Solution:
First, specify the table name and field, separated by a dot.
<table>.<field> (ex. ca_objects.date_created)

Then, use an accepted date range format to search for the date you want to return:

ca_objects.date_created:8/2/2013

Use the same basic procedure to search on other specific metadata elements, replacing the date value with the desired text.

See also:

Search Syntax
Date and Time Formats

Creating a "Researcher" Access Role

Problem:
You want certain users to log in as researchers with read-only capabilities.
Solution:
Navigate to Manage -> Access Control -> Access Roles -> New Role. Set all relevant "Actions" to allow user to view, but not edit, different tables. Then, create a login and password for your user under "User Logins," and make sure you click "Roles -> Researcher" (or whatever you've named your read-only access role). Make sure that you have displays configured, because this is the only way that a read-only login will be able to view information (through the Summary screen).

See also:

Displays
Access Roles

Adding or removing elements from an editor UI doesn't "stick"

Problem:
You want to add or remove elements from a screen in an editor user interface, but upon saving your changes the screen configuration reverts to its previous state.
Solution:
Your server is probably configured with limits that prevent the changes from fully saving. This is especially common when editing a screen with many elements already configured. Two PHP server settings to examine:
  1. The Suhosin PHP extension can interfere with saving of large CA forms. If it is installed on your server try setting the suhosin.simulation directive to On
  2. You may need to increase the value of max_input_vars. It is set by default in most PHP installations to 1000. Try increasing it to 3000 or more.

See also:

Displays
Access Roles

Viewing Search Results as a Spreadsheet

Problem:
You've realized that there are mistakes in multiple records, and you want to be able to view and correct them without having to open each individual record.
Solution:
Use the "editable" layout with your search results to view metadata in a simple, editable spreadsheet format. Note that you must have a display configured in order to dictate which metadata will be included in the spreadsheet, and you won't be able to edit repeating or complex data.

See also:

Editable_Spreadsheets

Keeping Track of your Path

Problem:
You're going back and forth between record types and working within hierarchies, and you're having trouble keeping track of your position in the database.
Solution:
Turn on the "breadcrumb trail" in Preferences. This will display your current path within the system in a laundry-list format.

See also:

Preferences


Grouping Records Using Sets

Problem:
You need to group certain records together in order to share them with other members of your team.
Solution:
Use "Sets" to create groups of records that you can share and easily return to. This is distinct from Collections because it's an ad-hoc collection of records for purposes such as slideshows, lessons, or shared work. Sets are often temporary groupings. To create a set, navigate to Manage -> My Sets and chose the type of set you would like to create (Public Presentation or User Set). Then, to begin adding items to the set, type the first few letters of a record's preferred label into the type-ahead field. To make the set accessible to a work group, first create the group in Manage -> Administration, and then set Group Access on the Set itself.

See also:

Sets

Creating a Display through the User Interface

Problem:
You need to print out a report for a given record, but none of the pre-configured displays contain the proper metadata.
Solution:
Navigate to Manage --> My Displays, choose the relevant table from the drop-down at the top-right of the screen, and click the small "+." Then, navigate to the "Display List" editor (click "Display List" from the left-hand navigation) and drag and drop the metadata bundles to configure your display.

See also:

Displays
Namespaces

Variants
Actions
Navigation
Tools
User
Personal tools