Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

Q: Which printer software should we use?

A: BarTender Automation Edition is most recommended. You are free to choose any other option as long as they support automated printing. Most of them follow similar approaches and should work with OpenSpecimen.

...

A: No. This is same as above. However, historically, this has been used to specify the path of printer label design template

Q. Bartender Videos

Refer to the files below for help setting up a File Integration:
https://support.seagullscientific.com/hc/en-us/articles/227353867-Print-Document-Using-a-Data-File-Integration-Video-6-31-
https://support.seagullscientific.com/hc/en-us/articles/227354787-Print-Document-Using-Print-Command-Script-Video-9-40-

Also, we have two webinar with additional information:
https://support.seagullscientific.com/hc/en-us/articles/115004072388-Building-a-file-integration-using-a-CSV-file-38-26-
https://support.seagullscientific.com/hc/en-us/articles/115003215107-Building-a-file-integration-using-Print-Command-Script-27-58- 

Q Sample output files

  1. Sample file in CSV format.
  2. Sample file in CMD format.

...

FieldDescriptionExample Values
CpShortTitle

Short title of collection protocol(CP).

Default value is *, meaning any CP

Lung Cancer


VisitSite

Collection site of visit.

Default value is *, meaning any visit site

Arkansas Hospital
SpecimenClass

Specimen class.

Default value is *, meaning any specimen class

Example 1: Fluid

Example 2: Cells

SpecimenType

Specimen type.

Default value is *, meaning any specimen type

Example 1: Whole Blood

Example 2: Cryopreserved Cells

Login

Login name of OpenSpecimen user who will be printing labels.

Default value is *, meaning any user.

john@biospecimen.org
IpRange

Specifies IP address range, using CIDR notation, of workstations of users who will be issuing print label requests.

Default value is *, meaning any workstation

Example 1: 192.168.2.0/24 matches IPv4 addresses in range 192.168.2.0 to 192.168.2.255

Example 2: 2001:db8::/48 matches IPv6 addresses in range 2001:db8:0:0:0:0:0:0 to 2001:db8:ffff:ffff:ffff:ffff:ffff:ffff

LabelType

Type of label depending on how and where it will be used e.g. Cap, Slide. If specified, value of this field is written to both database table and cmd file. The printer software can read this type and print labels accordingly.

Default value is *, meaning don't care

Cap, Slide, or any other value that is used to denote type of printing the printer software needs to carry out
LabelDesign

A name of the design template to use for printing labels. This value is of interest to printer software in deciding how label content should be arranged and printed.

Default value is *, meaning don't care

Example: Cryovial Cap Label

Name of design template configured in printer software. In this instance, name specifies label design suitable for printing labels to be used for cryovial caps

LabelTokens

Specifies list of comma-separated attribute names of Participant, Visit or Specimen records that needs to be printed on labels. For detailed list of available tokens, please refer below table

Default value: specimen_label,specimen_type,specimen_location

specimen_label,specimen_type,specimen_created_on will instruct OpenSpecimen to output values of following attributes of specimen record - label, specimen type and created on date
Printer

Name of the printer. The printer name and their network addresses are configured in printer software to direct the label printing to appropriate printer

rosy, daisy

rosy and daisy are symbolic names that can be configured in printer software to send requests to printers configured at IP address 192.168.2.110 and 192.168.2.220 respectively

CmdFilesDir

Absolute path of directory on local filesystem that OpenSpecimen uses to generate cmd files. This should be a shared directory that is accessible to OpenSpecimen as well as printer software (like Bartender or Nice Label)

Default value is * indicating do not generate cmd files

E:/Printer/CmdFiles/
CmdFileFmt

The format of data content in cmd file. Supported values are "key-value" and "csv".

Default value is * indicating do not generate cmd files

Current command line formats are tested with Bartender and Nice Label software. If you use some other software and face any issue, please let us know.

NOTE: The fields are case sensitive. Use "cvs" and "key-value".

Lineage

ALIQUOTS, PARENT, or DERIVATIVE


...

  1. Sign-in as super-admin user
    User should be able to view Settings card on home page

  2. Click on Settings card
    Module names are displayed on left side and their corresponding configuration parameters are displayed on right side of viewport

  3. Click on Biospecimen module
    All Biospecimen configuration parameters are displayed on right side

  4. Click on "Specimen Label Print Rules"
    User should be able to see current value of configuration variable along with user and time when the variable was last updated.

  5. Upload updated print rules file to change the settings

Step 2: Configure what needs to be printed on the visit label

Similar to specimen print rules file, visit uses visit_print_rules.csv to decide on how visit label content should be formatted and printed. The default rules shipped with OpenSpecimen prints vist name, date and collection protocol(CP) short title. The printing rules can be customised based on CP, site among other attributes as specified in rule.

...