The Snippet Library in Franklin is a centralized space for managing reusable content across your organization. It streamlines case analysis by allowing you to easily insert standardized text into various workflows, ensuring consistency, efficiency, and quality across all your analyses.
What Can You Do with the Snippet Library?
Insert pre-defined snippets into text fields using the “Add Snippet” button.
Search, browse, and select relevant snippets based on context
Organize snippets into folders and categories for easy access and management.
Customize snippets to align with your organization's specific workflows and guidelines.
Note:
The Snippet Library must be configured for your organization. To enable this feature, please contact our support team and provide the details of your snippets library as outlined in the table below.
How to Use the Snippet Library
Access the Library
The “Add Snippet” button appears in relevant rich-text fields
Click the button to open the snippet selection dropdown.
You’ll see only snippets relevant to the section you are working in, based on the area in the product it is.
Search & Filter
You can use the search bar to quickly find snippets by name, folder, or content.
Snippets are grouped into folders (if applicable) and sorted alphabetically.
You can also search by typing “#” followed by text from the name, folder, or content (e.g., #pathogenic).
Insert a Snippet
Select a snippet from the dropdown list.
The snippet content is inserted at the current cursor position in the text field.
You can edit the inserted text freely or add multiple snippets as needed.
Where Snippets Can Be Used
The feature is now supported in the following locations:
Field Location | Snippet Type | Notes |
Variant Interpretation (SNP & SV) |
| Standard and custom interpretation fields |
Somatic Variant Interpretation |
| Germline-like usage in somatic fields |
Gene Summary (GDI, Classification) |
| Includes fields in gene curation and classification wizard |
Variant Comments |
| Available from tile menu and side panel |
Case Details (Standard & Custom) |
| Supports free-text fields and custom-defined ones |
Supplying Snippet Data for Your Organization
To configure your organization's Snippet Library, provide a TSV with the following details for each snippet:
Column | Description | Possible Values |
Name | The title of the snippet shown in the dropdown list. | Free text |
Folder [Optional] | The grouping used for organizing snippets in the dropdown. | Free text |
Snippet Type | The category that defines where the snippet will appear in Franklin. |
|
Snippet Subtype [Optional] | A specific grouping related to the variant type in which the snippet will be presented. |
|
Description [Optional] | A short description for internal use (not shown in the dropdown). | Free text |
Content | The rich text content (supports HTML) that will be inserted into fields. | Free text (For formatted text, use HTML) |
Examples
Name | Folder | Snippet Type | Snippet Subtype | Description | Content |
PVS1 | Pathogenic Criteria | SNP_INTERPRETATION | NONSENSE | PVS1 rule for null variants | Null variant in a gene where loss of function is a known mechanism of disease. |
BP4 | Benign Criteria | SNP_INTERPRETATION |
| BP4 rule for benign predictions | Multiple computational algorithms predict no impact on the gene or gene product, supporting benign classification. |
Heterozygous Deletion | Pathogenic CNVs | SV_INTERPRETATION | DELETION | CNV deletion in a dosage-sensitive gene | This heterozygous deletion impacts a dosage-sensitive gene associated with the patient's phenotype, supporting pathogenic classification. |
Whole Gene Duplication | Likely Benign CNVs | SV_INTERPRETATION | DUPLICATION | CNV duplication without clinical significance | This duplication spans an entire gene not known to be dosage-sensitive and is considered likely benign. |
BA1 | Benign Criteria | SNP_INTERPRETATION |
| BA1 rule for high population frequency |
|