Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Questions

...

  • 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 134135, expenses)

    • Output: Amount

Data Attributes

  • (high-level list of data fields)
  • Data Attributes will come from the following application areas: Orders, Invoices, and Agreements

...

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/

...

Contains personal data. This field may be omitted in cases when GDPR-compliance is required.

Folio Attribute (Module/Path:Object)

Folio Data Element Description

Parameters/Query

Table Name: mod-agreements/subscription_agreement







Table Name: mod-agreements/entitlement







Table Name: mod-agreements/order_line







Table Name: mod-agreements/erm_resourceTable Name: mod-finance-storage/invoice_line_numberInvoice Line Number ID (mod-invoice-storage/invoice_line_number:id)UUID of the invoice line number
Total (mod-invoice-storage/invoice_line_number:total)invoice line number total with adjustmentsThis total includes expenditures with adjustments.
Subtotal (mod-invoice-storage/invoice_line_number:subtotal)invoice line number subtotal without adjustmentsThis total includes expenditures without adjustments.
Fund Distributions (mod-invoice-storage/invoice_line_number:fundDistributions)shows the distribution of expenditures by fundWhen you connect to Fund Distributions from the invoice line number table, it will show a row for each fund charged, so the resulting rows will need to be grouped by fund. This will vary depending on whether you want to report by Fund (total) or by PO Line Number (item). 
PO Line ID (mod-invoice-storage/invoice_line_number:poLineID)ID of the purchase order lineProvides a join between the mod-finance-storage/invoice_line_number table and mod-orders-storage/po_lines table.
Adjustments (mod-invoice-storage/invoice_line_number:adjustments)invoice line number adjustmentsOften prorated charges (e.g., service charges, shipping, taxes, etc.) and some non-prorated charges are under adjustments on the invoice line number table
Adjustments Total (mod-invoice-storage/invoice_line_number:adjustments_total)total of invoice line number adjustmentsTable Name: mod-finance-storage/invoices
Invoice ID (mod-invoice-storage/invoices:id)UUID of the invoice.

Provides a join between the mod-orders-storage/invoices table and the mod-finance-storage/invoice_line_number table. 

Invoice Paid Date (mod-invoice-storage/invoices:paidDate)Date the invoice was paid.placeholder for the invoice paid date data attribute; this will be used to set the time period being reported. Often, we show fiscal year as the time period (e.g., 7/1/XX through 6/30/XX)
Invoice Status (mod-invoice-storage/invoices:status)Status of the invoice (e.g., paid, approved,etc.)This report needs to show the status as paid.
Table Name: mod-orders-storage/orders
Order ID (mod-orders-storage/orders:id)UUID for a specific orderProvides join between the mod-orders-storage/orders table and the mod-orders-storage/order_lines table.
Acquisition Unit ID (mod-orders-storage/orders:acqUnitIdsThe ID of acquisition unit. Optional. Use this attribute only if you need to show the acquisition unit involved.
Order Type  (mod-orders-storage/orders:order_type)Provides the category for the order type ( One-Time or Ongoing)Will be needed to get "One-time" (firm order) or" Ongoing" (continuation, subscription) expenditures. Show a sum of all expenditures for each order type. Filter by order type.
Approval Date (mod-orders-storage/orders:approvalDate)Date the order was approved.Optional. Used for reporting based on the date the order was made. 
Table name: mod-orders-storage/order_linesOrder Lines ID (mod-orders-storage/order_lines:id)The ID of the order line.Acquisition Method (mod-orders-storage/order_lines:acquisitionMethod)The acquisition method of the order, e.g. firm order, approval, subscriptions, etc.Order Format (mod-orders-storage/order_lines:orderFormat)The format of the material being ordered, e.g., physical, electronic, or mixed.PO Line Number (mod-orders-storage/order_lines:poLineNumber)The line number on the purchase order.Instance ID (mod-orders-storage/order_lines:instanceID)The ID for the instance (bibliographic record ID).Agreement ID (mod-orders-storage/order_lines:agreementID)The ID of the agreement pertaining to this order line.PO ID (mod-orders-storage/order_lines:purchaseOrderID)The ID of the purchase order for this purchase order line.Table name: mod-orders-storage/po_lines
PO lines ID: (mod-orders-storage/po_lines:id)The UUID of a PO LineProvides a join between the mod-order-storage/po_lines table and the mod-orders-storage/orders table. 
PO lines Order Format name: (mod-orders-storage/po-lines/order-format:name)Provides the format of the item purchasedWill provide in the report the format name of the order. (Electronic Resource, Physical Resource, P/E Mix,Other).
Reporting Codes: (mod-orders-storage/po_lines:reporting codes)Tags: (mod-orders-storage/po_lines:tags)Acquisition Method: (mod-orders-storage/po_lines:acquisitionMethod)
Description: (mod-orders-storage/po_lines:description)The title of the resource being ordered.May not be needed. 
Details (Subscription): (mod-orders-storage/po_lines:details)What is the definition of this data attribute?
Electronic Resource ID (mod-orders-storage/po_lines:eresource)UUID of the electronic resource (details) record.Indicates that the item being order is an electronic resource.
Physical ID (mod-orders-storage/po_lines:physical)UUID of the physical (details) record.Indicates that the item being order is a physical resource.
Requester (mod-orders-storage/po_lines:requester)The person who requested the order.Contains personal data. This field may be omitted in cases when GDPR-compliance is required.
Selector (mod-orders-storage/po_lines:selector)The person who is authorized to submit the order.








Plus the data from the RM-Costs Cluster Prototype