arrow-left

All pages
gitbookPowered by GitBook
1 of 2

Loading...

Loading...

Report Templates

Connected Insights requires you to provide a report template for each test definition to ensure consistency of reports produced across cases. This section summarizes the actions that can be performed with report templates to customize the look and content of PDF reports to your specifications.

  • Create several report templates and use them in more than one test definition.

  • Use a default report template provided by Connected Insights or customize the report as needed. These customizations include: – Changing the logo of the laboratory. – Changing the report name. – Reformatting the page and date. – Changing text in the Supplemental Information section.

    • Style or format changes to the report

For more information on the customization options, refer to .

hashtag
Create a Report Template

  1. On the top toolbar, select Configuration, and then select the Test Components tab.

  2. Navigate to Report Templates and select New.

  3. Select Download the template.

hashtag
Download Report Template

  1. On the top toolbar, select Configuration, and then select the Test Components tab.

  2. Select Report Templates, and then select Pre-configured Demo Report Template or Pre-configured Demo Report Template (Version 2.3).

  3. After the report loads, select Download as ODT.

hashtag
Test Changes After Report Template Customization

  1. On the top toolbar, select Configuration, and then select the Test Components tab.

  2. Navigate to Report Templates and select New.

  3. For Create your new report, select Upload template.

Save the base ODT template.
  • Edit the file with an applicable document editor. The document editor must be able to load v1.3 ODT files. For information on making custom edits to the report, refer to .

  • Select Upload template to re-upload the template with the recently made changes. Uploaded files must in the ODT format.

  • Select Confirm Report Creation when the report preview displays. Download the original report in the ODT format at any time. You can also archive and unarchive report templates. Archiving a report template makes it unavailable for use when creating a test definition.

  • Using file explorer, navigate to the template with the changes and select Open.
  • Review the PDF preview to make sure that the modified report displays as intended.

  • Report Customizations
    Report Customizations

    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

      • 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

      • Carbone studio and its documentation are updated regularly. Please ensure any command used in an ODT is compatible with Carbone version 4.25.5 or earlier.

    Use LibreOffice or an equivalent ODT editor to do common report customizations, including:

    • Changing the report name.

    • Updating the date and time format.

    • Adjusting the font size and color.

    • Reordering and removing sections.

    hashtag
    Change the Report Name

    1. Open the template in the ODT editor.

    2. 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')}

      ❗ The default template includes different report name text for the first page and subsequent pages.

    hashtag
    Change Date and Time Format

    1. Open the template in the ODT editor.

    2. Throughout multiple places in the template, find the following code that generates the report updated time text: formatD('YYYY-MM-DD HH:mm')}

    3. Replace YYYY-MM-DD HH:mm with the desired format (for example,YYYY-MM-DD).

    hashtag
    Change Font Color and Size

    1. Open the template in the ODT editor.

    2. 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.

    3. [Optional] If you must update the font color and size for the whole document, adjust the paragraph style.

    hashtag
    Reorder Sections

    1. Open template in the ODT editor.

    2. Identify the sections that must be rearranged.

    3. 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.

    hashtag
    Remove a Section

    1. Open the template in the ODT editor.

    2. 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.

    3. Delete the section.

    hashtag
    Insert Information

    Insert single data (for example, Methodology) or aggregate data as follows.

    1. Open the template in the ODT editor.

    2. Place the cursor where you want the new information to appear.

    3. 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.

    hashtag
    Remove the Pertinent negatives genes list

    1. Open the template in the ODT editor.

    2. Search for the following line (use Ctrl+F to search): {$lbl.pertinentNegativesReported:ifEM():show('Pertinent negatives reported')}

    3. Use the ODT editor to select and delete the table containing the searched for text above.

    hashtag
    Change Paper Size

    1. Open the template in the ODT editor.

    2. Select each paragraph style and adjust the page size to the required size needed for printing.

    hashtag
    Change Methodology Description and Gene List

    1. Open the template in the ODT editor.

    2. Search for and delete the following line (use Ctrl+F to search):{d.reportData.methodology.assayDescription:convCRLF()}

    3. 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.

    hashtag
    Show Findings by Tier

    1. 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).

    2. Open the template in the ODT editor.

    3. Search for the following line (use Ctrl+F to search):classification.actionabilityOrder:ifGTE(7.0)

  • Inserting or removing information, such as single or aggregate data.

  • Changing the paper size.

  • Update Methodology Description and Gene List.

  • Show Findings by Tier

  • Repeat step 2 for the second page. This replacement causes the report name to change in subsequent pages.

    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.

  • Search for and delete the following line (use Ctrl+F to search):{d.reportData.methodology.assayGeneListText:convCRLF()}

  • Replace line with desired gene list.

  • 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.