OLE Search- Design Planning

 DRAFT. To be reviewed with Project Team and then introduced to SME Teams.

The following have been created to ensure OLE solicits detailed and explicit user and technical requirements for LIBRARY SEARCH. SME Teams and lead SME's should complete the following:

1. Review below Reference and Search summary information to evaluate current OLE Search.
2. Download and submit Search Features Survey(TBA- each SME Team; optionally each Partner Library, or compiled by TC or Systems Integration).
3. Download and complete the Search Requirements Template (google docs) for each SME Team/module for global search features used to find library materials (Acquisitions, Licensing, Cataloging, Circulation).

Project team, Systems Integration and functional SMEs will then work with combined requirements to formulate UI's, search logic, indexing, and document working requirements: Search Specifications- OLE 0.8

Reference:

Utilize below as helpful and appropriate.

• OLE DEMO (http://demo.ole.kuali.org/ole-demo/portal.jsp)
  • Use: the OLE DEMO drive to explore OLE and past OLE 0.3 and 0.6 coding for Search.
  • OLE 0.6 User Documentation / Drivers Manual to assist in reviewing coded search features.
  • OLE DEMO is refreshed biweekly.
  • OLE DEMO is used by the Board and FC for external demonstrations during conferences, to staff, and potential partners. We request that users stay out of the environment during these times on the OLE Demo Calendar
• OLE TEST (http://env4.ole.kuali.org/)
  • Use:  the OLE TST drive to test and review progressive search development and coding in 0.8.
  • OLE TST code is promoted biweekly on Friday afternoons and will be unavailable to users.
  • Note: OLE-DEV and OLE-TST do NOT currently (6/29/12) have bulk Bib and Instance records for testing of Search services. Those will be persisted in July pending completion of OLE Instance v.9.
• OLE Data Model & Fields
  • Use: While OLE stores the below Document Types in the DocumentStore, OLE also maintains a relational database to store transactional data, users, patrons, and maintenance tables.
  • To access Fields used in transactions (such as Purchase Orders, Loans), users may view the following from inside OLE TST or OLE DEMO:
    • Go to OLE Application, and select the Administration Tab
    • Select: "Functional Field Description Lookup". 
    • Users must select the appropriate Namespace (OLE-PURAP for acquisitions; OLE-VND, OLE-COA) and its Tab "component"- on which tab does field display?
    • Note: We are currently maintaining Rice 1 and Rice 2 data tables, and users must select the appropriate tool to access its tables (Acquisitions- Rice 1; Cataloging, Circulation, Licensing- Rice 2)
  • Alternatives:
    • Go to any transactional doc, and just find its basic display/label name on UI, and we can translate in future specs.
    • Install a database tool (such as free Oracle SQL Developer), and link to OLE tables (oracle.ole.kuali.org- contact Project Team or see Jenkins)
• OLE Wiki, Document Types & Schemas
  • Use: use the wiki and its linked schemas to identify additional fields to be used in search design (fields, filters, sorts, facets, display)
  • OLE Bibliographic Documents - Docstore, Marc & Dublin Core
  • Bibliographic <Node metadata: DateUpload, DateLastUpdated. Future: FastAddFlag, Public, DateEntered?, CreateBy?>
  • OLE Instance- Docstore
  • Instance <Node Metadata: DateEntered, CreatedBy, LastUpdated, LastUpdatedBy, Harvestable, Status, SuppressFromPublic, FastAddFlag>
  • Item (availability) Status
  • OLE License Workflow
• OLE Wiki: OLE Search Technical Documentation     
  • Use: To understand technical framework as coded so far for fields, facets, indexes, sorts, search logic and operators.
  • The wiki provides iterative documentation on the progress of Search coding, and docstore architecture with data model.
  • Doctypes & Formats:
    • Bib: Marc, Dublin Core (qualified, unqualified)
    • Instance
    • Licenses
    • Crosswalks used in Search fields/indexing
  • It provides an overview to coding in place for DocStore (federated) Search:
    • Available Search Fields
    • Available facets
    • Available Sorts
    • Search logic
    • NISO standards for sort (in progress)
  • It provides an overview of Transactional/Workflow searches completed or in progress for:
    • Acquisitions Search
    • Order Holding Queue
    • Receiving Queue
    • KFS/KNS Doc Search
    • KFS/KNS available fund/budget searches
    • Patron Search
    • Maintenance Docs/Lookups (searching & adding to controlled value selection lists)
    • License Agreement Search
    • Dup Check Match-Search used in Overlay & Ingest logic
• OLE Jira, Master Search Executive OLE-1144
  • Use: To reference past functional documentation if more in-depth research or trouble-shooting required.
  • coding updates & original specifications (open, in-progress, testing, complete)
  • November/OLE 0.3 Search (initial Bib search, sorts, facets) OLE-1996
  • OLE 0.8 new/fixes in progress:
    • NISO Sort OLE-2194 and NISO Standard for Sort (wiki)
    • Search Display- Non-Roman OLE-2934
    • Facet fixes OLE-3015
    • Instance version9- OLE-2980
    • Instance Editor OLE-2555 and related

 

OLE Search Fields, Facets, Sorts Summary

(current to 6/29/12)

For Acquisitions/Transactional Searches and Search fields- please reference: OLE Technical Documentation- Search-Transactional Searches

Decision Points

1. SEE SEARCH FEATURES SURVEY/features options
2. Date of Publication facets-
   1. what groupings/how
   2. 260$c versus control fields 008/07-10
3. Source of Language code lists- need to document how HTC applied
4. Framework Approach Options: 
   1. KNS Tx Search
      1. see also: KS code contribution for 2.2 or 2.3- adding combined table lookups (not search, but lookups, allowing AND, OR logic on lookup fields)
   2. SOLR (with JQUERY UI)
      1. Per MS/Rice- we could add our existing UI's to KRAD library....may/may not require some mods since these were dev'd pre-KRAD
   3. KRAD
      1. Based on JQRY (OLE Docstore Search UI is jqry, but not KRAD at present)
      2. Per MS/Rice, KRAD standard operators
         1. AND("&&")
         2. OR("|")
         3. NOT("!")
         4. BETWEEN("..")
         5. BETWEEN_EXCLUSIVE_LOWER(">..")
         6. BETWEEN_EXCLUSIVE_UPPER("...")
         7. BETWEEN_EXCLUSIVE_UPPER2("..<")
         8. BETWEEN_EXCLUSIVE(">..<")
         9. NULL("NULL")
         10. NOT_NULL("!NULL")
         11. LIKE_ONE("?")
         12. LIKE_MANY("*")
         13. LIKE_MANY_P("%")
         14. GREATER_THAN(">")
         15. LESS_THAN("<")
         16. EQUAL("=")
         17. GREATER_THAN_EQUAL(">=")
         18. LESS_THAN_EQUAL("<=")OR("|")
5. Extend or replace KFS/OLE Custom Doc Searches
6. Normalization
7. Edits to Instance Schema, fields?
8. Authority records: linkages, search, NACO standards
9. Authority "work-around" 1.0
   1. Marc editor allows any form of name entries
   2. how updating names- manual copy paste from authority?
   3. right now records- some Lname/Fname, some Fname/Lname, bad punctuation etc.
   4. validations on editor, vs tech svc workflows on bibs, overlay/oclc or authority
10. Call Number Browse (coming in OLE 0.8)
11. Linked PO or Circ record from Item, and Order/Circ status (coming in OLE 0.8)
12. Linked License Agreement (electronic journals etc)- in progress
13. Search filters: Location, Format, Dates, Language, Record/Doc Status, Item Availability status,  TBA
14. External Linked Data: Authority, or other stores
15. Saved DocStore Searches (or user preferences)
16. Wildcard behaviors
17. Positional Operators
18. Truncation
19. Nested Search (more than one operator in same expression)
20. Field/Marc tagging search
21. Checkin, Checkout from Search
22. Rice/KNS upgrades (future): search facets and other enhancements for transactional search
23. Non-Roman Characters (ie, Chinese, Russian, etc)
24. Docstore UI Design Components:
    1. Search UI 
    2. Search Fields
    3. Filters
    4. Sorts
    5. Facets
    6. Pagination
    7. Preferences
    8. Search Results UI
    9. Results view options
    10. Record display: brief, expanded, preview