[FOLIO-1290] Map Inventory/instance-types (resource types) to Codex Resource Types Created: 15/Jun/18  Updated: 17/Jul/19  Resolved: 24/Aug/18

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Story Priority: P2
Reporter: Niels Erik Nielsen Assignee: Niels Erik Nielsen
Resolution: Done Votes: 0
Labels: sprint40, sprint41, sprint42, sprint43
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Attachments: PNG File Screenshot from 2018-06-18 14-01-32.png     PNG File Screenshot from 2018-06-18 14-02-35.png     PNG File Screenshot from 2018-06-18 14-02-46.png     PNG File Screenshot from 2018-06-18 14-03-03.png     PNG File Screenshot from 2018-06-18 14-17-27.png     PNG File image-2018-06-15-16-19-10-708.png     PNG File image-2018-06-15-16-41-11-357.png     PNG File image-2018-06-15-16-48-08-525.png    
Issue links:
Blocks
blocks UIIN-151 Settings page. Inventory > Instances ... Closed
blocks UIIN-149 Settings page. Inventory > Instances ... Closed
blocks UIIN-150 Settings page. Inventory > Instances ... Closed
Relates
relates to FOLIO-1575 Map Inventory/instance-types (resourc... Open
relates to FOLIO-1437 Map Inventory/instance-types (resourc... Closed
relates to MODCXINV-28 Update dependencies to include new ve... Closed
Sprint:

 Description   

Currently ui-search operates with these resource types:

mod-inventory has these resource types:

We currently map from inventory to codex type in mod-codex-inventory, using this map:

"Spoken Record":  Audio
"Books": Books
"Computer Files": Databases
"eBooks":  eBooks
"3-D Objects":  Kits
"Kits": Kits
"Mixed Material": Kits
"Maps": Maps
"Music (Audio)": Music
"Music (MSS)": Music
"Music (Scores)": Music
"Serials": Periodicals
"Charts Posters": Posters
"Theses": Thesis and Dissertation
"Error": Unspecified
"Videorecording": Video
"Web Resources": Web resources

(the current set of /instance-types doesn't seem to support mappings to Newspapers, Newsletters, Reports, Proceedings)

This map will not work as we load the new RDA content types (https://www.loc.gov/standards/valuelist/rdacontent.html) to /instance-types; none (or very few) of these resource types will remain.

Short term we thus need to map the RDA content types to the Codex search types (I'm uncertain how, neither rda carrier or rda content has a 'book' concept for instance).

Charlotte Whitt, can the SIG help with this?

Next, I'd propose we move the mapping into the /mod-inventory-storage/instance-types table so it can be managed by librarians through the settings:

Otherwise it will require new releases of mod-codex-inventory whenever a librarian adds or renames a local resource type (or one cannot search for Instances by that resource type)

This of course requires, that Adam Dickmeiss can use the mapping from mod-inventory-storage/instance-types instead of the current mapping in mod-codex-inventory itself.

This proposal would require changes to mod-inventory-storage, ui-inventory, mod-codex-inventory, and possibly the dataloader.



 Comments   
Comment by Niels Erik Nielsen [ 15/Jun/18 ]

Regarding mapping:

There's currently a bug when setting a filter in ui-search, then clicking on an instance to view it in ui-inventory. The codex filter term is forwarded to ui-inventory, which does not know the Codex resource type terms or have knowledge about how to map them to inventory terms.

It may already be filed. I'm not sure in which project to file it anyway - it probably will touch multiple projects front-end and back-end.

Comment by Niels Erik Nielsen [ 15/Jun/18 ]

For now I've implemented following mapping from inventory instance-types to codex resource types in (a branch of) mod-codex-inventory.

But some of those mappings seem not natural. For instance, we can't know whether a 'text' is 'Books' or 'Serials'?

Inventory instance-types Codex resource types
cartographic dataset Maps
cartographic image Maps
cartographic moving image Maps
cartographic tactile image Maps
cartographic tactile three-dimensional form Maps
cartographic three-dimensional form Maps
computer dataset Databases
computer program Databases
notated movement Kits
notated music Music
performed music Music
sounds Audio
spoken word Audio
still image Kits
tactile image Kits
tactile notated music Music
tactile notated movement Kits
tactile text Books
tactile three-dimensional form Kits
text Books
three-dimensional form Kits
three-dimensional moving image Video
two-dimensional moving image Video
other Unspecified
Unspecified Unspecified
Comment by Mike Taylor [ 16/Jun/18 ]

There's currently a bug when setting a filter in ui-search, then clicking on an instance to view it in ui-inventory. The codex filter term is forwarded to ui-inventory, which does not know the Codex resource type terms or have knowledge about how to map them to inventory terms.

I don't think that's right, At least. I definitely wrote code that had the intention of mapping selected filter-values when following a link from Codex Search to Inventory: see https://github.com/folio-org/ui-search/blob/master/src/redirectParams.js#L71-L97

Comment by Niels Erik Nielsen [ 18/Jun/18 ]

All right, I may have jumped to conclusion about the cause, but this is what I saw:

In ui-search, search for 'water'

Filter by 'Music'

Click the Instance to view it in Inventory

'Music' is mapped to 'Music (Scores)' in the filter list, but Inventory cannot find any Instances with that resource type, since the Instance in question is of type 'Music (Audio)'.

***

Another things is, on some tries (the first?), I get this:

Guess that could be due to the parentheses in the Inventory resource-type term.

Comment by Mike Taylor [ 18/Jun/18 ]

Well, I don't know what the actual error is about, nor why you only sometimes see it. But leaving that aside, I now see that your underlying problem is more sophisticated than I'd realised. I thought you were saying that the filter settings weren't getting mapped; now I see the problem is that the map is not good enough. In this case, it looks like we may need to enhance the mapping code so that it's able to specify that a given filter-value in the Codex app maps to multiple filter-values in the destination app. (I can make that change if you want me to: if so, please file a specific issue on me.)

Comment by Charlotte Whitt [ 21/Jun/18 ]

Mike Taylor - I'll reach out to Khalilah Gambrell re. doing an updated mapping exercise of Resource Types (EPKB, Codex, Inventory mapping), now we are implementing the refined Resource types based on the RDA content terms (https://www.loc.gov/standards/valuelist/rdacontent.html) in Inventory.

Comment by Charlotte Whitt [ 26/Jun/18 ]

Niels Erik Nielsen - Khalilah, Laura W. and I are working on the mapping - see part (column D-G) - work in progress: https://docs.google.com/spreadsheets/d/1RRLjsTl-SMGEh-5RkVwguffKW4dvkO-IwTdca6kFXeE/edit?ts=5b323ccd#gid=667989703

Comment by Charlotte Whitt [ 26/Jun/18 ]

Niels Erik Nielsen comment to your walk through above. Then a term in the filter list, should only be shown in Inventory (and Codex) IF there is at least one record with the given 'Resource type'. If no records has the term, then it should not be listed in the Filter list. Not sure if this is possible to implement now, or we need to wait for the hit count feature is in place?

Comment by Charlotte Whitt [ 26/Jun/18 ]

Mike Taylor re.:

it looks like we may need to enhance the mapping code so that it's able to specify that a given filter-value in the Codex app maps to multiple filter-values in the destination app. (I can make that change if you want me to: if so, please file a specific issue on me.)

Yes, that is needed for several of the Resource Type terms in Codex Search app. Let's leave it for now, and then I'll write a new jira with the new mapping requirements, when the SMEs and I have finished the work with mapping based on Resource types in Inventory will follow the list of RDA content terms, and Formats will follow the list of RDA carrier terms.

Comment by Charlotte Whitt [ 27/Jun/18 ]

Hi Niels Erik Nielsen - here the normalized list - see: column G in: https://docs.google.com/spreadsheets/d/1RRLjsTl-SMGEh-5RkVwguffKW4dvkO-IwTdca6kFXeE/edit#gid=667989703

Note:

  1. There are no changes to the eHoldings mapping - these are written up in the list as e.g. e: Streamingaudio
  2. We use lowercase letter for all terms in the Codex Resource type list (in alpha, we used capitalization - writing the term with its first letter as a capital letter)
  3. The colored text is referring to the two list in the standard
    • purple = RDA content
    • orange = RDA carrier
  4. We want to use the category, as a grouping term for all the more specific term listed in the category
  5. A few terms, are the specific term (and not the carrier category), e.g. computer--online resource
  6. And a couple of places, we hope that it will be possible to express, the combination. So this is to be understood as, e.g. I: text + computer carrier (combined expression) => Resource type: 'text' AND Format: the category 'computer carrier'
Comment by Niels Erik Nielsen [ 29/Jun/18 ]

We don't yet have the ability to include multiple Inventory.Instance properties (ie instanceType, instanceFormat) for mapping to Codex.Instance resource-type. For now we will have to use Inventory.Instance.instanceType with the new RDA Content terms.

Charlotte Whitt and I modified the initial, simple mapping (see https://folio-org.atlassian.net/browse/FOLIO-1290?focusedCommentId=193787&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel) with regards to some of the terms:

Inventory instance-types Codex resource types
cartographic dataset Maps
cartographic image Maps
cartographic moving image Maps
cartographic tactile image Maps
cartographic tactile three-dimensional form Maps
cartographic three-dimensional form Maps
computer dataset Databases
computer program Databases
notated movement Unspecified
notated music Music
performed music Music
sounds Audio
spoken word Audio
still image Posters
tactile image Posters
tactile notated music Music
tactile notated movement Unspecified
tactile text Books
tactile three-dimensional form Kits
text Books
three-dimensional form Kits
three-dimensional moving image Video
two-dimensional moving image Video
other Unspecified
Unspecified Unspecified
Comment by Mike Taylor [ 03/Jul/18 ]

Let's leave it for now, and then I'll write a new jira with the new mapping requirements, when the SMEs and I have finished the work with mapping.

Thanks, that sounds good. Feel free to assign to me when you've created it.

Comment by Charlotte Whitt [ 24/Aug/18 ]

Manual tested in FOLIO Snapshot Stable. All looks good. I'll close the issue as done.

A new issue for mapping Inventory/instance-types (resource types) *and *instance-format (format) to Codex Resource Types is created - FOLIO-1437 Closed (set in draft mode, until the fast working MM-SIG group has finished their requirements).

Generated at Thu Feb 08 23:12:14 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.