Template Variables

Variable Syntax

Variables are enclosed in curly braces and support optional format specifiers and length limits:

{Variable} // Basic replacement
{Variable:Format} // With format specifier
{Variable,MaxLength} // Truncated to max length
{Variable:Format,MaxLength} // Both format and max length

Examples

{SurgicalNumber} // "S24-1234:A-1"
{PatientName:Last} // "Smith"
{PatientName:Last,7} // "Smith" (or "Washing" if longer)
{CaseDate:yyyy} // "2024"
{Timestamp:MM/dd/yyyy HH:mm} // "01/15/2024 14:30"

Supported File Printer Types: Currently, file printers support Cassette and Slide label templates only. Most variables are available for both types, with some slide-specific variables noted below.

Tip: Click the clipboard icon next to any variable to copy it with suggested defaults. Adjust the format and length as needed.

Case Information

Variable	Description	Format Options
`{SurgicalWheel}`	Surgical wheel title (e.g., "S" for surgical)	-
`{CaseDate}`	Case date (default format: yy)	`:yy` - Two-digit year `:yyyy` - Four-digit year `:MM/dd/yyyy` - Full date `:SurgicalWheel` - Use wheel's configured format Any .NET date format string
`{CaseSurgicalNumber}`	Case serial number (numeric portion, zero-padded per wheel format)	-
`{CaseIdentifier}`	Full case surgical number	-
`{CaseAlternateIdentifier}`	Case alternate ID	-
`{SurgeryDate}`	Surgery date (default format: yyyy MMMM dd)	Any .NET date format string

Trackable Parts

Variable	Description	Notes
`{SurgicalNumber}`	Full trackable surgical number	e.g., "S24-1234:A-1" for cassette or "S24-1234:A-1-1" for slide
`{SpecimenPart}`	Specimen part identifier	Alpha or numeric per surgical wheel configuration
`{CassettePart}`	Cassette part identifier	Alpha or numeric per surgical wheel configuration
`{AlternateIdentifier}`	Trackable alternate ID	-
`{ParentAlternateIdentifier}`	Parent trackable's alternate ID (specimen for cassette, cassette for slide)	-

Slide-Specific Variables

These variables are only available for slide file printers.

Variable	Description	Format Options
`{SlidePart}`	Slide part identifier	Alpha or numeric per surgical wheel configuration
`{StainTest}`	Stain test name (empty for unstained slides)	`:Abbreviation` - Short form, falls back to Title (e.g., "H+E") `:Title` - Full name, falls back to Abbreviation (default) `:Code` - CPT code `:Manufacturer` - Manufacturer name `:AntigenRetrieval` - Antigen retrieval name `:AntigenRetrievalCategory` - Antigen retrieval category `:Category` - Stain test category
`{SectioningDate}`	Date slide was sectioned (default format: yyyy MMMM dd)	Any .NET date format string
`{CuttingDepth}`	Cutting depth information	`:Full` - Title and measurements (e.g., "5μ @10μ Standard") `:Title` - Title only (e.g., "Standard") `:Measurements` - Depth only (e.g., "5μ @10μ" or "5μ")
`{DilutionFactor}`	Dilution factor	Any .NET numeric format string

Patient/Subject Information

Variable	Description	Format Options
`{PatientName}`	Patient or research patient name (uses NameFormat)	`:First` - First name only `:Last` - Last name only `:FirstLast` - First Last `:LastFirst` - Last, First (default) `:InitialsOnly` - Initials (e.g., "JMS") `:FirstMiddleLast` - First Middle Last `:LastFirstMiddle` - Last, First Middle `:FirstInitialLast` - F. Last `:FirstMiddleInitialLast` - First M. Last `:LastFirstMiddleInitial` - Last, First M. `:FirstLastIncludeProfessionalTitles` - First Last, PhD `:LastFirstIncludeProfessionalTitles` - Last, First PhD
`{PatientIdentifier}`	Patient EMR number or research patient identifier	-
`{Gender}`	Subject gender	-

Animal Information

These variables apply when the case subject is an animal.

Variable	Description	Format Options
`{AnimalName}`	Animal identifier (uses AnimalDisplayFormat)	`:Any` - Primary if available, else Alternate (default) `:Primary` - Primary identifier only `:Alternate` - Alternate identifier only `:ExternalId` - External identifier only
`{AnimalOwner}`	Animal owner name (uses NameFormat)	View Formats
`{Species}`	Animal species (returns "Human" for patient cases)	-
`{Strain}`	Animal strain	-
`{Breed}`	Animal breed	-
`{Treatment}`	Treatment name	-

Research Information

These variables apply to research cases.

Variable	Description	Format Options
`{Study}`	Study name (uses StudyDisplayFormat)	`:Any` - Title if available, else Identifier (default) `:Title` - Title only `:Identifier` - Identifier only
`{StudyPhase}`	Study phase title	-
`{StudyIndication}`	Study indication	-
`{Cohort}`	Cohort name (uses CohortDisplayFormat)	`:Arm` - Arm only `:Title` - Title only Default: Title if available, else Arm
`{PrincipalInvestigator}`	Principal investigator name (uses NameFormat)	View Formats
`{Researcher}`	Researcher name (uses NameFormat)	View Formats

Tissue/Procedure Information

Variable	Description	Format Options
`{Tissue}`	Tissue collection (uses TissueDisplayFormat)	`:Full` - Title with anatomic site, e.g., "Liver (Left Lobe)" (default) `:Abbreviation` - Abbreviation only, falls back to Title `:Title` - Title only, falls back to Abbreviation `:AnatomicSite` - Anatomic site only
`{BiopsyProcedure}`	Biopsy procedure name	-

Timestamps and Dates

Variable	Description	Format Options
`{Timestamp}`	Current date/time when label is printed (default format: yyyy MMMM dd)	`:yyyy-MM-dd` - ISO date `:MM/dd/yyyy` - US date `:HH:mm` - Time only Any .NET date/time format string
`{Created}`	Trackable creation date (default format: yyyy MMMM dd)	Any .NET date/time format string

Other Information

Variable	Description	Format Options
`{Technician}`	Assigned technician name (uses NameFormat)	View Formats
`{PrimaBarcode}`	Barcode content for scanning	-
`{InternalIdentifier}`	Internal database ID	Any .NET numeric format string
`{CustomText}`	Reserved for custom text (returns empty)	-

Special Variables

Variable	Description	Notes
`{HopperNumber}`	Printer hopper number	Cassette printers only; replaced based on cassette color mapping

Format String Reference

Many variables support specific format enums. The format string is case-insensitive.

Date/Time Formats (.NET Format Strings)

Used by: CaseDate, SurgeryDate, Created, Timestamp, SectioningDate

Format	Example Output	Description
`yy`	24	Two-digit year (CaseDate default)
`yyyy`	2024	Four-digit year
`MM/dd/yyyy`	01/15/2024	US date format
`dd-MMM-yyyy`	15-Jan-2024	Day-Month-Year
`yyyy-MM-dd`	2024-01-15	ISO 8601 date
`HH:mm`	14:30	24-hour time
`hh:mm tt`	02:30 PM	12-hour time with AM/PM
`yyyy MMMM dd`	2024 January 15	Default format for most dates
`SurgicalWheel`	(varies)	CaseDate only: uses wheel's configured format

NameFormat (Person Names)

Used by: PatientName, AnimalOwner, PrincipalInvestigator, Researcher, Technician

Format	Example Output	Description
`First`	John	First name only
`Last`	Smith	Last name only
`FirstLast`	John Smith	First name Last name
`LastFirst`	Smith, John	Last name, First name (default)
`InitialsOnly`	JMS	All initials
`FirstMiddleLast`	John Michael Smith	First Middle Last
`LastFirstMiddle`	Smith, John Michael	Last, First Middle
`FirstInitialLast`	J. Smith	First initial. Last
`FirstMiddleInitialLast`	John M. Smith	First Middle-initial. Last
`LastFirstMiddleInitial`	Smith, John M.	Last, First Middle-initial.
`FirstLastIncludeProfessionalTitles`	John Smith, PhD	With professional titles
`LastFirstIncludeProfessionalTitles`	Smith, John PhD	With professional titles

AnimalDisplayFormat

Used by: AnimalName

Format	Description
`Any`	Primary identifier if available, otherwise Alternate (default)
`Primary`	Primary identifier only
`Alternate`	Alternate identifier only
`ExternalId`	External identifier only

StudyDisplayFormat

Used by: Study

Format	Description
`Any`	Title if available, otherwise Identifier (default)
`Title`	Title only
`Identifier`	Identifier only

CohortDisplayFormat

Used by: Cohort

Format	Description
`Arm`	Arm value only
`Title`	Title only
(default)	Title if available, otherwise Arm

TissueDisplayFormat

Used by: Tissue

Format	Example Output	Description
`Full`	Liver (Left Lobe)	Title with anatomic site in parentheses (default)
`Abbreviation`	LIV	Abbreviation, falls back to Title
`Title`	Liver	Title only, falls back to Abbreviation
`AnatomicSite`	Left Lobe	Anatomic site only

StainTestDisplayFormat

Used by: StainTest (slide-specific)

Format	Example Output	Description
`Abbreviation`	H&E	Abbreviation, falls back to Title
`Title`	Hematoxylin and Eosin	Full title, falls back to Abbreviation (default)
`Code`	88305	CPT code
`Manufacturer`	Leica	Manufacturer name
`AntigenRetrieval`	HIER Citrate	Antigen retrieval method
`AntigenRetrievalCategory`	HIER	Antigen retrieval category
`Category`	IHC	Stain test category

CuttingDepthDisplayFormat

Used by: CuttingDepth (slide-specific)

Format	Example Output	Description
`Full`	5μ @10μ Standard	Measurements and title
`Title`	Standard	Title only
`Measurements`	5μ @10μ	Depth and interval only (or just depth if no interval)

« Template Selection Next: Examples »