Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • List name: Title of the list

  • Record type: The type of FOLIO record used for the list

  • Visibility: Shared or Private.

    • Shared: Shared lists can be accessed by all users with permissions to the Lists app in this organization.

    • Private: Private lists can only be accessed by the user logged inwho created the list.

  • Status: Active or Inactive

    • Active: An active list contains a query and a resulting record set.

    • Inactive: An inactive list contains a query but no record set.

  • Source: Username or FOLIO account used to create the list.

  • Date Updated: The last time the list was changed or refreshed. If a list has not been updated recently, Refresh the list to get the most recent data.

...

Query details for the selected list appear in the Query section and include the query string, the number of records found by the query. This is a raw clearing query that is passed into the FOLIO query engine. The number of items in the list is displayed below.

...

In a list, the fields for the record set display as column headings. Customize the display of column headings in the record set by checking or unchecking the field(s) in Actions > Show columns as appropriate. Options for field headings will depend on the Record Type.image-20241029-193029.pngImage Removed

...

Refreshing a List

Lists can be dynamically updated with new results based on their query. To Refresh the list, click Actions > Refresh List and click the View updated list link in the confirmation message.

image-20241029-192404.png

Create a list

Guidelines

  • When you create a new list shared list, remember to prefix your list with your institution code (AC, MH, HC, SC, UM). If you do not need to share your list with other users, make it private.

  • When you run your test query, if the number of results is very large (greater than 25K) please add additional criteria to reduce the size of the list

  • Please utilize five-colleges-test for any experiments with Lists

  • Be aware Lists is still undergoing development. Double check your results with other applications

  • The data you see will be for all Five Colleges unless you explicitly limit to your data. This is not always possible.

  • A new list must have List information and a Query assigned to establish the record set for the list. A Test query must be performed before the query can be run and saved.

List information

To add list details for a new list, follow these steps:

...

  1. In the Lists pane, click on New.

  2. In the New List window, add criteria in the List information section:

  3. List name : The name that will appear on the list. If you are creating a shared list, prefix your list with your institution code

  4. Description (optional): Explain what purpose the list serves

  5. Visibility: Define if other uses can view the list. A shared list is visible to all users. A private list is available only to you

  6. Status : Set the list as active or inactive

  7. Select the appropriate Record type. You can only query one type of record. Query fields and result headers will depend on the record type chosen.

Supported record types

  1. Holdings

    1. Instances

    2. Items

    3. Loans

    4. Organizations - contact info

    5. Organizations - vendor info

    6. Purchase order lines,

    7. Users.

...

Test query runs the query and displays a preview of the returned record set. The first 100 records are displayed in the preview pane and the total count of records appears at the top of the preview pane. If the Test query returns more than 10025,000 results, refine your criteria to return a smaller set

...