Engineer.Table Support

Introduction 

EngineerTable allows the presentation of iSheet tables in HighQ Home or Wiki pages. 

Prerequisites 

• HighQ Collaborate 

• A System Admin Account is required to install the software. (See Installation) 

• Scripting Enabled on your HighQ instance or allowed for each user who will be editing a page containing a list - more details are available in the HighQ Knowledge base regarding this: Enable users to bypass XSS protection and add custom Javascript to a - Thomson Reuters HighQ Knowledge  

Please note: Engineer.Legal plugins do not currently support System Dashboards or "Custom Pages" due to limitations in these modules 

Limits

EngineerTable is designed to be a table widget/data visualization as as such should not be used as an isheet replacement. It will not gracefully handle very large isheets (over 10,000 rows, 40 columns) and will be capped at 100 rows if File Links, Folder Links, or Attachment colums are included. Large images may take time to load.

Installation

If this is your first Engineer Legal plugin you'll need to create your engineerLegal-plugins file. Instructions for this will be in your welcome email.

Download engineerTable.js, engineerCore.js

Upload both files to your HighQ instance in the System Admin File Library - This can be reached by clicking the profile picture/icon in the top right of your HighQ Instance > System Admin > File Library. Click “Add new file” and select each of the files to upload.

Copy each of the URLs for the uploaded files, we'll need to reference these in your engineerLegal-plugins file. DO NOT use the Get Link/Public link column, this will make your file publicly accessible. 

Updating your version

When new versions become available download the updated js files provided. Then, in your HighQ instance, navigate to the System Admin File Library and locate your existing engineerTable.js install. Clicking on the file ID to the left of this filename will open the "Update file" page, allowing you to replace the older file with the updated one you just downloaded. BEWARE: this overwrite happens immediately upon clicking Save and is irreversible. Ensure you are overwriting the correct file by double checking the File name field before clicking Choose File. It is advisable to always have backups of all files stored in the System Admin File Library.

After updating the file it can sometimes take a a little while to update for all users if their browsers are caching older code, if any user reports issues advising them to clear their cache using CTRL + SHIFT + R to do a hard refresh of the page.

Adding a table to a HighQ site 

You’ll need iSheets and either the Home or Wiki modules available in your site. 

• Create an iSheet with the columns and data you want to display on your home page

• Create a new view your iSheet called Home Page and ensure only the columns you want displayed are included

• Save your view.

Add to your Home/Wiki page 

Go to the Home or Wiki page where you would like your table to appear. Edit the panel and select Source view. 

Use the HighQ editor to add a link to your iSheet view (more help here: Add a link to a page with the rich text editor - Thomson Reuters HighQ Knowledge)

Once you've created your link, open the panel in Source view and paste in the below minimum code needed to run – the “flag_” links will need to be replaced with your links from the installation section. Ensure there is no space before the closing "</script>" tag when you edit these as this can cause the chart to load multiple times.

As of the new version 4 there is a new, simplified method to load each plugin, allowing quick switching between different plugin types, you only need to include:

<div id="tableContainer1"><script>

    engineerLegal({

      container: 'tableContainer1',
      plugin: 'table',

    });

  </script>
<!-- EngineerLegal-plugins--><script src="./flag/flag_50i54j53i54h51k53k54.action"></script>
<!--EngineerCore--><script src="./flag/flag_50l53n55j49j57k51i50.action"></script>
</div>

the old method of loading a plugin is still supported, please contact us to upgrade rather that using the below deprecated method:

<!-- DEPRECATED CODE -->
<div id="tableContainer1"><script>

            engineerTable({

            container: 'tableContainer1',

            });

</script><!-- EngineerCore --><script src="./flag/flag_50i54j53i54h51k53k54.action"></script><!--EngineerTable--><script src="./flag/flag_50l53n55j49j57k51i50.action"></script></div>

Click Ok and then Save and your table should appear. 

You can hide the link to your iSheet view if you don't want it to be visible by opening the Source view again, and locating this bit of HTML: 

class="CKContextLink" and adding a space inside the last double quote and adding the word "hidden" so: class="CKContextLink hidden"

Modifying Options 

The code for each table can be modified by setting the options, these are the lines of code ending in a comma (,) between the curly braces ({}) after “engineerTable”. Each line changes or provides information to a different component of the table. Details of all the options available are listed in the Advanced Configuration section of this guide. 

To add a new option, add a new line after the last comma and before the last curly brace and add your option line as below. 

Warning: HighQ does not keep a version history of your edits to code in Home pages so it's good practice you save your code into another window such as notepad before making changes in case you need to roll back.  

        container: 'tableContainer1', <<ADD NEW LINE HERE>> 

   }); 

For example, if you wanted to limit your table widget to only show the top 10 rows from your iSheet you could use the recordLimit option. 

We would add a new line to the code above, add our option, then a colon (:) then a single quote (‘) then the number of rows you want to limit the widget to, then another single quote and comma. 

        container: 'tableContainer1',  

        recordLimit: ‘10’, 

   }); 

FAQs 

Can I have multiple tables on the same page? 

Yes! Follow the instructions for adding a table to a HighQ site above then ensure the "container" required option on your new table is different to any other containers on the page. This could mean counting up to tableContainer2 for your second table etc. You must also update the line of HTML <div id="tableContainer2"> to match.

How do I set the width of a column? 

The table will dynamically resize to the fit the width of the page but the columns will be proportional to their widths set in the iSheet itself. Setting the "flexColumns" option to false (below) will set the column widths to those specified in your iSheet configuration which may lead to left-right scroll being displayed.

Advanced Configuration 

This section lists all the possible options that can be used to modify the standard behavior of the table. See “Modifying Options” section for instructions on using these. 

Required Options 

The below options MUST be included for the table to load.

container

e.g.

container: 'tableContainer1', 

Tells the code where you want the table to appear on your page. It requires a corresponding HTML element similar to <div id="tableContainer1">&nbsp;</div> somewhere on the page. This div element can use any term between the quotes in the id= attribute as long as it corresponds exactly with the container option value. 

Configuration Options 

The below options can be used to modify the behavior or look and feel of the table. They do not need to be set and can be removed to return them to their defaults.

flexColumns

e.g.

flexColumns: 'false', 

When set to false the table widget will not attempt to resize columns to fit the width of the user interface and instead will fix the width of the column to those set in the HighQ iSheet column settings. It will generate horizontal scroll bars if this width exceeds the width of the viewable area of the page.

showHeaders

e.g.

showHeaders: 'false', 

When set to false then the iSheet table header row will be hidden.

headerColor

e.g.

headerColor: 'gray', 

Sets background color of the header row of the table. Accepts HTML color names or HEX codes.

headerTextColor

e.g.

headerTextColor: 'red', 

Sets color of the header row text of the table. Accepts HTML color names or HEX codes.

stickyHeaders

e.g.

stickyHeaders: 'true', 

When enabled then the table header will "stick" to the top of browser when scrolling down the page. Please note that this may conflict with HighQ's own sticky navigation bar and take precedence.

tableHeight

e.g.

tableHeight: '600px', 

Set the maximum height that the table will take up on the page. If the number of records exceeds this height then the component will display a scroll bar.

verticalAlign

e.g.

verticalAlign: 'top', 

Tell EngineerTable to vertically align each cell entry to the "top", "middle" or "bottom" of each cell.

showLastModified

e.g.

showLastModified: 'true', 

Displays a last modified date of your iSheet data above your table by finding the latest modified date in your data. You iSheetViewLink view must contain the HighQ Modified Date column.

recordLimit

e.g.

recordLimit: '20', 

Limits the number of records displayed by your table to the first x number in your iSheet view

selectedColumns

e.g.

selectedColumns: '2,4,5,7', 

Use a comma-separated list with no trailing spaces of the column numbers (starting from 0) from your data view that you want to display in your table. This is useful if you want to hide columns such as the Modified Date column from your table but still want to use the showLastModified option above. Please note, this option will be automatically get by EngineerMap and EngineerList if EngineerTable is used in conjunction.

recordLinks

e.g.

recordLinks: 'viewItem', 

Adds a button to the first column of your table that can perform one of several actions depending on the configuration option:

recordLinks: 'viewItem',     - will open the HighQ view item modal window for the record selected

recordLinks: 'print',            - will open the HighQ print preview pane for the iSheet record selected

recordLinks: 'isheet',          - will navigate to the iSheet view filtered to just show the record selected

recordLinks: 'default',         - will navigate to the iSheet of the record selected but the default view instead of the view chosen for the table

recordLinks: 'edit',         - will navigate to the iSheet record in a modal window and open the edit item modal allowing changes to be made. The table will refresh when the modal is closed

recordLinks: 'editInline',         - if the EngineerAPI plugin is available, table will enable inline edit options for each row allowing all editable to columns to be updated from inside the table itself - Inline edit supports Single Line Text, Multi Line Text (not HTML), Number, Date/Time, Choice, and Score column types

editInlineHeight

e.g.

editInlineHeight: '150px', 

When recordLinks is set to editInline, this option can expand the height of the editable row, allowing more space for large text/choice fields

rowButtonText

e.g.

rowButtonText: 'View', 

When recordLinks above is set, rowButtonText can be used to set the text that appears on the button generated. Please note, this text can include emoji

rowButtonWidth

e.g.

rowButtonWidth: '60', 

When recordLinks above is set, rowButtonWidth can be used to set the width of the button column in pixels.

transposeTable

e.g.

transposeTable: 'true', 

When transposeTable is set to true the table will build with the headers down the left side with each iSheet row added as a column to the right. This makes comparison of data easier.

sumColumns

e.g.

sumColumns: '3,6', 

When set to one or more column numbers (starting from 0) in a comma separated list sumColumns will add a total row to the bottom of the table for each column listed. This will only populate for iSheet Number and Calculation type columns.

meanColumns

e.g.

meanColumns: '3,6',
meanIgnoreBlanks: 'true',

When set to one or more column numbers (starting from 0) in a comma separated list sumColumns will add a mean (average) row to the bottom of the table for each column listed. This will only populate for iSheet Number and Calculation type columns.
When meanIgnoreBlanks is set to try, blank rows will be excluded from the calculation rather than treated as 0

numberAlign

e.g.

numberAlign: 'left', 

By default number and calculation column values with right align (like Excel), setting this to left with override this

quickFilter

e.g.

quickFilter: 'true',
quickFilterPlaceholder: 'Search Table',

quickFilterButtonText: 'Search',

quickFilterClearText: 'Reset',

When set to true it enables a search box above the table that will search across all rows and columns and hide rows that do not contain an exact match

filterColumn

e.g.

filterColumn: '0', 

Used in combination with filterTerm, below, to set a hard-coded filter, this sets which column the filterTerm option should apply to

filterTerm

e.g.

filterTerm: 'Litigation',
filterTermFuzzy: 'true'

Used in combination with filterColumn, above, to set a hard-coded filter, this looks through all values in the filterColumn an displays only those containing the specified term, or containing the specified term if the filterTermFuzzy option is set to true.

exportButton

e.g.

exportButton: 'true', 

When set to "true", enables a button above the table allowing the user to export the data to CSV and download

collapse

e.g.

collapse: 'row', 

When set to "row", "column", or "both" with hide any row and/or column that is completely blank for all cells

truncateText

e.g.

truncateText: '50', 

When set to a number this option will truncate single line text and multiline text columns to the chosen number of characters (it may look like fewer if rich HTML is enabled). It will display a Show more link, allowing the user to expand the cell to see the full text.

linkTab

e.g.

linkTab: 'self', 

Tells HighQ hyperlink columns in the table whether to open in a new tab (blank) or the current tab (self)

progressColumns

e.g.

progressColumns: '1,5',
progressColorComplete: 'green',

progressColor: 'blue',

progressColorExceeded: 'red',

progress3d: 'true',

When set to a number or comma separated list of numbers (no spaces) this option will convert number columns (percentage) into a progress bar.

freezeColumns

e.g.

freezeColumns: '2', 

When set to a number this option will freeze that number of columns from the left of your table and set the flexColumns option to false. This will force the columns to display at the width set in the isheet columns admin page. If the width is greater than HighQ's page width, scroll bars will display and the frozen left column will remain in place as the remainder scroll left and right.

clickHighlight

e.g.

clickHighlight: 'true', 

When working with wider tabled using flexColumns: 'false', this option allows the user to click a row and highlight it to make scrolling right easier.

addItemButton

e.g.

addItemButton: 'true',
addItemTitle: 'New Matter', 

Will enable an "Add Record" button above the table, allowing the user (if they have permission) to add a new record to the iSheet, and refreshing the table when done. addItemTitle allows the button title to be customized.