JATOS

https://www.jatos.org/
Admin
JATOS is a powerful platform designed for researchers to easily create, manage and run online...
Tokens:120,404
Snippets:1,431
Trust Score:8.2
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install NFS Server Provisioner Helm Chart

Source: https://www.jatos.org/JATOS-in-a-cluster.html

Installs the NFS server provisioner using Helm, enabling shared storage for Kubernetes. This example configures it for DigitalOcean block storage with a 11Gi persistent volume.

```bash
helm install nfs-server stable/nfs-server-provisioner --set persistence.enabled=true,persistence.storageClass=do-block-storage,persistence.size=11Gi
```

--------------------------------

### Example localhost.run Output

Source: https://www.jatos.org/Expose-your-local-JATOS.html

This is an example of the output you might see after successfully establishing a tunnel with localhost.run, providing the public URLs.

```bash
$ ssh -R 80:localhost:9000 ssh.localhost.run
Connect to http://kristian-44bs.localhost.run or https://kristian-44bs.localhost.run
```

--------------------------------

### Create systemd Service File for JATOS

Source: https://www.jatos.org/JATOS-on-a-server.html

Example systemd service file configuration for automatically starting JATOS on server reboot. Adjust paths and user as necessary.

```systemd
[Unit]
Description=JATOS
After=network-online.target
# If you use JATOS with MySQL, use:  
#After=network-online.target mysql.service  

[Service]
PIDFile=/my/path/to/jatos/RUNNING_PID
User=my-jatos-user
ExecStart=/my/path/to/jatos/loader.sh start
ExecStop=/bin/kill $MAINPID
ExecStopPost=/bin/rm -f /my/path/to/jatos/RUNNING_PID
Restart=on-failure
RestartSec=5

[Install]
WantedBy=multi-user.target
```

--------------------------------

### Example API Request using PowerShell

Source: https://www.jatos.org/JATOS-API.html

Shows how to make a GET request to a JATOS API endpoint using PowerShell's Invoke-WebRequest cmdlet, including the Authorization header.

```powershell
$headers=@{}
$headers.Add("Authorization", "Bearer jap_OeYwru727YeLzxcHSvIFlTQ52Ud03wo7cd41f")
$response = Invoke-WebRequest -Uri 'https://www.example.com/jatos/api/v1/admin/token' -Method GET -Headers $headers
```

--------------------------------

### Start JATOS Loader (macOS/Linux)

Source: https://www.jatos.org/Installation.html

Run the loader shell script to start your local JATOS installation on macOS and Linux. You may need to adjust permissions first.

```shell
./loader.sh start
```

--------------------------------

### Start JATOS Services with Docker Compose

Source: https://www.jatos.org/JATOS-with-Docker-Compose.html

Navigate to the cloned directory and start the JATOS, MySQL, and Nginx services using Docker Compose.

```bash
docker compose -f compose.yaml up  

```

--------------------------------

### Run JATOS Loader (Windows)

Source: https://www.jatos.org/Installation.html

Execute the JATOS loader script to start your local JATOS installation on Windows. Close the command window to stop JATOS.

```batch
loader.bat
```

--------------------------------

### Clone JATOS Docker Compose Repository

Source: https://www.jatos.org/JATOS-with-Docker-Compose.html

Clone the example Git repository to get started with JATOS and Docker Compose.

```bash
git clone https://github.com/JATOS/JATOS_with_docker_compose.git  

```

--------------------------------

### Install NFS Server Provisioner

Source: https://www.jatos.org/next/JATOS-in-a-cluster.html

Installs the nfs-server-provisioner using Helm, enabling ReadWriteMany persistent volumes for JATOS in a cluster. Configure persistence and storage class as needed.

```bash
helm install nfs-server stable/nfs-server-provisioner --set persistence.enabled=true,persistence.storageClass=do-block-storage,persistence.size=11Gi  

```

--------------------------------

### Example API Request using MATLAB

Source: https://www.jatos.org/JATOS-API.html

Demonstrates how to make an HTTP GET request to a JATOS API endpoint using MATLAB's HTTP interface, including the Authorization header.

```matlab
%% HTTP Interface
import matlab.net.*
import matlab.net.http.*

header = HeaderField('Authorization', 'Bearer jap_OeYwru727YeLzxcHSvIFlTQ52Ud03wo7cd41f');
uri = URI('https://example.com/jatos/api/v1/admin/token');
response = RequestMessage('get', header).send(uri.EncodedURI);
```

--------------------------------

### Example API Request using R

Source: https://www.jatos.org/JATOS-API.html

Illustrates how to make a GET request to a JATOS API endpoint using R's httr package, including the Authorization header.

```r
require(httr)

headers = c(
  `Authorization` = "Bearer jap_OeYwru727YeLzxcHSvIFlTQ52Ud03wo7cd41f"
)
res <- httr::GET(url = "https://example.com/jatos/api/v1/admin/token", httr::add_headers(.headers=headers))
```

--------------------------------

### Example Study Link and End Redirect URL

Source: https://www.jatos.org/End-page-after-your-study-finished.html

This example shows how a study link's URL parameters can be dynamically inserted into the End Redirect URL defined in study properties.

```text
http://myjatosdomain/publix/v6UkpHR8Sfu?SONA_ID=123abc
```

```text
https://rug.sona-systems.com/webstudy_credit.aspx?experiment_id=123&credit_token=1234567&survey_code=[SONA_ID]
```

```text
https://rug.sona-systems.com/webstudy_credit.aspx?experiment_id=123&credit_token=1234567&survey_code=123abc
```

--------------------------------

### Example API Request using JavaScript

Source: https://www.jatos.org/JATOS-API.html

Provides a basic example of making a fetch request to a JATOS API endpoint using JavaScript, including the Authorization header.

```javascript
fetch('https://example.com/jatos/api/v1/admin/token', {
  headers: {
    'Authorization': 'Bearer jap_OeYwru727YeLzxcHSvIFlTQ52Ud03wo7cd41f'
  }
});
```

--------------------------------

### Example API Request using cURL

Source: https://www.jatos.org/JATOS-API.html

Demonstrates how to make a GET request to a JATOS API endpoint using cURL, including the Authorization header.

```curl
curl -i -H "Authorization: Bearer jap_OeYwru727YeLzxcHSvIFlTQ52Ud03wo7cd41f" https://example.com/jatos/api/v1/admin/token
```

--------------------------------

### JATOS Configuration for Branding URL

Source: https://www.jatos.org/JATOS-on-DigitalOcean.html

This example shows how to configure JATOS to display a custom welcome message or branding URL on its home page.

```yaml
  jatos:
    image: "jatos/jatos:latest"
    container_name: "jatos"
    command:
      - '-Djatos.brandingUrl=https://mydomain.com/foobar-university-welcome-page.html'
    ...
```

--------------------------------

### Example JAS File Schema

Source: https://www.jatos.org/JATOS-Study-Archive-JZIP.html

Provides an example of the JSON structure for a JAS file, which defines study properties like version, title, components, and batches.

```json
{
    "version": "3",
    "data": {
        "uuid": "537cfff1-de92-1d80-264c-6b589e82f6de",
        "title": "Simple Reaction Time Task",
        "description": "Here we describe the study.",
        "groupStudy": false,
        "linearStudy": false,
        "allowPreview": false,
        "dirName": "simple_rt_task",
        "comments": "",
        "jsonData": "{\"a\":\"test\",\"b\":5}",
        "endRedirectUrl": "",
        "studyEntryMsg": null,
        "componentList": [
            {
                "uuid": "dea21111-a966-5b24-9f15-a89fefa3f711",
                "title": "Introduction and Consent",
                "htmlFilePath": "intro.html",
                "reloadable": true,
                "active": true,
                "comments": "",
                "jsonData": null
            },
            {
                "uuid": "970a92f0-b966-4b2f-bf15-b89fefa3f911",
                "title": "Experiment",
                "htmlFilePath": "experiment.html",
                "reloadable": false,
                "active": true,
                "comments": "",
                "jsonData": null
            }
        ],
        "batchList": [
            {
                "uuid": "9c7992ca-aa24-4081-8b0e-ee70f49cd65f",
                "title": "Default",
                "active": true,
                "maxActiveMembers": null,
                "maxTotalMembers": null,
                "maxTotalWorkers": null,
                "allowedWorkerTypes": [
                    "PersonalSingle",
                    "Jatos",
                    "PersonalMultiple"
                ],
                "comments": null,
                "jsonData": null
            }
        ]
    }
}

```

--------------------------------

### Docker Compose Command to Start Services

Source: https://www.jatos.org/JATOS-on-DigitalOcean.html

This command initiates the Docker Compose services defined in the compose.yaml file in detached mode.

```bash
docker compose -f /root/compose.yaml up -d
```

--------------------------------

### Start JATOS Component by Title

Source: https://www.jatos.org/jatos.js-Reference.html

Starts a JATOS component using its title. If multiple components share the same title, the first one encountered is started. Requires JATOS v3.7.5+.

```javascript
jatos.startComponentByTitle("Some title");
```

--------------------------------

### Configure JATOS Data Folder Paths (Command Line)

Source: https://www.jatos.org/JATOS-on-a-server.html

Alternatively, specify JATOS data folder locations using command-line arguments when starting JATOS.

```bash
-Djatos.studyAssetsRootPath="/path/to/my/jatos-data-folder/study_assets_root" -Djatos.resultUploads.path="/path/to/my/jatos-data-folder/result_uploads" -Djatos.studyLogs.path="/path/to/my/jatos-data-folder/study_logs"
```

--------------------------------

### Start ngrok Tunnel for JATOS

Source: https://www.jatos.org/Expose-your-local-JATOS.html

Use this command in your terminal to expose your local JATOS instance running on port 9000 to the internet via ngrok.

```bash
./ngrok http 9000
```

--------------------------------

### jatos.startNextComponent

Source: https://www.jatos.org/jatos.js-Reference.html

Finishes the currently running component and starts the next component in the study. Optionally sends result data and a log message.

```APIDOC
## `jatos.startNextComponent`

### Description
Finishes the currently running component and starts the next component in this study. The next component is the one with position + 1. You can additionally send result data and a message back to the JATOS server.

### Method
`jatos.startNextComponent([resultData], [message], [onError])`

### Parameters
#### Arguments
- **resultData** (object|string) - Optional - String or object that will be sent as result data. An object will be serialized to JSON.
- **message** (string) - Optional - Message that should be logged (max 255 chars).
- **onError** (function) - Optional - Callback function if it fails.

### Examples
1. Jump to the next component.
```javascript
jatos.startNextComponent();
```

2. Send result data and jump to the next component.
```javascript
var resultData = "my important result data";
jatos.startNextComponent(resultData);
```

3. Send result data, jump to the next component, and send a message back.
```javascript
var resultData = "my important result data";
jatos.startNextComponent(resultData, "everything okay");
```
```

--------------------------------

### jatos.startComponentByTitle

Source: https://www.jatos.org/jatos.js-Reference.html

Finishes the currently running component and starts the component with the given title. If multiple components share the same title, the first one found is started. It can optionally send result data and a log message to the JATOS server.

```APIDOC
## `jatos.startComponentByTitle`

### Description
Finishes the currently running component and starts the component with the given title. If multiple components share the same title, the first one found is started. This function can optionally send result data and a log message to the JATOS server. (Requires JATOS version >= 3.7.5).

### Method
`jatos.startComponentByTitle(title, resultData, message, onError)`

### Parameters
#### Path Parameters
- **title** (string) - Required - Title of the component to start.
- **resultData** (object|string) - Optional - String or object that will be sent as result data. An object will be serialized to JSON.
- **message** (string) - Optional - Message that should be logged (max 255 chars). This parameter is only used in the version with a message.
- **onError** (function) - Optional - Callback function to be executed if the operation fails.

### Examples
1. Jump to component with title "Some title".
```javascript
jatos.startComponentByTitle("Some title");
```

2. Send result data and jump to component with title "Some title".
```javascript
var resultData = "my important result data";
jatos.startComponentByTitle("Some title", resultData);
```

3. Send result data, jump to component with title "Some title", and send a message back.
```javascript
var resultData = "my important result data";
jatos.startComponentByTitle("Some title", resultData, "everything okay");
```
```

--------------------------------

### Start JATOS Component by Position

Source: https://www.jatos.org/jatos.js-Reference.html

Starts a JATOS component based on its sequential position within the study. This is robust against study structure changes like exports/imports.

```javascript
jatos.startComponentByPos(3);
```

--------------------------------

### Initialize Study with jatos.onLoad

Source: https://www.jatos.org/Adapt-pre-written-code-to-run-it-in-JATOS.html

Start all your study-specific code within the jatos.onLoad function. This ensures your code runs after JATOS has initialized.

```javascript
jatos.onLoad(function() {
  // start your code here
});
```

--------------------------------

### Set OpenAI API Key (Command-line)

Source: https://www.jatos.org/JATOS_Configuration.html

Provide your OpenAI API key via a command-line argument when starting JATOS.

```bash
-Djatos.openai.apiKey="my-openai-key"  

```

--------------------------------

### Check Java Version

Source: https://www.jatos.org/Installation.html

Verify if Java 11 is installed by running this command in your terminal or command window.

```shell
java -version
```

--------------------------------

### Start Next Component in JATOS

Source: https://www.jatos.org/Combine-two-pre-written-studies-into-one.html

When combining studies, ensure the first component correctly transitions to the next. Use `jatos.startNextComponent()` to continue the study flow.

```javascript
jatos.startNextComponent(myResultDataObject);

```

--------------------------------

### Reload systemd and Enable JATOS Service

Source: https://www.jatos.org/JATOS-on-a-server.html

After creating or modifying the JATOS systemd service file, reload systemd and enable the service to start on boot.

```bash
systemctl daemon-reload
systemctl enable jatos.service
```

--------------------------------

### Start localhost.run Tunnel for JATOS

Source: https://www.jatos.org/Expose-your-local-JATOS.html

Execute this SSH command to tunnel traffic from port 80 on localhost.run to your local JATOS instance on port 9000.

```bash
ssh -R 80:localhost:9000 ssh.localhost.run
```

--------------------------------

### jatos.startComponentByTitle

Source: https://www.jatos.org/next/jatos.js-Reference.html

Finishes the currently running component and starts the component with the given title. Optionally sends result data and a log message. Requires JATOS version >= 3.7.5.

```APIDOC
## `jatos.startComponentByTitle`

### Description
Finishes the currently running component and starts the component with the given title. If multiple components share the same title, the first one found is started. This function can optionally send result data and a log message back to the JATOS server. Requires JATOS version 3.7.5 or higher.

### Method Signature
There are two versions:
1. Without message:
   `jatos.startComponentByTitle(title, resultData, onError)`
2. With message:
   `jatos.startComponentByTitle(title, resultData, message, onError)`

### Parameters
*   **title** (string) - Required - Title of the component to start.
*   **resultData** (object|string) - Optional - String or object that will be sent as result data. An object will be serialized to JSON.
*   **message** (string) - Optional - Message that should be logged (max 255 chars). Only available in the version with a message.
*   **onError** (function) - Optional - Callback function to be executed if the operation fails.

### Examples
1. Jump to component with title "Some title".
```javascript
jatos.startComponentByTitle("Some title");
```

2. Send result data and jump to component with title "Some title".
```javascript
var resultData = "my important result data";
jatos.startComponentByTitle("Some title", resultData);
```

3. Send result data, jump to component with title "Some title", and send a message back.
```javascript
var resultData = "my important result data";
jatos.startComponentByTitle("Some title", resultData, "everything okay");
```
```

--------------------------------

### jatos.startComponent

Source: https://www.jatos.org/jatos.js-Reference.html

Finishes the currently running component and starts the component with the given ID or UUID. It can optionally send result data and a log message to the JATOS server.

```APIDOC
## `jatos.startComponent`

### Description
Finishes the currently running component and starts the component with the given ID or UUID. This function can optionally send result data and a log message to the JATOS server. It's generally recommended to use `jatos.startComponentByPos` for better compatibility with study exports.

### Method
`jatos.startComponent(componentIdOrUuid, resultData, message, onError)`

### Parameters
#### Path Parameters
- **componentIdOrUuid** (number|string) - Required - ID or UUID of the component to start.
- **resultData** (object|string) - Optional - String or object that will be sent as result data. An object will be serialized to JSON.
- **message** (string) - Optional - Message that should be logged (max 255 chars). This parameter is only used in the version with a message.
- **onError** (function) - Optional - Callback function to be executed if the operation fails.

### Examples
1. Jump to component with ID 23.
```javascript
jatos.startComponent(23);
```

2. Jump to component by using its UUID.
```javascript
jatos.startComponent("3d277289-754b-4fd6-aa76-c8404deda02e");
```

3. Send result data and jump to another component.
```javascript
var resultData = "my important result data";
jatos.startComponent(23, resultData);
```

4. Send result data, jump to another component, and send a message back.
```javascript
var resultData = "my important result data";
jatos.startComponent(23, resultData, "everything okay");
```
```

--------------------------------

### Join Group with Open Channel and Message Callbacks

Source: https://www.jatos.org/jatos.js-Reference.html

This example shows how to join a group and define callbacks for when the group channel opens (`onOpen`), when another member opens their channel (`onMemberOpen`), and when a message is received from another member (`onMessage`).

```javascript
jatos.joinGroup({
  "onOpen": onOpen,
  "onMemberOpen": onMemberOpen,
  "onMessage": onMessage
});

function onOpen() {
  console.log("You joined a group and opened a group channel.");
}

function onMemberOpen(memberId) {
  console.log("In our group, another member (ID " + memberId + ") opened a group channel.");
}

function onMessage(msg) {
  console.log("You received a message: " + msg);
}
```

--------------------------------

### Send Message on Member Open Callback

Source: https://www.jatos.org/jatos.js-Reference.html

This example demonstrates sending a welcome message to a new group member immediately after they open their group channel, using the `onMemberOpen` callback.

```javascript
jatos.joinGroup({
  "onMemberOpen": onMemberOpen,
  "onMessage": onMessage
});

function onMemberOpen(memberId) {
  var msg = "Welcome to the group!";
  jatos.sendGroupMsgTo(memberId, msg);
}

function onMessage(msg) {
   console.log("You received a message: " + msg);
}
```

--------------------------------

### Apache VirtualHost for JATOS with Restricted GUI Access

Source: https://www.jatos.org/JATOS-with-Apache.html

This configuration extends the HTTPS setup to restrict access to the JATOS GUI (paths starting with /jatos) to specific local networks. It ensures only authorized networks can access the JATOS interface.

```apache
ServerName www.example.com  

<VirtualHost *:80>  
  Redirect "/" "https://www.example.com/"  
</VirtualHost>  

<VirtualHost *:443>  
  # Restrict access to JATOS' GUI to the local network  
  <Location "/jatos">  
    Order deny,allow  
    Deny from all  
    Allow from 127.0.0.1 ::1  
    Allow from localhost  
    Allow from 192.168  
  </Location>  

  SSLEngine On  
  SSLCertificateFile /etc/ssl/certs/localhost.crt  
  SSLCertificateKeyFile /etc/ssl/private/localhost.key  

  RewriteEngine On  
  RewriteCond %{HTTP:Upgrade} =websocket [NC]  
  RewriteRule /(.*)           ws://localhost:9000/$1 [P,L]  
  RewriteCond %{HTTP:Upgrade} !=websocket [NC]  
  RewriteRule /(.*)           http://localhost:9000/$1 [P,L]  
</VirtualHost>  

```

--------------------------------

### Set JATOS Base Path and Temporary Directory via Command Line

Source: https://www.jatos.org/JATOS_Configuration.html

Configure JATOS's base URL path and temporary directory using command-line arguments when starting JATOS.

```bash
./loader.sh start -Djatos.urlBasePath="/mybasepath/" -Djatos.tmpPath="/my/tmp/dir"  

```

--------------------------------

### Start JATOS Component by Title

Source: https://www.jatos.org/next/jatos.js-Reference.html

Starts a JATOS component using its title. If multiple components share the title, the first one is started. Supports sending result data and a log message.

```javascript
jatos.startComponentByTitle("Some title");
```

```javascript
var resultData = "my important result data";
jatos.startComponentByTitle("Some title", resultData);
```

```javascript
var resultData = "my important result data";
jatos.startComponentByTitle("Some title", resultData, "everything okay");
```

--------------------------------

### Configure Welcome Message URL

Source: https://www.jatos.org/JATOS_Configuration.html

Specifies a URL for JATOS to fetch static HTML for the home page welcome message. If left empty, the default message is shown.

```properties
jatos.brandingUrl = "https://mydomain.com/foobar-university-welcome-page.html"  
```

```bash
-Djatos.brandingUrl="https://mydomain.com/foobar-university-welcome-page.html"  
```

--------------------------------

### Start JATOS Component by ID

Source: https://www.jatos.org/next/jatos.js-Reference.html

Starts a JATOS component using its unique ID. This function can optionally send result data.

```javascript
jatos.startComponent(23);
```

```javascript
var resultData = "my important result data";
jatos.startComponent(23, resultData);
```

--------------------------------

### Apply JATOS Kubernetes Configuration

Source: https://www.jatos.org/JATOS-in-a-cluster.html

Apply the Kustomize configuration to deploy the JATOS cluster on Kubernetes. Replace `<my_JATOS_kustomize_directory>` with the actual path to your Kustomize directory.

```bash
kubectl apply -k <my_JATOS_kustomize_directory>
```

--------------------------------

### Start JATOS Component by ID

Source: https://www.jatos.org/jatos.js-Reference.html

Starts a JATOS component using its numerical ID. This is a direct way to navigate within a study.

```javascript
jatos.startComponent(23);
```

--------------------------------

### Import Study using JavaScript Fetch API

Source: https://www.jatos.org/JATOS-API.html

This JavaScript example demonstrates uploading a JZIP file using the Fetch API. The 'Content-Type' header should not be manually set as the browser handles it with FormData.

```javascript
const form = new FormData();
form.append('study', File(['<data goes here>'], 'test.jzip'));

fetch('https://example.com/jatos/api/v1/study', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'Authorization': 'Bearer jap_OeYwru727YeLzxcHSvIFlTQ52Ud03wo7cd41f'
    # Do not set Content-Type; the browser will set it with the correct boundary
  },
  body: form
});
```

--------------------------------

### Start JATOS Component with Result Data

Source: https://www.jatos.org/jatos.js-Reference.html

Starts a JATOS component and sends associated result data. The data can be a string or an object, which will be JSON-stringified.

```javascript
var resultData = "my important result data";
jatos.startComponent(23, resultData);
```

--------------------------------

### Start JATOS Component by UUID

Source: https://www.jatos.org/jatos.js-Reference.html

Starts a JATOS component using its unique identifier (UUID). This method is useful for referencing components programmatically.

```javascript
jatos.startComponent("3d277289-754b-4fd6-aa76-c8404deda02e");
```

--------------------------------

### Start JATOS Component by Position

Source: https://www.jatos.org/next/jatos.js-Reference.html

Starts a JATOS component based on its sequential position within the study. Supports sending result data and a log message.

```javascript
jatos.startComponentByPos(3);
```

```javascript
var resultData = "my important result data";
jatos.startComponentByPos(3, resultData);
```

```javascript
var resultData = "my important result data";
jatos.startComponentByPos(3, resultData, "everything okay");
```

--------------------------------

### Start JATOS Component by Position with Result Data

Source: https://www.jatos.org/jatos.js-Reference.html

Starts a JATOS component by its position and sends result data. This allows for passing information along with navigation.

```javascript
var resultData = "my important result data";
jatos.startComponentByPos(3, resultData);
```

--------------------------------

### Configure JATOS Branding URL via GitHub Raw Content

Source: https://www.jatos.org/Customize-JATOS-Home-Page.html

Set the `jatos.brandingUrl` in `conf/jatos.conf` to a URL pointing to your custom HTML welcome block hosted on GitHub. This method is easy but may be subject to GitHub's rate limits.

```properties
jatos.brandingUrl = "https://raw.githubusercontent.com/my-user/my-repo/main/foobar-university-welcome.html"
```

--------------------------------

### Start JATOS Component by Title with Result Data

Source: https://www.jatos.org/jatos.js-Reference.html

Starts a JATOS component by its title and sends result data. This is useful for navigating to specific, named sections of a study.

```javascript
var resultData = "my important result data";
jatos.startComponentByTitle("Some title", resultData);
```

--------------------------------

### Enable OpenAI Proxy (Command-line)

Source: https://www.jatos.org/JATOS_Configuration.html

Use this command-line argument to enable the OpenAI proxy during JATOS study runs.

```bash
-Djatos.openai.allowed=true  

```

--------------------------------

### Example API Request using Python

Source: https://www.jatos.org/JATOS-API.html

Shows how to make a POST request to a JATOS API endpoint using Python's requests library, including the Authorization header.

```python
import requests

headers = {
    'Authorization': 'Bearer jap_OeYwru727YeLzxcHSvIFlTQ52Ud03wo7cd41f',
}
response = requests.post('https://example.com/jatos/api/v1/admin/token', headers=headers)
```

--------------------------------

### Enable Apache Modules

Source: https://www.jatos.org/JATOS-with-Apache.html

Enables necessary Apache modules for reverse proxying and WebSocket support. Ensure Apache version 2.4 or higher is used.

```bash
a2enmod proxy proxy_http proxy_wstunnel http2 rewrite headers ssl  

```

--------------------------------

### Unzip JATOS Archive

Source: https://www.jatos.org/JATOS-in-Amazons-Cloud-without-Docker.html

Extract the downloaded JATOS zip archive to prepare for its execution. If the 'unzip' command is not found, it can be installed using 'sudo apt-get install unzip'.

```bash
unzip jatos_linux_java.zip
```

--------------------------------

### Example Study Input JSON

Source: https://www.jatos.org/Write-your-own-Study-Basics-and-Beyond.html

This is an example of the JSON structure that can be placed in the study input field of JATOS study properties. It defines parameters like the number of trials and retries.

```json
{
  "numberOfTrials": 12,
  "retries": 5,
  "order": [
    4,
    3,
    0,
    1
  ]
}
```

--------------------------------

### Download JATOS Release (with Java)

Source: https://www.jatos.org/JATOS-in-Amazons-Cloud-without-Docker.html

Download the JATOS release package that includes a bundled Java runtime environment. This is useful if you prefer not to manage Java installation separately.

```bash
wget https://github.com/JATOS/JATOS/releases/latest/download/jatos_linux_java.zip
```

--------------------------------

### Start JATOS Component with Result Data and Message

Source: https://www.jatos.org/jatos.js-Reference.html

Starts a JATOS component, sends result data, and includes a message for logging in JATOS. This is useful for tracking specific events or states.

```javascript
var resultData = "my important result data";
jatos.startComponent(23, resultData, "everything okay");
```

--------------------------------

### Join Group with Group Session Updates

Source: https://www.jatos.org/jatos.js-Reference.html

This minimal example demonstrates joining a group and setting up a callback to receive updates whenever the Group Session data changes on the JATOS server. The `onGroupSession` callback logs the path of the change and the new value.

```javascript
jatos.joinGroup({
  "onGroupSession": onGroupSession
});

function onGroupSession(path, op) {
  var changedObj = jatos.groupSession.find(path);
  console.log("Group Session was updated in path " + path + " with operation " + op + " to " + JSON.stringify(changedObj));
}
```

--------------------------------

### Configure JATOS with a Mounted Configuration File

Source: https://www.jatos.org/Install-JATOS-via-Docker.html

Mount a local 'jatos.conf' file into the Docker container to configure JATOS. The ':ro' flag makes the volume read-only.

```bash
docker run -d --volume ./jatos.conf:/opt/jatos/conf/jatos.conf:ro -p 9000:9000 jatos/jatos:latest
```

--------------------------------

### Start JATOS Component by Position with Result Data and Message

Source: https://www.jatos.org/jatos.js-Reference.html

Starts a JATOS component by position, sends result data, and includes a log message. This provides detailed tracking of study progression.

```javascript
var resultData = "my important result data";
jatos.startComponentByPos(3, resultData, "everything okay");
```

--------------------------------

### Start JATOS Component by Title with Result Data and Message

Source: https://www.jatos.org/jatos.js-Reference.html

Starts a JATOS component by title, sends result data, and includes a log message. This offers a flexible way to navigate and log study progress.

```javascript
var resultData = "my important result data";
jatos.startComponentByTitle("Some title", resultData, "everything okay");
```

--------------------------------

### Show Default Overlay

Source: https://www.jatos.org/jatos.js-Reference.html

Displays a default overlay with 'Please wait.' text and a spinning wheel image in the center of the screen.

```javascript
jatos.showOverlay();
```

--------------------------------

### Unpack JATOS Archive

Source: https://www.jatos.org/JATOS-on-a-server.html

Unpack the downloaded JATOS zip file to your chosen installation directory.

```bash
unzip jatos.zip
```

--------------------------------

### Imitate MTurk Sandbox Run

Source: https://www.jatos.org/Tips-and-Tricks.html

To imitate a run from MTurk's Sandbox, append the 'turkSubmitTo=sandbox' parameter to the imitation URL. Replace 'myStudyCode' with your actual study code.

```http
http://localhost:9000/publix/myStudyCode?workerId=123456&assignmentId=abcdef&turkSubmitTo=sandbox
```

--------------------------------

### Configure Frame Options Header via Command Line

Source: https://www.jatos.org/JATOS_Configuration.html

Set the X-Frame-Options header using command-line arguments to control embedding JATOS in iframes. `null` allows embedding everywhere.

```bash
-Dplay.filters.headers.frameOptions=null  

```

--------------------------------

### Load jatos.js Library in PsychoPy

Source: https://www.jatos.org/PsychoPy-and-JATOS.html

Loads the jatos.js library before the experiment starts. This is essential for JATOS integration.

```javascript
jQuery.getScript("jatos.js");  

```

--------------------------------

### Run 10 Studies Simultaneously on Linux

Source: https://www.jatos.org/Tips-and-Tricks.html

Use this command on Linux to open 10 browser tabs, each running the specified study URL with a 0.5-second delay between each.

```bash
seq 10 | xargs -I{} -- sh -c 'xdg-open https://www.example.com/publix/q9umWwAIUZ6; sleep .5'
```

--------------------------------

### Configure Database URL

Source: https://www.jatos.org/JATOS_Configuration.html

Set the JDBC URL for connecting to the JATOS database. This example uses MySQL.

```properties
jatos.db.url = "jdbc:mysql://127.0.0.1:3306/jatos?characterEncoding=UTF-8&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC"
```

```bash
-Djatos.db.url="jdbc:mysql://127.0.0.1:3306/jatos?characterEncoding=UTF-8&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC"
```

```bash
JATOS_DB_URL="jdbc:mysql://127.0.0.1:3306/jatos?characterEncoding=UTF-8&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC"
```

--------------------------------

### jatos.startLastComponent

Source: https://www.jatos.org/jatos.js-Reference.html

Finishes the current component and starts the last component of the study. Optionally sends result data and a log message.

```APIDOC
## `jatos.startLastComponent`

### Description
Finishes the current component and starts the last component of this study. If the last component is inactive, it starts the component with the highest active position. You can additionally send result data and a message back to the JATOS server.

### Method
`jatos.startLastComponent([resultData], [message], [onError])`

### Parameters
#### Arguments
- **resultData** (object|string) - Optional - String or object that will be sent as result data. An object will be serialized to JSON.
- **message** (string) - Optional - Message that should be logged (max 255 chars).
- **onError** (function) - Optional - Callback function if it fails.

### Examples
1. Jump to the last component.
```javascript
jatos.startLastComponent();
```

2. Send result data and jump to the last component.
```javascript
var resultData = "my important result data";
jatos.startLastComponent(resultData);
```

3. Send result data, jump to the last component, and send a message back.
```javascript
var resultData = "my important result data";
jatos.startLastComponent(resultData, "everything okay");
```
```
Tokens:
Raw