Creating Types

Creating A Type
Navigate to the Types page of your Repo
Click the "+ Create Type" button.
Enter the Type Information
Give your Type a Label that will help you and others understand the purpose and how to use Type.
From the Label you enter, we will craft a name for your Type that is URL safe, but you can always edit that name if you wish.
Because names must be URL safe, spaces and most special characters are not allowed, but underscores (_) and dashes (-) are.
Additionally, names are case insensitive, meaning that "TestName" and "testname" are the same name.
Choose the Category
Enter the Description
Click Create
Categories of Types
Article Types - To set up Article Types, you should add all of the properties needed to uniquely define the Article. In many cases, this may just be the unique $Id that every article must have, but you can add any other properties that are needed.
Evidence Types - To set up evidence types, you will define:
The properties of the Evidence
The About, which describes the Article Type the Evidence will be about
Claim Types - When setting up Claims, there are two main types
Manual Claims - Claims that you will Commit to WarmHub
To set up these Claims, you will define:
The properties of the Claim
The About, which describes the Article Type the Claim will be about
Auto Claims - Claims that WarmHub will automatically compute and commit for you.
For more information see Auto Claims
Source Types - To set up Source Types, you should add all of the properties needed to uniquely define the Source.
For an observation this may be information about the instrument used in the observation
For a citation, this should be all of the information needed for others to locate the source
Custom Types - Custom Types can help you define any unique structure or set of properties, so that they can be easily used to define properties of Articles, Evidence, Claims, or Sources.
Properties

The main component that helps define all types are their properties. Each property is a specific element of the data that can or must be present whenever someone commits data of that type.
Creating a Property
Navigate to the page of a specific type
When you create a new type, you will land on the page for that type, where you can add properties.
To navigate to this page later, you can click on the edit icon of a type from the table on the types page.
Click the "+ Create Property" button
By selecting the copy icon in the Actions column you can duplicate a property, so that you can quickly make multiple properties with similar structure.
Enter the Required Elements of the Property
Label - Give your Type a Label that will help you and others understand the purpose and how to use Type.
Name - From the Label you enter, we will craft a name for your Type that is URL safe, but you can always edit that name if you wish.
Required - Check this box, if any commit of this type must contain this property to be valid and accepted into the repo. If the box is unchecked, then commits of that type can be made with or without that property.
Type - This is the type or format of data that this property will be. For example: Text, Integer, URL, DateTime, etc.
Many of the standard types are available through the automatically imported types from our warmhub/standard repo, but all of the other Custom or Article types that are in the Repo will show up here as well.
Value - Select whether this property will be a single element, or if users can commit an array containing multiple data elements of this property.
Description - This describes the property and helps others understand how it should be used.
Click the Create button
Make sure to save your Type before leaving the page
Last updated