Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Initial eHoldings documentation added

JIRA Tickets associated with this Report Cluster:

...

  • (describe report cluster parameters, criteria, filters, etc.)


Information

-See ERM Statistics summary for report descriptions and priority.


Information Resources for Data Attributes

...

FOLIO Attribute Definition Sources

-API reference documentation for all modules located at:  https://dev.folio.org/reference/api/

...

-See eUsage: requirements/fields

-See  UXPROD-1264 - Calculate Statistics: Costs Per Download

-See the Finance Data Model

...

Plus the data from the RM-Costs Cluster Prototype

For each row in mod_agreements/entitlement with an ent_authority equal to either of:

  • EKB-TITLE
  • EKB-PACKAGE

The description of the resource can be obtained from an eHoldings API using the value stored in ent_reference as follows:

  • If ent_authority = "EKB-TITLE", use mod-kb-ebsco-java/resources/{resourceId} using the value of ent_reference as the {resourceId}
  • If ent_authority = "EKB-PACKAGE", use mod-kb-ebsco-java/packages/{packageId} using the value of ent_reference as the {packageId}


Folio Attribute (Module/Path:Object)

Folio Data Element Description

Parameters/Query

Table Name: mod-kb-ebsco-java/resources/{resourceId}

eHoldings resource ID (mod-kb-ebsco-java/resources:id)

ID for the eHoldings resource.

This will be an identifier created from three parts, each part being an integer:

<provider id>-<package id>-<title id>

For example:

"Gale Cengage" (provider id = 18) provide a package "Academic ASAP" (package id = 34) which contains a title "Harvard Business Review" (title id = 32090)

  • the identifier for the resource "Harvard Business Review in the Academic ASAP package from Gale Cengage" is 18-34-32090


eHoldings resource name (mod-kb-ebsco-java/resources:attributes:name)Name of the resource (i.e. title of book/journal/etc.)
eHoldings resource publication type (mod-kb-ebsco-java/resources:attributes:publicationType)Type of resource (e.g. book/journal/...)
eHoldings resource identifier (mod-kb-ebsco-java/resources:attributes:identifiers{id})External identifier for the resource (e.g. an ISBN or ISSN)

*Repeatable field*

eHoldings resource identifier type (mod-kb-ebsco-java/resources:attributes:identifiers{type})The identifier type (e.g. ISBN/ISSN)
eHoldings resource identifier subtype (mod-kb-ebsco-java/resources:attributes:identifiers{subtype})The identifier subtype (e.g. Print/Electronic)
Table Name: mod-kb-ebsco-java/resources/{resourceId}

eHoldings package ID (mod-kb-ebsco-java/packages:id)

ID for the eHoldings package.

This will be an identifier created from two parts, each part being an integer:

<provider id>-<package id>

For example:

"Gale Cengage" (provider id = 18) provide a package "Academic ASAP" (package id = 34)

  • the identifier for the package "Academic ASAP from Gale Cengage" is 18-34


eHoldings package name (mod-kb-ebsco-java/packages:name)The name of the package
eHoldings package name (mod-kb-ebsco-java/packages:titleCount)The number of titles in the package
eHoldings package name (mod-kb-ebsco-java/packages:selectedCount)The number of titles in the package that have been marked as "selected" by the institution