Reference Data
Reference data covers the following domains:
Accounts & their hierarchies
Collections, Databases, Contents & Articles
Platforms & Applications
Publishers
Display Formats
Accounts
Please provide account information with following details. 2 first fields are required for Counter app, Geographical & classification for Publisher app, others for Reporting app.
Accounts are unique across applications. Data providers have to handle this constraint & build a in case it is not the case on their side.
Column Name | Description | Format | Comment / Possible values |
|---|---|---|---|
Account Id | Unique identifier | VARCHAR | |
Account Name | Account name | VARCHAR | |
Ringgold ID | Account's Ringgold identifier | VARCHAR | |
Consortium flag | Is the account a consortium | BOOLEAN | |
Region/State Id | Geographical region or state of the account | VARCHAR | |
Country ID | Geographical country of the account | CHAR | ISO 3166-1 2 letters code (ex US) |
Account Classification | Account classification label given by the provider | VARCHAR | Optional, for usage reporting |
Important
You must send the proper geographical ids in accounts data, please download the standard list: inqwell_reference_data.sql
Accounts Hierarchy
It is a simple pair of accounts table. A child can have multiple parents.
With a daily feed in place, Inqwell computes start & end dates for hierarchy paths so they get involved in hierarchical reporting / 0 usage if valid for the required period
Column | Description | Format |
|---|---|---|
Child Account Id | Unique identifier of a child account | VARCHAR |
Parent Account Id | Unique identifier of one of his parent | VARCHAR |
Articles
Please provide article information with following details:
Column | Description | Format |
|---|---|---|
Application Id | Unique identifier of the application hosting the article | VARCHAR |
Article Id | Unique identifier of an article | VARCHAR |
Article Name | Article name | VARCHAR |
DOI | DOI if known | VARCHAR |
Online ISSN | Online ISSN if known | VARCHAR |
Print ISSN | Print ISSN if known | VARCHAR |
Online ISBN | Online ISBN if known | VARCHAR |
Print ISBN | Online ISBN if known | VARCHAR |
Volume | Volume number | INTEGER |
Issue | Issue number | VARCHAR |
Issue Date | Issue date of this article | DATE |
Author | Author(s) names, required for Publisher app | VARCHAR |
Contents
Please provide content information with following details:
Column | Description | Format |
|---|---|---|
Application Id | Unique identifier of the application hosting the article | VARCHAR |
Content Id | Unique identifier of a journal/book | VARCHAR |
Content Name | Journal/Book name | VARCHAR |
Content Type | Type of content
| VARCHAR |
DOI | DOI if known | VARCHAR |
Online ISSN | Online ISSN if known | VARCHAR |
Print ISSN | Print ISSN if known | VARCHAR |
Online ISBN | Online ISBN if known | VARCHAR |
Print ISBN | Online ISBN if known | VARCHAR |
Proprietary Identifier | Unique identifier given by the provider | VARCHAR |
Publisher ID | Publisher unique identifier, required for Counter & Publisher apps | VARCHAR |
Content Subject | Content subject (classification), for reporting drill down | VARCHAR |
Archive Date | Date of archiving (JR1a) | DATE |
Databases
Database dimension is used for Database reports in Counter. Please provide content information with following details:
Column | Description | Format |
|---|---|---|
Application Id | Unique identifier of the application hosting the article | VARCHAR |
Database Id | Unique identifier | VARCHAR |
Database Name | Name of the database | VARCHAR |
Publisher ID | Publisher of the database, usually the provider itself | VARCHAR |
Database Family | Optional database family (for usage drill down purpose only) | VARCHAR |
Collections
Collection dimension is used for Collections reports (JR4 for example) in Counter
Column | Description | Format |
|---|---|---|
Application Id | Unique identifier of the application hosting the article | VARCHAR |
Collection Id | Unique identifier of a collection | VARCHAR |
Collection name | Name of the collection given by the provider | VARCHAR |
Publishers
This table contains publishers at content level and database level. Please provide content information with following details:
Column | Description | Format |
|---|---|---|
Application Id | Unique identifier of the application hosting the article | VARCHAR |
Publisher Id | Unique identifier of a publisher | VARCHAR |
Publisher name | Name of the publisher given by the provider | VARCHAR |
Applications
A provider can serve content through various applications. This table lists the applications available.
The 2 usages of this data are:
Usage drill down
Multi-reference content, when same reference data has multiple identifier across applications.
If the provider sends multiple applications, he has to provide every content at application level, even if it means to duplicate rows (articles, content, database, collections, publishers)
Column | Description | Format |
|---|---|---|
Application Id | Unique identifier of an application serving content | VARCHAR |
Application Name | Name of the application | VARCHAR |
Platforms
This table contains the platform information. There is one row for a provider. This row is created by SquidSolutions. The provider doesn't have to deliver a feed for it. It will feed the column "Platform" in Counter reports
Column | Description | Format |
|---|---|---|
Platform Id | Unique identifier of a platform | VARCHAR |
Platform Name | Name of the platform | VARCHAR |
Formats
This table contains formats definition, including the debouncing period & flags to determine on which reports they are taken in account or not. There is no daily feed put in place. In case you need a new format, please contact SquidSolutions to get an updated list.
Please download the standard list of formats that comes by default: inqwell_reference_data.sql
Column | Description | Format |
|---|---|---|
Format ID | Unique identifier of a child account | VARCHAR |
Format Name | Unique identifier a parent of this account | VARCHAR |
Debouncing period | Window period (in seconds) used to debounce duplicate events (10s for HTML displays, 30s for PDF downloads) | INTEGER |
JR flag | When true, format is counted for Journal reports (content type must be Journal) | BOOLEAN |
BR flag | When true, format is counted for Book reports (content type must be also Book or Book Chapter) | BOOLEAN |
Multimedia flag | When true, format is counted for Multimedia report | BOOLEAN |
DR flag | When true, format is counted for Database reports | BOOLEAN |
Item flag | When true, format is counted for JR3 report | BOOLEAN |