Columns
On this page
Required columns
The following columns are required for all OpenRefine Projects. If one of these columns is not present, you should receive an error message in OpenRefine that will prevent you from ingesting the package unless it is resolved.
| Column name | Validation | Default value if left bank | Notes |
|---|---|---|---|
PublicationTitle | All rows must have a string value in the PublicationTitle column |
| This is the title of the publication. It is most likely that your data will already contain this information and you can rename an existing column. |
title.identifier.issn | Must be a valid ISSN conforming to the format ‘XXXX-XXXX’ where X represents a digit, or solely in the case of the last position, an uppercase X |
| --This is the ISSN of the publication. Duplicate ISSNs in your file will generate a warning message in OpenRefine. Resolve these issues before ingesting the data into GOKb because duplicate ISSNs will cause titles to merge during ingest. --You will also receive an error message in OpenRefine if your ISSNs are improperly formatted. You can use the macros described here to fix them. |
title.identifier.eissn | Must be a valid ISSN conforming to the format ‘XXXX-XXXX’ where X represents a digit, or solely in the case of the last position, an uppercase X |
| This is the eISSN of the publication. EISSNs are treated the same way as ISSNs. |
tipp.url | Must be a valid URI |
| This is the URL used to access the title. For example: http://link.springer.com/2092-6731. If you get an error message about improperly formatted URLs, look for missing punctuation and spaces – those are the most common errors. |
platform.host.name | Must match an existing platform name in GOKb. If the platform does not yet exist in GOKb it must be added via the CRED (web UI) |
| This is the name of the platform where the title list is hosted, which may or may not contain the name of the content provider. For example, Elsevier's platform is called ScienceDirect. If the appropriate platform doesn't exist in GOKb, please consult the editor to find out if it should be added.
|
| package.name | Must match an existing package name in GOKb. If the package does not yet exist in GOKb it can be added by clicking the 'Create New' option in the GOKb lookup window | This is the name of the package or packages being loaded. You can create packages on the fly using the OpenRefine package look up tool. Please consult the package and naming conventions page for more details on how to determine a package name. | |
org.publisher.name | Must match an existing Org name in GOKb. Orgs cannot be created ‘on the fly’ when a Refine project is ingested. All the Orgs within the project must already exist in GOKb before the project can be ingested successfully. |
| The is the organization responsible for producing the content in a journal. The publisher should be the top-level entity responsible for a title. For example, if Elsevier publishers a title as part of its Academic Press imprint, the publisher should still be Elsevier. A separate field can be used to capture imprints. If the organization you need doesn't exist in GOKb, contact the editor to have it added. |
Optional columns
Optional columns are recognized by GOKb but are not required for ingest. If you are working with data that lacks some of these fields, you do not necessarily need to add them. You may choose to do so under certain circumstances, described in more detail here.
| Column name | Validation | Default value if left blank | Notes |
|---|---|---|---|
DateFirstPackageIssue | Must be formatted as a Refine ‘date’. By implication this means it must be specific to a day (e.g. 1st January 2013) |
| The publication date of the first/earliest issue for a journal publication within the package. The easiest way to fix this is by using the quick resolution option to attempt automatic conversion. If you have messier or more complicated dates, you can consult the dates page for more information. |
VolumeFirstPackageIssue | None |
| The volume number of the first/earliest issue for a journal publication within the package |
NumberFirstPackageIssue | None |
| The issue number of the first/earliest issue for a journal publication within the package |
DateLastPackageIssue | Must be formatted as a Refine ‘date’. By implication this means it must be specific to a day (e.g. 31st December 2013) |
| The publication date of the last/latest issue for a journal publication within the package. If all of DateLastPackageIssue, VolumeLastPackageIssue and NumberLastPackageIssue are blank, it is assumed that the package includes ‘up to the current issue’ You can use a quick fix transformation to change an end date to the correct format, with the day set as the last day of the month. |
VolumeLastPackageIssue | None |
| The Volume number (or other designation) of the last/latest issue for a journal publication within the package. If all of DateLastPackageIssue, VolumeLastPackageIssue and NumberLastPackageIssue are blank, it is assumed that the package includes ‘up to the current issue’ |
NumberLastPackageIssue | None |
| The issue number (or other designation) of the last/latest issue for a journal publication within the package. If all of DateLastPackageIssue, VolumeLastPackageIssue and NumberLastPackageIssue are blank, it is assumed that the package includes ‘up to the current issue’ |
CoverageDepth | Must follow the KBART guidelines for Coverage Depth given at http://www.uksg.org/kbart/s5/guidelines/data_fields#coverage_depth This means the only valid values in this column are ‘fulltext’, ‘selected articles’ or ‘abstracts’ | “fulltext” | Coverage Depth as defined by KBART Guidelines. If this column is missing, you don't need to add it manually unless you believe your data contains non-fulltext resources. |
CoverageNotes | None |
| Should follow the KBART guidelines for Coverage Notes given at http://www.uksg.org/kbart/s5/guidelines/data_fields#coverage_notes. However, it should be noted that many ‘KBART files’ use the Coverage Notes field for more general ‘notes’, especially related to title changes, and GOKb will not prevent this. |
KBARTEmbargo | Must follow the the KBART guidelines for Embargo Information given at http://www.uksg.org/kbart/s5/guidelines/data_fields#embargo |
| Embargo period as defined by KBART Guidelines |
PrimaryTIPP | If populated must be one of Yes or No. | “No” | A TIPP is considered the ‘Primary TIPP’ for a Title if it represents the main online presence for the journal. |
TIPPStatus | If populated must be one of ‘Current’, ‘Retired’, ‘Expected’ | “Current” | If your data contains forthcoming titles, you can give them a status of "Expected." See Dealing with Expected TIPPs in OpenRefine for more information on how to use this column. |
TIPPPayment | If populated must be one of: Complimentary, Limited Promotion, Paid, Opt-out Promotion, Uncharged, Unknown | “Paid” | Specifies whether the TIPP is being offered under some special payment option. For example if the title is being offered for free despite being part of a paid package, this can be recorded here. This is a deceptively complex field! |
Custom columns
Custom columns allow you to add information to GOKb is that is not recognized by any of the standard fields. Custom identifier information will be exposed through the GOKB API and co-referencing service. Other custom fields will be stored as free-text.
| Column name | Validation | Default value if left blank | Notes |
|---|---|---|---|
title.identifier.{identifier namespace} | Specific identifier namespaces may have specific validation rules (e.g. ISBN) |
| Any number of identifiers for a title can be added to the file using this format. The ‘identifier namespace’ is the type of identifier which is included in the column. For example a column headed “title.identifier.doi” for a column containing DOIs for the publications listed. For publisher proprietary identifiers, use the format "title.identifier.{publishername} |
gokb.{ti || tipp}.{fieldname} | None |
| Allows the addition of user define fields attached to either the TI or the TIPP. For example if you include a column named: gokb.ti.note1 This would add a 'note1' field to the TI described in the row. Equivalently: gokb.tipp.note1 would add a 'note1' field to the TIPP described in the row There is no limit to the number of such columns and a TI or TIPP can have multiple custom fields. |
Commonly used custom columns
| Column name | Validation | Default value if blank | Notes |
|---|---|---|---|
| title.identifier.{authorizedprovidername} | None | If a provider includes a proprietary ID in it's title list, you can create a namespace using a custom column. It's important that all projects use the namespace for a provider's IDs. To ensure consistency, use this format, where the authorizedprovidername equals the name on the provider's organization record in GOKb. It's also important to check that IDs using this name space are used across all offerings by that provider. If an ID is used only within a single package, you'll need to create it as a custom field on the TIPP. | |
| title.identifier.doi | None | If a provider includes DOIs, use this field to import them to the DOI namespace. Note that some providers may use DOIs in the title_id field of a KBART file. | |
| gokb.ti.{Provider}PrecedingPublicationID | None | KBART phase II includes a field for preceding publication ID, and some providers have begun to include this information. | |
| gokb.ti.TitleHistoryNote | None | Some providers include a text note with title history information. |
Operated as a Community Resource by the Open Library Foundation