Customizations
In Connected Insights, use the default report template or introduce customizations to configure the reports according to your specifications. For more information on using the default report template, refer to Report Templates.
The following applications can be used to customize the report:
LibreOffice v7.5 or later
Carbone Studio Illumina recommends using LibreOffice to customize the report. For more information on the customizations that can be done with LibreOffice, refer to the writer guide on the LibreOffice website. Carbone studio and its documentation are updated regularly. Please ensure any command used in an ODT is compatible with Carbone version 4.22.4 or earlier.
Use LibreOffice or an equivalent ODT editor to do common report customizations, including:
Changing the logo in the header.
Changing the report name.
Updating the date and time format.
Adjusting the font size and color.
Reordering and removing sections.
Inserting or removing information, such as single or aggregate data and the Genomic biomarkers table asterisk.
Changing the paper size.
Update Methodology Description and Gene List.
Show Findings by Tier
Change the Logo
Prepare the image file that is going to be inserted into the template.
Make sure that the image is between 200 and 600 pixels so that it can fit within the header.
Make sure that the image file size is less than 50 KB to avoid a delay in report generation.
Open the template in the ODT editor.
Replace the Laboratory image in the header as follows. a. Select the Laboratory image within the header of the first page. b. Replace the image with the formatted image from step 1. If you are using LibreOffice, right-click and select Replace. For more information on LibreOffice functions, refer to the writer guide on the LibreOffice website. The location and size are adjustable after the image is placed in the header.
❗ The default template includes a different header style for the first page and subsequent pages.
c. Select the image in the header of the second page. d. Replace the image with the formatted image from step1. If you are using LibreOffice, right-click and select Replace.
For more information on LibreOffice functions, refer to the writer guide on the LibreOffice website. This replacement causes the header image to change in subsequent pages.
Change the Report Name
Open the template in the ODT editor.
At the top of the template of the first page, replace the following text with the new report name:
{d.reportData.reportLabels.report:ifEM():show('Report'):upperCase()}
❗ The default template includes different report name text for the first page and subsequent pages.
Repeat step 2 for the second page. This replacement causes the report name to change in subsequent pages.
Change Date and Time Format
Open the template in the ODT editor.
At the top of the template, find the following code that generates the report updated time text:
{d.subjects[0].reports[0].reportDetails.updateDate:formatD('YYYY-MM-DD HH:mm')}
Replace
YYYY-MM-DD HH:mm
with the desired format (for example,YYYY-MM-DD
).
Localize Time and Date
Open the template in the ODT editor.
Find and replace every instance of
(UTC)
with{d.reportData.localDates.timezone.shortName}
. This will replace "UTC" with the local time zone abbreviated name (for example, "PT" for Pacific Time).Find the following code that generates the updated date and time text:
d.subjects[0].reports[0].reportDetails.updateDate
Replace every instance with
d.reportData.localDates.reportUpdateDate
Find the following code that generates the report approval date and time text:
d.reportData.reportHistory[i].approvedDate
Replace every instance with
d.reportData.reportHistory[i].approvedDateLocal
Change Font Color and Size
Open the template in the ODT editor.
Change the font color and style using the font characteristics function for an individual text section.
❗ Color and size are changeable, but the font style and type cannot be altered.
[Optional] If you must update the font color and size for the whole document, adjust the paragraph style.
Reorder Sections
Open template in the ODT editor.
Identify the sections that must be rearranged.
Select and copy all relevant text or tables in that section.
❗ The sections of the template primarily consist of tables. Make sure that the entire table is selected when reordering a section. If you do not,then formatting issues can occur.
Enter a paragraph break between the sections where the copied section is being placed.
Paste the copied section to the new location.
Make sure that all of the information is present and formatted correctly.
Delete the original section.
Repeat steps 1–7 for any other sections that must be reordered.
Remove a Section
Open the template in the ODT editor.
Select the section of the report that you want to remove.
❗ The sections of the template primarily consist of tables. To remove the section, make sure that the entire table is selected. If you do not, then formatting issues can occur.
Delete the section.
Insert Information
Insert single data (for example, Methodology) or aggregate data as follows.
Open the template in the ODT editor.
Place the cursor where you want the new information to appear.
Add the applicable code or text used to generate new content or enter free text that you want to appear in all of the generated reports. For example, enter
{d.createdDate:formatD('YYYY-MM-DD')}
for the date the report was created or{d.reportData.therapies[]:aggCount}
to add a count for the number of therapy assertions included in the report.
Remove the Genomic Biomarkers Table Asterisk (Remove Pertinent Negative)
Open the template (version 1) in the ODT editor.
Search for and delete the following line (use Ctrl+F to search):
{$lbl.gbTableFooter:ifEM():show('*Contains disease related genes only')}
Search for the following and delete only the asterisk (
*
):('Nothing reported')}*
Remove the Nothing Reported genes list
Open the template (version 2) in the ODT editor.
Search for the following line (use Ctrl+F to search):
{$lbl.nothingReportedV2:ifEM():show('Nothing Reported')}
Use the ODT editor delete the table row containing the searched for text above.
Change Supplemental Information Description
Open the template in the ODT editor.
Search for supplemental information in the search field at the bottom of the template. You can also select Ctrl+F to search.
Make the desired edits. For more information on complex edits, refer to the ODT editor help documentation. The following edits are common:
Change an existing term heading or its definition by updating the text within the single quotation marks for a given term or definition. For example,
{$lbl.geneList:ifEM():show('Gene List')}
can be changed to the following:{$lbl.geneList:ifEM():show('Genes Included In This Test')}
Add static text (for example, laboratory contact information) by placing the cursor outside of the braces
({ })
where the status text begins. Then, type the text. If needed, press Enter to start a new line. Refer to the following example:Before editing:
{d.dataSourceVersions}{d.dataSourceVersions:ifEM():showBegin()}{$lbl.notProvided:ifEM():show('Not provided')}{d.dataSourceVersions :showEnd()}
After editing:
{d.dataSourceVersions}{d.dataSourceVersions:ifEM():showBegin()}{$lbl.notProvided:ifEM():show('Not provided')}{d.dataSourceVersions :showEnd()} Contact Information Name of Laboratory +1 (123) 555-1234 Email@Email.com
Change Paper Size
Open the template in the ODT editor.
Select each paragraph style and adjust the page size to the required size needed for printing.
Change Methodology Description and Gene List
Open the template in the ODT editor.
Search for and delete the following line (use Ctrl+F to search):
{d.reportData.methodology.assayDescription:convCRLF()}
Replace line with desired methodology text used for the specified workflow. Example text can be found in the default PDF generated from a case in ICI.
Search for and delete the following line (use Ctrl+F to search):
{d.reportData.methodology.assayGeneListText:convCRLF()}
Replace line with desired gene list.
Show Findings by Tier
The version 2 template can conditionally display findings at the beginning of the report based on the Tier/Actionability level. The default shows all levels in this section. To only display Tier I and Tier II (or equivalent).
Open the template in the ODT editor.
Search for the following line (use Ctrl+F to search):
classification.actionabilityOrder:ifGTE(7.0)
Change 7.0 to 5.0 in the instances of the line.
Search for the following line (use Ctrl+F to search):
classification.actionabilityOrder>6.9999
Change 6.9999 to 4.9999 in all instances of the line.
Last updated