ERM-Agreements Cost Statistics Cluster Prototype

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 Cost Statistics 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
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
How much did I pay for my agreements?
- 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
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:		Every package is an erm_resource
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
pkg_reference
From internal table mod_agreements.package_content_item:

From internal table mod_agreements.platform_title_instance:

From internal table mod_agreements.platform:

From internal table mod_agreements.title_instance:

From internal table mod_agreements.work:

From internal table mod_agreements.identifier_occurrence:

From internal table mod_agreements.identifier:

Plus the data from the RM-Costs Cluster Prototype