Skip to main content

Customizing ID Sequences

Format string for server-generated Entity, Experiment, and Item IDs. This string will have its .format() method invoked with the following arguments:

  • {entity_type}: name of the entity type (string); Entity only

  • {item_type}: name of the item type (string); Item only

  • {sequence_number}: value of the sequence (integer); Entity and Item

  • {experiment_number}: value of the sequence (integer); Experiment only

  • {workflow}: name of the Workflow (string); Experiment only

  • {date}: current date in "YYYY-MM-DD" format (string)

  • {time}: current time in "HHMMSS" format (string)

In Sample Protocols, the following additional arguments are available:

  • {parents}: list of parent names; can be joined using a custom formatter:

    • {parents:join -} produces "parent1-parent2-...-parentN"

  • {experiment}: name of experiment

  • {worksheet}: name of LIMS worksheet

In fan-out and 1-to-1 Sample Protocols, the following additional arguments are available:

  • {parent}: name of parent

  • {total_child_count}: total # of child Entities that exist for {parent}, inclusive of the Entity being named

    • {parent}-{total_child_count:02}

  • {entity_type_child_count}: total # of child Entities that exist for {parent} that are of the same type as the Entity being named, inclusive of the Entity being named

    • {parent}-{entity_type_child_count:02}

General Note

You may also use the variable datetime, which can be formatted using strptime

  • {datetime:%m%d%y}