Scripts

The <export-script> post-session action executes a calculated script after a session has completed.

• Used to implement custom post-session logic using calculated parameters.
• Supports execution of Python functions defined in file assets.
• Integrates with the LabBench blackboard for passing execution context.
• Can be executed per session or in batch across stored participants.

Execution behavior:

• Sets ExportLocation and ExportName on the context before execution.
• Executes the provided script expression.
• Expects the script to return True on success.
• Throws an exception if the script returns False.

Definition

The <export-script> element defines a script-based post-session action.

<export-script name="Upload data" 
    location="C:\LabBenchExport\intro.postSessionActions" 
    script="Uploader.upload_file(f'{Participant}.csv')" />

which has the following attributes:

file-asset

Almost invariably, relies on executing Python code defined in scripts:

<file-asset file="Script.py" />

variable

The example above uses an object that implements an FTP client and can upload a file. This client is instantiated as a protocol variable:

<variable name="Uploader" value="func: Script.CreateUploader(context)" />

Integration Example

In this example, the <export-script> action depends on coordinated configuration:

• <file-asset> exposes Python functions.
• <variable> instantiates a Python object using func:.
• <export-script> invokes methods on that object.

Minimal Python interface required by the action:

def CreateUploader(context):
    return AnonymousFTPClient(context, "127.0.0.1", port=2121)

class AnonymousFTPClient:
    def upload_file(self, local_filename):
        # Must return True on success
        return True

Key requirements:

• Functions referenced via func: must accept context.
• The script expression must evaluate to a boolean.
• context.ExportLocation is provided automatically before execution.

Example protocol

• Introduction to post-session actions