• Requester Interface
• Gold
• API
• CML
• Channel API
• Image Moderation API

Common attributes

label

Every CML base tag (along with the cml:checkbox and cml:radio child tags) can have a label attribute. This will be displayed next to the generated form element. If no name attribute is specified on a base tag, this will be converted into a name by removing alpha-numeric characters and replacing spaces with an underscore.

name

Every CML base tag (except cml:group) along with the cml:checkbox and cml:radio child tags can have a name attribute. This must be unique across all base tags. The name should not contain capital letters, spaces, or non alpha-numeric characters. This will become a column header in your generated CSV.

value

The primary use for this attribute is setting cml:hidden tag values. In the case of cml:option, cml:checkbox and cml:radio, label will become the value if none is specified. If you want to have a default value for cml:text or cml:textarea, we suggest using the default attribute as this provides a better experience for the user.

default

When specified on cml:select, it must be the label name of the option that will be selected by default. When used on cml:textrea or cml:text, this provides an example input for the user and disappears once the user selects the form element. Default values will not be submitted.

instructions

Every CML base tag can have an instructions attribute. This will be displayed next to the generated form element to help clarify the desired input. If both an instructions attribute and a <cml:instructions /> tag is specified, only the value of the attribute will be used.

only-if

Every CML base tag can have an only-if attribute. The value of this attribute should be the name of the field a user must complete before this field or group of fields will be displayed. See logic for more details.

validates

Every CML base tag can have a validates attribute. This attribute enforces the specified validations to occur on this form element. See validations for more details.

aggregation

Every CML base tag can have an aggregation attribute. This attribute tells us how to aggregate your data once it has been collected. The value of this attribute can currently be avg, agg, or all. See aggregation for more details.

gold attributes

gold  

Every CML base tag can have a gold attribute except cml:group. If set to "true" this will link the form element with the data specified in the form_element_name_gold column of your uploaded spreadsheet. If it is not set to “true,” it will link the form element with the column specified. See our gold documentation for more details.

exact  

The exact attribute requires that the set of worker responses and the set of gold standard responses for a cml field are identical. This only applies to cml:text/textarea fields with multiple="true" and cml:checkboxes field. A worker’s responses will not pass gold if they include any item not found in the set of gold responses (e.g., if a, b, and c are set in your gold data, then a worker will only be correct if he submits a, b, and c). Order does not matter. Best used with cml:gold.

strict  

The strict attribute requires that every response submitted is included in the set of gold standard responses. Unlike exact, however, strict allows workers to omit responses that are part of the gold set (e.g., if a, b, and c are set in your gold data, a worker will be considered correct if he submits only a and b). Best used with cml:gold.

src  

The src attribute specifies which column in the uploaded data the gold information will be retrieved from. Only necessary when creating Gold from a spreadsheet. Best used with cml:gold.

matcher  

The matcher attribute allows you to redefine the method by which a worker’s response is evaluated against Gold Standard data. In the absence of the matcher attribute, a worker’s response and the Gold Standard response must match exactly. The Matcher attribute allows for more flexibility. The following property values can be used to affect gold behavior:

Property values:

• not - Allows gold creation on what should not be submitted. This works with any input in your form. Example: If 'a' is set as a gold value on field with matcher set to "not", and a worker submits 'a' as a response, the worker will miss the gold unit. Responses are saved in the same way as you would normal gold responses. See our gold documentation for more details.
• range - Specifies a numerical range within a worker's response must fall. You must define a minimum and maximum value, which can be set in the gold digging interface or with a spreadsheet The headers should be formatted as column_name_min and column_name_max). A number validator is recommended.
• address - (usAddress2, ukAddress, frAddress, internationalAddress) - Allows one to create gold on individual components (E.g., the state) of an address. When a worker misses the gold, they will see a message that clearly explains which components they missed. See validations for more details.

Best used with cml:gold.