ERM-Agreements Costs Cluster Prototype

Table name: erm_agreements_subscription_agreement

agreement ID
(mod_agreements/subscription_agreement:

sa_id)

UUID of Agreement

agreement Name
(mod_agreements/subscription_agreement:sa_name)

A name for the agreement assigned by the institution

agreement Description
(mod_agreements/subscription_agreement:sa_description)

A description for the agreement assigned by the institution

reference data ID of status
(mod_agreements/subscription_agreement: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)

reference data ID of reason of closure
(mod_agreements/subscription_agreement: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)

reference data ID of renewal priority 
(mod_agreements/subscription_agreement: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

reference data ID of "is perpetual"(mod_agreements/subscription_agreement: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

identifier of local reference
(mod_agreements/subscription_agreement: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

license notes of agreement
(mod_agreements/subscription_agreement:sa_license_note)

To record any general information about the license for the Agreement

ID to custom properties
(mod_agreements/subscription_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)

Table name: erm_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

entitlement ID
(mod_agreements/entitlement:ent_id)

UUID of Entitlement (aka Agreement Line)

associated agreement ID
(mod_agreements/entitlement:ent_owner_fk)

ID of Agreement (mod_agreements.subscription_agreement.sa_id) to which the entitlement belongs

associated resource ID
(mod_agreements/entitlement: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

active from date
(mod_agreements/entitlement:ent_active_from)

Date from which the entitlement was active in format yyyy-MM-dd. No time or timezone

active to date
(mod_agreements/entitlement:ent_active_to)

Date to which the entitlement was active in format yyyy-MM-dd. No time or timezone

authority
(mod_agreements/entitlement: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

reference ID of resource
(mod_agreements/entitlement: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)

• the identifier for the resource "Academic ASAP from Gale Cenage" is 18-34 (this would have an ent_authority of EKB-PACKAGE)

• the identifier for the resource "Harvard Business Review in the Academic ASAP package from Gale Cengage" is 18-34-32090  (this would have an ent_authority of EKB-TITLE)

note
(mod_agreements/entitlement:ent_note)

A textual note about the entitlement

Table name: erm_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

record ID
(mod_agreements/order_line:pol_id)

UUID of order_line record

po-line ID
(mod_agreements/order_line:pol_orders_fk)

ID of purchase order line in Orders app

entitlement ID
(mod_agreements/order_line:pol_owner_fk)

ID of entitlement (mod_agreements.entitlement.ent_id) to which purchase order line is linked

Table name: erm_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

ERM resource ID
(mod_agreements/erm_resource:id)

ID of erm_resource

resource name
(mod_agreements/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)

type ID
(mod_agreements/erm_resource:res_type_fk)

ID of reference data value (mod_agreements.refdata_value.rdv_id) for the type of resource. 

Common values include "serial", "monograph", "book", "journal".

subtype ID
(mod_agreements/erm_resource:res_subtype_fk)

ID of reference data value (mod_agreements.refdata_value.rdv_id) for the subtype of resource

Common values include "electronic" or "print".

Table name: erm_agreements_package

A package represents a group of content

Every package is an erm_resource.

Each package contains zero or more package_content_items

package ID
(mod_agreements/package: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

provider of package ID
(mod_agreements/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

source of package
(mod_agreements/package:pkg_source)

String describing the source of the package data

remote kb ID
(mod_agreements/package:pkg_remote_kb)

ID of the remote knowledgebase from which the package data was obtained (in mod_agreements.remotekb)

reference to external system
(mod_agreements/package:pkg_reference)

ID or reference for the package in an external system

Table name: erm_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

record ID
(mod_agreements/package_content_item: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

platform title instance ID
(mod_agreements/package_content_item:pci_pti_fk)

ID of the platform_title_instance that the package_content_item is linked to

package ID
(mod_agreements/package_content_item:pci_pkg_fk)

ID of the package that the package_content_item belongs to

access start date
(mod_agreements/package_content_item: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

access end date
(mod_agreements/mod_agreements/package_content_item: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

Table name: erm_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

platform title instance ID
(mod_agreements/platform_title_instance: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

associated platform ID
(mod_agreements/platform_title_instance:pti_pt_fk)

The ID of the platform that the platform_title_instance belongs to

associated title instance ID
(mod_agreements/platform_title_instance:pti_ti_fk)

The ID of the title_instance to which the platform_title_instance is linked

URL (mod_agreements/platform_title_instance:pti_url)

The URL of the platform_title_instance

This is the URL where the relevant resource content can be accessed

Table name: erm_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

platform ID
(mod_agreements/platform:pt_id)

UUID of Platform

platform name
(mod_agreements/platform:pt_name)

Name/label of the platform

Table name: erm_agreements_title_instance

A title_instance represents a resource (e.g. book or journal title) Every title_instance is an erm_resource
Each title_instance is linked to a work. Multiple title_instance records can link to a single work

title instance ID
(mod_agreements/title_instance: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

associated work ID
(mod_agreements/title_instance:ti_work_fk)

The ID of the work to which the title_instance is linked

monograph published date
(mod_agreements/title_instance: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)

last name of first author if mono
(mod_agreements/title_instance: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)

edition if mono
(mod_agreements/title_instance:ti_monograph_edition)

For monographs (books), edition of the book.

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)

volume if mono
(mod_agreements/title_instance: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)

last name of first editor if mono
(mod_agreements/title_instance:ti_first_editor)

For monographs (books), the last name of the book’s first editor.