Table of Contents
- What is DataShop?
- Getting Data In
- Accessing DataShop
- Project / Dataset Administration
- Citing DataShop and Datasets
- Filtering Data
- Export: Getting Data Out
- Using Other Tools
- Contact Us
A custom field is a new column you define for annotating transaction data. DataShop currently supports adding and modifying custom fields at the transaction level.
You can add custom fields when logging or importing data, or after a dataset exists (using the Custom Fields page and/or web services).
Many tutors have been instrumented to record custom fields while logging. Some examples include a field that captures the time of each tutor response to the millisecond; a field noting the agent that took the action in a multi-agent system; and a field recording a categorization of the problem the student is working on. Data mining tools can be used to generate new information about an existing dataset, and the output of those programs can be stored in custom fields without having to create a new dataset.
You can add or modify a custom field's metadata from the Custom Fields page (Dataset Info > Custom Fields), but to set the data in that custom field, you need to use web services, which is a way to interact with DataShop through a program you write.
A custom field has an owner, the user who created it. Users who have edit or admin permission for a project can create custom fields for a dataset in it. Only the owner or a DataShop administrator can delete or modify the custom field. Only DataShop administrators can delete custom fields that were logged with the data.
Custom Field Metadata
The following fields describe a custom field:
- name—descriptive name for the new custom field. Must be unique across all custom fields for the dataset. Must be no more than 255 characters.
- description—description for the new custom field. Must be no more than 500 characters.
- level—the level of aggregation that the custom field describes. Currently, the only accepted value is transaction. Future versions may support other levels such as step or student. Cannot be modified later.
A custom field value is classified as one or more of the following data types assigned internally by DataShop:
- number—must be no more than 65,000 characters
- string—must be no more than 65,000 characters
- date—see format suggestions; must be no more than 255 characters
The Custom Fields page indicates the types of custom fields, what percentage of those custom fields fall into the aforementioned categories, and what percentage of transactions are associated with each custom field.
Caveat: Very large custom fields may cause unexpected behavior in some applications. Excel correctly handles exports with very large custom field values if you import the text from Excel. Other text editors may incorrectly wrap the text values if they become too large while programs like vim, jEdit, and Notepad++ correctly handle the maximum lengths. Additionally, when viewing custom fields in the web interface, the values are truncated to 255 characters to prevent issues with browsers. To get the full custom field value, use the transaction export feature.