Notebook Review Tables
Reference guide to Benchling warehouse notebook review process, review, and reviewer tables.
This page is for Developer Documentation.
Notebook Review Tables
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$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 userThis 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 |