Creating a New Data Schema or Data Schema Version

This article explains how to create a new data schema using the Rhino FCP UI.  

NOTE: To learn how to create a new data schema using the Rhino SDK, see Creating a New Data Schema using the Rhino SDK.

Opening the Data Schemas Screen

To open the Data Schemas screen, do the following.

1. Select Data Schemas from the main menu.  The Data Schemas window opens.

   

2. Data schemas that have already been created appear on the screen.  The version, date the schema was created, the number of fields in the schema, number of datasets associated with the schema, and the creator of the schema are shown.
3. To search for a data schema, use the text boxes located at the top right corner of the page.  To search by name enter the full name or part of the name in the Search Name text box.  To search by description, enter part of the schema's description in the Search Description text box. (The description is what was entered when the schema was created.)
4. To see more details about the data schema, select it.  The details for the selected data schema is shown.

Creating New Data Schema

To create a new data schema will do the following.

1. In the Data Schemas window, select the Create New Data Schema button in the upper right hand corner of the screen.

2. The Create a New Data Schema screen opens.

   

3. Enter a name for the data schema.
4. Enter a description.  While a description that will help you understand the nature of the Data Schema, this is an optional field.
5. Indicate whether you want to create a blank data schema or upload a data schema from a file.  
   • If you chose to create a blank data schema: 
     • Select Create a New Data Schema.  A blank schema appears that you can define and customize.
     • Add fields by selecting the Add Field button to the right of the table.
     • If you need to delete a variable (or column) from your data schema, click on the circle icon with the X inside () located at the top of each column.
     • Select the blue cell in the schema field row.  Enter the name of the field.
     • Next, enter the unique identifier for the record in the identifier field (if needed)
     • Enter a description, select a type, indicate type parameters (if needed), and units.
     • To add another field, select Add Field button to the right of the table - and repeat these steps again.  If there is an issue, an error appears.  You’ll need to address it before the schema is created.
     • When complete, click Save.

NOTE: If needed, visit the following links to view additional information on Data Schema Field Attributes, Supported Data Schema Data Types, and/or Specifying Data Schema Field Permissions.

• If you chose to upload a data schema from a file: Select the file that you want to upload (it should be a CSV file), then click Open.  Here is an example of a CSV File with a structure that can be uploaded. If you chose to upload a data and are errors, fix the errors and try to upload again.

Variable Name,Age,Test Result A,TEST RESULT B,TEST RESULT C
Identifier,,,,
Description,Age of the patient,Result of test a,Result of test b,Result of test c
Type,Age,Percent,Percent,String
Type Parameters,,,,
Units,INT,Decimal,Decimal,STRING
Contains Sensitive Data?,FALSE,FALSE,FALSE,FALSE
Permissions,Default,Default,Default,Default
Required,TRUE,TRUE,TRUE,FALSE

6. When the schema is created, the schema entry and high-level details appears in the Data Schemas screen.  If you want to see the schema fields, click the entry.

Creating a New Data Schema Version

To create a new version of the data schema, do the following.

1. In the Data Schemas screen, select the New Version button of the Data Schema that you want to create a new version of.

2. The Create a New Schema Version screen appears.

   

   

    

3. Add a description (optional).
4. Choose to Edit Latest Schema, Create Blank Data Schema, or Upload from File.
   • If you chose Edit Latest Schema, do the following.
     1. Select Create New Schema Version.
     2. Edit the schema, then select Save.
     3. On the Data Schemas page, a new version appears.
   • If you chose create a blank data schema or upload the file, see step 5 of the Creating New Data Schema topic in this article.