• Sign In
  1. Start Page
  2. Research Studies
  3. Study Administrator Guide
  4. Create and Populate Datasets

Create Multiple Dataset Definitions from a TSV File

_Documentation

Create Multiple Dataset Definitions from a TSV File

Print

You can define many datasets at once using a schema.TSV file. To upload dataset fields in bulk, paste in a tab-delimited file that includes the five required columns and any additional columns.

To use the Bulk Import page:

  • Navigate to some folder of type Study.
  • Click the Manage tab.
  • Modify your browser's URL, replacing "manageStudy.view?" with "bulkImportDataTypes.view?", for example, http://localhost:8080/labkey/study/MyStudy/bulkImportDataTypes.view?
  • On the Bulk Import page, paste in tab-delimited text (copy and paste from Excel works well). The first row of the spreadsheet contains column headers. Each subsequent row of the spreadsheet describes one field from a dataset. See an example below.

Dataset Properties

These columns describe dataset-wide properties -- they have the same value for all fields in a given dataset.

DatasetNameHeader

Required. The name of the dataset being defined. This column can have any heading; the column header must match what you type in the Column Containing Dataset Name field.

DatasetLabelHeader

Required. The display name or label to use for the dataset.  This may include any characters.  This column can have any heading; the column header must match what you type in the Column Containing Dataset Label text box.

DatasetIdHeader

Required.  The integer id of the dataset being defined. This column can have any heading; the column header must match what you type in the Column Containing Dataset Id text box. 

Hidden

Optional. Indicates whether this dataset should be hidden.  Defaults to false.  Sample value: true

Category

Optional. Indicates the category for this dataset. Each dataset can belong to one category.  Categories are used to organize datasets.  Sample value: CRF Data

Field Properties

These columns describe field-specific properties, which will change within each dataset.

Property

Required.  This is the name of the field being defined. When importing data, this name will match the column header of the data import file. This should be a short name made of letters and numbers. It should not include spaces.

RangeURI

Required. This tells the type of data to be expected in a field. It is a string based on the XML Schema standard data type definitions. It must be one of the following values:

  • xsd:int – integer
  • xsd:double – floating point number
  • xsd:string – any text string
  • xsd:dateTime – date and time
  • xsd:boolean – boolean

Note: xsd is an alias for the formal namespace http://www.w3.org/2001/XMLSchema#

ConceptURI

Each property can be associated with a concept. Fields with the same concept have the same meaning even though they may not have the same name. The concept has a unique identifier string in the form of a URI and can have other associated data. 

Key

Indicates that this column is an extra key (int, max 1 per dataset).  Sample value:  0

AutoKey

Indicates that this extra key column should be auto-incrementing, and managed by the server.  Sample value: false

MvEnabled

Indicates whether this column supports missing value indicators (e.g. "Q" or "N"). See the Missing Value Indicator documentation page.  Sample value: false

Label

The display name to use for the field. This may include any characters.

Required

Indicates whether this field is required.

Example

The following schema.TSV file defines two datasets, Demographics and AbbreviatedPhysicalExam.

DatasetName DatasetId DatasetLabel Property Label RangeURI
Demographics 1 Demographics DEMdt Contact Date xsd:dateTime
Demographics 1 Demographics DEMbdt Date of Birth xsd:string
Demographics 1 Demographics DEMsex Gender xsd:string
AbbreviatedPhysicalExam 136 Abbreviated Physical Exam APXdt Exam Date xsd:dateTime
AbbreviatedPhysicalExam 136 Abbreviated Physical Exam APXwtkg Weight xsd:double
AbbreviatedPhysicalExam 136 Abbreviated Physical Exam APXtempc Body Temp xsd:double
AbbreviatedPhysicalExam 136 Abbreviated Physical Exam APXbpsys BP systolic xxx/ xsd:int
AbbreviatedPhysicalExam 136 Abbreviated Physical Exam APXbpdia BP diastolic /xxx xsd:int

Search

 

Pages

 

previousnext
 
expand allcollapse all