Turk Integration Types¶
Turk
The purpose of this integration is to provide a channel to collect data.
Turk Wave Configuration¶
Go through each screen of the Wave Form or Wizard for a Turk Wave
Turk Basic¶
This is the form snippet from basic Tab in the Turk Wave.
Rendered Form Turk Wave Tab basic
| Field | Info | Description |
|---|---|---|
| Protocol | Type: mixed | |
| description |
Type: text Required: No |
|
| integrationTypeCode |
Type: string(16) Required: No |
|
| Survey Channel | Type: mixed | How will the survey happen? |
| Dedicated Channel | Type: mixed | Deactivate previous waves using this channel |
| scheduleType | Type: mixed | |
| Trigger |
Type: text Required: No |
Key word to trigger self-initiated survey |
| Prompt Channel | Type: mixed | How will the prompting happen? Leave empty if same as survey |
| Response Channel | Type: mixed | Channel for response, if different than primary channel (e.g. API) |
| marking | Type: mixed |
Turk Questions¶
This is the form snippet from questions Tab in the Turk Wave.
Rendered Form Turk Wave Tab questions
| Field | Info | Description |
|---|
Turk Schedule¶
This is the form snippet from schedule Tab in the Turk Wave.
Rendered Form Turk Wave Tab schedule
| Field | Info | Description |
|---|---|---|
| taskFrequencyType | Type: mixed | |
| duration | Type: mixed | Number of days a participant is enrolled (set in Protocol) |
| OK to Enroll |
Type: boolean Required: No |
If enrollment is permitted now |
| Schedule |
Type: text Required: No |
help_block_schedule_configuration |
| Scheduling Conditions |
Type: text Required: No |
Only schedule when these conditions are met, e.g. dayOfWeek in ['Mon','Wed','Fri'] and dayOfMonth != 22 Fields: dayOfWeek (.e.g Mon), month (e.g. Jan), dayOfMonth (e.g. 15) |
| Start Date | Type: mixed | Starting date of the protocol, when surveys are scheduled / accepted. |
| Relative To Start Date |
Type: integer Required: Yes |
+1 for starting the next day |
| Specific Start Date | Type: mixed | Only if type is set to specific, otherwise calculated |
| Completion Threshold |
Type: text Required: No |
Minimum completed prompt percentage to mark as Complete |
| Notes |
Type: text Required: No |
|
| Allow in Observe |
Type: boolean Required: No |
Send link to web-based survey |
| Publish Conditions |
Type: text Required: No |
In addition to the Source Channel Filter |
| Field Workers |
Type: text Required: No |
Separated By commas, empty means everyone is eligible |
Turk Enrollment¶
This is the form snippet from enrollment Tab in the Turk Wave.
Rendered Form Turk Wave Tab enrollment
| Field | Info | Description |
|---|---|---|
| Turk Type |
Type: string() Required: Yes |
|
| Turk Deployment |
Type: string(12) Required: Yes |
|
| Auto Publish |
Type: boolean Required: No |
Auto-publish tasks to Audit/Import when queued |
Turk Task¶
This is the form snippet from task Tab in the Turk Wave.
Rendered Form Turk Wave Tab task
| Field | Info | Description |
|---|---|---|
| Task Title |
Type: text Required: No |
Public title |
| Description |
Type: text Required: No |
Public description of this task |
| Deployment Keywords |
Type: text Required: No |
Keywords make searching for jobs easier |
| Reward |
Type: text Required: Yes |
in USD, can be formula |
| Repetitions |
Type: integer Required: Yes |
Number of Repetitions (aka raters) |
| HIT Lifeftime |
Type: integer Required: Yes |
e.g. 1d 3h 5m for 1 day, 3 hour and 5 minutes |
| Assignment Duration |
Type: integer Required: Yes |
Time Worker has to complete assignment, e.g. 5m for 5 minutes |
| Auto Approval |
Type: integer Required: Yes |
Amount of time before Assignment is automatically approved " ."(faster if consensus reached) |
Turk Qualifications¶
This is the form snippet from qualifications Tab in the Turk Wave.
Rendered Form Turk Wave Tab qualifications
| Field | Info | Description |
|---|---|---|
| Use Qualifications |
Type: boolean Required: No |
Restrict tasks to qualified people |
| Locale |
Type: string(32) Required: No |
|
| MinApprovalRate |
Type: integer Required: No |
|
| MinApprovedHits |
Type: integer Required: No |
|
| Qualifications |
Type: text Required: No |
SET THESE IN JOB! Valid qualification types are: . Valid operators are: |
Turk Expiration¶
This is the form snippet from expiration Tab in the Turk Wave.
Rendered Form Turk Wave Tab expiration
| Field | Info | Description |
|---|---|---|
| Time before expiration |
Type: integer Required: No |
|
| Number of Reminders before Expiration |
Type: integer Required: No |
If 0, no reminders |
| Maximum response time |
Type: integer Required: No |
Time allowed after first response before marking as abandoned (eg, 5m, 3h, 2d) |
| Number of warnings |
Type: integer Required: No |
Once responding, number of warnings before marking as abandoned |
| Minimum Time Between Same Surveys |
Type: integer Required: No |
Delay surveys if necessary by this amount (eg, 5m, 3h, 2d) |
Turk Messages¶
This is the form snippet from messages Tab in the Turk Wave.
Rendered Form Turk Wave Tab messages
| Field | Info | Description |
|---|---|---|
| welcome |
Type: boolean Required: No |
Welcome! |
| welcome |
Type: text Required: No |
welcome Custom Message |
| taskEnd |
Type: boolean Required: No |
The task has ended. |
| taskEnd |
Type: text Required: No |
taskEnd Custom Message |
| prompt |
Type: boolean Required: No |
Time to take your survey! |
| prompt |
Type: text Required: No |
prompt Custom Message |
| end |
Type: boolean Required: No |
The assignment has ended. |
| end |
Type: text Required: No |
end Custom Message |
| expiration |
Type: boolean Required: No |
The assignment has expired |
| expiration |
Type: text Required: No |
expiration Custom Message |
| reminder | Type: mixed | Please start your survey. |
| reminder |
Type: text Required: No |
reminder Custom Message |
| warning | Type: mixed | You have {{ assignment.remainingTimeDisplay}} remaining. |
| warning |
Type: text Required: No |
warning Custom Message |