Derived Sample Automation Tokens

When configuring automations in the BaseSpace Clarity LIMS, copy tokens from the Tokens list and paste them into the Command-Line field.

These tokens are available for use in derived sample automations. If using multiple variables, add a space between each entry. All tokens and parameters are case-sensitive.

Token
Purpose
Example

{username}

Supplies the username of the current user running the step to the triggered automation script.

cmd /c "C:\ai\ai.bat {username}"

resolves to:

cmd /c C:\ai\ai.bat adminuser

{password}

Supplies the password of the current user running the step to the triggered automation script.

cmd /c "C:\ai\ai.bat {password}"

resolves to:

cmd /c C:\ai\ai.bat 3BlindMice

In log files, the password supplied on the command line is replaced with a series of *** characters.

{baseURI}

Supplies the base API URI to the triggered automation script.

cmd /c "C:\ai\ai.bat {baseURI}"

resolves to:

cmd /c C:\ai\ai.bat https://lims.lan.29/api

{derivedSampleLuids}

Supplies the derived sample LIMS IDs to the triggered automation script.

cmd /c "C:\ai\ai.bat {derivedSampleLuids}"

resolves to:

cmd /c C:\ai\ai.bat 2-1641 2-1642 2-1643

{userinput:customParameterName}

Allows for data input to supply the triggered automation script. Custom parameters are identified with the prefix 'userinput:'

The following command line requires the user to input a value for 'more_yield':

yieldscript.sh -y {userinput:more_yield} -u {username}

Last updated