Container Types

Introduction

Container type is a 'template' that can be used to create containers. You can create it once and reuse it every time you create new containers.

Container type is optional to create a container. From v4.2, OpenSpecimen is shipped with default container types.

Before you set up a container type, find out the below-required details:

  • Size of the container
  • Naming format

Currently, only super administrators or institute admins can add or edit a container type.

Creating a container type

  1. Select 'Containers' from the dashboard
  2. Click on 'Types' and then click 'Create' 

Bottom-up approach

Set up container types using the 'bottom-up' approach. For example to create a type for a -80 freezer that holds racks and boxes, create types in the order of Box→Rack→Freezer. Otherwise, you will not be able to select container type for 'Can hold' field for the freezer. (Since you have not created rack and box first.) 

 Expand to see create container type example
  1. Create a container type for a box

The example below shows a box that has a dimension of 9 rows by 9 columns. This means each box can hold a maximum 81 specimens. 

2. Create a container type for a rack that holds a box

The example below shows a -80 rack that has a dimension of 4 rows by 4 columns. This means that it has 16 shelves, so each rack can hold 16 boxes. 

3. Create a container type for a freezer that holds the rack

The example below shows a -80 freezer that has a dimension of 4 rows by 4 columns. This means that it has 16 shelves, so the freezer can hold 16 racks. 

Label formats to create container types

To define container name format, users can use available tokens to generate unique container names. This allows the system to auto-generate container name rather than a user creating labels at every level manually.

Notes:

  1. To create containers based on hierarchy, it is mandatory to have container label formats defined.
  2. While defining label formats, you need to ensure that it will result in an unique label.
 Click here to expand...


TokensDescription
%PCONT_NAME%

Token to include parent container name.

Note: This cannot be used at the root level like the parent as there is no container level on top of it.

%PCONT_UID(n)%

Token to include a sequential number for each child container within a parent

(n) - Specify number of digits. For example, if (2) is used, then the numbers generated will be 01, 02, 03 etc.

%PCONT_ALPHA_SEQ%Token to include unique alphabetical sequence within the parent container
%SITE_CODE%

Token to include container's site code. This helps to make containers unique across sites.

This code is set while creating sites.

%SITE_UID(n)%

Token to include a sequential number for each root container within a site

(n) - Specify number of digits. For example, if (2) is used, then the numbers generated will be 01, 02, 03 etc.

Examples:

  • Freezer level: If the format '%SITE_CODE%_F%SITE_UID(n)%' is set, the container name generated is 'BCS_F1'. 'BCS' is the site code set for the site which is selected as the parent site.
  • Sub container level like rack: If the format '%PCONT_NAME%_R%PCONT_UID(2)%' is set, the container name generated is like 'BCS_F1_R1'. This is the first rack within the freezer.

Similarly, the formats can be set for different levels of the container.

Create container types in bulk

From v5.1, you can create multiple container types in bulk through a bulk operation, refer to the wiki page for more details.

Delete container types in bulk

You might want to delete container types created by mistake or which are no longer in use. From v6.1, OpenSpecimen supports deleting multiple container types. To delete multiple container types -

  1. Go to the 'Container Types' page 
  2. Select the container types to be deleted
  3. Click 'Delete'
 Click here to expand...

Export/Import Container types in bulk

From v6.1 OpenSpecimen supports exporting container types in bulk. This is useful when container types are set up on the test server and have to be moved to the production server.

 Click here to expand...

To export container types:

  1. Go to the 'Container Types' page 
  2. Select the container types to be exported
  3. Click 'Export'
  4. This will export a CSV file

To import container types:

  1. Go to the 'Container types' page of other instance of OpenSpecimen where the container types are to be imported
  2. Click 'Import' and select 'Types'
  3. Upload the CSV file
  4. Click 'Validate and Import'