Questions
-is there an example of this report somewhere?
(Link to REPORT EXAMPLE)
JIRA Tickets associated with this Report Cluster:
The JIRA ticket for this report cluster is UXPROD-2368 ERM-Agreements Costs Cluster.
Report Description Detail
- This report is modeled on (Cluster), a cluster of ERM reports currently consisting of (REP-XXX, etc.). The purpose of this cluster of reports is to show cost statistics associated with ERM agreements.
- Have I already paid for serial/journal x?
- Output: invoice amount/details (+time frame specified in the invoice), associated with actions such as communicating with vendors
- Output: invoice amount/details (+time frame specified in the invoice), associated with actions such as communicating with vendors
- How much did serial/journal x cost me in YYYY?
- Output: invoice amount/details (+time frame for year), associated with external statistics such as for an annual report
- Output: invoice amount/details (+time frame for year), associated with external statistics such as for an annual report
- How much did I pay for my agreements?
- Output: time frame / invoice amounts
- Output: time frame / invoice amounts
- DBS - Deutsche Bibliotheksstatistik / German Library Statistics
From DBS/Reporting Master Spreadsheet: Journals and newspaper in electronic form: costs for those (licenses) in the reporting year (REP-68 , DBS 134 , expenses)
- Output: Amount
From DBS/Reporting Master Spreadsheet: Other costs for journals and newspapers in electronic form, e.g. one-time purchase of backfiles (REP-69 , DBS 135, expenses)
- Output: Amount
Data Attributes
- (high-level list of data fields)
- Data Attributes will come from the following application areas: Orders, Invoices, and Agreements
Report Criteria
- (describe report cluster parameters, criteria, filters, etc.)
Information Resources for Data Attributes
FOLIO Attribute Definition Sources
-See ERM Statistics summary for report descriptions and priority.
-API reference documentation for all modules located at: https://dev.folio.org/reference/api/
-Github
-See eUsage: requirements/fields
-See the Finance Data Model
-See UXPROD-1264 - Calculate Statistics: Costs Per Download
-RM-Costs Cluster Prototype FOLIO Wiki
-RM-Costs Cluster UXPROD-2255
Folio Attribute | Folio Data Element Description | Notes |
|---|---|---|
| From internal table mod_agreements.subscription_agreement: | ||
| sa_id | UUID of Agreement | |
| sa_name | A name for the agreement assigned by the institution | |
| sa_description | A description for the agreement assigned by the institution | |
| sa_agreement_status | ID of reference data value (mod_agreements.refdata_value.rdv_id) which describes the current status of the agreement (e.g. Active, Closed) | |
| sa_reason_for_closure | ID of reference data value (mod_agreements.refdata_value.rdv_id) which describes for a closed agreement, the reason the agreement has been closed (a closed agreement is one with status == "Closed" - set via sa_agreement_status) | |
| sa_renewal_priority | ID of reference data value (mod_agreements.refdata_value.rdv_id) which describes whether an agreement should be renewed, reviewed or cancelled | |
| sa_is_perpetual | ID of reference data value (mod_agreements.refdata_value.rdv_id) which describes whether the agreement is a perpetual agreement or not | |
| sa_local_reference | Where an agreement has been created through an integration / data import from an external system the sa_local_reference is used to store a reference/identifier for the agreement in the external system to support ongoing data synchronisation/updates | |
| sa_license_note | To record any general information about the license for the Agreement | |
| custom_properties_id | ID used to link custom_properties (aka supplementary properties) via mod_agreements.custom_properties.parent_id to an agreement. (n.b. each agreement can have zero to many custom_properties) | |
| From internal table mod_agreements.entitlement: | Each entitlement is linked to one and only one agreement Each agreement can be linked to zero to many entitlements Each entitlement must to linked to only one resource | |
| ent_id | UUID of Entitlement (aka Agreement Line) | |
| ent_owner_fk | ID of Agreement (mod_agreements.subscription_agreement.sa_id) to which the entitlement belongs | |
| ent_resource_fk | ID of the resource (mod_agreements.erm_resource.id, mod_agreements.package.id, mod_agreements.package_content_item.id ) which the Entitlement gives access to | |
| ent_active_from | Date from which the entitlement was active in format yyyy-MM-dd. No time or timezone | |
| ent_active_to | Date to which the entitlement was active in format yyyy-MM-dd. No time or timezone | |
| ent_authority | Where an entitlement gives access to a resource described in a source other than the mod_agreements internal knowledgebase, the ent_authority is a way of identifying where the definition of the resource is held | Where eHoldings is being used as the source of entitlement/agreement line resources, the value of ent_authority will be one of: EKB-TITLE EKB-PACKAGE |
| ent_reference | Where an entitlement gives access to a resource described in a source other than the mod_agreements internal knowledgebase, the ent_reference is the ID for the resource in the source identified by ent_authority | Where eHoldings is being used as the source of entitlement/agreement line resources, the ent_reference will be an identifier created from two or 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)
|
| ent_note | A textual note about the entitlement | |
| From internal table mod_agreements.order_line: | Links entitlements to purchase order lines in the Orders app. Each entitlement can be linked to zero to many purchase order lines. Each purchase borderline can be linked to zero to many entitlements | |
| pol_id | UUID of order_line record | |
| pol_orders_fk | ID of purchase order line in Orders app | |
| pol_owner_fk | ID of entitlement (mod_agreements.entitlement.ent_id) to which purchase order line is linked | |
| From internal table mod_agreements.erm_resource: | erm_resource is one facet of resources that can be linked to entitlements Each erm_resource can be linked to zero to many entitlements | |
| id | ID of erm_resource | |
| res_name | Name of the resource (can be name of a package or other resource type or the title of a published work such as a book or journal) | |
| res_type_fk | ID of reference data value for the type of resource. | Common values include "serial", "monograph", "book", "journal". |
| res_subtype_fk | ID of reference data value for the subtype of resource | Common values include "electronic" or "print". |
| From internal table mod_agreements.package: | A package represents a group of content Every package is an erm_resource. Each package contains zero or more package_content_items | |
| id | ID of package | The ID of the package will appear in the erm_resource table for the erm_resource record associated with the package |
| pkg_vendor_id | ID of the package provider organisation (in mod_agreements.orgs) | Despite the column name, this is for the provider of the package NOT the vendor of the package |
| pkg_source | String describing the source of the package data | |
| pkg_remote_kb | ID of the remote knowledgebase from which the package data was obtained (in mod_agreements.remotekb) | |
| pkg_reference | ID or reference for the package in an external system | |
| From internal table mod_agreements.package_content_item: | A package_content_item represents a particular resource (book or journal title) accessible via a particular online platform sold or made available as part of a particular package Every package_content_item is an erm_resource. Each package_content_item belongs to exactly one package Each package_content_item is linked to exactly one platform_title_instance | |
| id | ID of the package content item | The ID of the package_content_item will appear in the erm_resource table for the erm_resource record associated with the package_content_item |
| pci_pti_fk | ID of the platform_title_instance that the package_content_item is linked to | |
| pci_pkg_fk | ID of the package that the package_content_item belongs to | |
| pci_access_start | The date on which a package_content_item was first accessible in a package | If `null` then it is assumed that the package_content_item was accessible in the package at the earliest possible data |
| pci_access_end | The date on which a package_content_item was last accessible in a package | If `null` then it is assumed that the package_content_item is still accessible in the package at the current date |
| From internal table mod_agreements.platform_title_instance: | A platform_title_instance represents a particular resource (book or journal title) accessible via a particular online platform. Every platform_title_instance is an erm_resource. Each platform_title_instance belongs to exactly one platform Each platform_title_instance is linked to exactly one title_instance Each platform_title_instance is linked to zero or more package_content_items | |
| id | ID of the platform_title_instance | The ID of the platform_title_instance will appear in the erm_resource table for the erm_resource record associated with the platform_title_instance |
| pti_pt_fk | The ID of the platform that the platform_title_instance belongs to | |
| pti_ti_fk | The ID of the title_instance to which the platform_title_instance is linked | |
| pti_url | The URL of the platform_title_instance | This is the URL where the relevant resource content can be accessed |
| From internal table mod_agreements.platform: | A platform (in Agreements) is where a resource can be accessed online. An example might be “Highwire”. Each platform_title_instance belongs to a platform | |
pt_id | UUID of Platform | |
pt_name | Name/label of the platform | |
| From internal table mod_agreements.title_instance: | A title_instance represents a resource (e.g. book or journal title) Every title_instance is an erm_resource | |
id | ID of the title_instance | The ID of the title_instance will appear in the erm_resource table for the erm_resource record associated with the title_instance |
ti_work_fk | The ID of the work to which the title_instance is linked | |
ti_date_monograph_published | For monographs (books), the date the monograph was first published in the media specified by the linked erm_resource subtype (typically “print” or “electronic”) | Equivalent to the KBART Phase II (NISO RP-9-2014) properties date_monograph_published_print and date_monograph_published_online (see https://groups.niso.org/apps/group_public/download.php/16900/RP-9-2014_KBART.pdf) |
ti_first_author | For monographs (books), the last name of the book’s first author. | Equivalent to the KBART Phase II (NISO RP-9-2014) properties first_author (see https://groups.niso.org/apps/group_public/download.php/16900/RP-9-2014_KBART.pdf) |
ti_monograph_edition | For monographs (books), the last name of the book’s first author. | Equivalent to the KBART Phase II (NISO RP-9-2014) properties monograph_edition (see https://groups.niso.org/apps/group_public/download.php/16900/RP-9-2014_KBART.pdf) |
ti_monograph_volume | For monographs (books), the volume number of the book | Equivalent to the KBART Phase II (NISO RP-9-2014) properties monograph_volume (see https://groups.niso.org/apps/group_public/download.php/16900/RP-9-2014_KBART.pdf) |
ti_first_editor | For monographs (books), the last name of the book’s first editor. | Equivalent to the KBART Phase II (NISO RP-9-2014) properties first_editor (see https://groups.niso.org/apps/group_public/download.php/16900/RP-9-2014_KBART.pdf) |
| From internal table mod_agreements.work: | A work is broadly equivalent to a BIBFRAME ‘work’ which is “the conceptual essence of the cataloged resource”. See https://www.loc.gov/bibframe/docs/bibframe2-model.html | |
w_id | UUID of Work | |
w_title | Title of the work | |
| From internal table mod_agreements.identifier_occurrence: | identifier_occurrence allows title_instances to be linked to identifiers | |
io_id | UUID of identifier occurrence | |
io_ti_fk | ID of title_instance which is linked to the identifier | |
io_status | ID of reference data value (mod_agreements.refdata_value.rdv_id) which describes the status of the identifier occurrence | In the current implementation this is always “approved” and not used for any functionality |
io_identifier_fk | ID of the identifier which is ‘occurring’ against a title_instance | |
| From internal table mod_agreements.identifier: | Each identifier has an identifier_namespace. Identifier values should be unique within a namespace | |
id_id | UUID of identifier | |
id_ns_fk | ID of identifier namespace | |
id_value | Value of the identifier (i.e. the identifier string) | |
| From internal table mod_agreements.identifier_namespace: | Each identifier has an identifier_namespace. Identifier values should be unique within a namespace | |
idns_id | UUID of identifier_namespace | |
idns_value | Value of the namespace (i.e. the namespace name as a string) | e.g. ISSN |
| From internal table mod_agreements.coverage_statement: | coverage_statements are used to indicate what parts of a serial published work are available via an erm_resource | |
cs_id | UUID for coverage_statement | |
cs_start_issue | Earliest issue of the resource available as part of this coverage | |
cs_end_issue | Latest issue of the resource available as part of this coverage | |
cs_start_volume | Earliest volume of the resource available as part of this coverage | |
cs_end_volume | Latest volume of the resource available as part of this coverage | |
cs_resource_fk | ||
cs_start_date | Earliest date of publication of material from the resource available as part of this coverage | Note that this is the publication |
cs_end_date | Latest date of publication of material from resource available as part of this coverage |
Plus the data from the RM-Costs Cluster Prototype