Notebook

Table Overview

Name$raw FiltersDescription
entryarchived$ column is not TrueLists all notebook entries
entry_auditorLists all notebook entry audits and the responsible user
authorLists all notebook entry authors
review_processLists all entry review processes
review_process_versionLists all version changes to entry review processes
review_process_stageLists all stages of all entry review processes
project_review_processLists which entry review processes are in use by projects
bnch$creation_context$betaLists the step in a Study, Condition or Unit operation that entities, results and containers were created in
bnch$review$alphaLists all reviews tied to reviewable types (entries, stage entries, worksheets, study design)
bnch$reviewer$alphaList of reviewers tied to a review and the respective user. This is meant to replace entry_auditor with respect to Review Processes
bnch$worksheet$alphaLists all worksheets

entry

Table Row

Definition

Value Type

Example Values (if applicable)

Notes

id

Unique Benchling-prescribed ID for each line item in table

Format dependent on table

ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc

Primary key for a table

source_id

The project or registry that the object's permissions comes from

Foreign key for project.id or registry ID

src_hh9ffHqV

If an object isn't in a project, the permissions will be derived from the Registry

archive_purpose$

Archival reason for object in Benchling

Text

null, Made in Error, Retired, Other, etc

null = object not archived

archived$

Archival state for object in Benchling

Boolean

TRUE, FALSE

true = object archived

creator_id

Unique identifier for creator of object

Foreign key for principal.id

ent_yXrL3BjX

created_at

Created date for object

Timestamp without timezone

2019-12-06T23:24:44.885478

modified_at

Most recent modified date for object

Timestamp without timezone

2019-12-06T23:24:44.885478

name

Name of object in Benchling

Character Varying

Transfection Entry, QC Results, Therapeutic Cell Line, etc

display_id

Unique identifier surfaced in the actual Benchling site

Prefix-unique entry number

EXP001 or EXP20000416

Unique Entry number

folder_id

Unique identifier for folder containing object

Foreign key for folder.id

lib_J3tmt8BP

If object not in folder, then folder_id = project_id.If null, then object not in folder/project

workflow_id

Unique identifier for workflow containing object

Foreign key for workflow.id

wfw_DMcZhu4A

schema_id

Unique identifier for schema containing object

Foreign key for schema.id

ts_IOGwR6u4

entry_template_id

Unique identifier for entry template containing object

Foreign key for entry_template.id

tmpl_RlsGq4ng

entry_template_version_id

Unique identifier for entry template version containing object

Foreign key for entry_template_version.id

tmplver_LKfYYNbv

review_status

Current review status for object

null, NEEDS_REVIEW, NEEDS_REVISION, REJECTED, ACCEPTED

null, NEEDS_REVIEW, NEEDS_REVISION, REJECTED, ACCEPTED

review_requested_at

Date of most recent review requested for object

Timestamp without timezone

2019-12-06T23:24:44.885478

NOTE: we prefer using requested_at on the review warehouse table

review_completed_at

Date when the review was completed

Timestamp without timezone

2019-12-06T23:24:44.885478

NOTE: we prefer using completed_at on the review warehouse table

review_initial_requested_at

Date when the review was first sent for review

Timestamp without timezone

2019-12-06T23:24:44.885478

Compared to requested_at, this captures the first time any reviewable was sent for review

NOTE: we prefer using initial_requested_at on the review warehouse table

review_status_changed_at

Date of review status change for object

Timestamp without timezone

2019-12-06T23:24:44.885478

NOTE: we prefer using review_status_changed_at on the review warehouse table

review_process_version_id

Unique identifier for version id of review process

Foreign key for review_process_version.id

rlc_SN0IwfBx

url

URL for each object in Benchling

Browser URL

https://demo.benchling.com/#biotech-org/f/lib_J3tmt8BP-Entry%20Namet/etr_gRogHFOb-untitled/edit


entry_auditor

Table RowDefinitionValue TypeExample Values (if applicable)Notes
idUnique Benchling-prescribed ID for each line item in tableFormat dependent on tableent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etcPrimary key for a table
source_idThe project or registry that the object's permissions comes fromForeign key for project.id or registry IDsrc_hh9ffHqVIf an object isn't in a project, the permissions will be derived from the Registry
user_idUnique identifier for userForeign key for user.ident_yXrL3BjXSee User Table for more information
entry_idUnique identifier for EntryForeign key for entry.idetr_GtcscEZqSee Entry Table for more information
review_process_stage_idUnique identifier for review process stageForeign key for review_process_stage.idrlcstg_ZjNgNXks
review_statusThe status for the reviewString statusACCEPTED, NEEDS_REVIEW, REJECTED, RETRACTED, etc.
review_idUnique identifier for reviewForeign key for review.idrvw_JkYbw7mjSee Review table for more information

author

Table RowDefinitionValue TypeExample Values (if applicable)Notes
idUnique Benchling-prescribed ID for each line item in tableFormat dependent on tableent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etcPrimary key for a table
source_idThe project or registry that the object's permissions comes fromForeign key for project.id or registry IDsrc_hh9ffHqVIf an object isn't in a project, the permissions will be derived from the Registry
user_idUnique identifier for userForeign key for principal.ident_yXrL3BjXSee User Table for more information
entry_idUnique identifier for EntryForeign key for entry.idetr_GtcscEZqIf entry has multiple authors there will be multiple rows per entry_id. See Entry Table for more information

review_process

Table RowDefinitionValue TypeExample Values (if applicable)Notes
idUnique Benchling-prescribed ID for each line item in tableFormat dependent on tableent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etcPrimary key for a table
current_versionVersion id of the current (i.e. most up-to-date) review process versionForeign key for review_process_version.idrlc_6x2onGXv

review_process_version

Table RowDefinitionValue TypeExample Values (if applicable)Notes
idUnique Benchling-prescribed ID for each line item in tableFormat dependent on tableent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etcPrimary key for a table
review_process_idUnique identifier for review processForeign key for review_process.idrlc_fSmNiu8i
created_atCreated date for objectTimestamp without timezone2019-12-06T23:24:44.885478
nameName of the review processes versionCharacter VaryingSelf Review, Lab Sequential
lifecycle_typeReview process typeEnumerationSELF_REVIEW,SEQUENTIAL,PARALLEL
completion_stageStatus of a completed review using review processCharacter VaryingACCEPTED

review_process_stage

Table RowDefinitionValue TypeExample Values (if applicable)Notes
idUnique Benchling-prescribed ID for each line item in tableFormat dependent on tableent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etcPrimary key for a table
nameName of the review process stageCharacter VaryingSelf review, Stage 1
actionText appearing in the user-facing label when completing stageCharacter VaryingACCEPT
review_process_version_idUnique identifier for version id of review processForeign key for review_process_version.idrlc_SN0IwfBx

project_review_process

Table RowDefinitionValue TypeExample Values (if applicable)Notes
idUnique Benchling-prescribed ID for each line item in tableFormat dependent on tableent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etcPrimary key for a table
project_idUnique identifier for projectForeign key for project.idsrc_D44xhOol
review_process_idUnique identifier for review processForeign key for review_process.idrlc_fSmNiu8i

bnch$creation_context$beta

Table RowDefinitionValue TypeExample Values (if applicable)Notes
idUnique Benchling-prescribed ID for each line item in tableFormat dependent on tableent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etcPrimary key for a table
source_idThe project or registry that the object's permissions comes fromForeign key for project.id or registry IDsrc_hh9ffHqVIf an object isn't in a project, the permissions will be derived from the Registry
created_object_idUnique identifier for the created objectForeign key for any type of object that can have a creation contextent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
entry_idUnique identifier for the notebook entry that the object was created inForeign key for entry.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
worksheet_idUnique identifier for the worksheet that the object was created inForeign key for worksheet.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
procedure_step_execution_idUnique identifier for the the associated procedure step execution instance for the worksheet step that the object was created inForeign key for procedure_step_execution_instance.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
parameter_measured_value_idUnique identifier for the created procedure parameter measured valueForeign key for parameter_measured_value.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
parameter_confirmation_value_idUnique identifier for the created procedure parameter confirmation valueForeign key for parameter_confirmation_value.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
parameter_planned_value_idUnique identifier for the created procedure parameter planned valueForeign key for parameter_planned_value.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
run_idUnique identifier for the created Connect RunCharacter varyingent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
result_idUnique identifier for the created resultForeign key for result.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
entity_idUnique identifier for the created entityForeign key for entity.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
box_idUnique identifier for the created boxForeign key for box.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
plate_idUnique identifier for the created plateForeign key for plate.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
container_idUnique identifier for the created containerForeign key for container.ident_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc

bnch$review$alpha

Table Row

Definition

Value Type

Example Values (if applicable)

Notes

id

Unique Benchling-prescribed ID for each line item in table

Format dependent on table

rvw_JkYbw7mj, etc

Primary key for a table

source_id

The project or registry that the object's permissions comes from

Foreign key for project.id or registry ID

src_hh9ffHqV

If an object isn't in a project, the permissions will be derived from the Registry

created_at

Created date for object

Timestamp without timezone

2019-12-06T23:24:44.885478

review_status

The status for the review

String status

ACCEPTED, NEEDS_REVIEW, REJECTED, RETRACTED, etc.

review_process_id

Unique identifier for review process

Foreign key for review_process.id

rlc_fSmNiu8i

reviewable_id

Unique identifier for the reviewable object the review is associated with

Foreign key for entry.id, worksheet.id, study_design.id

etr_GtcscEZq, wks_gLZqJzcl, stdydsgn_DfDd5D1w

See respective reviewable's Table for more information

initiator_id

Unique identifier for user

This represents the User who initiated the review (sent for review, self-approved)

Foreign key for user.id

ent_yXrL3BjX

See User Table for more information

requested_at

Date when the review was most recently sent for review

Timestamp without timezone

2019-12-06T23:24:44.885478

completed_at

Date when the review was completed

Timestamp without timezone

2019-12-06T23:24:44.885478

initial_requested_at

Date when the review was first sent for review

Timestamp without timezone

2019-12-06T23:24:44.885478

Compared to requested_at, this captures the first time any reviewable was sent for review

review_status_changed_at

Date when the review status last changed

Timestamp without timezone

2019-12-06T23:24:44.885478


bnch$reviewer$alpha

Table Row

Definition

Value Type

Example Values (if applicable)

Notes

id

Unique Benchling-prescribed ID for each line item in table

Format dependent on table

reviewer_66, etc

Primary key for a table

source_id

The project or registry that the object's permissions comes from

Foreign key for project.id or registry ID

src_hh9ffHqV

If an object isn't in a project, the permissions will be derived from the Registry

user_id

Unique identifier for user tied to the review/review stage

Foreign key for user.id

ent_yXrL3BjX

See User Table for more information

reviewable_id

Unique identifier for the reviewable object the review is associated with

Foreign key for entry.id, worksheet.id, study_design.id

etr_GtcscEZq, wks_gLZqJzcl, stdydsgn_DfDd5D1w

See respective reviewable's Table for more information

reviewer_status

The status of the reviewer's review

String status

PENDING, FINISHED, REJECTED, BLOCKED

review_process_stage_id

Unique identifier for review process stage the reviewer is associated with

Foreign key for review_process_stage.id

rlcstg_ZjNgNXks

review_id

Unique identifier for review

Foreign key for review.id

rvw_JkYbw7mj

See Review Table for more information


bnch$worksheet$alpha

Table Row

Definition

Value Type

Example Values (if applicable)

Notes

id

Unique Benchling-prescribed ID for each line item in table

Format dependent on table

wks_gLZqJzcl, etc

Primary key for a table

source_id

The project or registry that the object's permissions comes from

Foreign key for project.id or registry ID

src_hh9ffHqV

If an object isn't in a project, the permissions will be derived from the Registry

archived$

Archival state for object in Benchling

Boolean

TRUE, FALSE

true = object archived

archive_purpose$

Archival reason for object in Benchling

Text

null, Made in Error, Retired, Other, etc

null = object not archived

creator_id

Unique identifier for creator of object

Foreign key for principal.id

ent_yXrL3BjX

created_at

Created date for object

Timestamp without timezone

2019-12-06T23:24:44.885478

modified_at

Most recent modified date for object

Timestamp without timezone

2019-12-06T23:24:44.885478

name

String name of the worksheet

String

Condition 1 - Replicate 1 - my method 433130470 - Worksheet Study

display_id

Unique identifier surfaced in the actual Benchling site

Prefix-unique entry number

EXP001 or EXP20000416

Unique Entry number

folder_id

Unique identifier for folder containing object

Foreign key for folder.id

lib_J3tmt8BP

If object not in folder, then folder_id = project_id.If null, then object not in folder/project

review_owner_id

Unique identifier for user

This represents the User who initiated the review (sent for review, self-approved)

Foreign key for user.id

ent_yXrL3BjX

NOTE: this is target to be sunset in favour of initiator_id on the review warehouse table

review_status

The status for the review

String status

ACCEPTED, NEEDS_REVIEW, REJECTED, RETRACTED, etc.

NOTE: this is target to be sunset in favour of review_status on the review warehouse table

requested_at

Date when the review was most recently sent for review

Timestamp without timezone

2019-12-06T23:24:44.885478

NOTE: this is target to be sunset in favour of requested_at on the review warehouse table

completed_at

Date when the review was completed

Timestamp without timezone

2019-12-06T23:24:44.885478

NOTE: this is target to be sunset in favour of completed_at on the review warehouse table

initial_requested_at

Date when the review was first sent for review

Timestamp without timezone

2019-12-06T23:24:44.885478

Compared to requested_at, this captures the first time any reviewable was sent for review

NOTE: this is target to be sunset in favour of initial_requested_at on the review warehouse table

review_status_changed_at

Date when the review status last changed

Timestamp without timezone

2019-12-06T23:24:44.885478

NOTE: this is target to be sunset in favour of review_status_changed_at on the review warehouse table

review_process

Unique identifier for review process

Foreign key for review_process.id

rlc_fSmNiu8i

NOTE: this is target to be sunset in favour of review_process_id on the review warehouse table

Example Queries

For some example queries using notebook warehouse tables, see here.


What’s Next