Uploading IGSN Registration Data

To register IGSN metadata in Kiel University’s IGSN service, you can upload data in various formats such as JSON or CSV. This document provides instructions on how to upload IGSN registration data using the supported file formats.

Uploading the File

  1. Locate the file upload section or the dropzone provided for uploading data.

  2. Drag and drop the JSON, CSV, or TSV file into the dropzone or click on the upload area to browse and select the file from your local system.

  3. After the upload process is complete, the system will process the data and perform validation checks on the uploaded file.

  4. You can now proceed with any further actions or operations you may need to perform on the IGSN metadata.

Note

It’s important to follow the specific file format requirements and ensure the data is correctly structured to avoid validation errors. Refer to the provided examples for further guidance on the required format.

File Formats

JSON

You can upload JSON files containing IGSN metadata following the metadata schema. The JSON file should represent either a single IGSN metadata object or an array of multiple IGSN metadata objects.

Example

Example of a minimal JSON file with a single IGSN metadata object with minimal information (cf. example_minimal.json).

{
  "creators":[
    {
      "name":"Musterfrau, Erika",
      "nameType":"Personal",
      "givenName":"Erika",
      "familyName":"Musterfrau"
    }
  ],
  "titles":[
    {
      "title":"My Sample Title"
    }
  ],
  "publicationYear":"2024"
}
  • In cases where an IGSN ID is not provided, a random ID will be generated.

  • Additionally, if the URL is not set, a fallback URL will be generated.

  • If no event is specified, the IGSN will be registered with state “Draft”.

Example

Example of a simple JSON file with a single IGSN metadata object (cf. example_simple.json):

{
  "event": "publish",
  "doi":"10.82421/example01",
  "url":"https://example.com",
  "creators":[
    {
      "name":"Musterfrau, Erika",
      "nameType":"Personal",
      "givenName":"Erika",
      "familyName":"Musterfrau"
    }
  ],
  "titles":[
    {
      "title":"My Sample Title"
    }
  ],
  "publicationYear":"2024"
}
  • The DOI and URL have been explicitly provided.

  • The event property has been explicitly specified. It can have one of the following values: publish, register, or hide. For additional details please refer to the official documentation.

Example

Example of a complex JSON file with a single IGSN metadata object (cf. example_complex.json):

{
  "event":"publish",
  "doi":"10.82421/EXAMPLE0000000",
  "url":"https://example.com",
  "creators":[
    {
      "name":"Mustermann, Erika",
      "nameType":"Personal",
      "givenName":"Erika",
      "familyName":"Mustermann",
      "nameIdentifiers":[
        {
          "nameIdentifier":"https://orcid.org/0000-0000-0000-0000",
          "nameIdentifierScheme":"ORCID",
          "schemeURI":"https://orcid.org/"
        }
      ]
    }
  ],
  "titles":[
    {
      "title":"Sample Title"
    }
  ],
  "publicationYear":"2024",
  "subjects":[
    {
      "subject":"Subject Example"
    }
  ],
  "contributors":[
    {
      "name":"Mustermann, Max",
      "nameType":"Personal",
      "givenName":"Max",
      "familyName":"Mustermann",
      "contributorType":"ContactPerson",
      "nameIdentifiers":[
        {
          "nameIdentifier":"https://orcid.org/0000-0000-0000-0001",
          "nameIdentifierScheme":"ORCID",
          "schemeURI":"https://orcid.org/"
        }
      ]
    },
    {
      "name":"Example Institution",
      "nameType":"Organizational",
      "contributorType":"Distributor"
    }
  ],
  "dates":[
    {
      "date":"2021-07-22",
      "dateType":"Collected"
    },
    {
      "date":"2021-07-29",
      "dateType":"Issued"
    }
  ],
  "relatedIdentifiers":[
    {
      "relatedIdentifier":"https://www.example.com",
      "relatedIdentifierType":"URL",
      "relationType":"IsDocumentedBy"
    }
  ],
  "descriptions":[
    {
      "description":"Short Description",
      "descriptionType":"Other"
    }
  ],
  "geoLocations":[
    {
      "geoLocationPoint":{
        "pointLatitude":45,
        "pointLongitude":53.23
      }
    }
  ]
}

CSV

You can also upload CSV files containing IGSN metadata. The file should follow a specific format, with each column representing a different field of the IGSN metadata.

Example

Example of a minimal CSV file (cf. example_minimal.csv):

"Creator","Title","Publication year"
"Musterfrau, Erika","My Sample Title",2024

Example

Example of a simple CSV file (cf. example_simple.csv):

"Event","URL","Identifier","Creator","Title","Publication year"
"publish","https://example.com","10.82421/example01","Musterfrau, Erika","My Sample Title",2024

Example

Example of a complex CSV file with additional fields (cf. example_complex.csv):

"Event","URL","Identifier","Creator","Title","Publication year","Subject","Contributor","Date","Related identifier","Description","Geo location","Alternate identifier"
"publish","https://example.com","10.82421/example01","Petersen, Thorge (orcid:0000-0002-2354-5914) [Kiel University (ror:04v76ef78)]; Paul-Stüve, Thilo (orcid:0000-0001-7451-0976) [Kiel University (ror:04v76ef78)]","My Sample Title",2024,"My subject","Musterfrau, Erika (orcid:0000-0000-0000-0000) [Affiliation name (ror:000000000)]; Mustermann, Max (orcid:0000-0000-0000-0001) [Affiliation name (ror:000000000)]","2023-07-06 (Issued); 2023-06-05T04:13:00+00:00 (Collected)","https://www.example.com","Short Description","54.0447,11.07825 (Kiel, Germany); 50.3267,9.0512","10273/example02 (IGSN); 10273/example03 (IGSN)"

Syntax

Creators/Contributors:

  • Names should be in the format <last_name>, <first_name>.

  • Multiple creators or contributors can be listed, separated by a semicolon (;).

  • You can include an ORCID ID for a creator or contributor by appending (orcid:0000-0000-0000-0000) after the name.

  • Affiliations can be added by including [Affiliation Name (ror:000000000)] after the name. Currently only ROR IDs are supported.

Dates:

  • Dates should be formated as described in W3CDTF22.

  • Multiple dates can be included, separated by a semicolon (;).

  • Optional date types can be added after the date, enclosed in round brackets. For example: 2023-06-05T04:13:00+00:00 (Collected).

Geolocations:

  • Multiple geolocations can be included, separated by a semicolon (;).

  • For each geolocation, you can specify the coordinates in the format <latitude>,<longitude>.

  • Optional place names can be added after the coordinates, enclosed in round brackets. For example: 54.0447,11.07825 (Kiel, Germany).

Note

More information can be found in the metadata schema