Search Framework Configuration

The Search Framwork Configuration controls what is displayed on the Search Workbench and to a large degree how the Search Workbench operates.

Title	Description
Name	Required. A unique name of the Doc Type. This will appear within the code.
Label	Required. A label for the Doc Type. This will appear in the Doc Type lookup on the Search Workbench.
Description	Optional. A description for the Doc Type.

Doc Formats Tab

The Doc Formats tab allows you to define multiple formats for document types and to provide each with a distinct label. The values in the drop down “Document Type” are from the Doc Types definitions described above.

To work with the Doc Formats section, first select a Document Type in that drop down.

Selecting Document Type Bibliographic will display the 3 formats defined for 3 different Bibliographic formats: Dublin Core, Dublin Unqualified, and MARC.

Selecting Document Types EHolding, Holding and Item will display a single document format definition for each. For all of these document types, the format is oleml (OLE Markup Language – an xml format).

Selecting Document Type License displays 4 different formats for License. The definitions are DOC (Word Doc), ONIXPL (ONIX for Publications Licenses), PDF (Adobe), and XSLT (Extensible Stylesheet Language Transformations).

The format definitions along with the Doc Types are used in the Doc Fields section described below.

Multiple doc formats can be added to the search framework configuration by filling in all of the required fields and clicking the add button.

Warning

DO NOT ADD OR CHANGE ANY VALUES IN THIS SECTION WITHOUT FIRST CONSULTING WITH A PROGRAMMER. Code changes are needed to support a new document type.

Doc Format Column definitions

Title	Description
Name	Required. A unique name of the Doc Format. This will appear within the code.
Label	Required. A label for the Doc Format.
Description	Optional. A description for the Doc Format.

Doc Fields Tab

The Doc Fields tab controls the fields that are available for searching, the fields that are displayed in the results, the fields that can be globally edited in the Global Edit screen, and the fields that will be exported in an XML format from the search results. It also controls the definitions of those fields in terms of the values recorded in the bibliographic records. For example a field called Title can be defined in terms of MARC fields.

Note

Changes to some Doc Fields values will only affect records added or edited after the change is made because an indexing update is necessary to alter the display.

In order to index and reindex bibliographic, holdings, e-holdings, and item records in Solr, go to http://demo.docstore.ole.kuali.org/admin.jsp for OLE's demo environment or http://tst.docstore.ole.kuali.org/admin.jsp if you are in the tst environment.

Click the Start button.

Click Show Status button to see the status.

Indexing is complete when you see the "Index End Time"

To use this section, you need to select values from both the drop downs: Document Type and Document Format. The values for these lists are from the previous sections Doc Types and Doc Formats. Selecting a Doc Type will change the values in the Document Format section.

Depending on the Document Type selected from the drop down, different columns will be displayed.

Doc Fields for Document Type – Bibliographic and Document Format – MARC

Selecting Document Type Bibliographic and Document Format MARC displays columns:

Name, Label, Description, Path Include, Path Exclude, Is Search, Is Display, Global Edit, Is Export, and Is Facet.

A Note on Titles: What OLE displays as Title in the search results is Title_sort. If you modify Title_display you will not see the results. However if you mouse-hover over a Title_sort value in the Search Workbench, you will see the Title_display value.

Multiple doc fields can be added to the search framework configuration by filling in all of the required fields and clicking the add button.

Doc Fields definitions

Title	Description
Name	Required. This is the name of the field used in Solr configuration. Please note that each Name value here must have the same name in the Solr configuration. Warning Adding a name here must be accompanied by a reconfiguration of Solr to be effective. Changing an existing Name value here without a corresponding name change in Solr will have unforeseen consequences.
Label	Required. This is what the users will see displayed as search values in the ‘In Field’ drop down on the Search Workbench for selecting the search criteria for Names ending in “_search” and the column names for search results for Names ending in “_display”. This can be changed without any corresponding change in Solr Configuration. Note As of this writing, changing the value for an existing Label does not affect what the users see.
Description	Optional. This is just for documentation. It does not have any impact on what the user sees on the Search Workbench.
Path Include	Optional. For Bibliographic Marc format fields, this is a reference to the underlying MARC fields and subfield codes. Entering a MARC field and subfield here defines what fields are displayed or searched on when this field is displayed in the search results or searched if selected in the search criteria. The default values displayed were derived from the OLE Search Technical Documentation page (section 1.3) on OLE’s Wiki page. There is a specific syntax to be used for both Path Include and Path Exclude. See Path Syntax below.
Path Exclude	Optional. For Bibliographic MARC format fields, this is a limitation on the Path Include values. If the path include for Title_display field for example was “245”, a value of “245-c” in this column would cause all values in 245 subfields to display except for the value in subfield 245 c. See Path Syntax below for a definition of the syntax to be used.
Is Search	Optional. Checking this box for a field will cause the field label to appear as a value in the “In Field” drop down on the Search Workbench. Removing the check will cause that field to disappear from those drop down values. Only check fields in this column which have “_search” as the last part of their names. See Cautionary Notes below.
Is Display	Optional. Checking this box for a field will cause the field label to appear as a column in the search results on the Search Workbench. Removing the check will cause that field column to disappear from the search results display on the Search Workbench. Only check fields in this column which have “_display” as the last part of their names. See Cautionary Notes below.
Global Edit	Optional. Checking this box for a field will allow the field to be edited in the Global Edit screens. A Global Edit screen for Bibliographic records is a future enhancement. This column will likely be hidden until that enhancement is ready.
Is Export	Optional. This is for a future feature that will allow export of fields in csv format. It has no impact on the “Export to Doc XML” function displayed under the search results on the Search WorkBench screen.
Is Facet	Optional. Checking this box will cause the Label for this field to appear in the “Narrow Search” section of the Search Workbench screen when searching for Bibliographic records. Only check fields in this column that have “_facet” as part of their names. See Cautionary Notes below.
Actions	Click add before clicking saveto add extra rows to the Doc Fields tab.

Path Syntax

There is a specific Path syntax to be used in the Path Include and Path Exclude column values for a field. Here are examples of the syntax.

245-a means MARC field 245, subfield a. This is the value that will be searched or displayed for that field name.

245-a;b means MARC field 245 subfield a and subfield b. The semi colon means that for display fields, the value displayed will be the concatenated values of those subfields.

234-c, 245-6 means MARC field 245 subfield c and field 245 subfield 6 will be displayed, the comma will cause those two values to display on two lines in the search results.

600,610,69* means all the subfields of 600 will be concatenated and displayed on the first line, all the subfields of 610 will be concatenated and displayed on the second line, all the values of all the subfields of all fields starting with 69 will be concatenated and displayed on a third line.

Note: There are some nonstandard subfields in a few of the default values that should not be confused as some kind of syntax. Examples include the Author_display Path Exclude field. The values “100-=” and “100-?” are actually subfields for the 100 field used by some of OLE’s partner institutions’ current systems – not syntax. It is likely that those subfields will not be used in OLE and will be removed from these default field definition values.

Doc Fields for Document Type Holdings, EHoldings, and Items; Document Format OLEML

Selecting Document Type Holding, EHoldings, or Items and Document Format OLEML displays columns:

Name, Label, Description, Is Search, Is Display, Global Edit, Is Export, and Is Facet.

Multiple doc fields can be added to the search framework configuration by filling in all of the required fields and clicking the add button.

Doc Fields definitions

Title	Description
Name	Required. This is the name of the field used in Solr configuration. Please note that each Name value here must have the same name in the Solr configuration. Warning Adding a name here must be accompanied by a reconfiguration of Solr to be effective. Changing an existing Name value here without a corresponding name change in Solr will have unforeseen consequences .
Label	Required. This is what the users will see displayed as search values in the ‘In Field’ drop down on the Search Workbench for selecting the search criteria for Names ending in “_search” and the column names for search results for Names ending in “_display”. This can be changed without any corresponding change in Solr Configuration. Note As of this writing, changing the value for an existing Label does not affect what the users see.
Description	Optional. This is just for documentation. It does not have any impact on what the user sees on the Search Workbench.
Is Search	Optional. Checking this box for a field will cause the field label to appear as a value in the “In Field” drop down on the Search Workbench. Removing the check will cause that field to disappear from those drop down values. Only check fields in this column which have “_search” as the last part of their names. See Cautionary Notes below.
Is Display	Optional. Checking this box for a field will cause the field label to appear as a column in the search results on the Search Workbench. Removing the check will cause that field column to disappear from the search results display on the Search Workbench. Only check fields in this column which have “_display” as the last part of their names. See Cautionary Notes below.
Global Edit	Optional. Checking this box for a field will allow the field to be edited in the Global Edit screens. A Global Edit screen for Bibliographic records is a future enhancement. This column will likely be hidden until that enhancement is ready.
Is Export	Optional. This is for a future feature that will allow export of fields in csv format. It has no impact on the “Export to Doc XML” function displayed under the search results on the Search WorkBench screen.
Is Facet	Optional. Checking this box will cause the Label for this field to appear in the “Narrow Search” section of the Search Workbench screen when searching for Bibliographic records. Only check fields in this column that have “_facet” as part of their names. See Cautionary Notes below.
Actions	Click add before clicking saveto add extra rows to the Doc Fields tab.