CMS Record Type Administration Guide#
In this guide we show you how to create and import a Record Type, and how to create Record Type to Record Type relationships.
Note
We have intentionally kept the metadata schema very lightweight. Ampletracks has over 13 data field types to choose from, and record types can be configured to have very specific fields that provide rich and descriptive metadata schemas.
Create Record Type#
In this guide we will be creating a lightweight Record Type for laboratory Equipment.
Navigate to the grey banner menu on the Ampletracks UI
Hover over Schema on the left-hand side
Select Record Types from the drop down menu
You will see 3 buttons to the right-hand side of the UI
Click on the Add Record Type button, you will be redirected to a new page
Specify the Name and Public preview message of the Record Type in the text input areas, and, optionally, add a label image
In Name, input ‘Equipment’
Optionally, in Public preview message, input ‘This is a piece of data acquisition equipment for our laboratory’
Click on the Save or the Save & Close button
Back to the Record Type list you will see your new Record Type listed
Hover over the cog icon next to your new Record Type listing
Select Data Fields, you will be redirected to the Data Field list for that Record Type
Click on the Add Data Field button
Data field: Name
From the drop-down menu under Type: select Textbox
From the drop-down menu under Position: select First field
Hint
Once you have more than one data field defined for your Record you will be able to select data field position on the Record indexing form relative to the position of the other data fields
You will then be prompted to provide a Name, Export name and Question, type ‘Name’ in all these
Options - There are several options to configure the behaviour of your data field beyond what it looks like and what types of answers it accepts
Display to the public will determine whether a data field answer is shown when a QR code associated with a Record is scanned and accessed whilst not logged in or having access to Ampletracks as a User
Required will determine whether the data field is required for the Record to be saved
Inheritance determines whether the data field will be inherited by a Child Record
…
Data field: Equipment type
From the drop-down menu under Type: select Textbox
From the drop-down menu under Position: select After Name
Data field: Host institution
From the drop-down menu under Type: select Textbox
From the drop-down menu under Position: select After Equipment type
Data field: Location
From the drop-down menu under Type: select Textbox
From the drop-down menu under Position: select After Host Institution
Data field: Description
From the drop-down menu under Type: select Textarea
From the drop-down menu under Position: select After Location
Data field: Image
From the drop-down menu under Type: select Image
From the drop-down menu under Position: select After Description
Data field: Additional information
From the drop-down menu under Type: select Textbox
From the drop-down menu under Position: select After Image
Data field: Link
From the drop-down menu under Type: select URL
From the drop-down menu under Position: select After Additional information
Data field: Contact
From the drop-down menu under Type: select Textbox
From the drop-down menu under Position: select After Link
Data field: Contact email
From the drop-down menu under Type: select Email Address
From the drop-down menu under Position: select After Contact
Import Record Type#
Navigate to the Ampletracks GitHub repository
From there access the
example
directory within the repositoryDownload the ‘barebones’ Sample Record Type XML specified structure
Navigate to the grey banner menu on the Ampletracks UI
Hover over Schema on the left-hand side
Select Record Types from the drop down menu
You will see 3 buttons to the right-hand side of the UI
Click on Import button, you will be redirected to a new page
On the new page click on the button to select a file stored locally on your machine with the file system interaction dialog box
Click the Import button once you have selected the file
Create a Record Type to Record Type Relationship#
Navigate to the grey banner menu on the Ampletracks UI
Hover over Schema on the left-hand side
Select Relationships from the drop down menu
You will see 2 buttons to the right-hand side of the UI
Click on Add Relationship Pair, you will be redirected to a new page
You will see a pane where you can select two types of records (whether the same or different) and specify the relationship between them in plain language
As an example we will specify a relationship between a Sample and a piece of Equipment
In the top pane select Equipment from the drop down menu
In the bottom pane select Sample from the drop down menu
On the left-hand text box type in “was measured using”, i.e. “Sample was measured using Equipment”
On the right-hand text box type in “measured”, i.e. “Equipment measured Sample”
For how many relationships we can have between record type and record type the minimum is 1 and the maximum is 1000000, if you wanted a Sample to have a maximum of 10 relationships to a piece of Equipment you need to input 10 in the left-hand box underneath max