Benchling Integration Setup Guide

The Quartzy-Benchling Integration allows users to quickly and easily sync data between Benchling and Quartzy. With the integration, users can: 

• Automatically sync new inventory items from your Quartzy Lab to your Benchling Registry as entities 
• Automatically sync updates/edits to inventory items from Quartzy to Benchling  
• Create new order requests in Quartzy without leaving Benchling (see prerequisites)   

Read below to find out how to integrate your lab's Benchling account with Quartzy! 

 

Table of Contents 

• Requirements
• Quartzy-Benchling Integration Setup
• FAQs 

Requirements 

• Quartzy:
  • The user that sets up the integration should be a Lab Admin in the Quartzy Lab that's being integrated
• Benchling:
  • The user that configures the integration must be an Organization Admin for their Benchling tenant 
  • Ensure the following features are enabled in your Benchling tenant:  
    • Access to the Developer Platform via User Icon > Feature Settings > Developer Console
    • Access to the Connections & Apps feature via the left navigation bar (folder with small circle icon) 
    • Access to the Registry via the left navigation bar
    • Optional: Benchling Workflows License  
      • Necessary for using the Add Request to Quartzy workflow
      • Ignore if you are only syncing inventory from Quartzy to Benchling and do not plan to use the Add Request to Quartzy workflow 
  • If you do not have the appropriate permissions or roles, or do not have access to the features mentioned above, reach out to Benchling customer support at support@benchling.com for assistance 

Quartzy-Benchling Integration Setup

 

1. Log into Benchling and create the following: 

A. Project: Quartzy Integration

• Folder: Quartzy Entities within the Quartzy Integration Project

• • This folder will contain all entities of items synced from Quartzy to Benchling 
• [Optional] Folder: Quartzy Orders within the Quartzy Integration Project 
  • Optional: this step is only required for users who would like to submit Quartzy requests from Benchling 
  • This folder will contain all Quartzy Order workflow tasks created in Benchling 

B. Registry Entity Schema: Quartzy Items. This will be the main schema for all items brought over from Quartzy. 

Get there by clicking your Profile icon > Feature settings > Registry settings > Create 

 

• Configure the Prefix, Name, and Entity Type as follows: 
  • Prefix:
    • User's choice; can be Quartzy, a shorthand such as QTZ, etc
  • Name
    • Quartzy Items 
  • Entity Type
    • Custom Entity 

• Set the Containable Type to Entity 

• Add the following Entity fields (Text format): 
  • Quartzy Inventory ID = REQUIRED 
  • Item Name
  • Vendor
  • Catalog #
  • Lot Number
  • CAS Number
  • Type
  • Unit Size 
  • Quantity
  • Price (USD)
  • Quartzy Location
  • Quartzy Sub Location
  • Quartzy Product ID
  • Quartzy Lab Name
  • Quartzy Lab ID
  • Quartzy URL
  • Lot number
  • Expiration Date
  • Technical Details 
• After you've added the above fields, select Quartzy Inventory ID from the Add a Constraint menu

 

• Click Next at the bottom of the page, then on the next screen (Access Policies page), click Create 
• Open the schema you just created, and click Set Name Template. This will ensure consistent, informative names are created for the Quartzy inventory items in Benchling.
  • Here are some example naming templates: 
    • • Item name: Vendor Name: Catalog number
      • [Lab Name] Item name: Vendor Name: Catalog number
      • [Item name] Vendor Name: Catalog # - Quartzy Inventory ID

 

• • • Once the Name Template is set, scroll to Available Registration Naming Options at the bottom of the page, and select "Generate new registry IDs, and replace name according to name template"  

C. Workflows Task Schema: Add Request in Quartzy.

[Optional] This step is only required for users that would like to submit Quartzy requests from Benchling. This will be the Task Schema used to sync order requests from Benchling to Quartzy.  

• • From the bottom of the page, click Remove Output Schema  
  • The table below highlights the configuration of the Workflow. Field names/values must match exactly as written in the table. 

Component	Field Name / Value	Field Type
Task Group Prefix	QZOrd	N/A
Name	Quartzy Order	N/A
ID Prefix	QZ	N/A
Execution Type	Direct	N/A
Status Lifecycle	Direct Completion	N/A
Default task group folder	Quartzy Orders	N/A
Responsible Team	None	N/A
Assignee	Checked	N/A
Flowchart only	Unchecked	N/A
Task field	Quartzy Item*	Entity link to desired schema or any entity, depending upon desired schema configuration
Task field	Date Required*	Date
Task field	Quantity*	Decimal
Output fields	None	N/A

The asterisk (*) denotes required fields 

 

2. Install the Quartzy App in Benchling

• First, find your Benchling tenant name; this can be found in the URL when you're logged into your Benchling account (see bolded): https://TenantName.benchling.com/ 
• Insert your tenant name into the following URL, and then copy/paste the URL into your browser and navigate to that page: https://TenantName.benchling.com/app-catalog/apps/appdef_aUL4IYt2ga/install  
• Click the Install button
  • Once installed, click the View app in workspace button 
  • Open another browser tab and log into Quartzy 
  • Navigate to the Developers tab of the lab you’re connecting to Benchling 
    • Scroll to the bottom of the page and click the Enable Integrations button
    • A Configuration Token will appear; copy this token
• Back in Benchling, click on the Configuration tab 
  • Under Registry Mappings, click the Add Element button
    • Then, enter the Configuration Token copied from Quartzy in the Lab Configuration Token field 
    • Inventory Type: If you’d like to sync ALL of your lab’s inventory types, leave the Inventory Type field blank. If you’d like to sync only specific types, copy/paste the type name(s) from Quartzy into this field (separated by commas if multiple) 
    • Folder: Select Quartzy Entities from the dropdown menu 
    • Custom Entity Schema: select Quartzy Items from the dropdown menu 
      • Select the matching schema field for each app field (example below)

• • • Workflow task schema: this is only for labs that are configuring the Add Request to Quartzy workflow. Leave this section blank if you are syncing inventory items only 
      • Select Add Request to Quartzy in the dropdown menu & select the matching task field for each app field (example below)

• • Completed task status: select Completed from the dropdown menu 

3. Configure the Event source:

Note: This is only for labs that are configuring the “Add Request” workflow

• Select User Icon > Feature Settings > Developer Console
• Navigate to Events, select "+" 
• Specify the following information: 
  • AWS Region: us-west-2
  • AWS Account ID: 183060441923
  • Event Bus Name: quartzy-sync
  • Event Type: v2.workflowTask.created

4. Establish permissions

A. Project Permissions 

• Navigate to the Quartzy Integration Project created in Step 1 

• Right-click > Settings
• Add Quartzy App with WRITE permissions
• Select Save 

B. Registry Permissions 

• Navigate to User Icon > Feature Settings > Registry Settings

• Select General

• Add the Quartzy App to the collaborator list and grant WRITE permissions 

• Select Update Collaborators 

C. Tenant and Organization Permissions 

• Navigate to User Icon > Organization

• Select Apps 

• Add the Quartzy App as a member of the organization

D. Schema Permissions

[Optional] Prevent registration of items outside of the integration.

• Navigate to the Quartzy Items registry schema

• Select Access Policies

• Add the Quartzy App to the collaborator list and grant CREATE permissions 

• Set all other collaborators in the list to READ permissions, keeping the ADMIN unchanged 

5. Click the Activate button at the top of the page

That's it! Going forward, when inventory items are added to your Quartzy lab (by any user in the lab), the items will automatically sync to your Benchling Registry as entities. Check out the following user guide for more details: Benchling Integration User Guide 

See FAQs below for how to add existing Quartzy inventory to Benchling. 

 

FAQs 

This integration helps me sync newly created inventory items from Quartzy to Benchling. How do I add the existing Quartzy Inventory to my Benchling Registry? 

To view existing Quartzy inventory items in Benchling, follow the two steps below:

1. Export the inventory you would like to see in Benchling from Quartzy to Excel. Here's how: Export your Quartzy Inventory to Excel

2. Format and then import that Excel file to Benchling. Detailed instructions can be found here: Import Registry Data in Bulk

That's it! The inventory you exported from Quartzy will then show up in your Benchling Registry. 

 

Next Up: Learn how to utilize the Quartzy-Benchling integration

 

More questions? Contact us