Notebook

Table Overview

Name	$raw Filters	Description
`entry`	archived$ column is not True	Lists all notebook entries
`entry_auditor`		Lists all notebook entry audits and the responsible user
`entry_template`		Lists all notebook entry templates
`author`		Lists all notebook entry authors
`review_process`		Lists all entry review processes
`review_process_version`		Lists all version changes to entry review processes
`review_process_stage`		Lists all stages of all entry review processes
`project_review_process`		Lists which entry review processes are in use by projects
`bnch$creation_context$beta`		Lists the step in a Study, Condition or Unit operation that entities, results and containers were created in
`bnch$review$alpha`		Lists all reviews tied to reviewable types (entries, stage entries, worksheets, study design)
`bnch$reviewer$alpha`		List of reviewers tied to a review and the respective user. This is meant to replace `entry_auditor` with respect to Review Processes
`bnch$worksheet$alpha`		Lists 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, REJECTED, RETRACTED, ACCEPTED, ACCEPTANCE_SNAPSHOT_IN_PROGRESS, REVIEW_SNAPSHOT_IN_PROGRESS	null, NEEDS_REVIEW, REJECTED, RETRACTED, ACCEPTED, ACCEPTANCE_SNAPSHOT_IN_PROGRESS, REVIEW_SNAPSHOT_IN_PROGRESS	null = entry not sent for review; REJECTED includes entries requiring revision; snapshot statuses are transient (only visible when blocking snapshot feature flags are enabled)
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 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
user_id	Unique identifier for user	Foreign key for user.id	ent_yXrL3BjX	See User Table for more information
entry_id	Unique identifier for Entry	Foreign key for entry.id	etr_GtcscEZq	See Entry Table for more information
review_process_stage_id	Unique identifier for review process stage	Foreign key for review_process_stage.id	rlcstg_ZjNgNXks
review_status	The status for the review	String status	ACCEPTED, NEEDS_REVIEW, REJECTED, RETRACTED, etc.
review_id	Unique identifier for review	Foreign key for review.id	rvw_JkYbw7mj	See Review table for more information

`entry_template`

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	tmpl_RlsGq4ng, 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	Template permissions are derived from the template collection's ownership
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 the entry template	Character Varying	Western Blot Template, PCR Protocol
schema_id	Unique identifier for schema	Foreign key for schema.id	ts_IOGwR6u4	Can be null if template is not schema-based

`author`

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
user_id	Unique identifier for user	Foreign key for principal.id	ent_yXrL3BjX	See User Table for more information
entry_id	Unique identifier for Entry	Foreign key for entry.id	etr_GtcscEZq	If entry has multiple authors there will be multiple rows per entry_id. See Entry Table for more information

`review_process`

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
current_version	Version id of the current (i.e. most up-to-date) review process version	Foreign key for review_process_version.id	rlc_6x2onGXv

`review_process_version`

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
review_process_id	Unique identifier for review process	Foreign key for review_process.id	rlc_fSmNiu8i
created_at	Created date for object	Timestamp without timezone	2019-12-06T23:24:44.885478
name	Name of the review processes version	Character Varying	Self Review, Lab Sequential
lifecycle_type	Review process type	Enumeration	`SELF_REVIEW`,`SEQUENTIAL`,`PARALLEL`
completion_stage	Status of a completed review using review process	Character Varying	`ACCEPTED`

`review_process_stage`

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
name	Name of the review process stage	Character Varying	Self review, Stage 1
action	Text appearing in the user-facing label when completing stage	Character Varying	`ACCEPT`
review_process_version_id	Unique identifier for version id of review process	Foreign key for review_process_version.id	rlc_SN0IwfBx

`project_review_process`

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
project_id	Unique identifier for project	Foreign key for project.id	src_D44xhOol
review_process_id	Unique identifier for review process	Foreign key for review_process.id	rlc_fSmNiu8i

`bnch$creation_context$beta`

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
created_object_id	Unique identifier for the created object	Foreign key for any type of object that can have a creation context	ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
entry_id	Unique identifier for the notebook entry that the object was created in	Foreign key for entry.id	ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
worksheet_id	Unique identifier for the worksheet that the object was created in	Foreign key for worksheet.id	ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
procedure_step_execution_id	Unique identifier for the the associated procedure step execution instance for the worksheet step that the object was created in	Foreign key for procedure_step_execution_instance.id	ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
parameter_measured_value_id	Unique identifier for the created procedure parameter measured value	Foreign key for parameter_measured_value.id	ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
parameter_confirmation_value_id	Unique identifier for the created procedure parameter confirmation value	Foreign key for parameter_confirmation_value.id	ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
parameter_planned_value_id	Unique identifier for the created procedure parameter planned value	Foreign key for parameter_planned_value.id	ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
run_id	Unique identifier for the created Connect Run	Character varying	ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
result_id	Unique identifier for the created result	Foreign key for result.id	ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
entity_id	Unique identifier for the created entity	Foreign key for entity.id	ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
box_id	Unique identifier for the created box	Foreign key for box.id	ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
plate_id	Unique identifier for the created plate	Foreign key for plate.id	ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc
container_id	Unique identifier for the created container	Foreign key for container.id	ent_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	null, ACCEPTED, NEEDS_REVIEW, REJECTED, RETRACTED, ACCEPTANCE_SNAPSHOT_IN_PROGRESS, REVIEW_SNAPSHOT_IN_PROGRESS	null = reviewable not sent for review; REJECTED includes items requiring revision; snapshot statuses are transient (only visible when blocking snapshot feature flags like ELN_REVIEW_REQUIRES_SUCCESSFUL_SNAPSHOT are enabled)
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

Note on Worksheet Review Data:

Unlike the entry table, the bnch$worksheet$alpha table does not contain embedded review fields. To access worksheet review information, you must join with the bnch$review$alpha table:

SELECT
    w.id,
    w.name,
    w.display_id,
    r.review_status,
    r.initiator_id,
    r.requested_at,
    r.completed_at,
    r.initial_requested_at,
    r.review_status_changed_at,
    r.review_process_id
FROM bnch$worksheet$alpha w
LEFT JOIN bnch$review$alpha r ON r.reviewable_id = w.id
WHERE w.archived$ = FALSE

Example Queries

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