Skip to main content

ID Sequence Arguments

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)

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

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

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

Note

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

  • {datetime:%b %d %Y %I:%M %p}

Note

By default, dates and times are reported as Universal Time Coordinated (UTC).

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"; fan-in only

  • {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}

Note

In MES, 1-to-1 Sample Protocols are used to create a single Item from the Batch. Fan-in and fan-out Sample Protocols are not supported.

In this context, {total_child_count} and {entity_type_child_count} are not useful because each parent (Batch) can only be processed once and create a single child.

In this section: