Post-Session Actions on LabBench, Version 6.0

CSV Export

Mon, 01 Jan 0001 00:00:00 +0000

Defines a post-session action that exports participant data to a CSV file.
Executed after a participant session or across multiple sessions (batch mode).
Supports dynamic file naming, conditional value evaluation, and culture-specific formatting.
Writes a single row per session, or multiple rows when executed in batch mode.

Definition

The post-session action is defined with:

        <export-to-csv name="Export to CSV" 
            location="C:\LabBenchExport\intro.postSessionActions" 
            filename="dynamic: f'{Participant}.csv'">
            <item name="ID" value="Participant" default="NA" />
            <item name="Participation" value="DATA.Participation" default="NA" condition="DATA.Completed" />
            <item name="Age" value="DATA.Age" default="NA" condition="DATA.Completed" />
        </export-to-csv>

and has the following attributes:

Export Data

Mon, 01 Jan 0001 00:00:00 +0000

Defines a post-session action that exports participant data to a single file.
Executes after a participant session has completed.
Produces one output file per participant.
The output format determines the file type and exporter used.

Definition

The post-session action is defined with:

<export-data name="Export data" 
            location="C:\LabBenchExport\intro.postSessionActions"
            format="json" 
            filename="dynamic: f'{Participant}.json'" />

and has the following attributes:

Attribute	Type	Specification
name	string	Identifier of the post-session action. Required. Must be non-empty.
location	string	File system directory where the exported file is written. Required. Must exist at validation time.
format	enum	Output format controlling file representation and default file extension. Supported values are defined in `ExportFormat`.
filename	string	Script expression evaluated at runtime to produce the output file name. Required. Must pass script validation.

format

Value	Description	Default Extension
json	Javescript Object Notation	json
hdf5	Hierarchical Data Format version 5	h5
matlab	Matlab File Format (Level 5)	mat

Log

Mon, 01 Jan 0001 00:00:00 +0000

Exports the experimental log of a participant to a PDF file.

Executed after a session using the post-session action system.
Reads log entries from the participant session.
Generates a formatted PDF containing filtered log entries.
Output is written to a file in the specified location.

Definition

The post-session action is defined with:

<export-log name="Log Export" 
            location="C:\LabBenchExport\intro.postSessionActions" 
            filename="dynamic: f'{Participant}.pdf'" 
            id="Inventors' Way"
            level="debug"/>

and has the following attributes:

Attribute	Type	Specification
name	string	Required. Identifier of the action. Must be non-empty.
location	string	Required. Directory where the generated PDF will be saved. Must exist at validation time.
filename	dynamic text	Required. Expression evaluated at runtime to produce the output file name.
id	dynamic text	Optional. Expression evaluated at runtime. If provided, rendered in the header of each page.
level	LogLevel	Optional. Minimum log level to include. Defaults to Information.

Scripts

Mon, 01 Jan 0001 00:00:00 +0000

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.

Copy file

Mon, 01 Jan 0001 00:00:00 +0000

Copies a file from a source directory to the action location.
Executed as part of the experiment action pipeline (e.g., post-session actions).
The filename is preserved; renaming is not supported.
Overwrites existing files at the destination.

Definition

The <copy> element defines a file copy operation from a source directory to the configured location.

<copy name="Copy file" 
    location="C:\LabBenchExport" 
    source="C:\LabBenchExport\intro.postSessionActions" 
    filename="dynamic: f'{Participant}.csv'" />

which has the following attributes:

Attribute	Type	Specification
name	string	Name of the action
location	string	Destination directory where the file will be copied. Must exist at execution time.
source	string	Source directory containing the file to copy. Must exist at execution time.
filename	dynamic text	Must resolve to the filename (not path). Required.