Skip to content

Commit

Permalink
Update pages to 3.9.1
Browse files Browse the repository at this point in the history
  • Loading branch information
kristian-lange committed Jun 8, 2024
1 parent 4de3bfb commit 8fb962b
Show file tree
Hide file tree
Showing 8 changed files with 34 additions and 28 deletions.
15 changes: 9 additions & 6 deletions versioned_docs/version-3.9.1/Manage_your_JATOS/Administration.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,12 @@ By clicking the **Study Manager** button you'll get to an overview about all stu

The information is displayed in a table with the columns:

* **Active** - In cases where e.g. a study uses to many server resources, an admin can **deactivate** (or activate again) it by clicking the switch in the 'Active' column. A deactivated study cannot be started by participants (workers) anymore, but an already started study run can be continued. That means, an admin will not interrupt a participant if they already started doing a study, but no new participants will be able to start it. The study members can still see and edit the study, as well as export its result data.
* **Study Assets Size** - The disk size of all asset files associated to this study (HTML, JS, CSS, images, videos, etc.).
* **Result Count** - The number of study results collected so far on this JATOS instance.
* **Result Data Size** - The size of all result data that are stored in the database. In brackets is the average size per result count.
* **Result File Size** - The size of all result files that are stored in the server's file system. In brackets is the average size per result count.
* **Last Started** - When was this study last started by a participant.
* **Active** - In cases where e.g. a study uses to many server resources, an admin can **deactivate** (or activate again) it by clicking the switch in the 'Active' column. A deactivated study cannot be started by participants (workers) anymore, but an already started study run can be continued. That means, an admin will not interrupt a participant if they already started doing a study, but no new participants will be able to start it. The study members can still see and edit the study, as well as export its result data.
* **ID** - The study ID
* **Title** - The study title
* **Members** - The users who are members of this study
* **Study assets size** - The disk size of all asset files associated to this study (HTML, JS, CSS, images, videos, etc.).
* **Result count** - The number of study results collected so far on this JATOS instance.
* **Result data size** - The size of all result data that are stored in the database. In brackets is the average size per result count.
* **Result file size** - The size of all result files that are stored in the server's file system. In brackets is the average size per result count.
* **Last started** - When was this study last started by a participant.
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ E.g. `batchId=1&componentId=1&componentPos=1&componentResultId=35&creationTime=1

#### 2. Cookie JATOS_GENERALSINGLE_UUIDS

This cookie is used by JATOS to store which study runs with a [General Single worker](Worker-Types.html#general-single-worker) already happened in this browser. It only stores a list of IDs that universally identifies a study (UUID).
This cookie is used by JATOS to store which study runs with a [General Single worker](Worker-Types.html#general-single-worker-and-study-link) already happened in this browser. It only stores a list of IDs that universally identifies a study (UUID).

#### 3. Play Framework session cookie named PLAY_SESSION

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If you include a file named '_endPage.html_' in your study assets folder along w
**Hint 3:** If you run your study with the **JATOS GUI (Run button)** it won't show you the _endPage.html_ but redirect you back to JATOS' GUI instead.


### 2. Study Properties' End Redirect URL
### 2. Study properties' End Redirect URL

Maybe you want to redirect to a different page, e.g. a Prolific's end page or your department's webpage. This you can do by putting the URL of that page into the study properties in JATOS' GUI.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,8 @@ This is how the Study Entry page might look like (you can customize the message)

The study link has the format `https://my.jatos.server/publix/run?code=study-code`, e.g. `https://cortex.jatos.org/publix/run?code=GwtCkuCY4bM`. As you can see it uses the URL query parameter 'code' to pass on the study code.

The advantage of using the Study Entry page is, that participants accidentally clicking on a study link (e.g. in in an email or on Twitter) without the intention of actually running the study (just out of curiosity) will now **not** automatically start the study run but be shown the Study Entry page where they have to press the '<span class="glyphicon glyphicon-play"></span>' button for confirmation. At least single-use links (Personal Single or General Single) can be used only once. Here the study entry page acts as a kind of barrier preventing the invalidation of the link.
The advantage of using the Study Entry page is, that participants accidentally clicking on a study link (e.g. in in an email or on X/Twitter) without the intention of actually running the study (just out of curiosity) will now **not** automatically start the study run but be shown the Study Entry page where they have to press the '<span class="glyphicon glyphicon-play"></span>' button for confirmation. At least single-use links (Personal Single or General Single) can be used only once. Here the study entry page acts as a kind of barrier preventing the invalidation of the link.


#### Customization of the message

Expand Down Expand Up @@ -153,7 +154,7 @@ A batch is also the place where [JATOS groups](Write-Group-Studies-I-Setup.html)
![Groups table](/img/v39x/groups_view.png)

* **Fixed** this button allows you to _fix_ a group. A fixed group doesn't allow new members to join. It keeps the group as it currently is. It has the same effect as the _jatos.js_' function [`jatos.setGroupFixed`](jatos.js-Reference.html#jatossetgroupfixed) ([more info](Write-Group-Studies-II-JavaScript-and-Messaging.html#fixing-a-group)).
* **Active Workers** are the workers that are currently members in the group
* **Past Workers** the ones that were members at one point in the past
* **Active workers** are the workers that are currently members in the group
* **Past workers** the ones that were members at one point in the past
* **Results** shows only the study results that belong to this group
* **Group State** can be START, FINISHED, or FIXED
* **Group state** can be START, FINISHED, or FIXED
2 changes: 1 addition & 1 deletion versioned_docs/version-3.9.1/Run_your_study/Study-Log.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 10

JATOS stores a log file for each study (not to be confused with [JATOS' log](Troubleshooting.html#read-log-file-in-the-browser) which is for the whole application). This file has a line for every relevant event that happened in a study, most importantly when a component result was saved, exported or deleted. Also, it contains a hash - a string that is generated by the contents of the result data itself. This, in principle, would allow any JATOS user to show that the data have not been modified, and that no result was deleted between data collection and publication.

You can see the log by clicking on **More** in the study toolbar and then **Study Log**:
You can see the log by clicking on **More** in the study toolbar and then **Study log**:

![Study Log button](/img/v39x/study_log_button.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Usually one develops a study on a local JATOS or a remote JATOS with a good inte

### Personal/General Single links seem not to work when distributed via social networks

Problem: The study runs fine, but as soon as one distributes links for Personal Single or General Single runs via social networks like Twitter, Facebook and Reddit or chat tools like Slack and Google Hangout it stops working. The participants only get the message 'A problem occurred: Study can be done only once.' and in the results the study run appears as started but never finished (State DATA_RETRIEVED).
Problem: The study runs fine, but as soon as one distributes links for Personal Single or General Single runs via social networks like X/Twitter, Facebook and Reddit or chat tools like Slack and Google Hangout it stops working. The participants only get the message 'A problem occurred: Study can be done only once.' and in the results the study run appears as started but never finished (State DATA_RETRIEVED).

The reason for this behaviour is that some of those tools open links that are posted in them before your participant can click on them. They do this to provide more information about the link, like a title and an image. Usually this is fine but Personal/General Single links work exactly once (if preview is not allowed) and a second request with the same link just responses with the forementioned error message.

Expand Down
28 changes: 15 additions & 13 deletions versioned_docs/version-3.9.1/Run_your_study/Worker-Types.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,33 @@
---
title: Worker types
title: Worker and study link types
slug: /Worker-Types.html
sidebar_position: 3
---

### Overview
Following Amazon Mechanical Turk’s terminology, a worker in JATOS is a person who runs a study. Different worker types access a study in different ways. For example, some workers can run the same study multiple times, whereas others can do it only once.

Following Amazon Mechanical Turk’s terminology, a worker in JATOS is a person who runs a study (also called participant). JATOS has different worker types and different worker types access a study in different ways. For example, some worker types can run the same study multiple times, whereas others can do it only once.

A study link is basically the URL that you hand out to a worker. A worker is always assoziated to a study link and share the same type naming. Also read [Run your study with study links](Run-your-Study-with-Study-Links.html) to get more information about study links.

| | Jatos | Personal Single | Personal Multiple | General Single | General Multiple | MTurk (Sandbox) |
|-|-------------------|-------------------|-------------------|-------------------|-------------------|------------------|
| **Typical use** | During study development | Small targeted group, each one of them gets a link | Small targeted group of workers who pilot the study or need to do it multiple times | Bigger groups but with less control; link shared e.g. via social media | Bigger groups and where the workers need to do it multiple times | For Amazon Mechanical Turk |
| **Created when?** | Together with the JATOS user | When you add the link | When you add the link | On-the-fly whenever someone uses the link | On-the-fly whenever someone uses the link | On-the-fly after a MTurk worker clicked on the HIT link |
| **Repeat the same study with the same link** | (has no links) | <span className="glyphicon glyphicon-remove-sign"></span> | <span className="glyphicon glyphicon-ok-sign"></span>(keeps the same worker) | <span className="glyphicon glyphicon-remove-sign"></span> | <span className="glyphicon glyphicon-ok-sign"></span>(creates a new worker each time)| <span className="glyphicon glyphicon-ok-sign"></span> |
| **Typical use** | During study development | Small targeted group - each one of them gets their own study link | Small targeted group of workers who pilot the study or need to do it multiple times - each one of them gets their own study link | Bigger groups but with less control - link is shared e.g. via social media | Bigger groups and where the workers need to do the study multiple times - link is shared e.g. via social media | For Amazon Mechanical Turk |
| **Repeat the same study with the same study link** | (has no links) | <span className="glyphicon glyphicon-remove-sign"></span> | <span className="glyphicon glyphicon-ok-sign"></span>(keeps the same worker) | <span className="glyphicon glyphicon-remove-sign"></span> | <span className="glyphicon glyphicon-ok-sign"></span>(creates a new worker each time)| <span className="glyphicon glyphicon-ok-sign"></span> |
| **Run different studies with the same worker** | <span className="glyphicon glyphicon-ok-sign"></span> | <span className="glyphicon glyphicon-remove-sign"></span> | <span className="glyphicon glyphicon-remove-sign"></span> | <span className="glyphicon glyphicon-remove-sign"></span> | <span className="glyphicon glyphicon-remove-sign"></span> | <span className="glyphicon glyphicon-ok-sign"></span> |
| **Supports [preview of studies](Worker-Types.html#preview-links)** | <span className="glyphicon glyphicon-remove-sign"></span> | <span className="glyphicon glyphicon-ok-sign"></span> | <span className="glyphicon glyphicon-remove-sign"></span> | <span className="glyphicon glyphicon-ok-sign"></span> | <span className="glyphicon glyphicon-remove-sign"></span> | <span className="glyphicon glyphicon-remove-sign"></span> |
| **Possible bulk creation** | <span className="glyphicon glyphicon-remove-sign"></span> | <span className="glyphicon glyphicon-ok-sign"></span> | <span className="glyphicon glyphicon-ok-sign"></span> | <span className="glyphicon glyphicon-remove-sign"></span> | <span className="glyphicon glyphicon-remove-sign"></span> | <span className="glyphicon glyphicon-remove-sign"></span> |
| **Run [group studies](Example-Group-Studies)** | <span className="glyphicon glyphicon-ok-sign"></span> | <span className="glyphicon glyphicon-ok-sign"></span> | <span className="glyphicon glyphicon-ok-sign"></span> | <span className="glyphicon glyphicon-ok-sign"></span> | <span className="glyphicon glyphicon-ok-sign"></span> | <span className="glyphicon glyphicon-ok-sign"></span> |


### Jatos Worker
### Jatos worker and study link

**Jatos workers can run any study as many times as they want.**

Jatos workers run a study (or any of its components individually) by clicking on the _Run_ buttons in the GUI. Jatos workers are usually the **researchers trying out their own studies**. Each JATOS user (i.e., anybody with a JATOS login) has their own Jatos worker. They are not meant to be used by participants.


### Personal Single worker
### Personal Single worker and study link

With a Personal Single study link **a study can be run only once** ([*But see Allow Preview](Restricting-study-flow.html#allow-preview)). You can think of them as _personalized links with single access_. Each Personal Single study link corresponds to a Personal Single worker.

Expand All @@ -34,7 +36,7 @@ Usually you would send a Personal Single study link to workers that you contact
[More about how to generate Personal type study links](Run-your-Study-with-Study-Links.html#personal-type-links)


### Personal Multiple worker
### Personal Multiple worker and study link

With a Personal Multiple study link the worker can **run a study as many times as they want**. Each Personal Multiple study link corresponds to a Personal Multiple worker.

Expand All @@ -43,21 +45,21 @@ You could send Personal Multiple study links to your pilot workers.
[More about how to generate Personal type study links](Run-your-Study-with-Study-Links.html#personal-type-links)


### General Single worker
### General Single worker and study link

This study link type can be used **many times by different participants to run a study but only once per browser** ([*But see Allow Preview](Restricting-study-flow.html#allow-preview)). Each time the link is used a new General Single worker is created on-the-fly.
This study link type can be used **many times by different participants to run a study but only once per browser** (*But see: [Allow Preview](Restricting-study-flow.html#allow-preview)). Each time the link is used a new General Single worker is created on-the-fly.

You could distribute a General Single study link through social media, like twitter, a mailing list or posting it on a public website. It is essentially useful for cases where you want to collect data from a large number of workers.
You could distribute a General Single study link through social media, like X/Twitter, a mailing list or posting it on a public website. It is essentially useful for cases where you want to collect data from a large number of workers.

Keep in mind, however, that JATOS uses the browser's cookies to decide whether a study link was already used. If someone uses a different computer, a new browser, or simply deletes their browser's cookies, then JATOS will assume that it's an unused study link. So the same person could (with some effort) use a General Single link several times.


### General Multiple worker
### General Multiple worker and study link

A General Multiple study link is the least restrictive type and can be used **many times by different participants to run a study**. The difference to a General Single is that the General Multiple study link can be used repeatedly **even in the same browser**. Each time a General Multiple study link is used a new General Multiple worker is created on-the-fly.


### MTurk (Sandbox) worker
### MTurk and MTurk Sandbox

MTurk and MTurk Sandbox workers access a JATOS study through a study link in Amazon's Mechanical Turk (MTurk).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Installing JATOS as a Internet server usually involves exchanging the embedded d

## Install Java

JATOS needs Java 8 or 11 to run (17 is not yet supported). You can install your own Java or get a JATOS that is already bundled with Java.
JATOS needs Java 11 to run (higher versions are not yet supported). You can install your own Java or get a JATOS that is already bundled with Java.


## Install JATOS
Expand Down

0 comments on commit 8fb962b

Please sign in to comment.