...
Field Attribute | Purpose | Example |
|---|---|---|
Id | Unique identifier of a field with a given [category, type, format] | id="ISBN_search |
Name | Name of the field suitable for display | name="ISBN" |
Type | Indicates the type of value of the field (informative purpose only) |
|
Mapping info can be defined for each field which specifies how the value(s) for the field should be extracted from the input file for the corresponding document. Mapping can be specified as XPATH value or a custom value.
Mapping Info/Attributes
Mapping Attribute | Purpose | Example |
|---|---|---|
Type | Indicates how the mapping info is to be interpreted |
|
Include | Values to be included |
|
Exclude | Values to be excluded |
|
Modifying configuration info:
- Open the DocumentConfig.xml file.
- Add/modify/delete one or more fields of any [document category/type/format].
- Save the file.
- Reload the DocStore application. (Restart the Tomcat server.)
- Re-index the data related to the document category/type/format modified.
Adding a field:
Copy and paste an existing field definition and modify the attributes suitably.
Modifying a field:
Name and mapping info can be modified for any existing field.
Deleting a field:
A field definition can be commented or deleted.
4.1 Document Configurations
A common place to define all Configurations related to all documents which are indexed & searchable by the solr are being defined in this file. Like the fields that can be searched, displayed and faceted (for each document category/type/format) cab be defined in the xml file 'DocumentConfig.xml' & conveyed to docstore. A sample of this file is as given below:
4.1.1 Document Configurations File
/opt/docstore/properties/DocumentConfig.xml
<documentConfig>
<documentCategory id="work" name="Work">
<documentType id="bibliographic" name="Bibliographic">
<documentFormat id="all" name="ALL">
<field id="Title_search" name="Title" type="text" />
<field id="Author_search" name="Author" type="text" />
.......
</documentFormat>
<documentFormat id="marc" name="MARC">
<field id="ISBN_display" name="ISBN" type="text">
<mapping type="custom">
<include>020-a;z</include>
<exclude/>
</mapping>
</field>
<field id="ISBN_search" name="ISBN" type="text">
<mapping type="custom">
<include>020-a;z</include>
<exclude/>
</mapping>
</field>
<field id="ISSN_display" name="ISSN" type="text">
<mapping type="custom">
<include>022-a;z</include>
<exclude/>
</mapping>
</field>
.......
</documentFormat>
......
</documentType>
........
</documentCategory>
.........
</documentConfig>
This configurations file is used by DocStore to index and to display the fields in several areas of DocStore search & web app modules. This is a one time loaded file and is also loaded by the solr doc builders and other applications once at the time of startup and there after be used at the time of indexing & display.
Currently Supported Document Categories, Types and Formats are as below
<documentConfig>
<documentCategory id="work" name="Work">
<documentType id="bibliographic" name="Bibliographic">
<documentFormat id="all" name="ALL" ...>
<documentFormat id="marc" name="MARC" ...>
<documentFormat id="dublin" name="Dublin Core" ...>
<documentFormat id="dublinunq" name="Dublin Unqualified" ...>
</documentType>
<documentType id="license" name="License">
<documentFormat id="all" name="ALL" ...>
<documentFormat id="onixpl" name="ONIXPL" ...>
<documentFormat id="pdf" name="PDF" ...>
<documentFormat id="doc" name="DOC" ...>
<documentFormat id="xslt" name="XSLT" ...>
</documentType>
<documentType id="instance" name="Instance">
<documentFormat id="oleml" name="OLEML" ...>
</documentType>
<documentType id="holdings" name="Instance Holding">
<documentFormat id="oleml" name="OLEML" ...>
</documentType>
<documentType id="item" name="Instance Item">
<documentFormat id="oleml" name="OLEML" ...>
</documentType>
</documentCategory>
<documentCategory id="security" name="Security">
</documentCategory>
</documentConfig>
4.1.2 Field Definitions
A Field inside this configurations file can be defined with attribute id is the name of the field inside solr by which it can be represented or indexed, name is the one to be displayable name of the filed and type is its entity type.
<field id="ISBN_search" name="ISBN" type="text">
<mapping type="custom">
<include>020-a;z</include>
<exclude/>
</mapping>
</field>
...
type="text" |
Field Definition
| No Format |
|---|
A Field inside configurations file can be defined with attribute id is the name of the field inside solr by which it can be represented or indexed,
name is the one to be displayable name of the filed and type is its entity type.
<field id="ISBN_search" name="ISBN" type="text">
<mapping type="custom">
<include>020-a;z</include>
<exclude/>
</mapping>
</field>
|
Mapping info can be defined for each field which specifies how the value(s) for the field should be extracted from the input file for the corresponding document. Mapping can be specified as XPATH value or a custom value.
Mapping Info/Attributes
Mapping Attribute | Purpose | Example |
|---|---|---|
Type | Indicates how the mapping info is to be interpreted | type="custom" |
Include | Values to be included | <include>020-a;z</include> |
Exclude | Values to be excluded | <exclude/> |
Mapping Entry:
| No Format |
|---|
Mapping is either of the types 'custom'/'xpath'. All the fields or defined values to include or exclude to derive actual field values of xml. Custom is the type where its definitions are customized and understood by only that type of doc builder. XPath is the one defined to be of derived xpath of the elements in conjunctions with its types of concerned java, what tags or fields to be included or excluded. |
...
<field id="ContractNumber_search" name="Contract Number" type="text"> |
...
<mapping type="xpath"> |
...
<include>/publicationsLicenseExpression/licenseDetail/licenseIdentifier/IDValue/ |
...
value</include> </mapping> |
...
</field> |
...
Above is |
...
4.1.3 Add/ Delete/ Update a Field Definition
Steps to Add / Update a new field to be added for indexing and display:
- Open the document DocumentConfig.xml from /opt/docstore/properties/
- You can just take an existing field definition of that type as reference for deriving a new field (In case of adding a new field). Incase of update just make the field definition to be modified as required.
- Take care it is not a duplicate id to any of the existing field definitions.
- Save the file.
- Restart docstore.
- Re-Index the concenrned category/type/format of documents to get changes be reflected in docstore.
above steps be followed in given order to reflect the required changes in docstore.
Incase of deletion of a field or if a specific field is 'not required to be indexed': All the above steps be followed except 2,
...
the example for the field of mapping type xpath.
|
Modifying configuration info:
- Open the DocumentConfig.xml file.
- Add/modify/delete one or more fields of any [document category/type/format].
- Save the file.
- Reload the DocStore application. (Restart the Tomcat server.)
- Re-index the data related to the document category/type/format modified.
Adding a field:
Copy and paste an existing field definition and modify the attributes suitably.
Modifying a field:
Name and mapping info can be modified for any existing field.
Deleting a field:
A field definition can be commented or deleted.
Transactional Search
OLE coding to-date for Acquisitions functions have utilized KNS Lookups, DocSearch (Detailed Search, Superuser Search), and named or session-based searches......
...