Identifier

Integer

No

No

System generated unique identifier for each container. 

Mandatory only while updating container name.

Display Name

String

No

No

Name

String

Yes

Yes

It should be unique within the system.

Barcode

String

No

No

It should be unique within the system.

Used for

String

No

Type of service provided.

• STORAGE

• DISTRIBUTION

Type Name

String

No

No

On providing the storage type name, properties like dimension and labeling scheme are fetched from the type if not provided in the file.

It should be an existing storage container type.

Activity Status

String

No

No

Closed → for Archived containers

Disabled → for containers to be deleted

• Active

• Closed

• Disabled

The value should be 'Active' during creation or kept blank, in which case it will take the default value as 'Active'.

Site Name

String

Depends

No

The site where the storage container should be stored

1. Mandatory only for parent containers. Not needed if the parent container is specified.

2. Mandatory if moving container from parent to another parent or site

Temperature

Integer

No

No

No. of Columns

Integer

Depends

No

Mandatory if it is not a dimensionless container

No. of Rows

Integer

Depends

No

Mandatory if it is not a dimensionless container

Position Labeling Mode

String

No

No

Specifies whether to use (row, column) coordinates or integers like 1, 2, 3, etc. to identify positions within the container. When not specified, (row, column) coordinates labeling mode is used by default.

• LINEAR/Linear,

• TWO_D/two_d/Two_D

Column Labeling Scheme

String

No

No

• Numbers

• Alphabets Upper Case

• Alphabets Lower Case

• Roman Upper Case

• Roman Lower Case

Default Value: Numbers

Row Labeling Scheme

String

No

No

• Numbers

• Alphabets Upper Case

• Alphabets Lower Case

• Roman Upper Case

• Roman Lower Case

Default Value: Numbers

Position Assignment

String

No

No

The position assignments of the containers.

• HZ_TOP_DOWN_LEFT_RIGHT

• HZ_TOP_DOWN_RIGHT_LEFT

• HZ_BOTTOM_UP_LEFT_RIGHT

• HZ_BOTTOM_UP_RIGHT_LEFT

• VT_TOP_DOWN_LEFT_RIGHT

• VT_TOP_DOWN_RIGHT_LEFT

• VT_BOTTOM_UP_LEFT_RIGHT

• VT_BOTTOM_UP_RIGHT_LEFT

Default Value: Horizontal, top-down, left to right

Allowed Specimen Class#1

String

No

No

Restrict container by specimen class(es).

• Fluid

• Molecular

• Tissue

• Cell

Allowed Specimen Type#1

String

No

No

Restrict container by specimen type(s). The specimen added will only be allowed to be stored in the container. 

You can add more restrictions by adding new columns 'Allowed Specimen Type#2', 'Allowed Specimen Type#3' etc

Permissible Values File

Allowed Collection Protocol#1

String

No

No

Restrict container by collection protocol(s).

The container will only be available for storage only for the collection protocols added in the field.

One or more existing collection protocols associated with the site selected.

Allowed Distribution Protocol#1

String

No

No

Restrict container by distribution protocol(s).

One or more existing distribution protocols associated with the site selected.

Stores Specimen

Boolean

No

No

Will this container directly store specimens within? E.g., a "freezer" or a rack does not store specimens, whereas a box stores specimens.

• true

• false

Storage Location#Parent Container Name

String

No

Depends

When updating a child container, make sure to include 'Storage Location#Parent Container Name' to avoid moving it outside its parent container.

Storage Location#Column

No

No

The position of this container in its parent container. E.g. a rack stored in a freezer at (1,1) or (1,a) etc.

Storage Location#Row

Integer

No

No

The position of this container in its parent container. E.g. a rack stored in a freezer at (1,1) or (1,a) etc.

Storage Location#Position

Integer

No

No

Linear position in its parent container