Questions
-is there an example of this report somewhere?
(Link to REPORT EXAMPLE)
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 ...
- Have I already paid for serial/journal x?
- Output:
- How much did serial/journal x cost me in YYYY?
- Output:
- How much did I pay for my agreements?
- Output:
- 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 (Module/Path:Object) | Folio Data Element Description | Parameters/Query |
|---|---|---|
| Table Name: 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/rcustom_properties.parent_id to an agreement. (n.b. each agreement can have zero to many custom_properties) | |
| Table Name: mod-agreements/entitlement | ||
| Table Name: mod-agreements/order_line | ||
| Table Name: mod-agreements/erm_resource | ||
Plus the data from the RM-Costs Cluster Prototype